openapi: 3.0.0 info: title: 'API Reference (Compact: no descriptions, no examples)' version: '2025-10-10' contact: email: docs@zuora.com x-compacted: removedDescriptions: true removedExamples: true compactedAt: '2025-10-13T03:37:10.424Z' servers: - url: https://rest.test.zuora.com - url: https://rest.sandbox.na.zuora.com - url: https://rest.apisandbox.zuora.com - url: https://rest.na.zuora.com - url: https://rest.zuora.com - url: https://rest.test.eu.zuora.com - url: https://rest.sandbox.eu.zuora.com - url: https://rest.eu.zuora.com - url: https://rest.test.ap.zuora.com - url: https://rest.ap.zuora.com security: - bearerAuth: [] tags: - name: Accounting Codes - name: Accounting Periods - name: Accounts - name: Delivery Adjustments - name: Aggregate Queries - name: Bill Run - name: Billing Documents - name: Billing Preview Run - name: Configuration Templates - name: Metadata - name: Bulk Data - name: Contact Snapshots - name: Contacts - name: Credit Memos - name: Custom Event Triggers - name: Custom Object Definitions - name: Custom Object Records - name: Custom Object Jobs - name: Custom Scheduled Events - name: Data Queries - name: Debit Memos - name: E-Invoicing - name: Invoice Schedules - name: Invoices - name: Journal Runs - name: Mass Updater - name: Notifications - name: OAuth - name: Operations - name: Payment Methods - name: Payments - name: Prepaid with Drawdown - name: Products - name: Sequence Sets - name: Subscriptions - name: Summary Journal Entries - name: Summary Statements - name: Taxation Items - name: Usage paths: /oauth/token: post: security: [] operationId: createToken parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: Zuora-Entity-Ids in: header required: false schema: type: string format: uuid requestBody: content: application/x-www-form-urlencoded: schema: properties: client_id: maxLength: 36 minLength: 36 type: string client_secret: maxLength: 42 type: string grant_type: enum: - client_credentials type: string required: - client_id - client_secret - grant_type type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/tokenResponse' headers: X-RateLimit-Limit-minute: schema: type: integer X-RateLimit-Remaining-minute: schema: type: integer Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '429': headers: X-RateLimit-Limit-minute: schema: type: integer X-RateLimit-Remaining-minute: schema: type: integer Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an OAuth token tags: - OAuth x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "client_id=b64e42ba-7e1a-4bc6-9146-5e1b420306b5" --data-urlencode "client_secret=dOFENLWU193EEoEsWjPZrcjLKVr5OrN1HC9Kqg" -d "grant_type=client_credentials" "https://rest.zuora.com/oauth/token" /v1/object/product: post: operationId: Object_POSTProduct parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyCreateProduct' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '400': content: application/json: schema: $ref: '#/components/schemas/ProxyBadRequestResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number WWW-Authenticate: schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Create a product' tags: - Products /v1/object/product/{id}: get: operationId: Object_GETProduct parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - in: query name: fields required: false schema: type: string - in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProxyGetProduct' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number WWW-Authenticate: schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '404': content: application/json: schema: $ref: '#/components/schemas/ProxyNoDataResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Retrieve a product' tags: - Products put: operationId: Object_PUTProduct parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyModifyProduct' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number WWW-Authenticate: schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Update a product' tags: - Products delete: operationId: Object_DELETEProduct parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProxyDeleteResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number WWW-Authenticate: schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Delete a product' tags: - Products /v1/accounts: post: operationId: POST_Account parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTAccountType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTAccountResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an account tags: - Accounts /v1/accounts/{account-key}: delete: operationId: DELETE_Account parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: account-key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeleteAccountResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an account tags: - Accounts get: operationId: GET_Account parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: account-key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETAccountType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an account tags: - Accounts put: operationId: PUT_Account parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: account-key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTAccountType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an account tags: - Accounts /v1/accounts/{account-key}/payment-methods: get: operationId: GET_AcountPaymentMethods parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: account-key required: true schema: type: string - in: query name: isDefaultOnly required: false schema: type: boolean - in: query name: isActiveOnly required: false schema: type: boolean - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETAccountPaymentMethodType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List payment methods of an account tags: - Accounts /v1/accounts/{account-key}/payment-methods/cascading: get: summary: Retrieve configuration of cascading payment methods for an account operationId: GetAccountPaymentMethodCascading parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: account-key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetCascadingPaymentMethodsConfigurationResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Accounts put: summary: Configure cascading payment methods for an account operationId: PutAccountPaymentMethodCascading parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: account-key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PutCascadingPaymentMethodsConfigurationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Accounts /v1/accounts/{account-key}/payment-methods/default: get: operationId: GET_AcountDefaultPaymentMethod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: account-key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETPaymentMethodResponseForAccount' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve the default payment method of an account tags: - Accounts /v1/accounts/{account-key}/summary: get: operationId: GET_AccountSummary parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: account-key required: true schema: type: string - in: query name: excludeUsage required: false schema: type: boolean - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETAccountSummaryType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an account summary tags: - Accounts /v1/contacts: post: operationId: POST_CreateContact parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTContactType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ContactResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a contact tags: - Contacts /v1/contacts/{contactId}: delete: operationId: DELETE_Contact parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: contactId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a contact tags: - Contacts get: operationId: GET_Contact parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: contactId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ContactResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a contact tags: - Contacts put: operationId: PUT_Contact parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: contactId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTContactType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ContactResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a contact tags: - Contacts /v1/contacts/{contactId}/transfer: put: operationId: transferContent parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - in: path name: contactId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTTransferContact' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Transfer a contact tags: - Contacts /v1/contacts/{contactId}/scrub: put: operationId: PUT_ScrubContact parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: contactId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Scrub a contact tags: - Contacts /v1/contact-snapshots/{contact-snapshot-id}: get: operationId: GET_ContactSnapshot parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - in: path name: contact-snapshot-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETContactSnapshotResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a contact snapshot tags: - Contact Snapshots /v1/subscriptions/preview: post: operationId: POST_PreviewSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTSubscriptionPreviewType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTSubscriptionPreviewResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Preview a subscription tags: - Subscriptions /v1/subscriptions/{subscription-key}/preview: post: operationId: PreviewExistingSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - in: header name: Zuora-Version required: false schema: type: string - in: path name: subscription-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PreviewExistingSubscriptionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PreviewExistingSubscriptionResponse' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Preview a subscription by subscription key tags: - Subscriptions x-accepts: application/json x-codegen-request-body-name: Request x-content-type: application/json /v1/subscriptions: post: operationId: POST_Subscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTSubscriptionType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTSubscriptionResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a subscription tags: - Subscriptions /v1/subscriptions/accounts/{account-key}: get: operationId: GET_SubscriptionsByAccount parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - in: path name: account-key required: true schema: type: string - in: query name: charge-detail required: false schema: type: string - in: query name: as-of-date schema: type: string - in: query name: exclude-rate-plans-with-no-charges required: false schema: type: boolean - in: query name: getDetailedMetrics schema: type: boolean default: false - in: query name: asOfDay schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETSubscriptionWrapper' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List subscriptions by account key tags: - Subscriptions /v1/subscriptions/{subscription-key}: get: operationId: GET_SubscriptionsByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: subscription-key required: true schema: type: string - in: query name: charge-detail required: false schema: type: string - in: query name: as-of-date schema: type: string - in: query name: exclude-rate-plans-with-no-charges required: false schema: type: boolean - in: query name: getDetailedMetrics schema: type: boolean default: false - name: asOfDay in: query schema: type: string - in: query name: getInvoiceOwnerDetails schema: type: boolean - in: query name: getSubscriptionOwnerDetails schema: type: boolean - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETSubscriptionByKeyWithSuccess' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a subscription by key tags: - Subscriptions put: operationId: PUT_Subscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - in: path name: subscription-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTSubscriptionType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PUTSubscriptionResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a subscription tags: - Subscriptions /v1/subscriptions/{subscription-key}/versions/{version}: get: operationId: GET_SubscriptionsByKeyAndVersion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: subscription-key required: true schema: type: string - in: path name: version required: true schema: type: string - in: query name: charge-detail required: false schema: type: string - in: query name: as-of-date schema: type: string - in: query name: exclude-rate-plans-with-no-charges required: false schema: type: boolean - in: query name: getDetailedMetrics schema: type: boolean default: false - in: query name: asOfDay schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETSubscriptionTypeWithSuccess' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a subscription by key and version tags: - Subscriptions /v1/subscriptions/{subscription-key}/renew: put: operationId: PUT_RenewSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - in: path name: subscription-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTRenewSubscriptionType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PUTRenewSubscriptionResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Renew a subscription tags: - Subscriptions /v1/subscriptions/{subscription-key}/cancel: put: operationId: PUT_CancelSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - in: path name: subscription-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTSubscriptionCancellationType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTSubscriptionCancellationResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a subscription tags: - Subscriptions /v1/subscriptions/{subscription-key}/resume: put: operationId: PUT_ResumeSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - in: path name: subscription-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTSubscriptionResumeType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PUTSubscriptionResumeResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Resume a subscription tags: - Subscriptions /v1/subscriptions/{subscription-key}/suspend: put: operationId: PUT_SuspendSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - in: path name: subscription-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTSubscriptionSuspendType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PUTSubscriptionSuspendResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Suspend a subscription tags: - Subscriptions /v1/subscriptions/{subscription-key}/delete: put: operationId: PUT_DeleteSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: subscription-key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/PUTDeleteSubscriptionResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a subscription by number tags: - Subscriptions /v1/subscriptions/{subscriptionNumber}/versions/{version}/customFields: put: operationId: PUT_UpdateSubscriptionCustomFieldsOfASpecifiedVersion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: subscriptionNumber required: true schema: format: string type: string - in: path name: version required: true schema: format: string type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTSubscriptionPatchSpecificVersionRequestType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update subscription custom fields of a subscription version tags: - Subscriptions /v1/subscriptions/subscription-metrics: get: operationId: GetMetricsBySubscriptionNumbers parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: query name: asOfDay schema: type: string - in: query name: subscriptionNumbers[] required: true schema: type: array items: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETMetricsBySubscriptionNumbersResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List subscription metrics by subscription numbers tags: - Subscriptions /v1/ppdd/reverse-rollover: post: operationId: POST_ReverseRollover parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTReverseRolloverRequestType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTReverseRolloverResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Reverse fund rollover tags: - Prepaid with Drawdown /v1/ppdd/rollover: post: operationId: POST_Rollover parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTTriggerRolloverRequestType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTTriggerRolloverResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Trigger fund rollover tags: - Prepaid with Drawdown /v1/prepaid-balance-funds/deplete: post: operationId: DepleteFunds parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTDepleteFundRequestType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTDepleteFundResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Deplete funds tags: - Prepaid with Drawdown /v1/usage: post: operationId: POST_Usage parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: multipart/form-data: schema: properties: file: format: binary type: string required: - file type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTUsageResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Upload a usage file tags: - Usage x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@UsageData.csv" "https://rest.zuora.com/v1/usage" /v1/invoices/invoice-item/{invoice-item-id}/usage-rate-detail: get: operationId: GET_Usage_Rate_Detail_By_Invoice_Item parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: invoice-item-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETUsageRateDetailWrapper' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve usage rate detail for an invoice item tags: - Usage /v1/object/usage: post: operationId: Object_POSTUsage parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyCreateUsage' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '400': content: application/json: schema: $ref: '#/components/schemas/ProxyBadRequestResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number WWW-Authenticate: schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Create a usage record' tags: - Usage /v1/object/usage/{id}: delete: operationId: Object_DELETEUsage parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProxyDeleteResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number WWW-Authenticate: schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Delete a usage record' tags: - Usage get: operationId: Object_GETUsage parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: query name: fields required: false schema: type: string - in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProxyGetUsage' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number WWW-Authenticate: schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '404': content: application/json: schema: $ref: '#/components/schemas/ProxyNoDataResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Retrieve a usage record' tags: - Usage put: operationId: Object_PUTUsage parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyModifyUsage' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number WWW-Authenticate: schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Update a usage record' tags: - Usage /v1/adjustments: get: operationId: GET_Subscription_Adjustments parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: query name: subscription-number required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETAdjustmentsBySubscriptionNumberResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all delivery adjustments of a subscription tags: - Delivery Adjustments post: operationId: Create_Adjustment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTCreateBillingAdjustmentRequestType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETAdjustmentsResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a delivery adjustment tags: - Delivery Adjustments /v1/adjustments/preview: post: operationId: Preview_Adjustment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTPreviewBillingAdjustmentRequestType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETAdjustmentsResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Preview a delivery adjustment tags: - Delivery Adjustments /v1/adjustments/{adjustment-key}: get: operationId: GET_Adjustment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: adjustment-key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETAdjustmentByIdResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a delivery adjustment tags: - Delivery Adjustments /v1/adjustments/{adjustmentId}/cancel: put: operationId: PUT_CancelAdjustment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: adjustmentId required: true schema: format: UUID type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/CancelBillingAdjustmentRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETCancelAdjustmentResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a delivery adjustment tags: - Delivery Adjustments /v1/billing-documents: get: operationId: GET_BillingDocuments parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - in: query name: accountId required: false schema: format: uuid type: string - in: query name: accountNumber required: false schema: format: uuid type: string - in: query name: documentDate required: false schema: format: date type: string - in: query name: status required: false schema: enum: - Draft - Posted - Canceled - Error type: string - in: query name: sort required: false schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/BillingDocumentQueryResponseElementType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List billing documents for an account tags: - Billing Documents x-code-samples: - label: Curl lang: curl source: | curl -X GET -H "Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3" -H "Content-Type: application/json" "https://rest.sandbox.eu.zuora.com/v1/billing-documents?accountId=402892c74c9193cd014c91d35b0a0132" /v1/accounts/billing-documents/files/deletion-jobs: post: operationId: POST_BillingDocumentFilesDeletionJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTBillingDocumentFilesDeletionJobRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTBillingDocumentFilesDeletionJobResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a job to hard delete billing document files tags: - Billing Documents /v1/accounts/billing-documents/files/deletion-jobs/{jobId}: get: operationId: GET_BillingDocumentFilesDeletionJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: jobId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETBillingDocumentFilesDeletionJobResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a job of hard deleting billing document files tags: - Billing Documents /v1/accounts/{key}/billing-documents/generate: post: operationId: POST_GenerateBillingDocuments parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostGenerateBillingDocumentType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GenerateBillingDocumentResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Generate billing documents by account ID tags: - Billing Documents /v1/invoices: post: operationId: POST_StandaloneInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostInvoiceType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PostInvoiceResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a standalone invoice tags: - Invoices put: operationId: PUT_BatchUpdateInvoices parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PutBatchInvoiceType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update invoices tags: - Invoices /v1/invoices/batch: post: operationId: POST_StandaloneInvoices parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostBatchInvoicesType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PostBatchInvoiceResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create standalone invoices tags: - Invoices /v1/invoices/bulk-post: post: operationId: POST_PostInvoices parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTInvoicesBatchPostType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvoicesBatchPostResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Post invoices tags: - Invoices /v1/invoices/pdf-status: get: operationId: GetInvoicePdfStatus parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - in: query name: invoiceKeys required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetInvoicePdfStatusBatchResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '400': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' WWW-Authenticate: schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string '403': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve the PDF file generation status of invoices tags: - Invoices x-accepts: application/json /v1/invoices/{invoiceKey}: delete: operationId: DELETE_DeleteInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeleteInvoiceResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an invoice tags: - Invoices get: operationId: Get_GetInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/PostInvoiceResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an invoice tags: - Invoices put: operationId: PUT_UpdateInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PutInvoiceType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PutInvoiceResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an invoice tags: - Invoices /v1/invoices/{invoiceKey}/application-parts: get: operationId: GET_InvoiceApplicationParts parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetInvoiceApplicationPartCollectionType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all application parts of an invoice tags: - Invoices /v1/invoices/{invoiceKey}/emails: post: operationId: POST_EmailInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostInvoiceEmailRequestType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Email an invoice tags: - Invoices /v1/invoices/{invoiceKey}/files: get: operationId: GET_InvoiceFiles parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETInvoiceFilesResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all files of an invoice tags: - Invoices post: operationId: POST_UploadFileForInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: multipart/form-data: schema: properties: file: format: binary type: string type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTUploadFileResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Upload a file for an invoice tags: - Invoices x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@InvoiceFile.pdf" "https://rest.zuora.com/v1/invoices/2c92c8955bd63cc1015bd7c151af02ab/files" /v1/invoices/{invoiceKey}/items: get: operationId: GET_InvoiceItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETInvoiceItemsResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all items of an invoice tags: - Invoices /v1/invoices/{invoiceKey}/items/{itemId}/taxation-items: get: operationId: GET_TaxationItemsOfInvoiceItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - in: path name: invoiceKey required: true schema: type: string - in: path name: itemId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETInvoiceTaxationItemsResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all taxation items of an invoice item tags: - Invoices /v1/invoices/{invoiceKey}/reverse: put: operationId: PUT_ReverseInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PutReverseInvoiceType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PutReverseInvoiceResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Reverse an invoice tags: - Invoices /v1/invoices/{invoiceKey}/taxation-items: post: operationId: POST_INV_TaxationItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTTaxationItemList' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETTaxationItemListType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create taxation items for an invoice tags: - Invoices /v1/invoices/{invoiceKey}/write-off: put: operationId: PUT_WriteOffInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTWriteOffInvoiceRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PUTWriteOffInvoiceResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Write off an invoice tags: - Invoices /v1/credit-memos: get: operationId: GET_CreditMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - in: query name: accountId required: false schema: type: string - in: query name: accountNumber required: false schema: type: string - in: query name: amount required: false schema: format: double type: number - in: query name: appliedAmount required: false schema: format: double type: number - in: query name: autoApplyUponPosting required: false schema: type: boolean - in: query name: createdById required: false schema: type: string - in: query name: createdDate required: false schema: format: date-time type: string - in: query name: creditMemoDate required: false schema: format: date type: string - in: query name: currency required: false schema: type: string - in: query name: excludeFromAutoApplyRules required: false schema: type: boolean - in: query name: number required: false schema: type: string - in: query name: referredInvoiceId required: false schema: type: string - in: query name: refundAmount required: false schema: format: double type: number - in: query name: sourceId required: false schema: type: string - in: query name: status required: false schema: enum: - Draft - Posted - Canceled - Error - PendingForTax - Generating - CancelInProgress type: string - in: query name: targetDate required: false schema: format: date type: string - in: query name: taxAmount required: false schema: format: double type: number - in: query name: totalTaxExemptAmount required: false schema: format: double type: number - in: query name: transferredToAccounting required: false schema: enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string - in: query name: unappliedAmount required: false schema: format: double type: number - in: query name: updatedById required: false schema: type: string - in: query name: updatedDate required: false schema: format: date-time type: string - in: query name: sort required: false schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETCreditMemoCollectionType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List credit memos tags: - Credit Memos post: operationId: POST_CreditMemoFromPrpc parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreditMemoFromChargeRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETCreditMemoType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a credit memo from a charge tags: - Credit Memos /v1/credit-memos/bulk: post: operationId: POST_CreateCreditMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTBulkCreditMemosRequestType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/BulkCreditMemosResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create credit memos tags: - Credit Memos put: operationId: PUT_UpdateCreditMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTBulkCreditMemosRequestType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/BulkCreditMemosResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update credit memos tags: - Credit Memos /v1/credit-memos/pdf-status: get: operationId: Get_CreditMemoPdfStatus parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - in: query name: creditMemoKeys required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetCreditMemoPdfStatusBatchResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '400': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' WWW-Authenticate: schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string '403': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve the PDF file generation status of credit memos tags: - Credit Memos x-accepts: application/json /v1/credit-memos/{creditMemoId}/items/{cmitemid}/taxation-items: get: operationId: GET_TaxationItemsOfCreditMemoItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - in: path name: cmitemid required: true schema: type: string - in: path name: creditMemoId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETTaxationItemsOfCreditMemoItemType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all taxation items of a credit memo item tags: - Credit Memos /v1/credit-memos/{creditMemoId}/write-off: put: operationId: PUT_WriteOffCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: creditMemoId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTCreditMemoWriteOff' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PUTCreditMemoWriteOffResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Write off a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}: delete: operationId: DELETE_CreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a credit memo tags: - Credit Memos get: operationId: GET_CreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETCreditMemoType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a credit memo tags: - Credit Memos put: operationId: PUT_UpdateCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTCreditMemoType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETCreditMemoType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/apply: put: operationId: PUT_ApplyCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplyCreditMemoType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETCreditMemoType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Apply a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/cancel: put: operationId: PUT_CancelCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETCreditMemoType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/emails: post: operationId: POST_EmailCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostCreditMemoEmailRequestType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Email a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/files: post: operationId: POST_UploadFileForCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: multipart/form-data: schema: properties: file: format: binary type: string type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTUploadFileResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Upload a file for a credit memo tags: - Credit Memos x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@CreditMemoFile.pdf" "https://rest.zuora.com/v1/credit-memos/402890555a7e9791015a879f064a0054/files" get: operationId: GET_CreditMemoFiles parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETCreditMemoFilesResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all files of a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/items: get: operationId: GET_CreditMemoItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - in: query name: amount required: false schema: format: double type: number - in: query name: appliedAmount required: false schema: format: double type: number - in: query name: createdById required: false schema: type: string - in: query name: createdDate required: false schema: format: date-time type: string - in: query name: id required: false schema: type: string - in: query name: refundAmount required: false schema: format: double type: number - in: query name: serviceEndDate required: false schema: format: date type: string - in: query name: serviceStartDate required: false schema: format: date type: string - in: query name: sku required: false schema: type: string - in: query name: skuName required: false schema: type: string - in: query name: sourceItemId required: false schema: type: string - in: query name: subscriptionId required: false schema: type: string - in: query name: updatedById required: false schema: type: string - in: query name: updatedDate required: false schema: format: date-time type: string - in: query name: sort required: false schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETCreditMemoItemsListType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List credit memo items tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/items/{cmitemid}: get: operationId: GET_CreditMemoItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: cmitemid required: true schema: type: string - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETCreditMemoItemType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a credit memo item tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/parts: get: operationId: GET_CreditMemoParts parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETCreditMemoPartsCollectionType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all parts of a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/parts/{partid}: get: operationId: GET_CreditMemoPart parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: partid required: true schema: type: string - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETCreditMemoPartType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a credit memo part tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/pdfs: post: operationId: POST_CreditMemoPDF parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTMemoPdfResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Generate a credit memo PDF file tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/post: put: operationId: PUT_PostCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETCreditMemoType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Post a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/refund: post: operationId: POST_RefundCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostNonRefRefundType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETRefundCreditMemoType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Refund a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/reverse: put: operationId: PUT_ReverseCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PutReverseCreditMemoType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PutReverseCreditMemoResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Reverse a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/taxation-items: post: operationId: POST_CM_TaxationItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTTaxationItemListForCMType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETTaxationItemListType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create taxation items for a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/unapply: put: operationId: PUT_UnapplyCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/UnapplyCreditMemoType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETCreditMemoType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Unapply a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/unpost: put: operationId: PUT_UnpostCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETCreditMemoType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Unpost a credit memo tags: - Credit Memos /v1/credit-memos/invoice/{invoiceKey}: post: operationId: POST_CreditMemoFromInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - in: path name: invoiceKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreditMemoFromInvoiceRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETCreditMemoType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a credit memo from an invoice tags: - Credit Memos /v1/credit-memos/unapply-async-jobs/{unapplyAsyncJobId}: get: operationId: getUnapplyCreditMemoAsyncJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - in: path name: unapplyAsyncJobId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvoiceSettlementAsyncJobResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an async unapply credit memo job by ID tags: - Credit Memos /v1/credit-memos/apply-async-jobs/{applyAsyncJobId}: get: operationId: getApplyCreditMemoAsyncJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - in: path name: applyAsyncJobId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvoiceSettlementAsyncJobResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an async unapply credit memo job by ID tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/apply-async: put: operationId: applyCreditMemoAsync parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/AsyncApplyCreditMemoRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvoiceSettlementAsyncJobResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Apply a credit memo aysnchronously tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/unapply-async: put: operationId: unapplyCreditMemoAsync parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/AsyncUnapplyCreditMemoRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvoiceSettlementAsyncJobResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Unapply a credit memo asynchronously tags: - Credit Memos /v1/debit-memos: get: operationId: GET_DebitMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - in: query name: accountId required: false schema: type: string - in: query name: accountNumber required: false schema: type: string - in: query name: amount required: false schema: format: double type: number - in: query name: balance required: false schema: format: double type: number - in: query name: beAppliedAmount required: false schema: format: double type: number - in: query name: createdById required: false schema: type: string - in: query name: createdDate required: false schema: format: date-time type: string - in: query name: currency required: false schema: type: string - in: query name: debitMemoDate required: false schema: format: date type: string - in: query name: dueDate required: false schema: format: date type: string - in: query name: number required: false schema: type: string - in: query name: referredInvoiceId required: false schema: type: string - in: query name: status required: false schema: enum: - Draft - Posted - Canceled - Error - PendingForTax - Generating - CancelInProgress type: string - in: query name: targetDate required: false schema: format: date type: string - in: query name: taxAmount required: false schema: format: double type: number - in: query name: totalTaxExemptAmount required: false schema: format: double type: number - in: query name: updatedById required: false schema: type: string - in: query name: updatedDate required: false schema: format: date-time type: string - in: query name: sort required: false schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETDebitMemoCollectionType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List debit memos tags: - Debit Memos post: operationId: POST_DebitMemoFromPrpc parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/DebitMemoFromChargeRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETDebitMemoType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a debit memo from a charge tags: - Debit Memos put: operationId: PUT_UpdateDebitMemosDueDates parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTBatchDebitMemosRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update due dates for debit memos tags: - Debit Memos /v1/debit-memos/bulk: post: operationId: POST_CreateDebitMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTBulkDebitMemosRequestType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/BulkDebitMemosResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create debit memos tags: - Debit Memos put: operationId: PUT_UpdateDebitMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTBulkDebitMemosRequestType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/BulkDebitMemosResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update debit memos tags: - Debit Memos /v1/debit-memos/pdf-status: get: operationId: Get_DebitMemoPdfStatus parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - in: query name: debitMemoKeys required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetDebitMemoPdfStatusBatchResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '400': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' WWW-Authenticate: schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string '403': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve the PDF file generation status of debit memos tags: - Debit Memos x-accepts: application/json /v1/debit-memos/{debitMemoId}/application-parts: get: operationId: GET_DebitMemoApplicationParts parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: debitMemoId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetDebitMemoApplicationPartCollectionType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all application parts of a debit memo tags: - Debit Memos /v1/debit-memos/{debitMemoId}/items/{dmitemid}/taxation-items: get: operationId: GET_TaxationItemsOfDebitMemoItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - in: path name: dmitemid required: true schema: type: string - in: path name: debitMemoId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETTaxationItemsOfDebitMemoItemType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all taxation items of a debit memo item tags: - Debit Memos /v1/debit-memos/{debitMemoKey}: delete: operationId: DELETE_DebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a debit memo tags: - Debit Memos get: operationId: GET_DebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETDebitMemoType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a debit memo tags: - Debit Memos put: operationId: PUT_DebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTDebitMemoType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETDebitMemoType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a debit memo tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/cancel: put: operationId: PUT_CancelDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETDebitMemoType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a debit memo tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/collect: post: operationId: POST_DebitMemoCollect parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/DebitMemoCollectRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DebitMemoCollectResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Collect a posted debit memo tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/emails: post: operationId: POST_EmailDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostDebitMemoEmailType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Email a debit memo tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/files: post: operationId: POST_UploadFileForDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: multipart/form-data: schema: properties: file: format: binary type: string type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTUploadFileResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Upload a file for a debit memo tags: - Debit Memos x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@DebitMemoFile.pdf" "https://rest.zuora.com/v1/debit-memos/402890555a87d7f5015a8919e4fe002e/files" get: operationId: GET_DebitMemoFiles parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETDebitMemoFilesResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all files of a debit memo tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/items: get: operationId: GET_DebitMemoItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - in: query name: amount required: false schema: format: double type: number - in: query name: beAppliedAmount required: false schema: format: double type: number - in: query name: createdById required: false schema: type: string - in: query name: createdDate required: false schema: format: date-time type: string - in: query name: id required: false schema: type: string - in: query name: serviceEndDate required: false schema: format: date type: string - in: query name: serviceStartDate required: false schema: format: date type: string - in: query name: sku required: false schema: type: string - in: query name: skuName required: false schema: type: string - in: query name: sourceItemId required: false schema: type: string - in: query name: subscriptionId required: false schema: type: string - in: query name: updatedById required: false schema: type: string - in: query name: updatedDate required: false schema: format: date-time type: string - in: query name: sort required: false schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETDebitMemoItemCollectionType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List debit memo items tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/items/{dmitemid}: get: operationId: GET_DebitMemoItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: dmitemid required: true schema: type: string - in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETDebitMemoItemType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a debit memo item tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/pdfs: post: operationId: POST_DebitMemoPDF parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTMemoPdfResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Generate a debit memo PDF file tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/post: put: operationId: PUT_PostDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETDebitMemoType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Post a debit memo tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/taxation-items: post: operationId: POST_DM_TaxationItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTTaxationItemListForDMType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETTaxationItemListType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create taxation items for a debit memo tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/unpost: put: operationId: PUT_UnpostDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETDebitMemoType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Unpost a debit memo tags: - Debit Memos /v1/debit-memos/invoice/{invoiceKey}: post: operationId: POST_DebitMemoFromInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/DebitMemoFromInvoiceRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETDebitMemoType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a debit memo from an invoice tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/write-off: put: operationId: PUT_WriteOffDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTWriteOffDebitMemoRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PUTWriteOffDebitMemoResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Write off a debit memo tags: - Debit Memos /v1/einvoice/service-providers: get: operationId: GET_EInvoicingServiceProviders parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListEInvoicingServiceProvidersResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List e-invoicing service providers tags: - E-Invoicing post: operationId: POST_EInvoicingServiceProvider parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEInvoicingServiceProviderRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetEInvoicingServiceProviderResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an e-invoicing service provider tags: - E-Invoicing /v1/einvoice/service-providers/{key}: delete: operationId: DELETE_EInvoicingServiceProvider parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an e-invoicing service provider tags: - E-Invoicing get: operationId: GET_EInvoicingServiceProvider parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetEInvoicingServiceProviderResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an e-invoicing service provider tags: - E-Invoicing put: operationId: PUT_UpdateEInvoicingServiceProvider parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateEInvoicingServiceProviderRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetEInvoicingServiceProviderResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an e-invoicing service provider tags: - E-Invoicing /v1/einvoice/business-regions: get: operationId: GET_EInvoicingBusinessRegions parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListEInvoicingBusinessRegionsResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List e-invoicing business regions tags: - E-Invoicing post: operationId: POST_CreateEInvoicingBusinessRegion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEInvoicingBusinessRegionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetEInvoicingBusinessRegionResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an e-invoicing business region tags: - E-Invoicing /v1/einvoice/business-regions/{key}: delete: operationId: DELETE_EInvoicingBusinessRegion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an e-invoicing business region tags: - E-Invoicing get: operationId: GET_EInvoicingBusinessRegion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetEInvoicingBusinessRegionResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an e-invoicing business region tags: - E-Invoicing put: operationId: PUT_UpdateEInvoicingBusinessRegion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateEInvoicingBusinessRegionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetEInvoicingBusinessRegionResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an e-invoicing business region tags: - E-Invoicing /v1/e-invoice/mandates: get: operationId: getEinvoiceMandates parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: query name: countryCode schema: type: string - in: query name: processType schema: type: string enum: - Clearance - ClearanceWithCancellation - PEPPOLNetwork - Unknown - in: query name: provider schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/EinvoiceFetchMandates' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List mandates for downloading files tags: - E-Invoicing /v1/invoices/{invoiceKey}/e-invoice/mandate: get: operationId: getEinvoiceMandateOnInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/EinvoiceInvoiceFetchMandate' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a mandate for downloading a file tags: - E-Invoicing /v1/credit-memos/{creditMemoKey}/e-invoice/mandate: get: operationId: getEinvoiceCreditMemoMandate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreditMemosEinvoiceMandate' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a mandate for downloading a credit memo tags: - E-Invoicing /v1/debit-memos/{debitMemoKey}/e-invoice/mandate: get: operationId: getEinvoiceDebitMemoMandate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/DebitMemosEinvoiceMandate' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a mandate for downloading a debit memo tags: - E-Invoicing /v1/invoices/{invoiceKey}/e-invoice/download: get: operationId: downloadEinvoiceOfSpecifiedFormat parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: query name: fileFormat schema: type: string enum: - XML - PDF - ZIP - OASIS_Universal_Business_Language_XML - in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/EinvoiceDownload' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Download a file in the specified file format tags: - E-Invoicing /v1/credit-memos/{creditMemoKey}/e-invoice/download/file: get: operationId: downloadCreditMemoEinvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: query name: fileFormat schema: type: string enum: - XML - PDF - ZIP - OASIS_Universal_Business_Language_XML - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreditMemosEinvoiceDownload' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Download a credit memo in the specified file format tags: - E-Invoicing /v1/debit-memos/{debitMemoKey}/e-invoice/download/file: get: operationId: downloadDebitMemoEinvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: query name: fileFormat schema: type: string enum: - XML - PDF - ZIP - OASIS_Universal_Business_Language_XML - in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/DebitMemosEinvoiceDownload' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Download a debit memo in the specified file format. tags: - E-Invoicing /v1/einvoice/templates: get: operationId: GET_EInvoiceFileTemplates parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: query name: country required: true schema: type: string - in: query name: documentType required: true schema: enum: - Invoice - CreditMemo - DebitMemo type: string - in: query name: provider required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListEInvoiceFileTemplatesResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List e-invoice file templates tags: - E-Invoicing post: operationId: POST_CreateEInvoiceFileTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEInvoiceFileTemplateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetEInvoiceFileTemplateResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an e-invoice file template tags: - E-Invoicing /v1/einvoice/templates/{key}: delete: operationId: DELETE_EInvoiceFileTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an e-invoice file template tags: - E-Invoicing get: operationId: GET_EInvoiceFileTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetEInvoiceFileTemplateResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an e-invoice file template tags: - E-Invoicing put: operationId: PUT_EInvoiceFileTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateEInvoiceFileTemplateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetEInvoiceFileTemplateResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an e-invoice file template tags: - E-Invoicing /v1/invoices/{invoiceKey}/e-invoice/sync-status: put: operationId: updateInvoiceInvokeSyncStatus parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: oneOf: - $ref: '#/components/schemas/ProxyUnauthorizedResponse' - $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number WWW-Authenticate: schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Sync the e-Invoice status of an invoice tags: - E-Invoicing /v1/debit-memos/{debitMemoKey}/e-invoice/sync-status: put: operationId: updateDebitMemoInvokeSyncStatus parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: oneOf: - $ref: '#/components/schemas/ProxyUnauthorizedResponse' - $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number WWW-Authenticate: schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Sync the e-Invoice status of a debit memo tags: - E-Invoicing /v1/credit-memos/{creditMemoKey}/e-invoice/sync-status: put: operationId: updateCreditMemoInvokeSyncStatus parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: oneOf: - $ref: '#/components/schemas/ProxyUnauthorizedResponse' - $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number WWW-Authenticate: schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Sync the e-Invoice status of a credit memo tags: - E-Invoicing /v1/invoices/{invoiceKey}/einvoice/generate: put: operationId: PUT_GenerationEInvoiceGenerationForInvoices parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Generate an e-invoice file for an invoice tags: - E-Invoicing /v1/credit-memos/{creditMemoKey}/e-invoice/generate: put: operationId: PUT_GenerateEInvoiceFileForCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Generate an e-invoice file for a credit memo tags: - E-Invoicing /v1/debit-memos/{debitMemoKey}/e-invoice/generate: put: operationId: PUT_GenerateEInvoiceFileForDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Generate an e-invoice file for a debit memo tags: - E-Invoicing /v1/invoice-schedules: post: operationId: POST_CreateInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTCreateInvoiceScheduleRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvoiceScheduleResponses' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an invoice schedule tags: - Invoice Schedules /v1/invoice-schedules/{scheduleKey}: delete: operationId: DELETE_InvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: scheduleKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an invoice schedule tags: - Invoice Schedules get: operationId: GET_InvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - in: path name: scheduleKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvoiceScheduleResponses' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an invoice schedule tags: - Invoice Schedules put: operationId: PUT_UpdateInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: scheduleKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTUpdateInvoiceScheduleRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvoiceScheduleResponses' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an invoice schedule tags: - Invoice Schedules /v1/invoice-schedules/{scheduleKey}/execute: post: operationId: POST_ExecuteInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: scheduleKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTExecuteInvoiceScheduleRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExecuteInvoiceScheduleBillRunResponse' autoEmail: {} autoPost: {} autoRenewal: {} billRunFilters: {} billRunNumber: {} createdById: {} createdDate: {} id: {} invoiceDate: {} noEmailForZeroAmountInvoice: {} status: {} success: {} targetDate: {} updatedById: {} updatedDate: {} headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Execute an invoice schedule tags: - Invoice Schedules /v1/invoice-schedules/{scheduleKey}/pause: put: operationId: PUT_PauseInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: scheduleKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvoiceScheduleResponses' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Pause an invoice schedule tags: - Invoice Schedules /v1/invoice-schedules/{scheduleKey}/resume: put: operationId: PUT_ResumeInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: scheduleKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvoiceScheduleResponses' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Resume an invoice schedule tags: - Invoice Schedules /v1/invoice-schedules/{scheduleKey}/detach: put: operationId: detachChargesFromInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: scheduleKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/DetachInvoiceScheduleRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Detach charges from an invoice schedule tags: - Invoice Schedules /v1/invoice-schedules/{scheduleKey}/attach: put: operationId: attachChargesToInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: scheduleKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/AttachInvoiceScheduleRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Attach charges to an invoice schedule tags: - Invoice Schedules /v1/object/taxation-item: post: operationId: Object_POSTTaxationItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyCreateTaxationItem' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '400': content: application/json: schema: $ref: '#/components/schemas/ProxyBadRequestResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number WWW-Authenticate: schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Create a taxation item' tags: - Taxation Items /v1/taxation-items/{id}: delete: operationId: DELETE_TaxationItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a taxation item tags: - Taxation Items get: operationId: GET_TaxationItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETTaxationItemType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: | Retrieve a taxation item tags: - Taxation Items put: operationId: PUT_TaxationItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTTaxationItemType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETTaxationItemType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a taxation item tags: - Taxation Items /v1/sequence-sets: get: operationId: GET_SequenceSets parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - in: query name: name required: false schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETSequenceSetsResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List sequence sets tags: - Sequence Sets post: operationId: POST_SequenceSets parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTSequenceSetsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTSequenceSetsResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create sequence sets tags: - Sequence Sets /v1/sequence-sets/{id}: delete: operationId: DELETE_SequenceSet parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a sequence set tags: - Sequence Sets get: operationId: GET_SequenceSet parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETSequenceSetResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a sequence set tags: - Sequence Sets put: operationId: PUT_SequenceSet parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTSequenceSetRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/PUTSequenceSetResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a sequence set tags: - Sequence Sets /v1/operations/billing-preview: post: operationId: POST_BillingPreview parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostBillingPreviewParam' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/BillingPreviewResult' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Generate a billing preview tags: - Operations /v1/operations/invoice-collect: post: operationId: POST_TransactionInvoicePayment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTInvoiceCollectType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTInvoiceCollectResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Invoice and collect tags: - Operations /v1/operations/jobs/{jobId}: get: operationId: GET_OperationJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: jobId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetOperationJobResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an operation job tags: - Operations /v1/operations/bulk-pdf: post: operationId: Create_BulkPDFToZIPGeneration parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTBulkPdfGenerationJobRequestType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTBulkPdfGenerationJobResponseType' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '400': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Export bulk PDF files tags: - Operations x-accepts: application/json x-codegen-request-body-name: Request x-content-type: application/json /v1/operations/bulk-pdf/{jobId}: get: operationId: Get_BulkPDFToZIPGeneration parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - in: path name: jobId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETBulkpdfGenerationJobResponseType' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve information of a bulk PDF file generation job tags: - Operations x-accepts: application/json /v1/bill-runs: post: operationId: POST_CreateBillRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTCreateBillRunRequestType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetBillRunResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a bill run tags: - Bill Run /v1/bill-runs/{billRunId}: delete: operationId: DELETE_DeleteBillRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: billRunId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetBillRunResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a bill run tags: - Bill Run get: operationId: GET_BillRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: billRunId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetBillRunResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a bill run tags: - Bill Run /v1/bill-runs/{billRunId}/cancel: put: operationId: PUT_CancelBillRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: billRunId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: properties: cancelOnce: default: true type: boolean type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CancelBillRunResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a bill run tags: - Bill Run /v1/bill-runs/{billRunId}/post: put: operationId: PUT_PostBillRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: billRunId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: properties: invoiceDate: format: date type: string required: - invoiceDate type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetBillRunResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Post a bill run tags: - Bill Run /v1/bill-runs/{billRunKey}/emails: post: operationId: POST_EmailBillingDocumentsfromBillRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: billRunKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTEmailBillingDocfromBillRunType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Email billing documents generated from a bill run tags: - Bill Run /v1/billing-preview-runs: post: operationId: POST_BillingPreviewRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostBillingPreviewRunParam' required: true responses: '200': content: application/json: schema: properties: billingPreviewRunId: type: string success: type: boolean type: object headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a billing preview run tags: - Billing Preview Run /v1/billing-preview-runs/{billingPreviewRunId}: get: operationId: GET_BillingPreviewRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - in: path name: billingPreviewRunId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetBillingPreviewRunResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a billing preview run tags: - Billing Preview Run /v1/payment-methods: post: operationId: POST_PaymentMethods parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTPaymentMethodRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTPaymentMethodResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a payment method tags: - Payment Methods /v1/payment-methods/decryption: post: operationId: POST_PaymentMethodsDecryption parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTPaymentMethodDecryption' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTPaymentMethodResponseDecryption' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an Apple Pay payment method tags: - Payment Methods /v1/payment-methods/{payment-method-id}: delete: operationId: DELETE_PaymentMethods parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: payment-method-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a payment method tags: - Payment Methods get: operationId: GET_PaymentMethod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: payment-method-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETPaymentMethodResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a payment method tags: - Payment Methods put: operationId: PUT_PaymentMethod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: payment-method-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTPaymentMethodRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PUTPaymentMethodResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a payment method tags: - Payment Methods /v1/payment-methods/{payment-method-id}/verify: put: operationId: PUT_VerifyPaymentMethods parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: payment-method-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTVerifyPaymentMethodType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PUTVerifyPaymentMethodResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Verify a payment method tags: - Payment Methods /v1/payment-methods/{payment-method-id}/scrub: put: operationId: PUT_ScrubPaymentMethods parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: payment-method-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Scrub a payment method tags: - Payment Methods /v1/payment-methods/{payment-method-id}/balance: get: summary: Retrieve the balance of a bank account tags: - Payment Methods operationId: getBankAccountBalance parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: payment-method-id required: true schema: type: string format: uuid - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetBankAccountBalanceResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' /v1/payment-methods/{payment-method-id}/profiles: get: operationId: GET_StoredCredentialProfiles parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: payment-method-id required: true schema: type: string - in: query name: includeAll schema: default: false type: boolean - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetStoredCredentialProfilesResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List stored credential profiles of a payment method tags: - Payment Methods post: operationId: POST_CreateStoredCredentialProfile parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: payment-method-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateStoredCredentialProfileRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModifiedStoredCredentialProfileResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a stored credential profile tags: - Payment Methods /v1/payment-methods/{payment-method-id}/profiles/{profile-number}/cancel: post: operationId: POST_CancelStoredCredentialProfile parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: payment-method-id required: true schema: type: string - in: path name: profile-number required: true schema: type: integer - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModifiedStoredCredentialProfileResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a stored credential profile tags: - Payment Methods x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3" "https://rest.zuora.com/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/cancel" /v1/payment-methods/{payment-method-id}/profiles/{profile-number}/expire: post: operationId: POST_ExpireStoredCredentialProfile parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: payment-method-id required: true schema: type: string - in: path name: profile-number required: true schema: type: integer - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModifiedStoredCredentialProfileResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Expire a stored credential profile tags: - Payment Methods x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3" "https://rest.zuora.com/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/expire" /payment-methods/apple-pay/domains: get: operationId: GET_ListApplePayDomains parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: query name: domainName schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETListApplePayDomainsResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List registered Apple Pay domains tags: - Payment Methods post: operationId: POST_RegisterApplePayDomain parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTRegisterApplePayDomainRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTRegisterApplePayDomainResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Register an Apple Pay domain tags: - Payment Methods /payment-methods/apple-pay/domains/{id}: delete: operationId: DELETE_UnregisterApplePayDomain parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/DELETEUnresigerApplePayDomainResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Unregister an Apple Pay domain tags: - Payment Methods /web-payments/sessions: post: operationId: POST_CreatePaymentSession parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTCreatePaymentSessionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTCreatePaymentSessionResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a payment session tags: - Payment Methods /v1/payments: get: operationId: GET_RetrieveAllPayments parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - in: query name: accountId required: false schema: type: string - in: query name: amount required: false schema: format: double type: number - in: query name: appliedAmount required: false schema: format: double type: number - in: query name: createdById required: false schema: type: string - in: query name: createdDate required: false schema: format: date-time type: string - in: query name: creditBalanceAmount required: false schema: format: double type: number - in: query name: currency required: false schema: type: string - in: query name: effectiveDate required: false schema: format: date-time type: string - in: query name: number required: false schema: type: string - in: query name: refundAmount required: false schema: format: double type: number - in: query name: status required: false schema: enum: - Draft - Processing - Processed - Error - Canceled - Posted type: string - in: query name: type required: false schema: enum: - External - Electronic type: string - in: query name: unappliedAmount required: false schema: format: double type: number - in: query name: updatedById required: false schema: type: string - in: query name: updatedDate required: false schema: format: date-time type: string - in: query name: sort required: false schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaymentCollectionResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List payments tags: - Payments post: operationId: POST_CreatePayment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePaymentType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETARPaymentTypeWithPaymentOption' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a payment tags: - Payments /v1/payments/{paymentId}: put: operationId: PUT_UpdatePayment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: paymentId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePaymentType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETARPaymentType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a payment tags: - Payments /v1/payments/{paymentKey}: delete: operationId: DELETE_Payment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a payment tags: - Payments get: operationId: GET_Payment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETARPaymentType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a payment tags: - Payments /v1/payments/{paymentKey}/apply: put: operationId: PUT_ApplyPayment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplyPaymentType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETARPaymentType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Apply a payment tags: - Payments /v1/payments/{paymentKey}/cancel: put: operationId: PUT_CancelPayment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETARPaymentType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a payment tags: - Payments /v1/payments/{paymentKey}/parts: get: operationId: GET_PaymentParts parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETPaymentPartsCollectionType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all parts of a payment tags: - Payments /v1/payments/{paymentKey}/parts/{partid}: get: operationId: GET_PaymentPart parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: partid required: true schema: type: string - in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETPaymentPartType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a payment part tags: - Payments /v1/payments/{paymentKey}/parts/{partid}/item-parts: get: operationId: GET_PaymentItemParts parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - in: path name: partid required: true schema: type: string - in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETPaymentItemPartCollectionType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all payment part items tags: - Payments /v1/payments/{paymentKey}/parts/{partid}/item-parts/{itempartid}: get: operationId: GET_PaymentItemPart parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: partid required: true schema: type: string - in: path name: itempartid required: true schema: type: string - in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETPaymentItemPartType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a payment part item tags: - Payments /v1/payments/{paymentKey}/refunds: post: operationId: POST_RefundPayment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostRefundType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETRefundPaymentType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Refund a payment tags: - Payments /v1/payments/{paymentKey}/refunds/unapply: post: operationId: POST_RefundPaymentwithAutoUnapply parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostRefundwithAutoUnapplyType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETRefundPaymentTypeAutoUnapply' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Refund a payment with auto-unapplying tags: - Payments /v1/payments/{paymentKey}/transfer: put: operationId: PUT_TransferPayment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/TransferPaymentType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETARPaymentType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Transfer a payment tags: - Payments /v1/payments/{paymentKey}/unapply: put: operationId: PUT_UnapplyPayment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/UnapplyPaymentType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETARPaymentType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Unapply a payment tags: - Payments /v1/summary-statement-runs: post: operationId: createSummaryStatementRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SummaryStatementRunRequestType' responses: '200': content: application/json: schema: $ref: '#/components/schemas/SummaryStatementRunResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string summary: Create a summary statement run tags: - Summary Statements /v1/accounting-codes: get: operationId: GET_AllAccountingCodes parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize_finance_accounting' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETAccountingCodesType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all accounting codes tags: - Accounting Codes post: operationId: POST_AccountingCode parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTAccountingCodeType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTAccountingCodeResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an accounting code tags: - Accounting Codes /v1/accounting-codes/{ac-id}: delete: operationId: DELETE_AccountingCode parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: ac-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an accounting code tags: - Accounting Codes get: operationId: GET_AccountingCode parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: ac-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETAccountingCodeItemType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an accounting code tags: - Accounting Codes put: operationId: PUT_AccountingCode parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: ac-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTAccountingCodeType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an accounting code tags: - Accounting Codes /v1/accounting-codes/{ac-id}/activate: put: operationId: PUT_ActivateAccountingCode parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: ac-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Activate an accounting code tags: - Accounting Codes /v1/accounting-codes/{ac-id}/deactivate: put: operationId: PUT_DeactivateAccountingCode parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: ac-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Deactivate an accounting code tags: - Accounting Codes /v1/accounting-periods: get: operationId: GET_AllAccountingPeriods parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize_finance_accounting' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETAccountingPeriodsType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all accounting periods tags: - Accounting Periods post: operationId: POST_AccountingPeriod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTAccountingPeriodType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTAccountingPeriodResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an accounting period tags: - Accounting Periods /v1/accounting-periods/{ap-id}: delete: operationId: DELETE_AccountingPeriod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: ap-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an accounting period tags: - Accounting Periods get: operationId: GET_AccountingPeriod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: ap-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETAccountingPeriodType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an accounting period tags: - Accounting Periods put: operationId: PUT_UpdateAccountingPeriod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: ap-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTAccountingPeriodType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an accounting period tags: - Accounting Periods /v1/accounting-periods/{ap-id}/close: put: operationId: PUT_CloseAccountingPeriod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: ap-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Close an accounting period tags: - Accounting Periods /v1/accounting-periods/{ap-id}/pending-close: put: operationId: PUT_PendingCloseAccountingPeriod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: ap-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Set an accounting period to pending close tags: - Accounting Periods /v1/accounting-periods/{ap-id}/reopen: put: operationId: PUT_ReopenAccountingPeriod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: ap-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Reopen an accounting period tags: - Accounting Periods /v1/accounting-periods/{ap-id}/run-trial-balance: put: operationId: PUT_RunTrialBalance parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: ap-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Run trial balance tags: - Accounting Periods /v1/journal-entries: post: operationId: POST_SummaryJournalEntry parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTJournalEntryType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTJournalEntryResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a summary journal entry tags: - Summary Journal Entries /v1/journal-entries/journal-runs/{jr-number}: get: operationId: GET_AllSummaryJournalEntries parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize_finance_revenue' - in: path name: jr-number required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETJournalEntriesInJournalRunType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all summary journal entries in a journal run tags: - Summary Journal Entries /v1/journal-entries/{je-number}: delete: operationId: DELETE_SummaryJournalEntry parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: je-number required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a summary journal entry tags: - Summary Journal Entries get: operationId: GET_SummaryJournalEntry parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: je-number required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETJournalEntryDetailType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a summary journal entry tags: - Summary Journal Entries /v1/journal-entries/{je-number}/basic-information: put: operationId: PUT_BasicSummaryJournalEntry parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: je-number required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTBasicSummaryJournalEntryType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a summary journal entry tags: - Summary Journal Entries /v1/journal-entries/{je-number}/cancel: put: operationId: PUT_SummaryJournalEntry parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: je-number required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a summary journal entry tags: - Summary Journal Entries /v1/journal-runs: post: operationId: POST_JournalRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTJournalRunType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTJournalRunResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a journal run tags: - Journal Runs /v1/journal-runs/{jr-number}: delete: operationId: DELETE_JournalRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: jr-number required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a journal run tags: - Journal Runs get: operationId: GET_JournalRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: jr-number required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETJournalRunType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a journal run tags: - Journal Runs /v1/journal-runs/{jr-number}/cancel: put: operationId: PUT_JournalRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: jr-number required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a journal run tags: - Journal Runs /v1/bulk: post: operationId: POST_MassUpdater parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: multipart/form-data: schema: properties: file: format: binary type: string params: type: string required: - file - params type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/POSTMassUpdateResponseType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Perform a mass action tags: - Mass Updater x-code-samples: - label: cURL lang: curl source: | curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@CreateRevenueSchedules.csv" -F "params="{\"actionType\": \"CreateRevenueSchedule\"}" "https://rest.zuora.com/v1/bulk" /v1/bulk/{bulk-key}: get: operationId: GET_MassUpdater parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: bulk-key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETMassUpdateType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all results of a mass action tags: - Mass Updater /v1/bulk/{bulk-key}/stop: put: operationId: PUT_MassUpdater parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: bulk-key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Stop a mass action tags: - Mass Updater /events/event-triggers: post: operationId: POST_EventTrigger parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostEventTriggerRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/EventTrigger' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an event trigger tags: - Custom Event Triggers get: operationId: GET_EventTriggers parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: query name: baseObject required: false schema: type: string - in: query name: eventTypeName required: false schema: type: string - in: query name: active required: false schema: type: string - in: query name: start required: false schema: default: 0 minimum: 0 type: integer - in: query name: limit required: false schema: default: 10 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/EventTrigger' type: array next: type: string type: object headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List event triggers tags: - Custom Event Triggers /events/event-triggers/{id}: get: operationId: GET_EventTrigger parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/EventTrigger' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an event trigger tags: - Custom Event Triggers put: operationId: PUT_EventTrigger parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PutEventTriggerRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/EventTrigger' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an event trigger tags: - Custom Event Triggers delete: operationId: DELETE_EventTrigger parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: format: uuid type: string responses: '204': headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an event trigger tags: - Custom Event Triggers /events/scheduled-events: post: operationId: POST_ScheduledEvent parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostScheduledEventRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetScheduledEventResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a scheduled event tags: - Custom Scheduled Events get: operationId: GET_ScheduledEvents parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: query name: eventTypeName required: false schema: type: string - in: query name: apiObject required: false schema: type: string - in: query name: apiField required: false schema: type: string - in: query name: active required: false schema: type: boolean - in: query name: start required: false schema: default: 0 minimum: 0 type: integer - in: query name: limit required: false schema: default: 10 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/GetScheduledEventResponse' type: array next: type: string type: object headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all scheduled events tags: - Custom Scheduled Events /events/scheduled-events/{id}: get: operationId: GET_ScheduledEventByID parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetScheduledEventResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a scheduled event by ID tags: - Custom Scheduled Events put: operationId: UPDATE_ScheduledEventByID parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PutScheduledEventRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetScheduledEventResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a scheduled event by ID tags: - Custom Scheduled Events delete: operationId: DELETE_ScheduledEventByID parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: type: string responses: '204': headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a scheduled event by ID tags: - Custom Scheduled Events /notifications/notification-definitions: post: operationId: POST_Create_Notification_Definition parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTPublicNotificationDefinitionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETPublicNotificationDefinitionResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a notification definition tags: - Notifications get: operationId: GET_Query_Notification_Definitions parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - allowEmptyValue: true in: query name: start schema: default: 1 format: int32 type: integer - allowEmptyValue: true in: query name: limit schema: default: 20 format: int32 maximum: 100 minimum: 1 type: integer - allowEmptyValue: true in: query name: profileId schema: format: uuid type: string - in: query name: eventCategory schema: type: number - allowEmptyValue: true in: query name: eventTypeName schema: type: string - allowEmptyValue: true in: query name: emailTemplateId schema: format: uuid type: string responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/GETPublicNotificationDefinitionResponse' type: array next: type: string type: object headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List notification definitions tags: - Notifications /notifications/notification-definitions/{id}: get: operationId: GET_Get_Notification_Definition parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETPublicNotificationDefinitionResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a notification definition tags: - Notifications put: operationId: PUT_Update_Notification_Definition parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTPublicNotificationDefinitionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETPublicNotificationDefinitionResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a notification definition tags: - Notifications delete: operationId: DELETE_Delete_Notification_Definition parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: id required: true schema: format: uuid type: string responses: '204': headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a notification definition tags: - Notifications /notifications/email-templates/import: post: operationId: POST_CreateOrUpdateEmailTemplates parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTCreateOrUpdateEmailTemplateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreateOrUpdateEmailTemplatesResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create or update email templates tags: - Notifications /notifications/email-templates: post: operationId: POST_Create_Email_Template parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTPublicEmailTemplateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETPublicEmailTemplateResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an email template tags: - Notifications get: operationId: GET_Query_Email_Templates parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - allowEmptyValue: true in: query name: start schema: default: 1 format: int32 type: integer - allowEmptyValue: true in: query name: limit schema: default: 20 format: int32 maximum: 100 minimum: 1 type: integer - allowEmptyValue: true in: query name: eventCategory schema: type: number - allowEmptyValue: true in: query name: eventTypeName schema: type: string - allowEmptyValue: true in: query name: name schema: type: string responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/GETPublicEmailTemplateResponse' type: array next: type: string type: object headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List email templates tags: - Notifications /notifications/email-templates/{id}: get: operationId: GET_Get_Email_Template parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETPublicEmailTemplateResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an email template tags: - Notifications put: operationId: PUT_Update_Email_Template parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTPublicEmailTemplateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETPublicEmailTemplateResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an email template tags: - Notifications delete: operationId: DELETE_Delete_Email_Template parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: id required: true schema: format: uuid type: string responses: '204': headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an email template tags: - Notifications /notifications/callout-templates/import: post: summary: Create or update callout templates operationId: CreateOrUpdateCalloutTemplates tags: - Notifications parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTCreateOrUpdateCalloutTemplateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreateOrUpdateEmailTemplatesResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' /notifications/callout-templates: post: summary: Create a callout template operationId: CreateCalloutTemplate tags: - Notifications parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTPublicCalloutTemplateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETPublicCalloutTemplateResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' get: summary: List callout templates operationId: GetCalloutTemplates tags: - Notifications parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - allowEmptyValue: true in: query name: start schema: default: 1 format: int32 type: integer - allowEmptyValue: true in: query name: limit schema: default: 20 format: int32 maximum: 100 minimum: 1 type: integer - allowEmptyValue: true in: query name: eventCategory schema: type: number - allowEmptyValue: true in: query name: eventTypeName schema: type: string - allowEmptyValue: true in: query name: name schema: type: string responses: '200': content: application/json: schema: type: object properties: data: items: $ref: '#/components/schemas/GETPublicCalloutTemplateResponse' type: array next: type: string headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' /notifications/callout-templates/{id}: get: summary: Retrieve a callout template operationId: GetCalloutTemplte tags: - Notifications parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETPublicCalloutTemplateResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' put: summary: Update a callout template operationId: UpdateCalloutTemplate tags: - Notifications parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTPublicCalloutTemplateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETPublicCalloutTemplateResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' delete: summary: Delete a callout template operationId: DeleteCalloutTemplate tags: - Notifications parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: id required: true schema: format: uuid type: string responses: '204': headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' /notifications/reusable-blocks/import: post: operationId: createOrUpdateReusableBlocks parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOrUpdateReusableBlockRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreateOrUpdateReusableBlockResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create or update reusable blocks tags: - Notifications /notifications/reusable-blocks: post: operationId: createReusableBlock parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePublicReusableBlockRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetPublicReusableBlockResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a reusable block tags: - Notifications get: operationId: getReusableBlocks parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - allowEmptyValue: true in: query name: start schema: default: 1 format: int32 type: integer - allowEmptyValue: true in: query name: limit schema: default: 20 format: int32 maximum: 5000 minimum: 1 type: integer - allowEmptyValue: true in: query name: activeOnly schema: type: boolean default: true - allowEmptyValue: true in: query name: category schema: type: string enum: - Headers - Footers - Other - allowEmptyValue: true in: query name: name schema: type: string - allowEmptyValue: true in: query name: tag schema: type: array items: type: string responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/GetPublicReusableBlockResponse' type: array next: type: string type: object headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List reusable blocks tags: - Notifications /notifications/reusable-blocks/{blockKey}: get: operationId: getReusableBlock parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: blockKey required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetPublicReusableBlockResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a reusable block tags: - Notifications put: operationId: updateReusableBlock parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: blockKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePublicReusableBlockRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/UpdatePublicReusableBlockResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a reusable block tags: - Notifications delete: operationId: deleteReusableBlock parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: blockKey required: true schema: type: string responses: '204': headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a reusable block tags: - Notifications /notifications/history: delete: operationId: DELETE_Delete_Notification_History_For_Account parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: query name: accountId required: true schema: format: uuid type: string responses: '202': content: application/json: schema: $ref: '#/components/schemas/NotificationsHistoryDeletionTaskResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: type: string headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete notification histories for an account tags: - Notifications x-code-samples: - label: Curl lang: curl source: | curl -X DELETE -H "Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3" -H "Content-Type: application/json" "https://rest.zuora.com//notifications/history?accountId=402892c74c9193cd014c96bbe7c101f9" /notifications/history/tasks/{id}: get: operationId: GET_Get_Notification_History_Deletion_Task parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/NotificationsHistoryDeletionTaskResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a notification history deletion task tags: - Notifications /notifications/callout-histories/resend: post: operationId: POST_ResendCalloutNotifications parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTResendCalloutNotifications' required: true responses: '202': content: application/json: schema: $ref: '#/components/schemas/ResendCalloutNotificationsFailedResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ResendCalloutNotificationsFailedResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Resend callout notifications tags: - Notifications /notifications/email-histories/resend: post: operationId: POST_ResendEmailNotifications parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTResendEmailNotifications' required: true responses: '202': content: application/json: schema: $ref: '#/components/schemas/ResendEmailNotificationsFailedResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ResendEmailNotificationsFailedResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Resend email notifications tags: - Notifications /v1/notification-history/callout: get: operationId: GET_CalloutHistory parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - in: query name: endTime required: false schema: format: date-time type: string - in: query name: startTime required: false schema: format: date-time type: string - in: query name: objectId required: false schema: type: string - in: query name: failedOnly required: false schema: type: boolean - in: query name: eventCategory required: false schema: type: string - in: query name: includeResponseContent required: false schema: type: boolean - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETCalloutHistoryVOsType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: List callout notification histories tags: - Notifications /v1/notification-history/email: get: operationId: GET_EmailHistory parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - in: query name: accountId schema: type: string - in: query name: endTime required: false schema: format: date-time type: string - in: query name: startTime required: false schema: format: date-time type: string - in: query name: objectId required: false schema: type: string - in: query name: failedOnly required: false schema: type: boolean - in: query name: eventCategory required: false schema: type: number - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETEmailHistoryVOsType' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: List email notification histories tags: - Notifications /objects/definitions/default: post: operationId: POST_CustomObjectDefinitions parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: header name: Zuora-Version required: false schema: format: date type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PostCustomObjectDefinitionsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETAllCustomObjectDefinitionsInNamespaceResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create custom object definitions tags: - Custom Object Definitions get: operationId: GET_AllCustomObjectDefinitionsInNamespace parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: header name: Zuora-Version required: false schema: format: date type: string - in: query name: select required: false schema: enum: - type type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETAllCustomObjectDefinitionsInNamespaceResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List custom object definitions tags: - Custom Object Definitions /objects/migrations: post: operationId: POST_UpdateCustomObjectDefinition parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: header name: Zuora-Version required: false schema: format: date type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MigrationUpdateCustomObjectDefinitionsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/MigrationUpdateCustomObjectDefinitionsResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a custom object definition tags: - Custom Object Definitions /objects/definitions/default/{object}: get: operationId: GET_CustomObjectDefinitionByType parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: header name: Zuora-Version required: false schema: format: date type: string - in: path name: object required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomObjectDefinition' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a custom object definition tags: - Custom Object Definitions delete: operationId: Delete_CustomObjectDefinitionByType parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: header name: Zuora-Version required: false schema: format: date type: string - in: path name: object required: true schema: type: string responses: '200': content: application/json: schema: format: uri type: string headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a custom object definition tags: - Custom Object Definitions /objects/records/default/{object}: post: operationId: POST_CustomObjectRecords parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: header name: Zuora-Version required: false schema: format: date type: string - in: path name: object required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PostCustomObjectRecordsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PostCustomObjectRecordsResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/CustomObjectRecordsErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse401Record' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/CustomObjectRecordsThrottledResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create custom object records tags: - Custom Object Records get: operationId: GET_AllRecordsForCustomObjectType parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: header name: Zuora-Version required: false schema: format: date type: string - in: path name: object required: true schema: type: string - in: query name: q required: false schema: type: string - in: query name: ids required: false schema: type: string - in: query name: pageSize required: false schema: maximum: 1000 minimum: 1 type: integer - in: query name: cursor required: false schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/QueryCustomObjectRecordsResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List records for a custom object tags: - Custom Object Records /objects/records/default/{object}/{id}: get: operationId: GET_CustomObjectRecordByID parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: header name: Zuora-Version required: false schema: format: date type: string - in: path name: object required: true schema: type: string - in: path name: id required: true schema: format: uuid maxLength: 36 minLength: 36 type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomObjectRecordWithAllFields' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a custom object record tags: - Custom Object Records put: operationId: PUT_CustomObjectRecord parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_If_Match' - in: header name: Zuora-Version required: false schema: format: date type: string - in: path name: object required: true schema: type: string - in: path name: id required: true schema: format: uuid maxLength: 36 minLength: 36 type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomObjectRecordWithOnlyCustomFields' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomObjectRecordWithAllFields' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a custom object record tags: - Custom Object Records patch: operationId: Patch_PartialUpdateCustomObjectRecord parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: header name: Zuora-Version required: false schema: format: date type: string - in: path name: object required: true schema: type: string - in: path name: id required: true schema: format: uuid maxLength: 36 minLength: 36 type: string requestBody: content: application/merge-patch+json: schema: $ref: '#/components/schemas/CustomObjectRecordWithOnlyCustomFields' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomObjectRecordWithAllFields' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Partially update a custom object record tags: - Custom Object Records delete: operationId: Delete_CustomObjectRecordByID parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: header name: Zuora-Version required: false schema: format: date type: string - in: path name: object required: true schema: type: string - in: path name: id required: true schema: format: uuid maxLength: 36 minLength: 36 type: string responses: '200': content: application/json: schema: format: uri type: string headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a custom object record tags: - Custom Object Records /objects/batch/default/{object}: post: operationId: POST_CustomObjectRecordsBatchUpdateOrDelete parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: header name: Zuora-Version required: false schema: format: date type: string - in: path name: object required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomObjectRecordBatchRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomObjectRecordsBatchUpdatePartialSuccessResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/CustomObjectRecordsErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse401Record' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/CustomObjectRecordsThrottledResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update or delete custom object records tags: - Custom Object Records /objects/jobs: post: operationId: POST_CustomObjectBulkJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: header name: Zuora-Version required: false schema: format: date type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomObjectBulkJobRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomObjectBulkJobResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Submit a custom object bulk job tags: - Custom Object Jobs get: operationId: GET_AllCustomObjectBulkJobs parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: header name: Zuora-Version required: false schema: format: date type: string - in: query name: pageSize required: false schema: default: 25 maximum: 100 type: integer - in: query name: cursor required: false schema: type: string - in: query name: status required: false schema: enum: - pending - accepted - in_progress - completed - failed - cancelled type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomObjectBulkJobResponseCollection' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all custom object bulk jobs tags: - Custom Object Jobs x-code-samples: - label: Curl lang: curl source: | curl -X GET -H "Authorization: Bearer e5cb941a9b1f47838b4085b4d5e00415" -H "Content-Type: application/json" "https://rest.zuora.com/objects/jobs?pageSize=2&cursor=a9e9a58d-0a11-4685-b1ab-99521dbc20a1" /objects/jobs/{id}: get: operationId: GET_CustomObjectBulkJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: header name: Zuora-Version required: false schema: format: date type: string - in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomObjectBulkJobResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a custom object bulk job tags: - Custom Object Jobs /objects/jobs/{id}/files: post: operationId: POST_UploadFileForCustomObjectBulkJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: header name: Zuora-Version required: false schema: format: date type: string - in: header name: Content-Type required: true schema: type: string - in: path name: id required: true schema: format: uuid type: string requestBody: content: text/csv: schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomObjectBulkJobResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Upload a file for a custom object bulk job tags: - Custom Object Jobs x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer e5cb941a9b1f47838b4085b4d5e00415" -H "Content-Type: text/csv" --data-binary "@CustomObjectRecords.csv" "https://rest.zuora.com/objects/jobs/5112347a-f7a1-4373-99df-c082984de7be/files" /objects/jobs/{id}/errors: get: operationId: GET_CustomObjectBulkJobErrors parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: header name: Zuora-Version required: false schema: format: date type: string - in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomObjectBulkJobErrorResponseCollection' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all errors for a custom object bulk job tags: - Custom Object Jobs /objects/jobs/{id}/cancel: patch: operationId: PATCH_CustomObjectBulkJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: header name: Zuora-Version required: false schema: format: date type: string - in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomObjectBulkJobResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a custom object bulk job tags: - Custom Object Jobs /query/jobs: get: operationId: GET_DataQueryJobs parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: query name: queryStatus required: false schema: enum: - accepted - in_progress - completed - failed - cancelled type: string - in: query name: pageSize required: false schema: default: 20 maximum: 1000 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetDataQueryJobsResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List data query jobs tags: - Data Queries post: operationId: POST_DataQueryJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: Content-Type in: header required: true schema: type: string enum: - application/json requestBody: content: application/json: schema: $ref: '#/components/schemas/SubmitDataQueryRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubmitDataQueryResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/DataQueryErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: schema: $ref: '#/components/schemas/DataQueryErrorResponse' summary: Submit a data query tags: - Data Queries /query/jobs/{job-id}: delete: operationId: DELETE_DataQueryJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: job-id required: true schema: format: uuid maxLength: 64 minLength: 64 type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeleteDataQueryJobResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/DataQueryErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a data query job tags: - Data Queries get: operationId: GET_DataQueryJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: job-id required: true schema: format: uuid maxLength: 36 minLength: 36 type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetDataQueryJobResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: schema: $ref: '#/components/schemas/DataQueryErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/DataQueryErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a data query job tags: - Data Queries /v1/batch-query/: post: operationId: POST_BatchQueryJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/SubmitBatchQueryRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubmitBatchQueryResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: Submit an aggregate query job tags: - Aggregate Queries /v1/batch-query/jobs/partner/{partner}/project/{project}: get: operationId: GET_LastBatchQueryJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: partner required: true schema: type: string - in: path name: project required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetAggregateQueryJobResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: Retrieve the last completed aggregate query job tags: - Aggregate Queries /v1/batch-query/jobs/{jobid}: delete: operationId: DELETE_BatchQueryJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: jobid required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeleteBatchQueryJobResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: Cancel a running aggregate query job tags: - Aggregate Queries get: operationId: GET_BatchQueryJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: jobid required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetAggregateQueryJobResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: Retrieve an aggregate query job tags: - Aggregate Queries /deployment-manager/deployment_artifacts: get: operationId: GET_DownloadDeploymentTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: query name: deployment_template_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/JsonNode' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '401': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '403': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '404': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string summary: Download a template tags: - Configuration Templates /deployment-manager/deployment_artifacts/compare: post: operationId: POST_CompareTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: query name: tenant required: true schema: type: string requestBody: content: multipart/form-data: schema: properties: template: format: binary type: string type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/CompareSchemaInfoResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '201': headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '403': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '404': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string summary: Compare settings between a source tenant and a target tenant tags: - Configuration Templates /deployment-manager/deployment_artifacts/deploy: post: operationId: POST_MigrateTenantSettings parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: query name: tenant required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TemplateMigrationClientRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/MigrationClientResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '201': headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '401': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '403': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '404': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string summary: Migrate settings from source tenant to target tenant tags: - Configuration Templates /deployment-manager/deployment_artifacts/retrieve-settings: get: operationId: GET_SourceComponentDetails parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' responses: '200': content: application/json: schema: $ref: '#/components/schemas/SettingSourceComponentResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '401': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '403': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '404': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string summary: List all details of source components tags: - Configuration Templates /deployment-manager/deployment_templates: get: operationId: GET_Templates parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' responses: '200': content: application/json: schema: $ref: '#/components/schemas/TemplateResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '401': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '403': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '404': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string summary: List all templates tags: - Configuration Templates post: operationId: POST_DeploymentTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTemplateRequestContent' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TemplateDetailResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '201': headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '401': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '403': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '404': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string summary: Create a deployment template tags: - Configuration Templates /deployment-manager/deployment_templates/{id}: delete: operationId: DELETE_DeploymentTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: type: string responses: '200': headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '204': headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '401': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '403': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '404': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string summary: Delete a template tags: - Configuration Templates get: operationId: GET_DeploymentTemplateDetail parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TemplateDetailResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '401': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '403': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string '404': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string summary: List all details of a template tags: - Configuration Templates /deployment-manager/deployment_templates/sync: post: tags: - Configuration Templates summary: Sync a deployment template with latest changes operationId: syncDeploymentTemplate parameters: - name: Content-Type in: header required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/SyncDeploymentTemplateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/TemplateDetailResponse' '400': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' '401': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' '403': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' '404': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' /deployment-manager/deployments/tenants: post: tags: - Metadata summary: Compare and deploy a source tenant to a target tenant operationId: CompareDeployTenant parameters: - name: Zuora-Entity-Ids in: header schema: type: string requestBody: content: multipart/form-data: schema: required: - customFields - description - name - notifications - productCatalog - reporting - sendEmail - settings - sourceTenantId - userRoles - workflows type: object properties: name: type: string sendEmail: type: boolean emails: type: string comments: type: string settings: type: boolean notifications: type: boolean workflows: type: boolean customFields: type: boolean customObjects: type: boolean productCatalog: type: boolean taxation: type: boolean userRoles: type: boolean reporting: type: boolean sourceTenantId: type: string required: true responses: '200': headers: RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string content: application/json: schema: $ref: '#/components/schemas/DeploymentManagerResponse' '400': content: application/json: {} /deployment-manager/deployments/templates: post: tags: - Metadata summary: Compare and deploy a template to a tenant operationId: CompareDeployTemplate parameters: - name: Zuora-Entity-Ids in: header schema: type: string requestBody: content: multipart/form-data: schema: required: - description - name - sendEmail - template type: object properties: name: type: string sendEmail: type: boolean emails: type: string comments: type: string template: type: string format: binary required: true responses: '200': headers: RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string content: application/json: schema: $ref: '#/components/schemas/DeploymentManagerResponse' /deployment-manager/deployments/{migrationId}/revert: post: tags: - Metadata summary: Revert a deployment operationId: RevertDeployment parameters: - name: Zuora-Entity-Ids in: header schema: type: string - name: migrationId in: path required: true schema: type: string responses: '200': headers: RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string content: application/json: schema: type: object properties: id: type: string name: type: string sourceTenantName: type: string sourceTenantDescription: type: string status: type: string enum: - DEPLOYING - REVERTING - PARTIALLY-REVERTED - FAILED - ROLLBACK-FAILED - REVERTED - COMPARING - SUBMITTED - SKIPPED - IDENTICAL - COMPARE-DONE - COMPARE-FAILED - CANCELLED startTime: type: string endTime: type: string migratedBy: type: string type: type: string environment: type: string emailIds: type: string productCatalog: type: boolean errors: type: string /deployment-manager/deployments/{migrationId}: get: tags: - Metadata summary: Retrieve a deployment log operationId: FetchDeploymentLogs parameters: - name: Zuora-Entity-Ids in: header schema: type: string - name: migrationId in: path required: true schema: type: string responses: '200': content: application/json: schema: type: object properties: id: type: string name: type: string status: type: string targetTenant: type: object properties: id: type: string name: type: string environment: type: string deploymentDate: type: string runBy: type: string succeeded: type: array items: type: object properties: component: type: string subComponent: type: string key: type: string failed: type: array items: type: object properties: component: type: string subComponent: type: string key: type: string errorInfo: type: string skipped: type: array items: type: object properties: component: type: string subComponent: type: string key: type: string reason: type: string /deployment-manager/deployments/tenant/product_catalog: post: tags: - Metadata summary: Compare and deploy the product catalog of a tenant to a target tenant operationId: CompareDeployTenantProductCatalog parameters: - name: Zuora-Entity-Ids in: header schema: type: string requestBody: content: multipart/form-data: schema: required: - activeProducts - activeRatePlans - compareField - description - inActiveProducts - inActiveRatePlans - name - sendEmail - sourceTenantId type: object properties: name: type: string sendEmail: type: boolean emails: type: string comments: type: string inActiveProducts: type: boolean activeProducts: type: boolean activeRatePlans: type: boolean inActiveRatePlans: type: boolean compareField: type: string enum: - name - sku sourceTenantId: type: string required: true responses: '200': headers: RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string content: application/json: schema: $ref: '#/components/schemas/DeploymentManagerResponse' '400': content: application/json: {} /deployment-manager/deployments/template/product_catalog: post: tags: - Metadata summary: Compare and deploy a template for product catalog to a tenant operationId: CompareDeployTemplateProductCatalog parameters: - name: Zuora-Entity-Ids in: header schema: type: string requestBody: content: multipart/form-data: schema: required: - activeProducts - activeRatePlans - compareField - description - inActiveProducts - inActiveRatePlans - name - sendEmail - template type: object properties: name: type: string sendEmail: type: boolean emails: type: string comments: type: string template: type: string format: binary inActiveProducts: type: boolean activeProducts: type: boolean activeRatePlans: type: boolean inActiveRatePlans: type: boolean compareField: type: string enum: - name - sku required: true responses: '200': headers: RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: schema: maxLength: 64 type: string content: application/json: schema: $ref: '#/components/schemas/DeploymentManagerResponse' /bulk-data/bulk-jobs: post: operationId: createBulkJob summary: Create a bulk job tags: - Bulk Data parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkJobRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreateResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: type: string minLength: 36 maxLength: 36 Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' /bulk-data/bulk-jobs/{id}/submissions: post: operationId: submitBulkJob summary: Submit a bulk job tags: - Bulk Data parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubmitBulkJobResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: type: string maxLength: 36 minLength: 36 Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' /bulk-data/bulk-jobs/{id}/summary: get: operationId: getBulkJobSummary parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: type: string format: uuid maxLength: 64 minLength: 64 responses: '200': content: application/json: schema: $ref: '#/components/schemas/QueryJobSummaryResponse' '404': {} '500': {} summary: Retrieve the summary of a bulk job tags: - Bulk Data /bulk-data/bulk-jobs/{id}/cancellations: post: operationId: cancelBulkJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: format: uuid maxLength: 64 minLength: 64 type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/IdStatusResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a bulk job tags: - Bulk Data /bulk-data/bulk-jobs/{id}/aborts: post: operationId: deleteAbortJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: format: uuid maxLength: 64 minLength: 64 type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/IdStatusResponse' headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Abort a bulk job tags: - Bulk Data /bulk-data/bulk-jobs/{id}/downloads: get: operationId: getDownloadLinksForJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: type: string format: uuid maxLength: 64 minLength: 64 responses: '200': content: application/json: schema: $ref: '#/components/schemas/DownloadsResponse' '404': {} '500': {} summary: List download links for a bulk job tags: - Bulk Data /bulk-data/bulk-jobs/summaries: get: operationId: getBulkJobSummaries parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: limit in: query required: false schema: type: integer format: int32 - name: cursor in: query required: false schema: type: string - name: status in: query required: false schema: type: string enum: - Created - Submitted - In Progress - Aborting - Completed - Failed - Aborted - Cancelled - Downloading responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetSummariesResponse' '404': {} '500': {} summary: List job summaries for bulk jobs tags: - Bulk Data /bulk-data/bulk-jobs/{id}/mappings: get: operationId: getMappingsForJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: format: uuid maxLength: 64 minLength: 64 type: string responses: '200': content: application/json: schema: type: object properties: mappings: type: array items: type: object properties: field: type: string column: type: string headers: Content-Encoding: schema: type: string RateLimit-Limit: schema: type: string RateLimit-Remaining: schema: type: number RateLimit-Reset: schema: type: number Zuora-Request-Id: schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List mappings for a bulk job tags: - Bulk Data components: securitySchemes: bearerAuth: type: http scheme: bearer basicAuth: type: http scheme: basic parameters: GLOBAL_HEADER_Zuora_Track_Id: name: Zuora-Track-Id in: header required: false schema: type: string maxLength: 64 GLOBAL_HEADER_Idempotency_Key: name: Idempotency-Key in: header required: false schema: type: string maxLength: 255 GLOBAL_HEADER_Accept_Encoding: name: Accept-Encoding in: header required: false schema: type: string GLOBAL_HEADER_Content_Encoding: name: Content-Encoding in: header required: false schema: type: string GLOBAL_REQUEST_rejectUnknownFields: name: rejectUnknownFields in: query required: false schema: type: boolean default: false GLOBAL_HEADER_Zuora_Entity_Ids_Single: name: Zuora-Entity-Ids in: header required: false schema: type: string GLOBAL_HEADER_Zuora_Org_Ids: name: Zuora-Org-Ids in: header required: false schema: type: string GLOBAL_HEADER_X_Zuora_WSDL_Version: name: X-Zuora-WSDL-Version in: header required: false schema: type: string default: 79 GLOBAL_HEADER_Zuora_Version: in: header name: Zuora-Version required: false schema: type: string GLOBAL_REQUEST_page: name: page in: query required: false schema: type: integer minimum: 1 default: 1 GLOBAL_REQUEST_pageSize: name: pageSize in: query required: false schema: type: integer maximum: 40 default: 20 GLOBAL_REQUEST_pageSize_finance_accounting: name: pageSize in: query required: false schema: type: integer maximum: 300 default: 300 GLOBAL_REQUEST_pageSize_finance_revenue: name: pageSize in: query required: false schema: type: integer maximum: 300 default: 8 GLOBAL_HEADER_If_Match: name: If-Match in: header required: false schema: type: string schemas: tokenResponse: properties: access_token: type: string expires_in: type: number jti: type: string scope: type: string token_type: type: string type: object ProxyCreateProduct: allOf: - properties: AllowFeatureChanges: type: boolean Category: maxLength: 100 type: string Description: maxLength: 500 type: string EffectiveEndDate: format: date type: string EffectiveStartDate: format: date type: string Name: maxLength: 100 type: string ProductNumber: maxLength: 100 type: string SKU: maxLength: 50 type: string required: - EffectiveEndDate - EffectiveStartDate - Name type: object - $ref: '#/components/schemas/ProductObjectNSFields' - $ref: '#/components/schemas/ProductObjectCustomFields' ProxyCreateOrModifyResponse: properties: Id: type: string Success: type: boolean type: object ProxyBadRequestResponse: properties: Errors: items: properties: Code: type: string Message: type: string type: object type: array Success: type: boolean type: object ProxyUnauthorizedResponse: properties: message: type: string type: object ProductObjectNSFields: properties: IntegrationId__NS: maxLength: 255 type: string IntegrationStatus__NS: maxLength: 255 type: string ItemType__NS: enum: - Inventory - Non Inventory - Service type: string SyncDate__NS: maxLength: 255 type: string title: productFieldsNS type: object ProductObjectCustomFields: additionalProperties: {} title: productFieldsCustom type: object ProxyGetProduct: allOf: - properties: AllowFeatureChanges: type: boolean Category: maxLength: 100 type: string CreatedById: maxLength: 32 type: string CreatedDate: format: date-time type: string Description: maxLength: 500 type: string EffectiveEndDate: format: date type: string EffectiveStartDate: format: date type: string Id: type: string Name: maxLength: 100 type: string SKU: maxLength: 50 type: string UpdatedById: maxLength: 32 type: string UpdatedDate: format: date-time type: string type: object - $ref: '#/components/schemas/ProductObjectNSFields' - $ref: '#/components/schemas/ProductObjectCustomFields' ProxyNoDataResponse: properties: done: type: boolean records: items: type: object type: array size: type: integer type: object ProxyModifyProduct: allOf: - properties: AllowFeatureChanges: type: boolean Category: maxLength: 100 type: string Description: maxLength: 500 type: string EffectiveEndDate: format: date type: string EffectiveStartDate: format: date type: string Name: maxLength: 100 type: string ProductNumber: maxLength: 100 type: string SKU: maxLength: 50 type: string type: object - $ref: '#/components/schemas/ProductObjectNSFields' - $ref: '#/components/schemas/ProductObjectCustomFields' ProxyDeleteResponse: properties: id: type: string success: type: boolean type: object POSTAccountType: allOf: - properties: accountNumber: type: string additionalEmailAddresses: items: type: string type: array applicationOrder: items: type: string type: array applyCredit: type: boolean applyCreditBalance: type: boolean autoPay: type: boolean batch: type: string billCycleDay: format: int64 type: integer billToContact: $ref: '#/components/schemas/POSTAccountTypeBillToContact' collect: default: true type: boolean communicationProfileId: type: string creditCard: $ref: '#/components/schemas/POSTAccountTypeCreditCard' creditMemoReasonCode: type: string creditMemoTemplateId: type: string crmId: type: string currency: type: string customerServiceRepName: maxLength: 50 type: string debitMemoTemplateId: type: string documentDate: format: date type: string einvoiceProfile: $ref: '#/components/schemas/PostAccountEInvoiceProfile' gatewayRoutingEligible: default: false type: boolean hpmCreditCardPaymentMethodId: type: string invoiceDeliveryPrefsEmail: default: false type: boolean invoiceDeliveryPrefsPrint: default: false type: boolean invoiceTemplateId: type: string name: type: string notes: type: string organizationLabel: type: string parentId: type: string partnerAccount: default: false type: boolean paymentGateway: type: string paymentMethod: $ref: '#/components/schemas/POSTPaymentMethodRequest' paymentTerm: type: string profileNumber: type: string purchaseOrderNumber: type: string runBilling: default: true type: boolean salesRep: type: string sequenceSetId: type: string nullable: true shipToContact: $ref: '#/components/schemas/CreateAccountShipToContact' shipToSameAsBillTo: type: boolean soldToContact: $ref: '#/components/schemas/POSTAccountTypeSoldToContact' soldToSameAsBillTo: type: boolean subscription: $ref: '#/components/schemas/POSTAccountTypeSubscription' summaryStatementTemplateId: type: string tagging: type: string targetDate: format: date type: string taxInfo: properties: VATId: type: string companyCode: type: string exemptCertificateId: type: string exemptCertificateType: type: string exemptDescription: type: string exemptEffectiveDate: format: date type: string exemptEntityUseCode: maxLength: 64 type: string exemptExpirationDate: format: date type: string exemptIssuingJurisdiction: type: string exemptStatus: type: string type: object required: - name - currency - billToContact type: object - $ref: '#/components/schemas/AccountObjectNSFields' - $ref: '#/components/schemas/AccountObjectCustomFields' POSTAccountResponseType: properties: accountId: type: string accountNumber: type: string billToContactId: type: string contractedMrr: format: decimal type: string creditMemoId: type: string invoiceId: type: string paidAmount: format: decimal type: string paymentId: type: string paymentMethodId: type: string shipToContactId: type: string soldToContactId: type: string subscriptionId: type: string subscriptionNumber: type: string success: type: boolean totalContractedValue: format: decimal type: string type: object ErrorResponse: properties: reasons: items: properties: code: type: string message: type: string type: object type: array type: object CommonResponse: properties: processId: type: string reasons: items: properties: code: type: string message: type: string type: object type: array requestId: format: uuid maxLength: 36 minLength: 36 type: string success: type: boolean type: object POSTAccountTypeBillToContact: allOf: - properties: address1: type: string address2: type: string city: type: string country: type: string county: type: string fax: type: string firstName: type: string homePhone: type: string lastName: type: string mobilePhone: type: string nickname: type: string otherPhone: type: string otherPhoneType: type: string personalEmail: type: string format: email maxLength: 80 state: type: string taxRegion: type: string workEmail: type: string workPhone: type: string zipCode: type: string required: - firstName - lastName type: object - $ref: '#/components/schemas/ContactObjectCustomFields' title: Contact POSTAccountTypeCreditCard: allOf: - properties: cardHolderInfo: properties: addressLine1: type: string addressLine2: type: string cardHolderName: type: string city: type: string country: type: string email: type: string phone: type: string state: type: string zipCode: type: string required: - addressLine1 - cardHolderName - city - country - state - zipCode cardNumber: type: string cardType: type: string expirationMonth: type: string expirationYear: type: string securityCode: type: string required: - cardHolderInfo - cardNumber - cardType - expirationMonth - expirationYear type: object - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' title: creditCard PostAccountEInvoiceProfile: allOf: - properties: businessCategory: type: string enum: - B2B - B2C - B2G businessName: maxLength: 255 type: string businessNumber: type: string businessNumberSchemeId: type: string enabled: type: boolean endpointId: type: string endpointSchemeId: type: string taxRegisterNumber: type: string type: object - $ref: '#/components/schemas/EinvoiceObjectCustomFields' title: einvoiceProfile POSTPaymentMethodRequest: type: object discriminator: propertyName: type mapping: CreditCard: '#/components/schemas/CreatePaymentMethodCreditCard' CreditCardReferenceTransaction: '#/components/schemas/CreatePaymentMethodCCReferenceTransaction' ACH: '#/components/schemas/CreatePaymentMethodACH' SEPA: '#/components/schemas/CreatePaymentMethodSEPA' Betalingsservice: '#/components/schemas/CreatePaymentMethodBetalingsservice' Autogiro: '#/components/schemas/CreatePaymentMethodAutogiro' Bacs: '#/components/schemas/CreatePaymentMethodBacs' Becs: '#/components/schemas/CreatePaymentMethodBecs' Becsnz: '#/components/schemas/CreatePaymentMethodBecsnz' PAD: '#/components/schemas/CreatePaymentMethodPAD' PayPalCP: '#/components/schemas/CreatePMPayPalCP' PayPalEC: '#/components/schemas/CreatePMPayPalEC' PayPalNativeEC: '#/components/schemas/CreatePMPayPalNativeEC' PayPalAdaptive: '#/components/schemas/CreatePaymentMethodPayPalAdaptive' AdyenApplePay: '#/components/schemas/CreatePaymentMethodApplePayAdyen' AdyenGooglePay: '#/components/schemas/CreatePaymentMethodGooglePayAdyen' GooglePay: '#/components/schemas/CreatePaymentMethodGooglePayChase' AmazonPay: '#/components/schemas/CreatePaymentMethodAmazonPay' oneOf: - $ref: '#/components/schemas/CreatePaymentMethodCreditCard' - $ref: '#/components/schemas/CreatePaymentMethodCCReferenceTransaction' - $ref: '#/components/schemas/CreatePaymentMethodACH' - $ref: '#/components/schemas/CreatePaymentMethodSEPA' - $ref: '#/components/schemas/CreatePaymentMethodBetalingsservice' - $ref: '#/components/schemas/CreatePaymentMethodAutogiro' - $ref: '#/components/schemas/CreatePaymentMethodBacs' - $ref: '#/components/schemas/CreatePaymentMethodBecs' - $ref: '#/components/schemas/CreatePaymentMethodBecsnz' - $ref: '#/components/schemas/CreatePaymentMethodPAD' - $ref: '#/components/schemas/CreatePMPayPalNativeEC' - $ref: '#/components/schemas/CreatePMPayPalCP' - $ref: '#/components/schemas/CreatePMPayPalEC' - $ref: '#/components/schemas/CreatePaymentMethodPayPalAdaptive' - $ref: '#/components/schemas/CreatePaymentMethodApplePayAdyen' - $ref: '#/components/schemas/CreatePaymentMethodGooglePayChase' - $ref: '#/components/schemas/CreatePaymentMethodAmazonPay' required: - type CreateAccountShipToContact: allOf: - properties: address1: type: string address2: type: string city: type: string country: type: string county: type: string fax: type: string firstName: type: string homePhone: type: string lastName: type: string mobilePhone: type: string nickname: type: string otherPhone: type: string otherPhoneType: type: string personalEmail: type: string format: email maxLength: 80 state: type: string taxRegion: type: string workEmail: type: string workPhone: type: string zipCode: type: string required: - firstName - lastName type: object - $ref: '#/components/schemas/ContactObjectCustomFields' title: ShipToContact POSTAccountTypeSoldToContact: allOf: - properties: address1: type: string address2: type: string city: type: string country: type: string county: type: string fax: type: string firstName: type: string homePhone: type: string lastName: type: string mobilePhone: type: string nickname: type: string otherPhone: type: string otherPhoneType: type: string personalEmail: type: string format: email maxLength: 80 state: type: string taxRegion: type: string workEmail: type: string workPhone: type: string zipCode: type: string required: - firstName - lastName type: object - $ref: '#/components/schemas/ContactObjectCustomFields' title: soldToContact POSTAccountTypeSubscription: allOf: - properties: autoRenew: type: boolean contractEffectiveDate: format: date type: string customerAcceptanceDate: format: date type: string initialTerm: format: int64 type: integer invoiceOwnerAccountKey: type: string invoiceSeparately: type: boolean notes: type: string renewalTerm: format: int64 type: integer serviceActivationDate: format: date type: string subscribeToRatePlans: items: $ref: '#/components/schemas/POSTSrpCreateType' type: array subscriptionNumber: type: string termStartDate: format: date type: string termType: type: string required: - contractEffectiveDate - termType type: object - $ref: '#/components/schemas/SubscriptionObjectQTFields' - $ref: '#/components/schemas/SubscriptionObjectNSFields' - $ref: '#/components/schemas/SubscriptionObjectCustomFields' title: subscription AccountObjectNSFields: properties: Class__NS: maxLength: 255 type: string CustomerType__NS: enum: - Company - Individual type: string Department__NS: maxLength: 255 type: string IntegrationId__NS: maxLength: 255 type: string IntegrationStatus__NS: maxLength: 255 type: string Location__NS: maxLength: 255 type: string Subsidiary__NS: maxLength: 255 type: string SyncDate__NS: maxLength: 255 type: string SynctoNetSuite__NS: enum: - 'Yes' - 'No' type: string title: accountFieldsNetSuite type: object AccountObjectCustomFields: additionalProperties: {} title: accountFieldsCustom type: object POSTSrpCreateType: allOf: - properties: chargeOverrides: items: $ref: '#/components/schemas/POSTScCreateType' type: array externalCatalogPlanId: type: string externalIdSourceSystem: type: string externallyManagedPlanId: type: string productRatePlanId: type: string productRatePlanNumber: type: string type: object - $ref: '#/components/schemas/RatePlanObjectCustomFields' title: subscribeToRatePlans SubscriptionObjectQTFields: properties: CpqBundleJsonId__QT: maxLength: 32 type: string OpportunityCloseDate__QT: format: date type: string OpportunityName__QT: maxLength: 100 type: string QuoteBusinessType__QT: maxLength: 32 type: string QuoteNumber__QT: maxLength: 32 type: string QuoteType__QT: maxLength: 32 type: string title: subscriptionFieldsQT type: object SubscriptionObjectNSFields: properties: IntegrationId__NS: maxLength: 255 type: string IntegrationStatus__NS: maxLength: 255 type: string Project__NS: maxLength: 255 type: string SalesOrder__NS: maxLength: 255 type: string SyncDate__NS: maxLength: 255 type: string title: subscriptionFieldsNS type: object SubscriptionObjectCustomFields: additionalProperties: {} title: subscriptionFieldsCustom type: object POSTScCreateType: allOf: - properties: amendedByOrderOn: type: string applyDiscountTo: type: string billCycleDay: type: string billCycleType: type: string billingPeriod: type: string billingPeriodAlignment: type: string billingTiming: type: string chargeModelConfiguration: $ref: '#/components/schemas/ChargeModelConfigurationType' discountAmount: type: number discountLevel: type: string discountPercentage: type: number endDateCondition: type: string excludeItemBillingFromRevenueAccounting: default: false type: boolean excludeItemBookingFromRevenueAccounting: default: false type: boolean includedUnits: type: number isAllocationEligible: type: boolean isUnbilled: type: boolean listPriceBase: type: string number: type: string numberOfPeriods: format: int64 type: integer originalOrderDate: format: date type: string overagePrice: type: number overageUnusedUnitsCreditOption: type: string price: type: number priceChangeOption: type: string priceIncreasePercentage: type: number productRatePlanChargeId: type: string productRatePlanChargeNumber: type: string quantity: type: number ratingGroup: type: string specificBillingPeriod: format: int64 type: integer specificEndDate: format: date type: string specificListPriceBase: format: int32 maximum: 200 minimum: 1 type: integer tiers: items: $ref: '#/components/schemas/POSTTierType' type: array triggerDate: format: date type: string triggerEvent: type: string unusedUnitsCreditRates: type: number upToPeriods: format: int64 type: integer upToPeriodsType: type: string weeklyBillCycleDay: type: string required: - productRatePlanChargeId type: object - $ref: '#/components/schemas/RatePlanChargeObjectCustomFields' title: chargeOverrides RatePlanObjectCustomFields: additionalProperties: {} title: RatePlanCustomFields type: object ChargeModelConfigurationType: properties: customFieldPerUnitRate: type: string customFieldTotalAmount: type: string formula: type: string title: chargeModelConfiguration type: object POSTTierType: properties: endingUnit: type: number price: type: number priceFormat: type: string startingUnit: type: number tier: format: int64 type: integer required: - tier - price title: tiers type: object RatePlanChargeObjectCustomFields: additionalProperties: {} title: ratePlanChargeFieldsCustom type: object ContactObjectCustomFields: additionalProperties: {} title: contactFieldsCustom type: object CreatePaymentMethodCreditCard: allOf: - type: object properties: type: type: string cardHolderInfo: $ref: '#/components/schemas/CreatePaymentMethodCardholderInfo' cardMaskNumber: type: string cardNumber: type: string cardType: type: string checkDuplicated: type: boolean expirationMonth: type: integer expirationYear: type: integer identityNumber: type: string mitConsentAgreementRef: maxLength: 128 type: string mitConsentAgreementSrc: enum: - External type: string mitNetworkTransactionId: maxLength: 128 type: string mitProfileAction: enum: - Activate - Persist type: string mitProfileAgreedOn: format: date type: string mitProfileType: enum: - Recurring - Unscheduled type: string screeningAmount: format: decimal type: number securityCode: type: string tokens: properties: gatewayType: type: string secondTokenId: type: string thirdTokenId: type: string tokenId: type: string required: - gatewayType - tokenId type: object tokenize: default: false type: boolean mandateInfo: properties: mandateId: maxLength: 36 type: string mandateReason: maxLength: 64 type: string mandateStatus: maxLength: 64 type: string type: object processingOptions: type: object properties: checkDuplicated: type: boolean - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - cardHolderInfo - cardNumber - cardType - expirationMonth - expirationYear CreatePaymentMethodCCReferenceTransaction: allOf: - type: object properties: type: type: string creditCardMaskNumber: maxLength: 19 type: string secondTokenId: type: string tokenId: type: string mandateInfo: properties: mandateId: maxLength: 36 type: string mandateReason: maxLength: 64 type: string mandateStatus: maxLength: 64 type: string - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' type: object required: - type - tokenId CreatePaymentMethodACH: allOf: - properties: type: type: string addressLine1: type: string addressLine2: type: string bankABACode: type: string bankAccountMaskNumber: type: string bankAccountName: maxLength: 70 type: string bankAccountNumber: maxLength: 30 type: string bankAccountType: enum: - BusinessChecking - Checking - Saving type: string bankName: maxLength: 70 type: string city: type: string country: type: string phone: type: string state: type: string zipCode: type: string mandateInfo: properties: mandateId: maxLength: 36 type: string mandateReason: maxLength: 64 type: string mandateStatus: maxLength: 64 type: string type: object processingOptions: properties: checkDuplicated: type: boolean type: object tokens: properties: gatewayType: type: string secondTokenId: type: string thirdTokenId: type: string tokenId: type: string type: object required: - gatewayType - tokenId tokenize: default: false type: boolean type: object title: AchPaymentMethod - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - bankABACode - bankAccountName - bankAccountNumber - bankAccountType - bankName CreatePaymentMethodSEPA: allOf: - properties: type: type: string IBAN: type: string accountHolderInfo: properties: accountHolderName: maxLength: 60 type: string addressLine1: type: string addressLine2: type: string city: type: string country: type: string email: type: string firstName: type: string lastName: type: string phone: type: string state: type: string zipCode: type: string type: object required: - accountHolderName accountMaskNumber: type: string businessIdentificationCode: type: string mandateInfo: properties: mandateId: maxLength: 36 type: string mandateReason: maxLength: 64 type: string mandateStatus: maxLength: 64 type: string type: object tokenize: default: false type: boolean tokens: properties: gatewayType: enum: - Adyen - Stripe type: string secondTokenId: type: string thirdTokenId: type: string tokenId: type: string type: object required: - gatewayType - tokenId processingOptions: properties: checkDuplicated: type: boolean type: object type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - IBAN - accountHolderInfo CreatePaymentMethodBetalingsservice: allOf: - properties: type: type: string accountHolderInfo: properties: accountHolderName: maxLength: 60 type: string addressLine1: type: string addressLine2: type: string city: type: string country: type: string email: type: string firstName: type: string lastName: type: string phone: type: string state: type: string zipCode: type: string type: object accountNumber: type: string accountMaskNumber: type: string bankCode: type: string identityNumber: type: string mandateInfo: properties: mandateId: maxLength: 36 type: string mandateReason: maxLength: 64 type: string mandateStatus: maxLength: 64 type: string type: object processingOptions: properties: checkDuplicated: type: boolean type: object type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - accountNumber - identityNumber - bankCode - accountHolderInfo CreatePaymentMethodAutogiro: allOf: - properties: type: type: string accountHolderInfo: properties: accountHolderName: maxLength: 60 type: string addressLine1: type: string addressLine2: type: string city: type: string country: type: string email: type: string firstName: type: string lastName: type: string phone: type: string state: type: string zipCode: type: string type: object accountNumber: type: string accountMaskNumber: type: string branchCode: type: string identityNumber: type: string mandateInfo: properties: mandateId: maxLength: 36 type: string mandateReason: maxLength: 64 type: string mandateStatus: maxLength: 64 type: string type: object processingOptions: properties: checkDuplicated: type: boolean type: object type: object title: AutogiroPaymentMethod - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - accountNumber - identityNumber - branchCode - accountHolderInfo CreatePaymentMethodBacs: allOf: - properties: type: type: string accountHolderInfo: properties: accountHolderName: maxLength: 60 type: string addressLine1: type: string addressLine2: type: string city: type: string country: type: string email: type: string firstName: type: string lastName: type: string phone: type: string state: type: string zipCode: type: string type: object accountNumber: type: string accountMaskNumber: type: string bankCode: type: string mandateInfo: properties: mandateId: maxLength: 36 type: string mandateReason: maxLength: 64 type: string mandateStatus: maxLength: 64 type: string type: object tokenize: default: false type: boolean tokens: properties: gatewayType: enum: - Stripe type: string secondTokenId: type: string thirdTokenId: type: string tokenId: type: string type: object processingOptions: properties: checkDuplicated: type: boolean type: object type: object title: BacsPaymentMethod - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - accountNumber - bankCode - accountHolderInfo CreatePaymentMethodBecs: allOf: - properties: type: type: string accountHolderInfo: properties: accountHolderName: maxLength: 60 type: string addressLine1: type: string addressLine2: type: string city: type: string country: type: string email: type: string firstName: type: string lastName: type: string phone: type: string state: type: string zipCode: type: string type: object accountNumber: type: string accountMaskNumber: type: string branchCode: type: string mandateInfo: properties: mandateId: maxLength: 36 type: string mandateReason: maxLength: 64 type: string mandateStatus: maxLength: 64 type: string type: object processingOptions: properties: checkDuplicated: type: boolean type: object type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - accountNumber - branchCode CreatePaymentMethodBecsnz: allOf: - properties: type: type: string accountHolderInfo: properties: accountHolderName: maxLength: 60 type: string addressLine1: type: string addressLine2: type: string city: type: string country: type: string email: type: string firstName: type: string lastName: type: string phone: type: string state: type: string zipCode: type: string type: object accountNumber: type: string accountMaskNumber: type: string branchCode: type: string bankCode: type: string mandateInfo: properties: mandateId: maxLength: 36 type: string mandateReason: maxLength: 64 type: string mandateStatus: maxLength: 64 type: string type: object processingOptions: properties: checkDuplicated: type: boolean type: object type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - accountNumber - bankCode - branchCode - accountHolderInfo CreatePaymentMethodPAD: allOf: - properties: type: type: string accountHolderInfo: properties: accountHolderName: maxLength: 60 type: string addressLine1: type: string addressLine2: type: string city: type: string country: type: string email: type: string firstName: type: string lastName: type: string phone: type: string state: type: string zipCode: type: string type: object accountNumber: type: string accountMaskNumber: type: string branchCode: type: string bankCode: type: string mandateInfo: properties: mandateId: maxLength: 36 type: string mandateReason: maxLength: 64 type: string mandateStatus: maxLength: 64 type: string type: object processingOptions: properties: checkDuplicated: type: boolean type: object type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - accountNumber - bankCode - branchCode - accountHolderInfo CreatePMPayPalCP: allOf: - properties: type: type: string BAID: type: string email: type: string tokens: properties: gatewayType: type: string secondTokenId: type: string thirdTokenId: type: string tokenId: type: string required: - gatewayType - tokenId type: object tokenize: default: false type: boolean type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - BAID - email CreatePMPayPalEC: allOf: - properties: type: type: string BAID: type: string email: type: string type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - BAID - email CreatePMPayPalNativeEC: allOf: - properties: type: type: string BAID: type: string email: type: string type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - BAID CreatePaymentMethodPayPalAdaptive: allOf: - properties: type: type: string preapprovalKey: type: string email: type: string format: email type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - preapprovalKey - email CreatePaymentMethodApplePayAdyen: allOf: - properties: type: type: string applePaymentData: type: string email: type: string format: email type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' required: - type - applePaymentData CreatePaymentMethodGooglePayAdyen: allOf: - properties: type: type: string googlePaymentToken: type: string email: type: string type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' required: - type - googlePaymentToken CreatePaymentMethodGooglePayChase: allOf: - properties: type: type: string googlePaymentToken: type: string type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' required: - type - googlePaymentToken CreatePaymentMethodAmazonPay: allOf: - properties: type: type: string amazonPayToken: type: string type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' required: - type - amazonPayToken PaymentMethodCommonFields: properties: accountKey: type: string authGateway: type: string currencyCode: type: string gatewayOptions: properties: key: type: string value: type: string type: object ipAddress: type: string makeDefault: default: false type: boolean skipValidation: default: false type: boolean type: type: string enum: - CreditCard - CreditCardReferenceTransaction - ACH - SEPA - Betalingsservice - Autogiro - Bacs - Becs - Becsnz - PAD - PayPalCP - PayPalEC - PayPalNativeEC - PayPalAdaptive - AdyenApplePay - AdyenGooglePay - GooglePay - AmazonPay type: object PaymentMethodObjectCustomFields: additionalProperties: {} title: paymentMethodFieldsCustom type: object CreatePaymentMethodCardholderInfo: properties: addressLine1: type: string addressLine2: type: string cardHolderName: type: string city: type: string country: type: string email: type: string phone: type: string state: type: string zipCode: type: string required: - cardHolderName title: cardHolderInfo type: object EinvoiceObjectCustomFields: additionalProperties: {} title: eInvoiceProfileCustomFields type: object DeleteAccountResponseType: properties: id: type: string jobId: type: string jobStatus: enum: - Pending type: string reasons: items: properties: code: type: string message: type: string type: object type: array success: type: boolean type: object GETAccountType: properties: basicInfo: $ref: '#/components/schemas/GETAccountTypeBasicInfo' billToContact: $ref: '#/components/schemas/GETAccountTypeBillToContact' billingAndPayment: properties: additionalEmailAddresses: items: type: string type: array autoPay: type: boolean billCycleDay: format: int64 type: integer currency: type: string defaultPaymentMethodId: type: string invoiceDeliveryPrefsEmail: type: boolean invoiceDeliveryPrefsPrint: type: boolean paymentMethodCascadingConsent: type: boolean paymentGateway: type: string paymentTerm: type: string type: object einvoiceProfile: $ref: '#/components/schemas/GetAccountEInvoiceProfile' gatewayRoutingEligible: type: boolean metrics: properties: balance: format: decimal type: string contractedMrr: format: decimal type: string creditBalance: format: decimal type: string reservedPaymentAmount: format: float type: number totalDebitMemoBalance: format: decimal type: string totalInvoiceBalance: format: decimal type: string unappliedCreditMemoAmount: format: decimal type: string unappliedPaymentAmount: format: decimal type: string type: object metricsData: items: $ref: '#/components/schemas/GETAccountCurrencyMetricsType' type: array shipToContact: $ref: '#/components/schemas/GetAccountTypeShipToContact' soldToContact: $ref: '#/components/schemas/GETAccountTypeSoldToContact' success: type: boolean taxInfo: properties: VATId: type: string companyCode: type: string exemptCertificateId: type: string exemptCertificateType: type: string exemptDescription: type: string exemptEffectiveDate: format: date type: string exemptEntityUseCode: maxLength: 64 type: string exemptExpirationDate: format: date type: string exemptIssuingJurisdiction: type: string exemptStatus: type: string type: object type: object GETAccountTypeBasicInfo: allOf: - properties: accountNumber: type: string batch: type: string communicationProfileId: type: string creditMemoTemplateId: type: string crmId: type: string customerServiceRepName: maxLength: 50 type: string debitMemoTemplateId: type: string id: type: string invoiceTemplateId: type: string nullable: true lastMetricsUpdate: format: date-time type: string name: type: string notes: type: string organizationLabel: type: string parentId: type: string partnerAccount: type: boolean profileNumber: type: string purchaseOrderNumber: type: string salesRep: type: string sequenceSetId: type: string nullable: true summaryStatementTemplateId: type: string nullable: true status: type: string tags: type: string type: object - $ref: '#/components/schemas/AccountObjectNSFields' - $ref: '#/components/schemas/AccountObjectCustomFields' title: basicInfo GETAccountTypeBillToContact: allOf: - properties: address1: type: string address2: type: string asBillTo: type: boolean asShipTo: type: boolean asSoldTo: type: boolean city: type: string country: type: string nullable: true county: type: string nullable: true fax: type: string firstName: type: string homePhone: type: string id: type: string lastName: type: string mobilePhone: type: string nickname: type: string otherPhone: type: string nullable: true otherPhoneType: type: string nullable: true personalEmail: type: string maxLength: 80 state: type: string taxRegion: type: string nullable: true workEmail: type: string workPhone: type: string zipCode: type: string type: object - $ref: '#/components/schemas/ContactObjectCustomFields' title: Contact GetAccountEInvoiceProfile: allOf: - properties: businessCategory: type: string enum: - B2B - B2C - B2G businessName: maxLength: 255 type: string businessNumber: type: string businessNumberSchemeId: type: string enabled: type: boolean endpointId: type: string endpointSchemeId: type: string taxRegisterNumber: type: string title: einvoiceProfile type: object - $ref: '#/components/schemas/EinvoiceObjectCustomFields' GETAccountCurrencyMetricsType: allOf: - properties: balance: type: string contractedMrr: format: decimal type: string currency: type: string reservedPaymentAmount: format: decimal type: string totalDebitMemoBalance: format: decimal type: string totalInvoiceBalance: format: decimal type: string unappliedCreditMemoAmount: format: decimal type: string unappliedPaymentAmount: format: decimal type: string type: object title: metricsData GetAccountTypeShipToContact: allOf: - properties: address1: type: string address2: type: string asBillTo: type: boolean asShipTo: type: boolean asSoldTo: type: boolean city: type: string country: type: string nullable: true county: type: string fax: type: string firstName: type: string homePhone: type: string id: type: string lastName: type: string mobilePhone: type: string nickname: type: string otherPhone: type: string otherPhoneType: type: string personalEmail: type: string maxLength: 80 state: type: string taxRegion: type: string workEmail: type: string workPhone: type: string zipCode: type: string type: object - $ref: '#/components/schemas/ContactObjectCustomFields' title: Contact GETAccountTypeSoldToContact: allOf: - properties: address1: type: string address2: type: string asBillTo: type: boolean asShipTo: type: boolean asSoldTo: type: boolean city: type: string country: type: string nullable: true county: type: string fax: type: string firstName: type: string homePhone: type: string id: type: string lastName: type: string mobilePhone: type: string nickname: type: string otherPhone: type: string otherPhoneType: type: string personalEmail: type: string maxLength: 80 state: type: string taxRegion: type: string workEmail: type: string workPhone: type: string zipCode: type: string type: object - $ref: '#/components/schemas/ContactObjectCustomFields' title: Contact PUTAccountType: allOf: - properties: additionalEmailAddresses: items: type: string type: array autoPay: type: boolean batch: type: string billCycleDay: maxLength: 2 type: integer billToContact: $ref: '#/components/schemas/PUTAccountTypeBillToContact' billToContactId: type: string communicationProfileId: type: string creditMemoTemplateId: type: string crmId: type: string customerServiceRepName: maxLength: 50 type: string debitMemoTemplateId: type: string defaultPaymentMethodId: maxLength: 64 type: string einvoiceProfile: $ref: '#/components/schemas/PUTAccountEinvoiceProfile' gatewayRoutingEligible: default: false type: boolean invoiceDeliveryPrefsEmail: type: boolean invoiceDeliveryPrefsPrint: type: boolean invoiceTemplateId: type: string name: type: string notes: type: string parentId: type: string partnerAccount: default: false type: boolean paymentGateway: type: string paymentTerm: type: string profileNumber: type: string purchaseOrderNumber: type: string salesRep: type: string sequenceSetId: type: string nullable: true shipToContact: $ref: '#/components/schemas/UpdateAccountShipToContact' shipToContactId: type: string soldToContact: $ref: '#/components/schemas/PUTAccountTypeSoldToContact' soldToContactId: type: string tagging: type: string summaryStatementTemplateId: type: string taxInfo: properties: VATId: type: string companyCode: type: string exemptCertificateId: type: string exemptCertificateType: type: string exemptDescription: type: string exemptEffectiveDate: format: date type: string exemptEntityUseCode: maxLength: 64 type: string exemptExpirationDate: format: date type: string exemptIssuingJurisdiction: type: string exemptStatus: type: string type: object type: object - $ref: '#/components/schemas/AccountObjectNSFields' - $ref: '#/components/schemas/AccountObjectCustomFields' PUTAccountTypeBillToContact: allOf: - properties: address1: type: string address2: type: string city: type: string country: type: string county: type: string fax: type: string firstName: type: string homePhone: type: string lastName: type: string mobilePhone: type: string nickname: type: string otherPhone: type: string otherPhoneType: type: string personalEmail: type: string format: email maxLength: 80 state: type: string taxRegion: type: string workEmail: type: string workPhone: type: string zipCode: type: string type: object - $ref: '#/components/schemas/ContactObjectCustomFields' title: Contact PUTAccountEinvoiceProfile: allOf: - properties: businessCategory: type: string enum: - B2B - B2C - B2G businessName: maxLength: 255 type: string businessNumber: type: string businessNumberSchemeId: type: string enabled: type: boolean endpointId: type: string endpointSchemeId: type: string taxRegisterNumber: type: string type: object - $ref: '#/components/schemas/EinvoiceObjectCustomFields' title: einvoiceProfile UpdateAccountShipToContact: allOf: - properties: address1: type: string address2: type: string city: type: string country: type: string county: type: string fax: type: string firstName: type: string homePhone: type: string lastName: type: string mobilePhone: type: string nickname: type: string otherPhone: type: string otherPhoneType: type: string personalEmail: type: string format: email maxLength: 80 state: type: string taxRegion: type: string workEmail: type: string workPhone: type: string zipCode: type: string type: object - $ref: '#/components/schemas/ContactObjectCustomFields' title: Contact PUTAccountTypeSoldToContact: allOf: - properties: address1: type: string address2: type: string city: type: string country: type: string county: type: string fax: type: string firstName: type: string homePhone: type: string lastName: type: string mobilePhone: type: string nickname: type: string otherPhone: type: string otherPhoneType: type: string personalEmail: type: string format: email maxLength: 80 state: type: string taxRegion: type: string workEmail: type: string workPhone: type: string zipCode: type: string type: object - $ref: '#/components/schemas/ContactObjectCustomFields' title: Contact GETAccountPaymentMethodType: allOf: - properties: defaultPaymentMethodId: type: string paymentGateway: type: string returnedPaymentMethodType: items: $ref: '#/components/schemas/GETPaymentMethodResponseForAccount' title: Payment Method Type type: array success: type: boolean type: object - $ref: '#/components/schemas/CustomAccountPaymentMethod' GETPaymentMethodResponseForAccount: allOf: - properties: accountHolderInfo: $ref: '#/components/schemas/GETAccountPMAccountHolderInfo' accountVerificationService: type: string accountVerificationStatus: enum: - Active - Expired - Expiring - Inactive type: string bankIdentificationNumber: type: string createdBy: type: string createdOn: format: date-time type: string creditCardMaskNumber: type: string creditCardType: type: string deviceSessionId: type: string existingMandate: enum: - 'Yes' - 'No' type: string id: type: string ipAddress: type: string isDefault: type: boolean lastFailedSaleTransactionDate: format: date-time type: string lastTransaction: type: string lastTransactionTime: format: date-time type: string mandateInfo: $ref: '#/components/schemas/POSTAccountPMMandateInfo' maxConsecutivePaymentFailures: type: integer numConsecutiveFailures: format: int32 type: integer paymentRetryWindow: type: integer secondTokenId: type: string status: enum: - Active - Closed - Scrubbed type: string tokenId: type: string totalNumberOfErrorPayments: format: int32 type: integer totalNumberOfProcessedPayments: format: int32 type: integer type: type: string enum: - CreditCard - CreditCardReferenceTransaction - ACH - SEPA - Betalingsservice - Autogiro - Bacs - Becs - Becsnz - PAD - PayPalCP - PayPalEC - PayPalNativeEC - PayPalAdaptive - AdyenApplePay - AdyenGooglePay - GooglePay updatedBy: type: string updatedOn: format: date-time type: string useDefaultRetryRule: type: boolean type: object - $ref: '#/components/schemas/PaymentMethodObjectCustomFieldsForAccount' - $ref: '#/components/schemas/GETPaymentMethodResponseBankTransferForAccount' - $ref: '#/components/schemas/GETPaymentMethodResponseACHForAccount' - $ref: '#/components/schemas/GETPaymentMethodResponseCreditCardForAccount' - $ref: '#/components/schemas/GETPaymentMethodResponsePayPalForAccount' - $ref: '#/components/schemas/GETPaymentMethodResponseGooglePayForAccount' - $ref: '#/components/schemas/GETPaymentMethodResponseApplePayForAccount' CustomAccountPaymentMethod: additionalProperties: title: Custom Payment Method type: object title: CustomPaymentMethod type: object GETAccountPMAccountHolderInfo: properties: accountHolderName: maxLength: 60 type: string addressLine1: type: string addressLine2: type: string city: type: string country: type: string nullable: true email: type: string phone: type: string state: type: string zipCode: type: string title: accountHolderInfo type: object POSTAccountPMMandateInfo: properties: existingMandateStatus: enum: - 'Yes' - 'No' type: string mandateCreationDate: format: date type: string mandateId: type: string mandateReason: type: string mandateReceivedStatus: enum: - 'Yes' - 'No' type: string mandateStatus: type: string mandateUpdateDate: format: date type: string mitConsentAgreementRef: type: string mitConsentAgreementSrc: enum: - External type: string mitProfileAction: enum: - Activate - Persist type: string mitProfileAgreedOn: format: date type: string mitProfileType: type: string mitTransactionId: maxLength: 128 type: string title: mandateInfo type: object PaymentMethodObjectCustomFieldsForAccount: additionalProperties: {} title: paymentMethodFieldsCustom type: object GETPaymentMethodResponseBankTransferForAccount: properties: IBAN: type: string accountNumber: type: string bankCode: type: string bankTransferType: type: string branchCode: type: string businessIdentificationCode: type: string identityNumber: type: string type: object GETPaymentMethodResponseACHForAccount: properties: bankABACode: type: string bankAccountName: type: string type: object GETPaymentMethodResponseCreditCardForAccount: properties: cardNumber: type: string expirationMonth: type: integer expirationYear: type: integer securityCode: type: string type: object GETPaymentMethodResponsePayPalForAccount: properties: BAID: type: string email: type: string preapprovalKey: type: string type: object GETPaymentMethodResponseGooglePayForAccount: properties: googleBIN: type: string googleCardNumber: type: string googleCardType: type: string googleExpiryDate: type: string googleGatewayToken: type: string type: object GETPaymentMethodResponseApplePayForAccount: properties: appleBIN: type: string appleCardNumber: type: string appleCardType: type: string appleExpiryDate: type: string appleGatewayToken: type: string type: object GetCascadingPaymentMethodsConfigurationResponse: properties: consent: type: boolean priorities: type: array items: type: object properties: paymentMethodId: type: string nullable: true order: type: integer minimum: 1 title: priority success: type: boolean type: object PutCascadingPaymentMethodsConfigurationRequest: properties: consent: type: boolean priorities: type: array items: type: object properties: paymentMethodId: type: string order: type: integer minimum: 1 required: - paymentMethodId - order title: priority type: object GETAccountSummaryType: properties: basicInfo: $ref: '#/components/schemas/GETAccountSummaryTypeBasicInfo' billToContact: $ref: '#/components/schemas/GETAccountSummaryTypeBillToContact' invoices: items: $ref: '#/components/schemas/GETAccountSummaryInvoiceType' type: array payments: items: $ref: '#/components/schemas/GETAccountSummaryPaymentType' type: array shipToContact: $ref: '#/components/schemas/GetAccountSummaryTypeShipToContact' soldToContact: $ref: '#/components/schemas/GETAccountSummaryTypeSoldToContact' subscriptions: items: $ref: '#/components/schemas/GETAccountSummarySubscriptionType' type: array success: type: boolean taxInfo: properties: VATId: type: string companyCode: type: string exemptCertificateId: type: string exemptCertificateType: type: string exemptDescription: type: string exemptEffectiveDate: format: date type: string exemptEntityUseCode: maxLength: 64 type: string exemptExpirationDate: format: date type: string exemptIssuingJurisdiction: type: string exemptStatus: type: string type: object usage: items: $ref: '#/components/schemas/GETAccountSummaryUsageType' type: array type: object GETAccountSummaryTypeBasicInfo: allOf: - properties: accountNumber: type: string additionalEmailAddresses: items: type: string type: array autoPay: type: boolean balance: format: decimal type: string batch: type: string billCycleDay: type: string currency: type: string defaultPaymentMethod: properties: creditCardExpirationMonth: type: string creditCardExpirationYear: type: string creditCardNumber: type: string creditCardType: type: string id: type: string paymentMethodType: type: string enum: - CreditCard - CreditCardReferenceTransaction - ACH - BankTransfer - PayPal - AdyenApplePay - AdyenGooglePay - GooglePay type: object id: type: string invoiceDeliveryPrefsEmail: type: boolean invoiceDeliveryPrefsPrint: type: boolean lastInvoiceDate: format: date type: string lastMetricsUpdate: format: date-time type: string lastPaymentAmount: format: decimal type: string lastPaymentDate: format: date type: string name: type: string organizationLabel: type: string partnerAccount: type: boolean paymentMethodCascadingConsent: type: boolean purchaseOrderNumber: type: string status: type: string tags: type: string type: object - $ref: '#/components/schemas/AccountObjectNSFields' - $ref: '#/components/schemas/AccountObjectCustomFields' title: basicInfo GETAccountSummaryTypeBillToContact: allOf: - properties: address1: type: string address2: type: string asBillTo: type: boolean asShipTo: type: boolean asSoldTo: type: boolean city: type: string country: type: string nullable: true county: type: string nullable: true fax: type: string firstName: type: string id: type: string lastName: type: string state: type: string taxRegion: type: string workEmail: type: string workPhone: type: string zipCode: type: string type: object - $ref: '#/components/schemas/ContactObjectCustomFields' title: Contact GETAccountSummaryInvoiceType: properties: amount: type: number balance: format: decimal type: string dueDate: format: date type: string id: type: string invoiceDate: format: date type: string invoiceNumber: type: string status: type: string title: invoices type: object GETAccountSummaryPaymentType: properties: effectiveDate: format: date type: string id: type: string paidInvoices: items: $ref: '#/components/schemas/GETAccountSummaryPaymentInvoiceType' type: array paymentNumber: type: string paymentType: type: string status: type: string title: payments type: object GetAccountSummaryTypeShipToContact: allOf: - properties: address1: type: string address2: type: string asBillTo: type: boolean asShipTo: type: boolean asSoldTo: type: boolean city: type: string country: type: string nullable: true county: type: string nullable: true fax: type: string firstName: type: string id: type: string lastName: type: string state: type: string taxRegion: type: string workEmail: type: string workPhone: type: string zipCode: type: string type: object - $ref: '#/components/schemas/ContactObjectCustomFields' title: Contact GETAccountSummaryTypeSoldToContact: allOf: - properties: address1: type: string address2: type: string asBillTo: type: boolean asShipTo: type: boolean asSoldTo: type: boolean city: type: string country: type: string nullable: true county: type: string nullable: true fax: type: string firstName: type: string id: type: string lastName: type: string state: type: string taxRegion: type: string workEmail: type: string workPhone: type: string zipCode: type: string type: object - $ref: '#/components/schemas/ContactObjectCustomFields' title: Contact GETAccountSummarySubscriptionType: allOf: - properties: autoRenew: type: boolean id: type: string initialTerm: type: string ratePlans: items: $ref: '#/components/schemas/GETAccountSummarySubscriptionRatePlanType' type: array renewalTerm: type: string status: type: string subscriptionNumber: type: string subscriptionStartDate: format: date type: string termEndDate: format: date type: string termStartDate: format: date type: string termType: type: string type: object - $ref: '#/components/schemas/SubscriptionObjectQTFields' - $ref: '#/components/schemas/SubscriptionObjectNSFields' - $ref: '#/components/schemas/SubscriptionObjectCustomFields' title: subscriptions GETAccountSummaryUsageType: properties: quantity: format: decimal type: string startDate: format: date type: string unitOfMeasure: type: string title: usage type: object GETAccountSummarySubscriptionRatePlanType: properties: productId: type: string productName: type: string productRatePlanId: type: string productSku: type: string ratePlanName: type: string title: ratePlans type: object GETAccountSummaryPaymentInvoiceType: properties: appliedPaymentAmount: format: decimal type: string invoiceId: type: string invoiceNumber: type: string title: paidInvoices type: object POSTContactType: allOf: - properties: accountId: type: string accountNumber: type: string address1: maxLength: 255 type: string address2: maxLength: 255 type: string asBillTo: type: boolean asShipTo: type: boolean asSoldTo: type: boolean city: maxLength: 40 type: string contactDescription: maxLength: 100 type: string country: maxLength: 64 type: string county: maxLength: 32 type: string fax: maxLength: 40 type: string firstName: maxLength: 100 type: string homePhone: maxLength: 40 type: string lastName: maxLength: 100 type: string mobilePhone: maxLength: 100 type: string nickname: maxLength: 100 type: string otherPhone: maxLength: 40 type: string otherPhoneType: enum: - Work - Mobile - Home - Other type: string personalEmail: maxLength: 80 type: string format: email state: maxLength: 40 type: string taxRegion: maxLength: 32 type: string workEmail: maxLength: 80 type: string workPhone: maxLength: 40 type: string zipCode: maxLength: 20 type: string required: - firstName - lastName type: object - $ref: '#/components/schemas/ContactObjectCustomFields' ContactResponse: allOf: - properties: accountId: type: string accountNumber: type: string address1: maxLength: 255 type: string address2: maxLength: 255 type: string asBillTo: type: boolean asShipTo: type: boolean asSoldTo: type: boolean city: maxLength: 40 type: string contactDescription: maxLength: 100 type: string country: maxLength: 64 type: string county: maxLength: 32 type: string fax: maxLength: 40 type: string firstName: maxLength: 100 type: string homePhone: maxLength: 40 type: string lastName: maxLength: 100 type: string mobilePhone: maxLength: 100 type: string nickname: maxLength: 100 type: string otherPhone: maxLength: 40 type: string otherPhoneType: enum: - Work - Mobile - Home - Other type: string personalEmail: maxLength: 80 type: string state: maxLength: 40 type: string success: type: boolean taxRegion: maxLength: 32 type: string workEmail: maxLength: 80 type: string workPhone: maxLength: 40 type: string zipCode: maxLength: 20 type: string type: object - $ref: '#/components/schemas/ContactObjectCustomFields' PUTContactType: allOf: - properties: address1: maxLength: 255 type: string address2: maxLength: 255 type: string asBillTo: type: boolean asShipTo: type: boolean asSoldTo: type: boolean city: maxLength: 40 type: string contactDescription: maxLength: 100 type: string country: maxLength: 64 type: string county: maxLength: 32 type: string fax: maxLength: 40 type: string firstName: maxLength: 100 type: string homePhone: maxLength: 40 type: string lastName: maxLength: 100 type: string mobilePhone: maxLength: 100 type: string nickname: maxLength: 100 type: string otherPhone: maxLength: 40 type: string otherPhoneType: enum: - Work - Mobile - Home - Other type: string personalEmail: maxLength: 80 type: string state: maxLength: 40 type: string taxRegion: maxLength: 32 type: string workEmail: maxLength: 80 type: string workPhone: maxLength: 40 type: string zipCode: maxLength: 20 type: string type: object - $ref: '#/components/schemas/ContactObjectCustomFields' PUTTransferContact: type: object properties: destinationAccountKey: type: string GETContactSnapshotResponse: allOf: - properties: address1: type: string address2: type: string asBillTo: type: boolean asShipTo: type: boolean asSoldTo: type: boolean city: type: string contactId: type: string country: type: string nullable: true county: type: string fax: format: number type: string firstName: type: string homePhone: format: number type: string id: type: string lastName: type: string mobilePhone: format: number type: string nickname: type: string otherPhone: type: string otherPhoneType: enum: - Work - Mobile - Home - Other type: string personalEmail: type: string maxLength: 80 postalCode: format: number type: string state: type: string taxRegion: type: string workEmail: type: string workPhone: format: number type: string type: object - $ref: '#/components/schemas/ContactSnapshotObjectCustomFields' ContactSnapshotObjectCustomFields: additionalProperties: {} title: contactSnapshotFieldsCustom type: object POSTSubscriptionPreviewType: allOf: - properties: accountKey: type: string contractEffectiveDate: format: date type: string customerAcceptanceDate: format: date type: string documentDate: format: date type: string includeExistingDraftDocItems: type: boolean initialTerm: format: int64 type: integer initialTermPeriodType: type: string invoiceOwnerAccountKey: type: string notes: maxLength: 1000 type: string previewAccountInfo: $ref: '#/components/schemas/POSTSubscriptionPreviewTypePreviewAccountInfo' previewType: enum: - LegalDoc - ChargeMetrics - LegalDocChargeMetrics type: string default: LegalDoc serviceActivationDate: format: date type: string subscribeToRatePlans: items: $ref: '#/components/schemas/POSTSrpCreateType' type: array targetDate: format: date type: string termStartDate: format: date type: string termType: type: string required: - termType - contractEffectiveDate - subscribeToRatePlans type: object - $ref: '#/components/schemas/SubscriptionObjectCustomFields' POSTSubscriptionPreviewResponseType: properties: chargeMetrics: properties: dmrr: type: string dtcv: type: string mrr: type: string number: type: string originRatePlanId: type: string originalId: type: string productRatePlanChargeId: type: string productRatePlanId: type: string tcv: type: string type: object contractedMrr: type: number creditMemo: properties: amount: format: double type: number amountWithoutTax: format: double type: number creditMemoItems: items: $ref: '#/components/schemas/POSTSubscriptionPreviewCreditMemoItemsType' type: array taxAmount: format: double type: number type: object documentDate: format: date type: string invoice: properties: amount: type: number amountWithoutTax: type: number invoiceItems: items: $ref: '#/components/schemas/POSTSubscriptionPreviewInvoiceItemsType' type: array targetDate: type: string taxAmount: type: number type: object success: type: boolean targetDate: format: date type: string taxAmount: type: number totalContractedValue: type: number type: object POSTSubscriptionPreviewCreditMemoItemsType: properties: amountWithoutTax: format: double type: number chargeAmount: format: double type: number chargeDescription: type: string chargeName: type: string productName: type: string productRatePlanChargeId: type: string quantity: type: integer serviceEndDate: format: date type: string serviceStartDate: format: date type: string taxAmount: format: double type: number taxationItems: items: $ref: '#/components/schemas/POSTSubscriptionPreviewTaxationItemsType' type: array unitOfMeasure: type: string title: creditMemoItems type: object POSTSubscriptionPreviewInvoiceItemsType: properties: chargeAmount: type: number chargeDescription: type: string chargeName: type: string productName: type: string productRatePlanChargeId: type: string quantity: type: number serviceEndDate: format: date type: string serviceStartDate: format: date type: string taxAmount: format: double type: number taxationItems: items: $ref: '#/components/schemas/POSTSubscriptionPreviewTaxationItemsType' type: array unitOfMeasure: type: string title: invoiceItems type: object POSTSubscriptionPreviewTaxationItemsType: properties: exemptAmount: type: number jurisdiction: type: string locationCode: type: string name: type: string taxAmount: format: double type: number taxCode: type: string taxCodeDescription: type: string taxDate: type: string taxRate: type: number taxRateDescription: type: string taxRateType: enum: - Percentage - FlatFee type: string title: taxationItems type: object POSTSubscriptionPreviewTypePreviewAccountInfo: allOf: - properties: billCycleDay: format: int64 type: integer billToContact: properties: city: type: string country: type: string county: type: string state: type: string taxRegion: type: string zipCode: type: string type: object currency: type: string required: - billCycleDay - billToContact - currency type: object - $ref: '#/components/schemas/AccountObjectNSFields' - $ref: '#/components/schemas/AccountObjectCustomFields' title: previewAccountInfo PreviewExistingSubscriptionRequest: properties: previewStartDate: $ref: '#/components/schemas/PreviewStartDate' previewThroughDate: $ref: '#/components/schemas/PreviewThroughDate' quantityForUsageCharges: items: $ref: '#/components/schemas/QuantityForUsageCharges' type: array type: object PreviewExistingSubscriptionResponse: allOf: - $ref: '#/components/schemas/CommonResponse' - properties: invoices: items: $ref: '#/components/schemas/PreviewExistingSubscriptionResultInvoices' type: array creditMemos: items: $ref: '#/components/schemas/PreviewExistingSubscriptionResultCreditMemos' type: array type: object PreviewExistingSubscriptionResultInvoices: properties: invoiceNumber: type: string amount: type: number format: double amountWithoutTax: type: number format: double taxAmount: type: number format: double targetDate: format: date type: string invoiceItems: items: $ref: '#/components/schemas/PreviewExistingSubscriptionInvoiceItemResult' type: array status: type: string enum: - Draft - Posted - null nullable: true isFromExistingInvoice: type: boolean type: object PreviewExistingSubscriptionResultCreditMemos: properties: creditMemoNumber: type: string amount: type: number format: double amountWithoutTax: type: number format: double taxAmount: type: number format: double targetDate: format: date type: string creditMemoItems: items: $ref: '#/components/schemas/PreviewExistingSubscriptionCreditMemoItemResult' type: array status: type: string nullable: true isFromExistingCreditMemo: type: boolean type: object PreviewExistingSubscriptionCreditMemoItemResult: properties: serviceStartDate: format: date type: string serviceEndDate: format: date type: string amountWithoutTax: type: number format: double taxAmount: type: number format: double chargeDescription: type: string chargeName: type: string chargeNumber: type: string productName: type: string productRatePlanChargeId: type: string processingType: type: string enum: - Charge - Discount - Tax unitPrice: type: number format: double quantity: type: number unitOfMeasure: type: string nullable: true discountDetails: items: $ref: '#/components/schemas/PreviewExistingSubscriptionDiscountDetails' type: array type: object PreviewExistingSubscriptionDiscountDetails: properties: discountChargeName: type: string discountChargeNumber: type: string discountRate: type: number type: object PreviewExistingSubscriptionInvoiceItemResult: properties: serviceStartDate: format: date type: string serviceEndDate: format: date type: string amountWithoutTax: type: number format: double taxAmount: type: number format: double chargeDescription: type: string chargeName: type: string chargeNumber: type: string productName: type: string productRatePlanChargeId: type: string processingType: type: string enum: - Charge - Discount - Tax unitPrice: type: number format: double quantity: type: number unitOfMeasure: type: string nullable: true discountDetails: items: $ref: '#/components/schemas/PreviewExistingSubscriptionDiscountDetails' type: array type: object PreviewStartDate: properties: previewStartDatePolicy: $ref: '#/components/schemas/PreviewStartDatePolicy' specificDate: type: string type: object PreviewThroughDate: properties: previewThruDatePolicy: $ref: '#/components/schemas/PreviewThruDatePolicy' nextBillingPeriods: type: number specificDate: type: string type: object QuantityForUsageCharges: allOf: - properties: chargeId: type: string quantity: type: number type: object PreviewThruDatePolicy: enum: - nextBillingPeriods - endOfTerm - specificDate type: string PreviewStartDatePolicy: enum: - startOfTerm - today - specificDate type: string POSTSubscriptionType: allOf: - properties: accountKey: type: string applicationOrder: items: type: string type: array applyCredit: type: boolean applyCreditBalance: type: boolean autoRenew: default: false type: boolean collect: default: true type: boolean contractEffectiveDate: format: date type: string creditMemoReasonCode: type: string customerAcceptanceDate: format: date type: string documentDate: format: date type: string externallyManagedBy: enum: - Amazon - Apple - Google - Roku type: string gatewayId: type: string initialTerm: format: int64 type: integer initialTermPeriodType: type: string invoiceOwnerAccountKey: type: string invoiceSeparately: type: boolean lastBookingDate: format: date type: string notes: maxLength: 1000 type: string paymentMethodId: type: string prepayment: type: boolean renewalSetting: type: string renewalTerm: format: int64 type: integer renewalTermPeriodType: type: string runBilling: default: true type: boolean serviceActivationDate: format: date type: string subscribeToRatePlans: items: $ref: '#/components/schemas/POSTSrpCreateType' type: array subscriptionNumber: type: string targetDate: format: date type: string termStartDate: format: date type: string termType: type: string required: - accountKey - contractEffectiveDate - subscribeToRatePlans - termType - renewalTerm type: object - $ref: '#/components/schemas/SubscriptionObjectQTFields' - $ref: '#/components/schemas/SubscriptionObjectNSFields' - $ref: '#/components/schemas/SubscriptionObjectCustomFields' POSTSubscriptionResponseType: properties: contractedMrr: type: number creditMemoId: type: string invoiceId: type: string paidAmount: type: number paymentId: type: string subscriptionId: type: string subscriptionNumber: type: string success: type: boolean totalContractedValue: type: number type: object GETSubscriptionWrapper: properties: nextPage: format: URL type: string subscriptions: items: $ref: '#/components/schemas/GETSubscriptionType' type: array success: type: boolean type: object GETSubscriptionType: allOf: - properties: accountId: type: string accountName: type: string accountNumber: type: string autoRenew: type: boolean billToContact: $ref: '#/components/schemas/GETAccountSummaryTypeBillToContact' cancelReason: type: string contractEffectiveDate: format: date type: string contractedMrr: type: number contractedNetMrr: type: number asOfDayGrossMrr: type: number asOfDayNetMrr: type: number netTotalContractedValue: type: number currency: type: string currentTerm: format: int64 type: integer currentTermPeriodType: type: string customerAcceptanceDate: format: date type: string externallyManagedBy: enum: - Amazon - Apple - Google - Roku type: string id: type: string initialTerm: format: int64 type: integer initialTermPeriodType: type: string invoiceGroupNumber: type: string nullable: true invoiceOwnerAccountId: type: string invoiceOwnerAccountName: type: string invoiceOwnerAccountNumber: type: string invoiceScheduleId: type: integer invoiceSeparately: type: boolean invoiceTemplateId: type: string invoiceTemplateName: type: string isLatestVersion: type: boolean lastBookingDate: format: date type: string notes: type: string orderNumber: type: string organizationLabel: type: string paymentTerm: type: string ratePlans: items: $ref: '#/components/schemas/GETSubscriptionRatePlanType' type: array renewalSetting: type: string renewalTerm: format: int64 type: integer renewalTermPeriodType: type: string revision: type: string sequenceSetId: type: string nullable: true communicationProfileId: type: string nullable: true sequenceSetName: type: string serviceActivationDate: format: date type: string shipToContact: $ref: '#/components/schemas/GetAccountSummaryTypeShipToContact' soldToContact: $ref: '#/components/schemas/GETAccountSummaryTypeSoldToContact' status: type: string statusHistory: items: $ref: '#/components/schemas/GETSubscriptionStatusHistoryType' type: array subscriptionEndDate: format: date type: string subscriptionNumber: type: string subscriptionStartDate: format: date type: string termEndDate: format: date type: string termStartDate: format: date type: string termType: type: string scheduledCancelDate: format: date type: string scheduledSuspendDate: format: date type: string scheduledResumeDate: format: date type: string totalContractedValue: type: number version: format: int64 type: integer type: object - $ref: '#/components/schemas/SubscriptionObjectQTFields' - $ref: '#/components/schemas/SubscriptionObjectNSFields' - $ref: '#/components/schemas/SubscriptionObjectCustomFields' title: subscriptions GETSubscriptionRatePlanType: allOf: - properties: externallyManagedPlanId: type: string id: type: string lastChangeType: type: string productId: type: string productName: type: string productRatePlanId: type: string productSku: type: string contractedMrr: type: number contractedNetMrr: type: number asOfDayGrossMrr: type: number asOfDayNetMrr: type: number ratePlanCharges: items: $ref: '#/components/schemas/GETSubscriptionRatePlanChargesType' type: array ratePlanName: type: string subscriptionProductFeatures: items: $ref: '#/components/schemas/GETSubscriptionProductFeatureType' type: array type: object - $ref: '#/components/schemas/RatePlanObjectCustomFields' title: ratePlans GETSubscriptionStatusHistoryType: allOf: - properties: endDate: format: date type: string startDate: format: date type: string status: type: string type: object title: statusHistory GETSubscriptionRatePlanChargesType: allOf: - properties: amendedByOrderOn: type: string applyDiscountTo: type: string applyToBillingPeriodPartially: type: boolean billingDay: type: string billingPeriod: type: string billingPeriodAlignment: type: string billingTiming: type: string chargeFunction: enum: - Standard - Prepayment - CommitmentTrueUp - Drawdown - CreditCommitment - DrawdownAndCreditCommitment type: string commitmentType: enum: - UNIT - CURRENCY type: string chargeModelConfiguration: $ref: '#/components/schemas/ChargeModelConfigurationType' chargeSegments: type: array items: $ref: '#/components/schemas/RatePlanChargeSegment' chargedThroughDate: format: date type: string creditOption: enum: - TimeBased - ConsumptionBased - FullCreditBack type: string currency: type: string discountAmount: type: number discountApplyDetails: items: $ref: '#/components/schemas/DiscountApplyDetails' type: array discountClass: type: string discountLevel: type: string discountPercentage: type: number dmrc: type: number done: type: boolean drawdownRate: type: number drawdownUom: type: string dtcv: type: number effectiveEndDate: format: date type: string effectiveStartDate: format: date type: string endDateCondition: type: string estimatedStartDate: type: string format: date estimatedEndDate: type: string format: date excludeItemBillingFromRevenueAccounting: type: boolean excludeItemBookingFromRevenueAccounting: type: boolean id: type: string includedUnits: type: number invoiceScheduleId: type: string isAllocationEligible: type: boolean isDimensionalPrice: type: boolean isPrepaid: type: boolean isPriceNegotiated: type: boolean isRollover: type: boolean isStackedDiscount: type: boolean isUnbilled: type: boolean listPriceBase: type: string model: type: string mrr: type: number name: type: string number: type: string numberOfDeliveries: type: number numberOfPeriods: format: int64 type: integer originalChargeId: type: string originalListPrice: type: number originalOrderDate: format: date type: string overageCalculationOption: type: string overagePrice: type: number overageUnusedUnitsCreditOption: type: string prepaidOperationType: enum: - topup - drawdown type: string prepaidQuantity: type: number prepaidTotalQuantity: type: number prepaidUom: type: string price: type: number pricingAttributes: type: object additionalProperties: true salesPrice: type: number priceChangeOption: type: string priceIncreasePercentage: type: number pricingSummary: type: string processedThroughDate: format: date type: string productCategory: type: string productClass: type: string productFamily: type: string productLine: type: string productRatePlanChargeId: type: string quantity: type: number ratingGroup: type: string reflectDiscountInNetAmount: type: boolean default: false revenueRecognitionTiming: maxLength: 200 type: string enum: - Upon Billing Document Posting Date - Upon Order Activation Date revenueAmortizationMethod: maxLength: 200 type: string enum: - Immediate - Ratable Using Start And End Dates rolloverApply: enum: - ApplyFirst - ApplyLast type: string rolloverPeriodLength: default: null type: integer rolloverPeriods: type: number segment: format: int64 type: integer smoothingModel: type: string specificBillingPeriod: format: int64 type: integer specificEndDate: format: date type: string specificListPriceBase: {} subscriptionChargeDeliverySchedule: $ref: '#/components/schemas/GETDeliveryScheduleType' subscriptionChargeIntervalPricing: items: $ref: '#/components/schemas/GETIntervalPriceType' type: array tcv: type: number tiers: items: $ref: '#/components/schemas/GETTierType' type: array triggerDate: format: date type: string triggerEvent: type: string type: type: string unusedUnitsCreditRates: type: number upsellOriginChargeNumber: type: string uom: type: string upToPeriods: type: string upToPeriodsType: type: string usageRecordRatingOption: type: string validityPeriodType: enum: - SUBSCRIPTION_TERM - ANNUAL - SEMI_ANNUAL - QUARTER - MONTH type: string version: format: int64 type: integer type: object - $ref: '#/components/schemas/RatePlanChargeObjectCustomFields' title: ratePlanCharges GETSubscriptionProductFeatureType: properties: featureCode: type: string id: type: string name: type: string title: subscriptionProductFeatures type: object RatePlanChargeSegment: type: object title: ratePlanChargeSegment properties: id: type: string amendedByOrderOn: format: date type: string applyDiscountTo: type: string enum: - ONETIME - RECURRING - USAGE - ONETIMERECURRING - ONETIMEUSAGE - RECURRINGUSAGE - ONETIMERECURRINGUSAGE - null nullable: true chargeFunction: enum: - Standard - Prepayment - CommitmentTrueUp - Drawdown - CreditCommitment - DrawdownAndCreditCommitment type: string chargeModelConfiguration: $ref: '#/components/schemas/ChargeModelConfigurationType' chargedThroughDate: format: date type: string commitmentType: enum: - UNIT - CURRENCY type: string prepaidCommittedAmount: type: string nullable: true creditOption: enum: - TimeBased - ConsumptionBased - FullCreditBack - null type: string nullable: true currency: $ref: '#/components/schemas/Currency' deliverySchedule: $ref: '#/components/schemas/GETDeliveryScheduleType' numberOfDeliveries: type: number nullable: true discountAmount: type: number nullable: true discountApplyDetails: items: $ref: '#/components/schemas/DiscountApplyDetails' type: array nullable: true discountClass: type: string nullable: true discountLevel: $ref: '#/components/schemas/DiscountLevel' discountPercentage: type: number nullable: true applyToBillingPeriodPartially: type: boolean default: false dmrc: type: number format: double done: type: boolean drawdownRate: type: number drawdownUom: $ref: '#/components/schemas/Uom' dtcv: type: number format: double effectiveEndDate: format: date type: string effectiveStartDate: format: date type: string endDateCondition: $ref: '#/components/schemas/EndDateCondition' includedUnits: type: number inputArgumentId: type: string isCommitted: type: boolean isPrepaid: type: boolean isRollover: type: boolean mrr: type: number format: double originalOrderDate: format: date type: string overagePrice: type: number prepaidOperationType: enum: - topup - drawdown type: string prepaidQuantity: type: number prepaidTotalQuantity: type: number prepaidUOM: $ref: '#/components/schemas/Uom' quantity: type: number price: type: number priceChangeOption: $ref: '#/components/schemas/PriceChangeOption' priceIncreasePercentage: type: number nullable: true minimum: -100 maximum: 100 pricingSummary: type: string originalListPrice: type: number nullable: true processedThroughDate: format: date type: string rolloverApply: enum: - ApplyFirst - ApplyLast type: string rolloverPeriodLength: type: integer rolloverPeriods: format: int64 type: integer prorationOption: type: string segment: format: int64 type: integer specificEndDate: format: date type: string subscriptionChargeIntervalPricing: items: $ref: '#/components/schemas/GETIntervalPriceType' type: array tcv: type: number format: double tiers: items: $ref: '#/components/schemas/RatePlanChargeTier' type: array nullable: true triggerDate: format: date type: string nullable: true billingPeriodAlignment: $ref: '#/components/schemas/BillingPeriodAlignment' triggerEvent: $ref: '#/components/schemas/TriggerEvent' upToPeriods: format: int64 type: integer nullable: true upToPeriodsType: $ref: '#/components/schemas/UpToPeriodsType' validityPeriodType: $ref: '#/components/schemas/ValidityPeriodType' salesPrice: type: number format: double accountingCode: type: string nullable: true revenueRecognitionCode: type: string nullable: true revRecTriggerCondition: type: string nullable: true estimatedEndDate: format: date type: string estimatedStartDate: format: date type: string taxable: type: boolean nullable: true taxCode: type: string nullable: true taxMode: type: string nullable: true enum: - TaxExclusive - TaxInclusive - null DiscountApplyDetails: properties: appliedProductName: type: string appliedProductRatePlanChargeId: type: string appliedProductRatePlanChargeName: type: string appliedProductRatePlanId: type: string appliedProductRatePlanName: type: string title: discountApplyDetails type: object GETDeliveryScheduleType: properties: frequency: enum: - Weekly type: string friday: type: boolean monday: type: boolean saturday: type: boolean sunday: type: boolean thursday: type: boolean tuesday: type: boolean wednesday: type: boolean title: deliverySchedule type: object GETIntervalPriceType: properties: duration: type: integer price: type: number sequence: type: integer subscriptionChargeIntervalPriceTiers: items: $ref: '#/components/schemas/GETIntervalPriceTierType' type: array type: enum: - Day - Month - Infinity type: string title: IntervalPricing type: object GETTierType: properties: endingUnit: type: number originalListPrice: type: number price: type: number priceFormat: type: string startingUnit: type: number tier: format: int64 type: integer title: tiers type: object GETIntervalPriceTierType: properties: endingUnit: type: number isOveragePrice: type: boolean price: type: number priceFormat: type: string startingUnit: type: number tier: format: int64 type: integer title: IntervalPricing type: object Currency: type: string DiscountLevel: type: string enum: - rateplan - subscription - account Uom: type: string EndDateCondition: type: string enum: - Subscription_End - Fixed_Period - Specific_End_Date - One_Time PriceChangeOption: type: string enum: - NoChange - SpecificPercentageValue - UseLatestProductCatalogPricing - null default: NoChange nullable: true RatePlanChargeTier: type: object title: chargeTier properties: tier: format: int64 type: integer minimum: 1 startingUnit: type: number format: double endingUnit: type: number format: double price: type: number priceFormat: type: string enum: - FlatFee - PerUnit originalListPrice: type: number format: double BillingPeriodAlignment: enum: - AlignToCharge - AlignToSubscriptionStart - AlignToTermStart - AlignToTermEnd type: string TriggerEvent: type: string enum: - ContractEffective - ServiceActivation - CustomerAcceptance - SpecificDate UpToPeriodsType: type: string enum: - Days - Weeks - Months - Years - Billing_Periods - null nullable: true ValidityPeriodType: type: string enum: - SUBSCRIPTION_TERM - ANNUAL - SEMI_ANNUAL - QUARTER - MONTH - null nullable: true GETSubscriptionByKeyWithSuccess: allOf: - properties: accountId: type: string accountName: type: string accountNumber: type: string autoRenew: type: boolean billToContact: $ref: '#/components/schemas/GETAccountSummaryTypeBillToContact' cancelReason: type: string contractEffectiveDate: format: date type: string contractedMrr: type: number contractedNetMrr: type: number asOfDayGrossMrr: type: number asOfDayNetMrr: type: number netTotalContractedValue: type: number currency: type: string currentTerm: format: int64 type: integer currentTermPeriodType: type: string customerAcceptanceDate: format: date type: string externallyManagedBy: enum: - Amazon - Apple - Google - Roku type: string id: type: string initialTerm: format: int64 type: integer initialTermPeriodType: type: string invoiceGroupNumber: type: string nullable: true invoiceOwnerAccountId: type: string invoiceOwnerAccountName: type: string invoiceOwnerAccountNumber: type: string invoiceScheduleId: type: integer invoiceSeparately: type: boolean invoiceTemplateId: type: string nullable: true invoiceTemplateName: type: string isLatestVersion: type: boolean lastBookingDate: format: date type: string notes: type: string orderNumber: type: string organizationLabel: type: string originalListPrice: type: number paymentTerm: type: string ratePlans: items: $ref: '#/components/schemas/GETSubscriptionRatePlanType' type: array renewalSetting: type: string renewalTerm: format: int64 type: integer renewalTermPeriodType: type: string revision: type: string sequenceSetId: type: string nullable: true communicationProfileId: type: string nullable: true sequenceSetName: type: string serviceActivationDate: format: date type: string shipToContact: $ref: '#/components/schemas/GetAccountSummaryTypeShipToContact' soldToContact: $ref: '#/components/schemas/GETAccountSummaryTypeSoldToContact' status: type: string statusHistory: items: $ref: '#/components/schemas/GETSubscriptionStatusHistoryType' type: array subscriptionEndDate: format: date type: string subscriptionNumber: type: string subscriptionStartDate: format: date type: string success: type: boolean termEndDate: format: date type: string termStartDate: format: date type: string termType: type: string scheduledCancelDate: format: date type: string scheduledSuspendDate: format: date type: string scheduledResumeDate: format: date type: string totalContractedValue: type: number version: format: int64 type: integer accountOwnerDetails: $ref: '#/components/schemas/GETAccountTypeBasicInfo' invoiceOwnerAccountDetails: $ref: '#/components/schemas/GETAccountTypeBasicInfo' type: object - $ref: '#/components/schemas/SubscriptionObjectQTFields' - $ref: '#/components/schemas/SubscriptionObjectNSFields' - $ref: '#/components/schemas/SubscriptionObjectCustomFields' PUTSubscriptionType: allOf: - properties: add: items: $ref: '#/components/schemas/PUTSrpAddType' type: array applicationOrder: items: type: string type: array applyCredit: type: boolean applyCreditBalance: type: boolean autoRenew: type: boolean bookingDate: format: date type: string change: items: $ref: '#/components/schemas/PUTSrpChangeType' type: array collect: default: false type: boolean creditMemoReasonCode: type: string currentTerm: format: int64 type: integer currentTermPeriodType: type: string documentDate: format: date type: string externallyManagedBy: enum: - Amazon - Apple - Google - Roku type: string includeExistingDraftDocItems: type: boolean invoiceSeparately: type: boolean notes: maxLength: 1000 type: string preview: type: boolean previewType: enum: - LegalDoc - ChargeMetrics - LegalDocChargeMetrics default: LegalDoc type: string remove: items: $ref: '#/components/schemas/PUTSrpRemoveType' type: array renewalSetting: type: string renewalTerm: format: int64 type: integer renewalTermPeriodType: type: string runBilling: default: false type: boolean targetDate: format: date type: string termStartDate: format: date type: string termType: type: string update: items: $ref: '#/components/schemas/PUTSrpUpdateType' type: array type: object - $ref: '#/components/schemas/SubscriptionObjectQTFields' - $ref: '#/components/schemas/SubscriptionObjectNSFields' - $ref: '#/components/schemas/SubscriptionObjectCustomFields' PUTSubscriptionResponseType: properties: chargeMetrics: properties: dmrr: type: string dtcv: type: string mrr: type: string number: type: string originRatePlanId: type: string originalId: type: string productRatePlanChargeId: type: string productRatePlanId: type: string tcv: type: string type: object creditMemo: properties: amount: format: double type: number amountWithoutTax: format: double type: number creditMemoItems: items: $ref: '#/components/schemas/POSTSubscriptionPreviewCreditMemoItemsType' type: array taxAmount: format: double type: number type: object creditMemoId: type: string invoice: properties: amount: format: double type: number amountWithoutTax: format: double type: number invoiceItems: items: $ref: '#/components/schemas/PUTSubscriptionPreviewInvoiceItemsType' type: array targetDate: format: date type: string taxAmount: format: double type: number type: object invoiceId: type: string invoiceItems: items: $ref: '#/components/schemas/PUTSubscriptionPreviewInvoiceItemsType' type: array paidAmount: type: number paymentId: type: string subscriptionId: type: string success: type: boolean targetDate: format: date type: string taxAmount: type: number totalDeltaMrr: type: number totalDeltaTcv: type: number type: object PUTSubscriptionPreviewInvoiceItemsType: properties: chargeAmount: type: number chargeDescription: type: string chargeName: type: string productName: type: string productRatePlanChargeId: type: string quantity: type: number serviceEndDate: format: date type: string serviceStartDate: format: date type: string taxationItems: items: $ref: '#/components/schemas/POSTSubscriptionPreviewTaxationItemsType' type: array unitOfMeasure: type: string title: invoiceItems type: object PUTSrpAddType: allOf: - properties: bookingDate: format: date type: string chargeOverrides: items: $ref: '#/components/schemas/PUTScAddType' type: array contractEffectiveDate: format: date type: string customerAcceptanceDate: format: date type: string externalCatalogPlanId: type: string externalIdSourceSystem: type: string externallyManagedPlanId: type: string productRatePlanId: type: string productRatePlanNumber: type: string serviceActivationDate: format: date type: string required: - contractEffectiveDate type: object - $ref: '#/components/schemas/RatePlanObjectCustomFields' title: add PUTSrpChangeType: allOf: - properties: bookingDate: format: date type: string chargeOverrides: items: $ref: '#/components/schemas/PUTScAddType' type: array contractEffectiveDate: format: date type: string customerAcceptanceDate: format: date type: string effectivePolicy: enum: - EffectiveImmediately - EffectiveEndOfBillingPeriod - SpecificDate type: string externalCatalogPlanId: type: string externalIdSourceSystem: type: string newExternalCatalogPlanId: type: string newExternalIdSourceSystem: type: string newProductRatePlanId: type: string newProductRatePlanNumber: type: string productRatePlanId: type: string productRatePlanNumber: type: string ratePlanId: type: string resetBcd: default: false type: boolean serviceActivationDate: format: date type: string subType: enum: - Upgrade - Downgrade - Crossgrade - PlanChanged type: string subscriptionRatePlanNumber: type: string type: object - $ref: '#/components/schemas/RatePlanObjectCustomFields' title: change PUTSrpRemoveType: properties: bookingDate: format: date type: string contractEffectiveDate: format: date type: string customerAcceptanceDate: format: date type: string externalCatalogPlanId: type: string externalIdSourceSystem: type: string productRatePlanNumber: type: string ratePlanId: type: string serviceActivationDate: format: date type: string subscriptionRatePlanNumber: type: string required: - contractEffectiveDate title: remove type: object PUTSrpUpdateType: allOf: - properties: bookingDate: format: date type: string chargeUpdateDetails: items: $ref: '#/components/schemas/PUTScUpdateType' type: array contractEffectiveDate: format: date type: string customerAcceptanceDate: format: date type: string externalCatalogPlanId: type: string externalIdSourceSystem: type: string externallyManagedPlanId: type: string productRatePlanNumber: type: string ratePlanId: type: string serviceActivationDate: format: date type: string specificUpdateDate: format: date type: string subscriptionRatePlanNumber: type: string required: - contractEffectiveDate type: object - $ref: '#/components/schemas/RatePlanObjectCustomFields' title: update PUTScUpdateType: allOf: - properties: billingPeriodAlignment: type: string chargeModelConfiguration: $ref: '#/components/schemas/ChargeModelConfigurationType' includedUnits: type: number overagePrice: type: number price: type: number priceChangeOption: type: string priceIncreasePercentage: type: number quantity: type: number ratePlanChargeId: type: string tiers: items: $ref: '#/components/schemas/POSTTierType' type: array triggerDate: format: date type: string triggerEvent: type: string required: - ratePlanChargeId type: object - $ref: '#/components/schemas/RatePlanChargeObjectCustomFields' title: chargeUpdateDetails PUTScAddType: allOf: - properties: amendedByOrderOn: type: string applyDiscountTo: type: string billCycleDay: type: string billCycleType: type: string billingPeriod: type: string billingPeriodAlignment: type: string billingTiming: type: string chargeModelConfiguration: $ref: '#/components/schemas/ChargeModelConfigurationType' discountAmount: type: number discountLevel: type: string discountPercentage: type: number endDateCondition: type: string excludeItemBillingFromRevenueAccounting: default: false type: boolean excludeItemBookingFromRevenueAccounting: default: false type: boolean includedUnits: type: number isAllocationEligible: type: boolean isUnbilled: type: boolean listPriceBase: type: string number: type: string numberOfPeriods: format: int64 type: integer originalOrderDate: format: date type: string overagePrice: type: number overageUnusedUnitsCreditOption: type: string price: type: number priceChangeOption: type: string priceIncreasePercentage: type: number productRatePlanChargeId: type: string productRatePlanChargeNumber: type: string quantity: type: number ratingGroup: type: string specificBillingPeriod: format: int64 type: integer specificEndDate: format: date type: string specificListPriceBase: format: int32 maximum: 200 minimum: 1 type: integer tiers: items: $ref: '#/components/schemas/POSTTierType' type: array triggerDate: format: date type: string triggerEvent: type: string unusedUnitsCreditRates: type: number upToPeriods: format: int64 type: integer upToPeriodsType: type: string required: - productRatePlanChargeId type: object - $ref: '#/components/schemas/RatePlanChargeObjectCustomFields' title: chargeOverrides GETSubscriptionTypeWithSuccess: allOf: - properties: accountId: type: string accountName: type: string accountNumber: type: string autoRenew: type: boolean billToContact: $ref: '#/components/schemas/GETAccountSummaryTypeBillToContact' cancelReason: type: string contractEffectiveDate: format: date type: string contractedMrr: type: number contractedNetMrr: type: number asOfDayGrossMrr: type: number asOfDayNetMrr: type: number netTotalContractedValue: type: number currency: type: string currentTerm: format: int64 type: integer currentTermPeriodType: type: string customerAcceptanceDate: format: date type: string externallyManagedBy: enum: - Amazon - Apple - Google - Roku type: string id: type: string initialTerm: format: int64 type: integer initialTermPeriodType: type: string invoiceGroupNumber: type: string nullable: true invoiceOwnerAccountId: type: string invoiceOwnerAccountName: type: string invoiceOwnerAccountNumber: type: string invoiceScheduleId: type: integer invoiceSeparately: type: boolean invoiceTemplateId: type: string invoiceTemplateName: type: string isLatestVersion: type: boolean lastBookingDate: format: date type: string notes: type: string orderNumber: type: string organizationLabel: type: string paymentTerm: type: string scheduledCancelDate: format: date type: string scheduledSuspendDate: format: date type: string scheduledResumeDate: format: date type: string ratePlans: items: $ref: '#/components/schemas/GETSubscriptionRatePlanType' type: array renewalSetting: type: string renewalTerm: format: int64 type: integer renewalTermPeriodType: type: string revision: type: string sequenceSetId: type: string nullable: true communicationProfileId: default: false type: string sequenceSetName: type: string serviceActivationDate: format: date type: string shipToContact: $ref: '#/components/schemas/GetAccountSummaryTypeShipToContact' soldToContact: $ref: '#/components/schemas/GETAccountSummaryTypeSoldToContact' status: type: string statusHistory: items: $ref: '#/components/schemas/GETSubscriptionStatusHistoryType' type: array subscriptionEndDate: format: date type: string subscriptionNumber: type: string subscriptionStartDate: format: date type: string success: type: boolean termEndDate: format: date type: string termStartDate: format: date type: string termType: type: string totalContractedValue: type: number version: format: int64 type: integer type: object - $ref: '#/components/schemas/SubscriptionObjectQTFields' - $ref: '#/components/schemas/SubscriptionObjectNSFields' - $ref: '#/components/schemas/SubscriptionObjectCustomFields' PUTRenewSubscriptionType: properties: applicationOrder: items: type: string type: array applyCredit: type: boolean applyCreditBalance: type: boolean collect: default: false type: boolean creditMemoReasonCode: type: string documentDate: format: date type: string orderDate: format: date type: string runBilling: default: false type: boolean targetDate: format: date type: string type: object PUTRenewSubscriptionResponseType: properties: creditMemoId: type: string invoiceId: type: string paidAmount: type: number paymentId: type: string success: type: boolean termEndDate: format: date type: string termStartDate: format: date type: string totalDeltaMrr: type: number totalDeltaTcv: type: number type: object POSTSubscriptionCancellationType: properties: applicationOrder: items: type: string type: array applyCredit: type: boolean applyCreditBalance: type: boolean bookingDate: format: date type: string cancellationEffectiveDate: format: date type: string cancellationPolicy: type: string collect: default: false type: boolean contractEffectiveDate: format: date type: string creditMemoReasonCode: type: string documentDate: format: date type: string orderDate: format: date type: string runBilling: default: false type: boolean targetDate: format: date type: string required: - cancellationPolicy type: object POSTSubscriptionCancellationResponseType: properties: cancelledDate: format: date type: string creditMemoId: type: string invoiceId: type: string paidAmount: type: number paymentId: type: string subscriptionId: type: string success: type: boolean totalDeltaMrr: type: number totalDeltaTcv: type: number type: object PUTSubscriptionResumeType: properties: applicationOrder: items: type: string type: array applyCredit: type: boolean applyCreditBalance: type: boolean bookingDate: format: date type: string collect: default: false type: boolean contractEffectiveDate: format: date type: string creditMemoReasonCode: type: string documentDate: format: date type: string extendsTerm: type: boolean orderDate: format: date type: string resumePeriods: type: string resumePeriodsType: type: string resumePolicy: type: string resumeSpecificDate: format: date type: string runBilling: default: false type: boolean targetDate: format: date type: string required: - resumePolicy type: object PUTSubscriptionResumeResponseType: properties: creditMemoId: type: string invoiceId: type: string paidAmount: type: number paymentId: type: string resumeDate: format: date type: string subscriptionId: type: string success: type: boolean termEndDate: format: date type: string totalDeltaTcv: type: number type: object PUTSubscriptionSuspendType: properties: applicationOrder: items: type: string type: array applyCredit: type: boolean applyCreditBalance: type: boolean bookingDate: format: date type: string collect: default: false type: boolean contractEffectiveDate: format: date type: string creditMemoReasonCode: type: string documentDate: format: date type: string extendsTerm: type: boolean orderDate: format: date type: string resume: type: boolean resumePeriods: type: string resumePeriodsType: type: string resumePolicy: type: string resumeSpecificDate: format: date type: string runBilling: default: false type: boolean suspendPeriods: type: string suspendPeriodsType: type: string suspendPolicy: type: string suspendSpecificDate: format: date type: string targetDate: format: date type: string required: - suspendPolicy type: object PUTSubscriptionSuspendResponseType: properties: creditMemoId: type: string invoiceId: type: string paidAmount: type: number paymentId: type: string resumeDate: format: date type: string nullable: true subscriptionId: type: string success: type: boolean suspendDate: format: date type: string termEndDate: format: date type: string totalDeltaTcv: type: number type: object PUTDeleteSubscriptionResponseType: properties: success: type: boolean type: object PUTSubscriptionPatchSpecificVersionRequestType: properties: customFields: $ref: '#/components/schemas/SubscriptionObjectCustomFields' ratePlans: items: properties: charges: items: properties: chargeId: type: string chargeNumber: type: string customFields: $ref: '#/components/schemas/RatePlanChargeObjectCustomFields' type: object type: array customFields: $ref: '#/components/schemas/RatePlanObjectCustomFields' ratePlanId: type: string required: - ratePlanId type: object type: array type: object GETMetricsBySubscriptionNumbersResponse: allOf: - $ref: '#/components/schemas/CommonResponse' - properties: subscriptionMetrics: items: properties: subscriptionNumber: type: string contractedMrr: type: number contractedNetMrr: type: number asOfDayGrossMrr: type: number asOfDayNetMrr: type: number netTotalContractedValue: type: number totalContractedValue: type: number type: object type: array type: object POSTReverseRolloverRequestType: allOf: - properties: destinationValidityPeriod: $ref: '#/components/schemas/DestinationValidityPeriodInfo' prepaymentUom: type: string sourceValidityPeriod: $ref: '#/components/schemas/SourceValidityPeriodInfo' subscriptionNumber: maxLength: 100 type: string required: - subscriptionNumber - prepaymentUom - sourceValidityPeriod - destinationValidityPeriod type: object POSTReverseRolloverResponseType: properties: message: type: string reverseRolloverFundCount: format: int64 type: integer success: type: boolean type: object DestinationValidityPeriodInfo: properties: endDate: format: date type: string startDate: format: date type: string required: - startDate - endDate title: destinationValidityPeriod type: object SourceValidityPeriodInfo: properties: endDate: format: date type: string startDate: format: date type: string required: - startDate - endDate title: sourceValidityPeriod type: object POSTTriggerRolloverRequestType: allOf: - properties: destinationValidityPeriod: $ref: '#/components/schemas/DestinationValidityPeriodInfo' prepaymentUom: type: string priority: type: string sourceValidityPeriod: $ref: '#/components/schemas/SourceValidityPeriodInfo' subscriptionNumber: maxLength: 100 type: string required: - subscriptionNumber - prepaymentUom - sourceValidityPeriod - destinationValidityPeriod - priority type: object POSTTriggerRolloverResponseType: properties: message: type: string rolloverFundCount: format: int64 type: integer success: type: boolean type: object POSTDepleteFundRequestType: properties: fundIds: type: object POSTDepleteFundResponseType: properties: fundIds: items: properties: fundId: type: string status: type: string message: type: string type: object type: array type: object POSTUsageResponseType: properties: checkImportStatus: type: string size: format: int64 type: integer success: type: boolean type: object GETUsageRateDetailWrapper: properties: data: properties: amountWithoutTax: format: double type: number chargeNumber: type: string invoiceId: type: string invoiceItemId: type: string invoiceNumber: type: string listPrice: type: string quantity: format: double type: number rateDetail: type: string servicePeriod: type: string uom: type: string type: object success: type: boolean type: object ProxyCreateUsage: allOf: - properties: AccountId: type: string AccountNumber: type: string ChargeId: type: string ChargeNumber: maxLength: 50 type: string Description: maxLength: 200 type: string EndDateTime: format: date-time type: string ProductRatePlanChargeNumber: type: string Quantity: format: double type: number StartDateTime: format: date-time type: string SubscriptionId: maxLength: 32 type: string SubscriptionNumber: maxLength: 100 type: string UOM: type: string UniqueKey: type: string required: - Quantity - StartDateTime - UOM type: object - $ref: '#/components/schemas/UsageObjectCustomFields' UsageObjectCustomFields: additionalProperties: {} title: usageFieldsCustom type: object ProxyGetUsage: allOf: - properties: AccountId: type: string AccountNumber: type: string ChargeId: type: string CreatedById: type: string CreatedDate: format: date-time type: string Description: type: string EndDateTime: format: date-time type: string Id: type: string ProductRatePlanChargeNumber: type: string Quantity: format: double type: number RbeStatus: type: string SourceType: type: string StartDateTime: format: date-time type: string SubscriptionId: type: string SubscriptionNumber: type: string UOM: type: string UpdatedById: type: string UpdatedDate: format: date-time type: string type: object - $ref: '#/components/schemas/UsageObjectCustomFields' ProxyModifyUsage: allOf: - properties: EndDateTime: format: date-time type: string Quantity: format: double type: number RbeStatus: type: string StartDateTime: format: date-time type: string UOM: type: string type: object - $ref: '#/components/schemas/UsageObjectCustomFields' GETAdjustmentsBySubscriptionNumberResponseType: allOf: - $ref: '#/components/schemas/CommonResponse' - properties: adjustments: items: $ref: '#/components/schemas/GETAdjustmentByIdResponseType' type: array type: object GETAdjustmentByIdResponseType: allOf: - properties: adjustmentId: format: UUID type: string adjustmentNumber: type: string amount: type: number billingDate: format: date type: string chargeNumber: type: string creditMemoNumber: type: string debitMemoNumber: type: string deferredRevenueAccountingCode: type: string deliveryDate: format: date type: string deliveryDay: format: string type: string reason: type: string recognizedRevenueAccountingCode: type: string revenueRecognitionRuleName: type: string status: type: string subscriptionNumber: type: string type: object POSTCreateBillingAdjustmentRequestType: properties: accountNumber: type: string chargeNumbers: items: type: string type: array deferredRevenueAccountingCode: type: string endDate: format: date type: string exclusion: items: properties: chargeNumbers: items: type: string type: array deliveryDate: format: date type: string type: object type: array reason: type: string recognizedRevenueAccountingCode: type: string revenueRecognitionRuleName: type: string startDate: format: date type: string subscriptionNumber: type: string type: enum: - DeliveryCredit type: string creditMemoCustomFields: additionalProperties: type: object title: creditMemoCustomFields type: object required: - startDate - endDate type: object GETAdjustmentsResponseType: allOf: - $ref: '#/components/schemas/CommonResponse' - properties: adjustments: items: $ref: '#/components/schemas/POSTAdjustmentResponseType' type: array ineligibleAdjustments: items: $ref: '#/components/schemas/POSTIneligibleAdjustmentResponseType' type: array totalAmount: type: number totalNumberOfDeliveries: type: number type: object POSTAdjustmentResponseType: allOf: - properties: adjustmentId: format: UUID type: string adjustmentNumber: format: string type: string amount: type: number billingDate: format: date type: string chargeNumber: type: string creditMemoNumber: type: string deferredRevenueAccountingCode: type: string deliveryDate: format: date type: string deliveryDay: type: string eligible: type: boolean reason: type: string recognizedRevenueAccountingCode: type: string revenueRecognitionRuleName: type: string status: type: string subscriptionNumber: type: string type: object POSTIneligibleAdjustmentResponseType: allOf: - properties: adjustmentId: format: UUID type: string adjustmentNumber: format: string type: string amount: type: number billingDate: format: date type: string chargeNumber: type: string deferredRevenueAccountingCode: type: string deliveryDate: format: date type: string deliveryDay: format: string type: string eligible: type: boolean errorMessage: type: string reason: type: string recognizedRevenueAccountingCode: type: string revenueRecognitionRuleName: type: string status: type: string subscriptionNumber: type: string type: object POSTPreviewBillingAdjustmentRequestType: properties: accountNumber: type: string chargeNumbers: items: type: string type: array deferredRevenueAccountingCode: type: string endDate: format: date type: string reason: type: string recognizedRevenueAccountingCode: type: string revenueRecognitionRuleName: type: string startDate: format: date type: string subscriptionNumber: type: string type: enum: - DeliveryCredit type: string required: - startDate - endDate type: object CancelBillingAdjustmentRequest: properties: debitMemoCustomFields: additionalProperties: type: object title: debitMemoCustomFields type: object GETCancelAdjustmentResponseType: allOf: - $ref: '#/components/schemas/CommonResponse' - properties: debitMemoNumber: type: string type: object BillingDocumentQueryResponseElementType: properties: documents: items: $ref: '#/components/schemas/GETBillingDocumentsResponseType' type: array nextPage: format: URL type: string success: type: boolean type: object GETBillingDocumentsResponseType: properties: accountId: format: uuid type: string amount: format: double type: number balance: format: double type: number documentDate: format: date type: string documentNumber: type: string documentType: enum: - Invoice - CreditMemo - DebitMemo type: string id: type: string status: enum: - Draft - Posted - Canceled - Error type: string currency: type: string nullable: true title: documents type: object POSTBillingDocumentFilesDeletionJobRequest: properties: accountIds: items: type: string type: array accountKeys: items: type: string type: array type: object POSTBillingDocumentFilesDeletionJobResponse: properties: id: type: string status: enum: - Pending type: string success: type: boolean type: object GETBillingDocumentFilesDeletionJobResponse: properties: id: type: string status: enum: - Pending - Processing - Completed - Error type: string success: type: boolean type: object PostGenerateBillingDocumentType: properties: autoPost: default: false enum: - true - false type: boolean autoRenew: default: false enum: - true - false type: boolean chargeTypeToExclude: items: type: string type: array creditMemoReasonCode: type: string effectiveDate: format: date type: string includeSubscriptions: default: true type: boolean includeOrderLineItems: default: true type: boolean subscriptionIds: items: type: string type: array targetDate: format: date type: string type: object GenerateBillingDocumentResponseType: properties: creditMemos: items: $ref: '#/components/schemas/CreditMemoResponseType' type: array invoices: items: $ref: '#/components/schemas/InvoiceResponseType' type: array success: type: boolean type: object CreditMemoResponseType: properties: id: type: string title: creditMemos type: object InvoiceResponseType: properties: id: type: string title: invoices type: object PostInvoiceType: allOf: - properties: accountId: type: string accountNumber: type: string autoPay: default: false type: boolean billToContact: $ref: '#/components/schemas/PostCreateInvoiceContactType' billToContactId: type: string comments: type: string currency: type: string customRates: items: $ref: '#/components/schemas/InvoiceWithCustomRatesType' maxItems: 2 type: array dueDate: format: date type: string invoiceDate: format: date type: string invoiceItems: items: $ref: '#/components/schemas/PostInvoiceItemType' type: array invoiceNumber: type: string paymentTerm: type: string sequenceSet: type: string shipToContact: $ref: '#/components/schemas/PostCreateInvoiceContactType' shipToContactId: type: string shipToSameAsBillTo: default: false type: boolean soldToContact: $ref: '#/components/schemas/PostCreateInvoiceContactType' soldToContactId: type: string soldToSameAsBillTo: default: false type: boolean status: default: Draft enum: - Draft - Posted type: string templateId: type: string transferredToAccounting: enum: - Processing - Error - Ignore - 'Yes' - 'No' type: string required: - invoiceDate title: invoices type: object - $ref: '#/components/schemas/InvoiceObjectNSFields' - $ref: '#/components/schemas/InvoiceObjectCustomFields' PostInvoiceResponse: allOf: - properties: accountId: type: string adjustmentAmount: type: number amount: type: number amountWithoutTax: type: number autoPay: type: boolean balance: type: number billRunId: type: string billToContactId: type: string nullable: true billToContactSnapshotId: type: string comments: type: string createdById: type: string createdDate: format: date-time type: string creditBalanceAdjustmentAmount: type: number creditMemoAmount: type: number currency: nullable: true type: string discount: type: number dueDate: format: date type: string einvoiceErrorCode: type: string einvoiceErrorMessage: type: string einvoiceFileId: type: string einvoiceStatus: enum: - Processing - RetrieveTimeOut - Generated - Success - Failed - ConditionalSuccess - ApprovedByAuthority - Rejected type: string id: type: string includesOneTime: type: boolean includesRecurring: type: boolean includesUsage: type: boolean invoiceDate: format: date type: string invoiceGroupNumber: type: string nullable: true invoiceNumber: type: string lastEmailSentDate: type: string organizationLabel: type: string paymentAmount: type: number paymentTerm: type: string nullable: true postedBy: type: string postedDate: format: date type: string refundAmount: type: number sequenceSetId: type: string nullable: true communicationProfileId: type: string nullable: true shipToContactId: type: string nullable: true shipToContactSnapshotId: type: string soldToContactId: type: string nullable: true soldToContactSnapshotId: type: string source: enum: - BillRun - API - ApiSubscribe - ApiAmend type: string sourceId: type: string sourceType: enum: - Subscription - Standalone - Order - Consolidation type: string status: enum: - Draft - Posted type: string success: type: boolean targetDate: format: date type: string taxAmount: type: number taxExemptAmount: type: number taxMessage: type: string nullable: true taxStatus: enum: - Complete - Error - UnknownError - DuplicateDoc - InvalidRequest - InvalidResponse - TaxEngineError - ConcurrentModify - InternalServerError - TaxCodeTemplateError - Voided type: string templateId: type: string nullable: true transferredToAccounting: enum: - Processing - Error - Ignore - 'Yes' - 'No' type: string updatedById: type: string updatedDate: format: date-time type: string type: object - $ref: '#/components/schemas/InvoiceObjectNSFields' - $ref: '#/components/schemas/InvoiceObjectCustomFields' InvoiceObjectNSFields: properties: IntegrationId__NS: maxLength: 255 type: string IntegrationStatus__NS: maxLength: 255 type: string SyncDate__NS: maxLength: 255 type: string title: invoiceFieldsNS type: object InvoiceObjectCustomFields: additionalProperties: {} title: invoiceFieldsCustom type: object PostCreateInvoiceContactType: allOf: - properties: address1: maxLength: 255 type: string address2: type: string city: maxLength: 40 type: string country: type: string county: maxLength: 32 type: string fax: maxLength: 40 type: string firstName: maxLength: 100 type: string homePhone: maxLength: 40 type: string lastName: maxLength: 100 type: string mobilePhone: maxLength: 40 type: string nickname: type: string otherPhone: maxLength: 40 type: string otherPhoneType: type: string personalEmail: maxLength: 80 type: string format: email state: type: string taxRegion: type: string workEmail: maxLength: 80 type: string workPhone: maxLength: 40 type: string zipCode: maxLength: 20 type: string required: - firstName - lastName type: object - $ref: '#/components/schemas/ContactCustomFields' title: Contact InvoiceWithCustomRatesType: allOf: - properties: currency: type: string customFxRate: format: decimal type: number rateDate: format: date type: string required: - currency - customFxRate type: object title: customRates PostInvoiceItemType: allOf: - properties: accountingCode: type: string adjustmentLiabilityAccountingCode: type: string adjustmentRevenueAccountingCode: type: string amount: type: number bookingReference: type: string chargeDate: format: date-time type: string chargeName: type: string contractAssetAccountingCode: type: string contractLiabilityAccountingCode: type: string contractRecognizedRevenueAccountingCode: type: string deferredRevenueAccountingCode: type: string discountItems: items: $ref: '#/components/schemas/PostDiscountItemType' type: array excludeItemBillingFromRevenueAccounting: type: boolean itemType: type: string productRatePlanChargeId: type: string purchaseOrderNumber: type: string quantity: default: 1 type: number recognizedRevenueAccountingCode: type: string revRecCode: type: string revRecTriggerCondition: enum: - ContractEffectiveDate - ServiceActivationDate - CustomerAcceptanceDate type: string revenueRecognitionRuleName: type: string serviceEndDate: format: date type: string serviceStartDate: format: date type: string sku: type: string taxCode: type: string taxItems: items: $ref: '#/components/schemas/PostTaxationItemType' type: array taxMode: enum: - TaxInclusive - TaxExclusive type: string unbilledReceivablesAccountingCode: type: string unitPrice: type: number uom: type: string required: - amount - serviceStartDate title: invoiceItems type: object - $ref: '#/components/schemas/InvoiceItemObjectNSFields' - $ref: '#/components/schemas/InvoiceItemObjectCustomFields' PostDiscountItemType: allOf: - properties: accountingCode: type: string accountsReceivableAccountingCode: type: string adjustmentLiabilityAccountingCode: type: string adjustmentRevenueAccountingCode: type: string amount: type: number bookingReference: type: string chargeDate: format: date-time type: string chargeName: type: string contractAssetAccountingCode: type: string contractLiabilityAccountingCode: type: string contractRecognizedRevenueAccountingCode: type: string deferredRevenueAccountingCode: type: string itemType: type: string productRatePlanChargeId: type: string purchaseOrderNumber: type: string recognizedRevenueAccountingCode: type: string revRecCode: type: string revRecTriggerCondition: enum: - ContractEffectiveDate - ServiceActivationDate - CustomerAcceptanceDate type: string revenueRecognitionRuleName: type: string sku: type: string taxItems: items: $ref: '#/components/schemas/PostTaxationItemType' type: array unbilledReceivablesAccountingCode: type: string unitPrice: type: number required: - amount title: invoiceItems type: object - $ref: '#/components/schemas/DiscountItemObjectNSFields' - $ref: '#/components/schemas/DiscountItemObjectCustomFields' PostTaxationItemType: allOf: - properties: exemptAmount: format: number type: string jurisdiction: type: string locationCode: type: string name: type: string taxAmount: format: number type: string taxCode: type: string taxCodeDescription: type: string taxDate: format: date type: string taxMode: enum: - TaxInclusive - TaxExclusive type: string taxRate: format: number type: string taxRateDescription: type: string taxRateType: enum: - Percentage - FlatFee type: string required: - name - taxAmount - taxDate - taxMode - taxRate - taxRateType title: taxItems type: object - $ref: '#/components/schemas/TaxationItemObjectCustomFields' InvoiceItemObjectNSFields: properties: IntegrationId__NS: maxLength: 255 type: string IntegrationStatus__NS: maxLength: 255 type: string SyncDate__NS: maxLength: 255 type: string title: invoiceItemFieldsNS type: object InvoiceItemObjectCustomFields: additionalProperties: {} title: invoiceItemFieldsCustom type: object TaxationItemObjectCustomFields: additionalProperties: {} title: taxationItemFieldsCustom type: object DiscountItemObjectNSFields: properties: IntegrationId__NS: maxLength: 255 type: string IntegrationStatus__NS: maxLength: 255 type: string SyncDate__NS: maxLength: 255 type: string title: discountItemFieldsNS type: object DiscountItemObjectCustomFields: additionalProperties: {} title: discountItemFieldsCustom type: object ContactCustomFields: additionalProperties: {} type: object PutBatchInvoiceType: properties: invoices: items: $ref: '#/components/schemas/BatchInvoiceType' type: array type: object BatchInvoiceType: allOf: - properties: autoPay: type: boolean comments: maxLength: 255 type: string dueDate: format: date type: string id: type: string invoiceDate: format: date type: string invoiceItems: items: $ref: '#/components/schemas/PutInvoiceItemType' type: array transferredToAccounting: enum: - Processing - 'Yes' - Error - Ignore type: string templateId: type: string type: object - $ref: '#/components/schemas/InvoiceObjectNSFields' - $ref: '#/components/schemas/InvoiceObjectCustomFields' title: invoices PutInvoiceItemType: allOf: - properties: accountingCode: type: string adjustmentLiabilityAccountingCode: type: string adjustmentRevenueAccountingCode: type: string amount: type: number bookingReference: type: string chargeDate: format: date-time type: string chargeName: type: string contractAssetAccountingCode: type: string contractLiabilityAccountingCode: type: string contractRecognizedRevenueAccountingCode: type: string deferredRevenueAccountingCode: type: string delete: type: boolean discountItems: items: $ref: '#/components/schemas/PutDiscountItemType' type: array excludeItemBillingFromRevenueAccounting: default: false type: boolean id: type: string itemType: type: string productRatePlanChargeId: type: string purchaseOrderNumber: type: string quantity: format: number type: string recognizedRevenueAccountingCode: type: string revRecCode: type: string revRecTriggerCondition: enum: - ContractEffectiveDate - ServiceActivationDate - CustomerAcceptanceDate type: string revenueRecognitionRuleName: type: string serviceEndDate: format: date type: string serviceStartDate: format: date type: string sku: type: string taxCode: type: string taxMode: enum: - TaxInclusive - TaxExclusive type: string unbilledReceivablesAccountingCode: type: string unitPrice: format: number type: string uom: type: string type: object - $ref: '#/components/schemas/InvoiceItemObjectNSFields' - $ref: '#/components/schemas/InvoiceItemObjectCustomFields' PutDiscountItemType: allOf: - properties: accountingCode: type: string adjustmentLiabilityAccountingCode: type: string adjustmentRevenueAccountingCode: type: string amount: format: number type: string bookingReference: type: string chargeDate: format: date-time type: string chargeName: type: string contractAssetAccountingCode: type: string contractLiabilityAccountingCode: type: string contractRecognizedRevenueAccountingCode: type: string deferredRevenueAccountingCode: type: string id: type: string itemType: type: string purchaseOrderNumber: type: string recognizedRevenueAccountingCode: type: string revRecCode: type: string revRecTriggerCondition: enum: - ContractEffectiveDate - ServiceActivationDate - CustomerAcceptanceDate type: string revenueRecognitionRuleName: type: string sku: type: string unbilledReceivablesAccountingCode: type: string unitPrice: format: number type: string required: - amount title: invoiceItems type: object - $ref: '#/components/schemas/DiscountItemObjectNSFields' - $ref: '#/components/schemas/DiscountItemObjectCustomFields' PostBatchInvoicesType: properties: invoices: items: $ref: '#/components/schemas/PostInvoiceType' type: array useSingleTransaction: type: boolean type: object PostBatchInvoiceResponse: properties: invoices: items: $ref: '#/components/schemas/PostBatchInvoiceItemResponse' type: array success: type: boolean type: object PostBatchInvoiceItemResponse: allOf: - properties: success: type: boolean type: object - $ref: '#/components/schemas/PostInvoiceResponse' POSTInvoicesBatchPostType: allOf: - properties: invoices: items: $ref: '#/components/schemas/InvoicePostType' title: invoices type: array type: object InvoicesBatchPostResponseType: allOf: - properties: invoices: items: $ref: '#/components/schemas/InvoicePostResponseType' title: invoices type: array success: type: boolean type: object InvoicePostResponseType: allOf: - properties: id: type: string success: type: boolean type: object InvoicePostType: allOf: - properties: id: type: string invoiceDate: format: date type: string type: object - $ref: '#/components/schemas/InvoiceObjectCustomFields' GetInvoicePdfStatusBatchResponse: properties: invoiceFiles: items: $ref: '#/components/schemas/GetInvoicePdfStatusResponse' type: array success: type: boolean type: object title: invoiceFiles GetInvoicePdfStatusResponse: allOf: - properties: invoiceId: type: string invoiceNumber: type: string pdfGenerationStatus: enum: - None - Pending - Processing - Generated - Error - Obsolete - Archived type: string createdOn: type: string updatedOn: type: string pdfFileURL: type: string errorCategory: type: string errorMessage: type: string type: object DeleteInvoiceResponseType: properties: id: type: string jobId: type: string jobStatus: enum: - Pending - Completed type: string reasons: items: properties: code: type: string message: type: string type: object type: array success: type: boolean type: object PutInvoiceType: allOf: - properties: autoPay: type: boolean comments: maxLength: 255 type: string dueDate: format: date type: string invoiceDate: format: date type: string invoiceItems: items: $ref: '#/components/schemas/PutInvoiceItemType' type: array transferredToAccounting: enum: - Processing - 'Yes' - Error - Ignore type: string templateId: type: string type: object - $ref: '#/components/schemas/InvoiceObjectNSFields' - $ref: '#/components/schemas/InvoiceObjectCustomFields' PutInvoiceResponseType: allOf: - properties: accountId: type: string amount: format: BigDecimal type: number autoPay: type: boolean balance: format: BigDecimal type: number cancelledById: type: string nullable: true cancelledOn: format: date-time type: string nullable: true comment: type: string createdById: type: string createdDate: format: date-time type: string creditBalanceAdjustmentAmount: format: BigDecimal type: number currency: type: string discount: format: BigDecimal type: number dueDate: format: date type: string id: type: string invoiceDate: format: date type: string number: type: string postedById: type: string postedOn: format: date-time type: string status: enum: - Draft - Posted - Canceled - Error type: string success: type: boolean targetDate: format: date type: string taxAmount: format: BigDecimal type: number templateId: type: string totalTaxExemptAmount: format: BigDecimal type: number transferredToAccounting: enum: - Processing - 'Yes' - Error - Ignore type: string updatedById: type: string updatedDate: format: date-time type: string type: object - $ref: '#/components/schemas/InvoiceObjectNSFields' - $ref: '#/components/schemas/InvoiceObjectCustomFields' GetInvoiceApplicationPartCollectionType: properties: applicationParts: items: $ref: '#/components/schemas/GetInvoiceApplicationPartType' type: array nextPage: format: URL type: string success: type: boolean type: object GetInvoiceApplicationPartType: properties: appliedAmount: format: double type: number createdById: format: uuid type: string createdDate: format: date-time type: string creditMemoId: format: uuid type: string paymentId: format: uuid type: string updatedById: format: uuid type: string updatedDate: format: date-time type: string title: applicationParts type: object PostInvoiceEmailRequestType: properties: emailAddresses: type: string includeAdditionalEmailAddresses: default: false enum: - true - false type: boolean useEmailTemplateSetting: default: false enum: - true - false type: boolean type: object GETInvoiceFilesResponse: properties: invoiceFiles: items: $ref: '#/components/schemas/InvoiceFile' type: array nextPage: format: URL type: string success: type: boolean type: object InvoiceFile: properties: id: type: string pdfFileUrl: type: string versionNumber: format: int64 type: integer title: invoiceFiles type: object POSTUploadFileResponse: properties: fileId: type: string success: type: boolean type: object GETInvoiceItemsResponse: properties: invoiceItems: items: $ref: '#/components/schemas/InvoiceItem' type: array nextPage: format: URL type: string success: type: boolean type: object InvoiceItem: allOf: - properties: accountingCode: type: string adjustmentLiabilityAccountingCode: type: string adjustmentRevenueAccountingCode: type: string appliedToItemId: type: string availableToCreditAmount: format: decimal type: number balance: format: decimal type: string bookingReference: type: string chargeAmount: format: decimal type: string chargeDate: format: date-time type: string chargeDescription: type: string chargeId: type: string chargeName: type: string chargeType: enum: - OneTime - Recurring - Usage type: string contractAssetAccountingCode: type: string contractLiabilityAccountingCode: type: string contractRecognizedRevenueAccountingCode: type: string deferredRevenueAccountingCode: type: string excludeItemBillingFromRevenueAccounting: type: boolean fulfillmentId: type: string id: type: string invoiceScheduleId: type: string invoiceScheduleItemId: type: string itemType: type: string numberOfDeliveries: type: number orderLineItemId: type: string processingType: enum: - Charge - Discount - Prepayment - Tax - Rounding type: string productName: type: string productRatePlanChargeId: type: string purchaseOrderNumber: type: string quantity: format: decimal type: string reflectDiscountInNetAmount: type: boolean default: false recognizedRevenueAccountingCode: type: string revRecCode: type: string revRecTriggerCondition: enum: - ContractEffectiveDate - ServiceActivationDate - CustomerAcceptanceDate type: string revenueRecognitionRuleName: type: string serviceEndDate: format: date type: string serviceStartDate: format: date type: string sku: type: string shipToContactId: type: string soldToContactId: type: string soldToContactSnapshotId: type: string sourceItemType: enum: - SubscriptionComponent - Rounding - ProductRatePlanCharge - None - OrderLineItem type: string subscriptionId: type: string subscriptionName: type: string taxAmount: format: decimal type: string taxCode: type: string taxMode: type: string taxationItems: properties: data: items: $ref: '#/components/schemas/GETInvoiceTaxItemType' type: array nextPage: format: URL type: string type: object unbilledReceivablesAccountingCode: type: string unitOfMeasure: type: string unitPrice: format: double type: number type: object - $ref: '#/components/schemas/InvoiceItemObjectNSFields' - $ref: '#/components/schemas/InvoiceItemObjectCustomFields' title: invoiceItems GETInvoiceTaxItemType: allOf: - $ref: '#/components/schemas/TaxationItemObjectCustomFields' - properties: availableToCreditAmount: format: decimal type: number applicableTaxUnRounded: type: number country: type: string balance: format: double type: number creditAmount: format: double type: number exemptAmount: format: double type: number id: type: string jurisdiction: type: string locationCode: type: string name: type: string paymentAmount: format: double type: number taxAmount: format: double type: number taxCode: type: string taxCodeDescription: type: string taxDate: format: date type: string taxRate: format: double type: number taxRateDescription: type: string taxRateType: enum: - Percentage - FlatFee type: string title: data type: object title: data GETInvoiceTaxationItemsResponse: properties: data: items: $ref: '#/components/schemas/GETInvoiceTaxItemType' type: array nextPage: format: URL type: string success: type: boolean type: object PutReverseInvoiceType: properties: applyEffectiveDate: format: date type: string comment: maxLength: 255 minLength: 0 type: string memoDate: format: date type: string reasonCode: type: string type: object PutReverseInvoiceResponseType: properties: creditMemo: properties: id: type: string type: object debitMemo: properties: id: type: string type: object id: type: string nullable: true jobId: type: string nullable: true jobStatus: type: string nullable: true enum: - Pending - Processing - Failed - Completed success: type: boolean type: object POSTTaxationItemList: properties: taxationItems: items: $ref: '#/components/schemas/POSTTaxationItemTypeForInvoice' type: array type: object GETTaxationItemListType: properties: success: type: boolean taxationItems: items: $ref: '#/components/schemas/GETTaxationItemTypewithSuccess' type: array type: object GETTaxationItemTypewithSuccess: allOf: - properties: createdById: type: string createdDate: format: date-time type: string exemptAmount: format: double type: number financeInformation: properties: accountsReceivableAccountingCode: type: string accountsReceivableAccountingCodeType: type: string salesTaxPayableAccountingCode: type: string salesTaxPayableAccountingCodeType: type: string type: object id: type: string invoiceItemId: type: string jurisdiction: type: string locationCode: type: string nullable: true name: type: string taxAmount: format: double type: number taxCode: type: string taxCodeDescription: type: string nullable: true taxDate: format: date type: string taxMode: enum: - TaxInclusive - TaxExclusive type: string taxRate: format: double type: number taxRateDescription: type: string nullable: true taxRateType: enum: - Percentage - FlatFee type: string updatedById: type: string updatedDate: format: date-time type: string type: object - $ref: '#/components/schemas/TaxationItemObjectCustomFields' title: taxationItems POSTTaxationItemTypeForInvoice: allOf: - properties: exemptAmount: format: number type: string financeInformation: properties: accountsReceivableAccountingCode: maxLength: 100 minLength: 0 type: string salesTaxPayableAccountingCode: maxLength: 100 minLength: 0 type: string type: object invoiceItemId: type: string jurisdiction: type: string locationCode: type: string name: type: string taxAmount: format: number type: string taxCode: type: string taxCodeDescription: type: string taxDate: format: date type: string taxMode: enum: - TaxInclusive - TaxExclusive type: string taxRate: format: number type: string taxRateDescription: type: string taxRateType: enum: - Percentage - FlatFee type: string required: - invoiceItemId - jurisdiction - name - taxAmount - taxDate - taxRate - taxRateType title: taxItems type: object - $ref: '#/components/schemas/TaxationItemObjectCustomFields' PUTWriteOffInvoiceRequest: allOf: - properties: comment: maxLength: 255 minLength: 0 type: string items: items: $ref: '#/components/schemas/CreditMemoItemFromWriteOffInvoice' type: array memoDate: format: date type: string revenueImpacting: enum: - 'Yes' - 'No' default: 'Yes' type: string amount: type: number taxAutoCalculation: type: boolean nonRevenueWriteOffAccountingCode: type: string reasonCode: type: string type: object - $ref: '#/components/schemas/CreditMemoObjectCustomFields' - $ref: '#/components/schemas/CreditMemoObjectNSFields' type: object PUTWriteOffInvoiceResponse: properties: creditMemo: properties: id: type: string type: object success: type: boolean type: object CreditMemoItemFromWriteOffInvoice: allOf: - properties: comment: type: string financeInformation: properties: deferredRevenueAccountingCode: maxLength: 100 minLength: 0 type: string onAccountAccountingCode: maxLength: 100 minLength: 0 type: string recognizedRevenueAccountingCode: maxLength: 100 minLength: 0 type: string revenueRecognitionRuleName: maxLength: 100 minLength: 0 type: string type: object invoiceItemId: type: string serviceEndDate: format: date type: string amountWithoutTax: type: number serviceStartDate: format: date type: string skuName: type: string unitOfMeasure: type: string taxationItems: items: properties: amount: type: number taxationItemId: type: string type: object type: array type: object - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields' title: items CreditMemoObjectCustomFields: additionalProperties: {} title: creditMemoFieldsCustom type: object CreditMemoObjectNSFields: properties: IntegrationId__NS: maxLength: 255 type: string IntegrationStatus__NS: maxLength: 255 type: string Origin__NS: maxLength: 255 type: string SyncDate__NS: maxLength: 255 type: string Transaction__NS: maxLength: 255 type: string title: creditMemoFieldsNS type: object CreditMemoItemObjectCustomFields: additionalProperties: {} title: creditMemoItemFieldsCustom type: object GETCreditMemoCollectionType: properties: creditmemos: items: $ref: '#/components/schemas/GETCreditMemoTypewithSuccess' type: array nextPage: format: URL type: string success: type: boolean type: object GETCreditMemoTypewithSuccess: allOf: - properties: accountId: type: string accountNumber: type: string amount: format: double type: number appliedAmount: format: double type: number autoApplyUponPosting: type: boolean billToContactId: type: string nullable: true cancelledById: type: string nullable: true cancelledOn: format: date-time type: string nullable: true comment: type: string nullable: true createdById: type: string createdDate: format: date-time type: string creditMemoDate: format: date type: string currency: type: string nullable: true einvoiceErrorCode: type: string nullable: true einvoiceErrorMessage: type: string nullable: true einvoiceFileId: type: string nullable: true einvoiceStatus: enum: - Processing - RetrieveTimeOut - Generated - Success - Failed - ConditionalSuccess - ApprovedByAuthority - Rejected type: string nullable: true excludeFromAutoApplyRules: type: boolean id: type: string invoiceGroupNumber: type: string nullable: true latestPDFFileId: type: string number: type: string organizationLabel: type: string postedById: type: string nullable: true postedOn: format: date-time type: string nullable: true reasonCode: type: string referredInvoiceId: type: string nullable: true refundAmount: format: double type: number revenueImpacting: enum: - 'Yes' - 'No' default: 'Yes' type: string reversed: type: boolean sequenceSetId: type: string nullable: true communicationProfileId: type: string nullable: true source: type: string sourceId: type: string sourceType: enum: - Subscription - Standalone - Invoice - Order - CreditMemo - Consolidation type: string status: enum: - Draft - Posted - Canceled - Error - PendingForTax - Generating - CancelInProgress type: string targetDate: format: date type: string nullable: true taxAmount: format: double type: number taxMessage: type: string nullable: true taxStatus: enum: - Complete - Error - UnknownError - DuplicateDoc - InvalidRequest - InvalidResponse - TaxEngineError - ConcurrentModify - InternalServerError - TaxCodeTemplateError - Voided type: string nullable: true totalTaxExemptAmount: format: double type: number transferredToAccounting: enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string unappliedAmount: format: double type: number updatedById: type: string updatedDate: format: date-time type: string type: object - $ref: '#/components/schemas/CreditMemoObjectNSFields' - $ref: '#/components/schemas/CreditMemoObjectCustomFields' title: creditmemos CreditMemoFromChargeRequest: allOf: - properties: accountId: type: string accountNumber: type: string autoPost: default: false type: boolean charges: items: $ref: '#/components/schemas/CreditMemoFromChargeDetailType' maxItems: 1000 type: array comment: type: string currency: type: string customRates: items: $ref: '#/components/schemas/CreditMemoFromChargeCustomRatesType' maxItems: 2 type: array effectiveDate: format: date type: string excludeFromAutoApplyRules: default: false type: boolean number: type: string maxLength: 32 reasonCode: type: string type: object - $ref: '#/components/schemas/CreditMemoObjectNSFields' - $ref: '#/components/schemas/CreditMemoObjectCustomFields' title: memos GETCreditMemoType: allOf: - properties: accountId: type: string accountNumber: type: string amount: format: double type: number appliedAmount: format: double type: number autoApplyUponPosting: type: boolean billToContactId: type: string nullable: true billToContactSnapshotId: type: string nullable: true cancelledById: type: string nullable: true cancelledOn: format: date-time type: string nullable: true comment: type: string nullable: true createdById: type: string createdDate: format: date-time type: string creditMemoDate: format: date type: string currency: type: string nullable: true einvoiceErrorCode: type: string nullable: true einvoiceErrorMessage: type: string nullable: true einvoiceFileId: type: string nullable: true einvoiceStatus: enum: - Processing - RetrieveTimeOut - Generated - Success - Failed - ConditionalSuccess - ApprovedByAuthority - Rejected type: string nullable: true excludeFromAutoApplyRules: type: boolean excludeItemBillingFromRevenueAccounting: type: boolean id: type: string invoiceGroupNumber: type: string nullable: true latestPDFFileId: type: string nullable: true number: type: string organizationLabel: type: string postedById: type: string postedOn: format: date-time type: string reasonCode: type: string referredInvoiceId: type: string nullable: true refundAmount: format: double type: number revenueImpacting: enum: - 'Yes' - 'No' default: 'Yes' type: string reversed: type: boolean sequenceSetId: type: string nullable: true communicationProfileId: type: string nullable: true source: type: string sourceId: type: string nullable: true sourceType: enum: - Subscription - Standalone - Invoice - Order - CreditMemo - Consolidation type: string status: enum: - Draft - Posted - Canceled - Error - PendingForTax - Generating - CancelInProgress type: string success: type: boolean targetDate: format: date type: string nullable: true taxAmount: format: double type: number taxMessage: type: string nullable: true taxStatus: enum: - Complete - Error - UnknownError - DuplicateDoc - InvalidRequest - InvalidResponse - TaxEngineError - ConcurrentModify - InternalServerError - TaxCodeTemplateError - Voided type: string nullable: true totalTaxExemptAmount: format: double type: number transferredToAccounting: enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string unappliedAmount: format: double type: number updatedById: type: string updatedDate: format: date-time type: string type: object - $ref: '#/components/schemas/CreditMemoObjectNSFields' - $ref: '#/components/schemas/CreditMemoObjectCustomFields' CreditMemoFromChargeDetailType: allOf: - properties: amount: format: double type: number excludeItemBillingFromRevenueAccounting: default: false type: boolean financeInformation: properties: deferredRevenueAccountingCode: maxLength: 100 minLength: 0 type: string onAccountAccountingCode: maxLength: 100 minLength: 0 type: string recognizedRevenueAccountingCode: maxLength: 100 minLength: 0 type: string revenueRecognitionRuleName: maxLength: 100 minLength: 0 type: string type: object productRatePlanChargeId: type: string quantity: format: double type: number serviceEndDate: format: date type: string serviceStartDate: format: date type: string required: - productRatePlanChargeId type: object - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields' title: charges CreditMemoFromChargeCustomRatesType: allOf: - properties: currency: type: string customFxRate: format: decimal type: number rateDate: format: date type: string required: - currency - customFxRate type: object - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields' title: customRates POSTBulkCreditMemosRequestType: discriminator: propertyName: sourceType mapping: Invoice: '#/components/schemas/BulkCreateCreditMemosFromInvoiceRequest' Standalone: '#/components/schemas/BulkCreateCreditMemosFromChargeRequest' oneOf: - $ref: '#/components/schemas/BulkCreateCreditMemosFromInvoiceRequest' - $ref: '#/components/schemas/BulkCreateCreditMemosFromChargeRequest' BulkCreditMemosResponseType: allOf: - properties: memos: items: $ref: '#/components/schemas/GETCreditMemoType' maxItems: 50 title: memos type: array success: type: boolean type: object BulkCreateCreditMemosFromInvoiceRequest: properties: sourceType: type: string enum: - Invoice memos: items: $ref: '#/components/schemas/CreditMemoFromInvoiceRequest' maxItems: 50 type: array required: - sourceType type: object BulkCreateCreditMemosFromChargeRequest: properties: sourceType: type: string enum: - Standalone - Invoice memos: items: $ref: '#/components/schemas/CreditMemoFromChargeRequest' maxItems: 50 type: array required: - sourceType type: object CreditMemoFromInvoiceRequest: allOf: - properties: autoApplyToInvoiceUponPosting: type: boolean autoPost: default: false type: boolean comment: maxLength: 255 minLength: 0 type: string effectiveDate: format: date type: string excludeFromAutoApplyRules: type: boolean invoiceId: type: string items: items: $ref: '#/components/schemas/CreditMemoItemFromInvoiceItemType' maxItems: 1000 type: array reasonCode: type: string taxAutoCalculation: default: true type: boolean type: object required: - invoiceId - $ref: '#/components/schemas/CreditMemoObjectNSFields' - $ref: '#/components/schemas/CreditMemoObjectCustomFields' title: memos CreditMemoItemFromInvoiceItemType: allOf: - properties: amount: format: double type: number financeInformation: properties: deferredRevenueAccountingCode: maxLength: 100 minLength: 0 type: string onAccountAccountingCode: maxLength: 100 minLength: 0 type: string recognizedRevenueAccountingCode: maxLength: 100 minLength: 0 type: string revenueRecognitionRuleName: maxLength: 100 minLength: 0 type: string type: object invoiceItemId: type: string quantity: format: double type: number serviceEndDate: format: date type: string serviceStartDate: format: date type: string skuName: type: string taxItems: items: $ref: '#/components/schemas/CreditMemoTaxItemFromInvoiceTaxItemType' type: array taxMode: default: TaxExclusive enum: - TaxExclusive - TaxInclusive type: string unitOfMeasure: type: string required: - skuName - amount - invoiceItemId type: object - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields' title: items CreditMemoTaxItemFromInvoiceTaxItemType: properties: amount: format: double type: number financeInformation: properties: onAccountAccountingCode: maxLength: 100 minLength: 0 type: string salesTaxPayableAccountingCode: maxLength: 100 minLength: 0 type: string type: object jurisdiction: type: string locationCode: type: string sourceTaxItemId: type: string taxCode: type: string taxCodeDescription: type: string taxDate: format: date type: string taxExemptAmount: format: double type: number taxName: type: string taxRate: format: double type: number taxRateDescription: type: string taxRateType: enum: - Percentage - FlatFee type: string title: taxItems type: object PUTBulkCreditMemosRequestType: allOf: - properties: memos: items: $ref: '#/components/schemas/PUTCreditMemosWithIdType' maxItems: 50 type: array type: object PUTCreditMemosWithIdType: allOf: - properties: id: type: string type: object - $ref: '#/components/schemas/PUTCreditMemoType' title: memos PUTCreditMemoType: allOf: - properties: autoApplyUponPosting: type: boolean comment: maxLength: 255 minLength: 0 type: string effectiveDate: format: date type: string excludeFromAutoApplyRules: type: boolean items: items: $ref: '#/components/schemas/PUTCreditMemoItemType' type: array reasonCode: type: string transferredToAccounting: enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string type: object - $ref: '#/components/schemas/CreditMemoObjectNSFields' - $ref: '#/components/schemas/CreditMemoObjectCustomFields' PUTCreditMemoItemType: allOf: - properties: amount: format: double type: number comment: type: string delete: type: boolean excludeItemBillingFromRevenueAccounting: default: false type: boolean financeInformation: properties: deferredRevenueAccountingCode: maxLength: 100 minLength: 0 type: string onAccountAccountingCode: maxLength: 100 minLength: 0 type: string recognizedRevenueAccountingCode: maxLength: 100 minLength: 0 type: string revenueRecognitionRuleName: maxLength: 100 minLength: 0 type: string type: object id: maxLength: 32 minLength: 32 type: string quantity: format: double type: number productRatePlanChargeId: type: string serviceEndDate: format: date type: string serviceStartDate: format: date type: string skuName: type: string taxItems: items: $ref: '#/components/schemas/PutCreditMemoTaxItemType' type: array unitOfMeasure: type: string type: object - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields' title: items PutCreditMemoTaxItemType: allOf: - properties: amount: format: double type: number financeInformation: properties: onAccountAccountingCode: maxLength: 100 minLength: 0 type: string salesTaxPayableAccountingCode: maxLength: 100 minLength: 0 type: string type: object id: type: string jurisdiction: type: string locationCode: type: string taxCode: type: string taxCodeDescription: type: string taxDate: format: date type: string taxExemptAmount: format: double type: number taxName: type: string taxRate: format: double type: number taxRateDescription: type: string taxRateType: enum: - Percentage - FlatFee type: string required: - id type: object - $ref: '#/components/schemas/CreditTaxationItemObjectCustomFields' title: taxItems CreditTaxationItemObjectCustomFields: additionalProperties: {} title: creditTaxationItemFieldsCustom type: object GetCreditMemoPdfStatusBatchResponse: properties: creditMemoFiles: items: $ref: '#/components/schemas/GetCreditMemoPdfStatusResponse' type: array success: type: boolean type: object title: creditMemoFiles GetCreditMemoPdfStatusResponse: allOf: - properties: creditMemoId: type: string creditMemoNumber: type: string pdfGenerationStatus: type: string enum: - None - Pending - Processing - Generated - Error - Obsolete createdOn: type: string updatedOn: type: string pdfFileURL: type: string errorCategory: type: string errorMessage: type: string type: object GETTaxationItemsOfCreditMemoItemType: allOf: - properties: data: items: $ref: '#/components/schemas/GETCMTaxItemTypeNew' type: array nextPage: format: URL type: string success: type: boolean type: object GETCMTaxItemTypeNew: allOf: - properties: appliedAmount: format: double type: number exemptAmount: format: double type: number financeInformation: properties: onAccountAccountingCode: type: string nullable: true onAccountAccountingCodeType: type: string nullable: true salesTaxPayableAccountingCode: type: string nullable: true salesTaxPayableAccountingCodeType: type: string nullable: true type: object id: type: string jurisdiction: type: string locationCode: type: string name: type: string refundAmount: format: double type: number sourceTaxItemId: type: string nullable: true taxAmount: format: double type: number taxCode: type: string taxCodeDescription: type: string taxDate: format: date type: string taxRate: format: double type: number taxRateDescription: type: string taxRateType: enum: - Percentage - FlatFee type: string unappliedAmount: format: double type: number type: object - $ref: '#/components/schemas/CreditTaxationItemObjectCustomFields' title: data PUTCreditMemoWriteOff: allOf: - properties: comment: type: string memoDate: format: date type: string reasonCode: type: string type: object - $ref: '#/components/schemas/DebitMemoObjectCustomFieldsCMWriteOff' PUTCreditMemoWriteOffResponseType: properties: debitMemo: properties: id: type: string type: object success: type: boolean type: object DebitMemoObjectCustomFieldsCMWriteOff: additionalProperties: {} title: debitMemoFieldsCustom type: object ApplyCreditMemoType: properties: debitMemos: items: $ref: '#/components/schemas/CreditMemoApplyDebitMemoRequestType' type: array effectiveDate: format: date type: string invoices: items: $ref: '#/components/schemas/CreditMemoApplyInvoiceRequestType' type: array type: object CreditMemoApplyDebitMemoRequestType: properties: amount: format: double type: number debitMemoId: type: string items: items: $ref: '#/components/schemas/CreditMemoApplyDebitMemoItemRequestType' type: array required: - amount - debitMemoId title: debitMemos type: object CreditMemoApplyInvoiceRequestType: properties: amount: format: double type: number invoiceId: type: string items: items: $ref: '#/components/schemas/CreditMemoApplyInvoiceItemRequestType' type: array required: - amount - invoiceId title: invoices type: object CreditMemoApplyInvoiceItemRequestType: properties: amount: format: double type: number creditMemoItemId: type: string creditTaxItemId: type: string invoiceItemId: type: string taxItemId: type: string required: - amount title: items type: object CreditMemoApplyDebitMemoItemRequestType: properties: amount: format: double type: number creditMemoItemId: type: string creditTaxItemId: type: string debitMemoItemId: type: string taxItemId: type: string required: - amount title: items type: object PostCreditMemoEmailRequestType: properties: emailAddresses: type: string includeAdditionalEmailAddresses: default: false enum: - true - false type: boolean pdfFileId: type: string useEmailTemplateSetting: default: false enum: - true - false type: boolean type: object GETCreditMemoFilesResponse: properties: creditMemoFiles: items: $ref: '#/components/schemas/CreditMemoFile' type: array nextPage: format: URL type: string success: type: boolean type: object CreditMemoFile: properties: id: type: string pdfFileUrl: type: string versionNumber: format: int64 type: integer title: creditMemoFile type: object GETCreditMemoItemsListType: properties: items: items: $ref: '#/components/schemas/GETCreditMemoItemTypewithSuccess' type: array nextPage: format: URL type: string success: type: boolean type: object GETCreditMemoItemTypewithSuccess: allOf: - properties: amount: format: double type: number amountWithoutTax: format: double type: number appliedAmount: format: double type: number appliedToItemId: type: string createdById: type: string createdDate: format: date-time type: string creditFromItemId: type: string creditFromItemSource: enum: - InvoiceItem - CreditMemoItem type: string excludeItemBillingFromRevenueAccounting: type: boolean financeInformation: properties: deferredRevenueAccountingCode: type: string deferredRevenueAccountingCodeType: type: string nonRevenueWriteOffAccountingCode: type: string nonRevenueWriteOffAccountingCodeType: type: string onAccountAccountingCode: type: string onAccountAccountingCodeType: type: string recognizedRevenueAccountingCode: type: string recognizedRevenueAccountingCodeType: type: string revenueRecognitionRuleName: type: string revenueScheduleNumber: type: string type: object id: type: string invoiceScheduleId: type: string invoiceScheduleItemId: type: string numberOfDeliveries: type: number processingType: type: string quantity: format: double type: number reflectDiscountInNetAmount: type: boolean default: false refundAmount: format: double type: number revenueImpacting: enum: - 'Yes' - 'No' default: 'Yes' type: string serviceEndDate: format: date type: string serviceStartDate: format: date type: string sku: type: string skuName: type: string shipToContactId: type: string soldToContactId: type: string soldToContactSnapshotId: type: string sourceItemId: type: string sourceItemType: enum: - SubscriptionComponent - InvoiceDetail - ProductRatePlanCharge - OrderLineItem type: string subscriptionId: type: string taxMode: enum: - TaxExclusive - TaxInclusive type: string taxationItems: properties: data: items: $ref: '#/components/schemas/GETCMTaxItemTypeNew' type: array nextPage: format: URL type: string type: object unappliedAmount: format: double type: number unitOfMeasure: type: string unitPrice: format: double type: number updatedById: type: string updatedDate: format: date-time type: string type: object - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields' title: items GETCreditMemoItemType: allOf: - properties: amount: format: double type: number amountWithoutTax: format: double type: number appliedAmount: format: double type: number appliedToItemId: type: string nullable: true createdById: type: string createdDate: format: date-time type: string creditFromItemId: type: string creditFromItemSource: enum: - InvoiceItem - CreditMemoItem type: string excludeItemBillingFromRevenueAccounting: type: boolean financeInformation: properties: deferredRevenueAccountingCode: type: string nullable: true deferredRevenueAccountingCodeType: type: string nullable: true nonRevenueWriteOffAccountingCode: type: string nullable: true nonRevenueWriteOffAccountingCodeType: type: string nullable: true onAccountAccountingCode: type: string nullable: true onAccountAccountingCodeType: type: string nullable: true recognizedRevenueAccountingCode: type: string nullable: true recognizedRevenueAccountingCodeType: type: string nullable: true revenueRecognitionRuleName: type: string revenueScheduleNumber: type: string type: object id: type: string invoiceScheduleId: type: string invoiceScheduleItemId: type: string numberOfDeliveries: type: number organizationLabel: type: string processingType: type: string quantity: format: double type: number refundAmount: format: double type: number reflectDiscountInNetAmount: type: boolean default: false revenueImpacting: enum: - 'Yes' - 'No' default: 'Yes' type: string serviceEndDate: format: date type: string serviceStartDate: format: date type: string sku: type: string skuName: type: string shipToContactId: type: string soldToContactId: type: string soldToContactSnapshotId: type: string sourceItemId: type: string sourceItemType: enum: - SubscriptionComponent - InvoiceDetail - ProductRatePlanCharge - OrderLineItem type: string subscriptionId: type: string success: type: boolean taxMode: enum: - TaxExclusive - TaxInclusive type: string taxationItems: properties: data: items: $ref: '#/components/schemas/GETCMTaxItemTypeNew' type: array nextPage: format: URL type: string type: object unappliedAmount: format: double type: number unitOfMeasure: type: string unitPrice: format: double type: number updatedById: type: string updatedDate: format: date-time type: string type: object - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields' GETCreditMemoPartsCollectionType: properties: nextPage: format: URL type: string parts: items: $ref: '#/components/schemas/GETCreditMemoPartTypewithSuccess' type: array success: type: boolean type: object GETCreditMemoPartTypewithSuccess: properties: amount: format: double type: number createdById: type: string createdDate: format: date-time type: string debitMemoId: type: string id: type: string invoiceId: type: string updatedById: type: string updatedDate: format: date-time type: string title: parts type: object GETCreditMemoPartType: properties: amount: format: double type: number createdById: type: string createdDate: format: date-time type: string debitMemoId: type: string id: type: string invoiceId: type: string organizationLabel: type: string success: type: boolean updatedById: type: string updatedDate: format: date-time type: string type: object POSTMemoPdfResponse: properties: success: type: boolean type: object PostNonRefRefundType: allOf: - properties: comment: maxLength: 255 minLength: 0 type: string customRates: items: $ref: '#/components/schemas/CreditMemoFromChargeCustomRatesType' maxItems: 2 type: array financeInformation: properties: bankAccountAccountingCode: maxLength: 100 minLength: 0 type: string onAccountAccountingCode: maxLength: 100 minLength: 0 type: string transferredToAccounting: enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string unappliedPaymentAccountingCode: maxLength: 100 minLength: 0 type: string type: object gatewayId: type: string gatewayOptions: properties: key: type: string value: type: string type: object items: items: $ref: '#/components/schemas/RefundCreditMemoItemType' type: array methodType: enum: - ACH - Cash - Check - CreditCard - PayPal - WireTransfer - DebitCard - CreditCardReferenceTransaction - BankTransfer - Other type: string paymentMethodId: type: string reasonCode: type: string referenceId: maxLength: 100 minLength: 0 type: string refundDate: format: date type: string secondRefundReferenceId: maxLength: 100 minLength: 0 type: string softDescriptor: maxLength: 35 type: string softDescriptorPhone: maxLength: 20 type: string totalAmount: format: double type: number type: enum: - External - Electronic type: string required: - totalAmount - type type: object - $ref: '#/components/schemas/RefundObjectNSFields' - $ref: '#/components/schemas/RefundObjectCustomFields' GETRefundCreditMemoType: allOf: - properties: accountId: type: string amount: format: double type: number cancelledOn: format: date-time type: string nullable: true comment: type: string nullable: true createdById: type: string createdDate: format: date-time type: string creditMemoId: type: string financeInformation: properties: bankAccountAccountingCode: type: string nullable: true bankAccountAccountingCodeType: type: string nullable: true transferredToAccounting: enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string nullable: true unappliedPaymentAccountingCode: type: string nullable: true unappliedPaymentAccountingCodeType: type: string nullable: true type: object gatewayId: type: string gatewayResponse: type: string gatewayResponseCode: type: string gatewayState: enum: - MarkedForSubmission - Submitted - Settled - NotSubmitted - FailedToSettle type: string id: type: string markedForSubmissionOn: format: date-time type: string nullable: true methodType: enum: - ACH - Cash - Check - CreditCard - PayPal - WireTransfer - DebitCard - CreditCardReferenceTransaction - BankTransfer - Other type: string number: type: string organizationLabel: type: string paymentId: type: string nullable: true paymentMethodId: type: string paymentMethodSnapshotId: type: string reasonCode: type: string nullable: true referenceId: type: string refundDate: format: date type: string refundTransactionTime: format: date-time type: string secondRefundReferenceId: type: string nullable: true settledOn: format: date-time type: string nullable: true softDescriptor: type: string nullable: true softDescriptorPhone: type: string nullable: true status: enum: - Processed - Canceled - Error - Processing type: string submittedOn: format: date-time type: string success: type: boolean type: enum: - External - Electronic type: string updatedById: type: string updatedDate: format: date-time type: string type: object - $ref: '#/components/schemas/RefundObjectNSFields' - $ref: '#/components/schemas/RefundObjectCustomFields' RefundObjectNSFields: properties: IntegrationId__NS: maxLength: 255 type: string IntegrationStatus__NS: maxLength: 255 type: string Origin__NS: maxLength: 255 type: string SyncDate__NS: maxLength: 255 type: string SynctoNetSuite__NS: maxLength: 255 type: string title: refundFieldsNS type: object RefundObjectCustomFields: additionalProperties: {} title: refundFieldsCustom type: object RefundCreditMemoItemType: properties: amount: format: double type: number creditMemoItemId: type: string creditTaxItemId: type: string required: - amount title: items type: object PutReverseCreditMemoType: properties: applyEffectiveDate: format: date type: string comment: maxLength: 255 minLength: 0 type: string memoDate: format: date type: string reasonCode: type: string type: object PutReverseCreditMemoResponseType: properties: creditMemo: properties: id: type: string type: object debitMemo: properties: id: type: string type: object success: type: boolean type: object POSTTaxationItemListForCMType: properties: taxationItems: items: $ref: '#/components/schemas/POSTTaxationItemForCMType' type: array type: object POSTTaxationItemForCMType: allOf: - properties: exemptAmount: format: double type: number financeInformation: properties: onAccountAccountingCode: maxLength: 100 minLength: 0 type: string salesTaxPayableAccountingCode: maxLength: 100 minLength: 0 type: string type: object jurisdiction: type: string locationCode: type: string memoItemId: type: string name: type: string sourceTaxItemId: type: string taxAmount: format: double type: number taxCode: type: string taxCodeDescription: type: string taxDate: format: date type: string taxRate: format: double type: number taxRateDescription: type: string taxRateType: enum: - Percentage - FlatFee type: string required: - taxRate - jurisdiction - name - taxRateType - taxAmount type: object - $ref: '#/components/schemas/TaxationItemObjectCustomFields' title: taxationItems UnapplyCreditMemoType: properties: debitMemos: items: $ref: '#/components/schemas/CreditMemoUnapplyDebitMemoRequestType' type: array effectiveDate: format: date type: string invoices: items: $ref: '#/components/schemas/CreditMemoUnapplyInvoiceRequestType' type: array type: object CreditMemoUnapplyDebitMemoRequestType: properties: amount: format: double type: number debitMemoId: type: string items: items: $ref: '#/components/schemas/CreditMemoUnapplyDebitMemoItemRequestType' type: array required: - amount - debitMemoId title: debitMemos type: object CreditMemoUnapplyInvoiceRequestType: properties: amount: format: double type: number invoiceId: type: string items: items: $ref: '#/components/schemas/CreditMemoUnapplyInvoiceItemRequestType' type: array required: - amount - invoiceId title: invoices type: object CreditMemoUnapplyInvoiceItemRequestType: properties: amount: format: double type: number creditMemoItemId: type: string creditTaxItemId: type: string invoiceItemId: type: string taxItemId: type: string required: - amount title: items type: object CreditMemoUnapplyDebitMemoItemRequestType: properties: amount: format: double type: number creditMemoItemId: type: string creditTaxItemId: type: string debitMemoItemId: type: string taxItemId: type: string required: - amount title: items type: object InvoiceSettlementAsyncJobResponse: allOf: - $ref: '#/components/schemas/CommonResponse' - properties: id: type: string status: $ref: '#/components/schemas/InvoiceSettlementAsyncJobStatus' operationType: $ref: '#/components/schemas/InvoiceSettlementAsyncJobOperationType' referenceId: type: string referenceType: $ref: '#/components/schemas/InvoiceSettlementAsyncJobReferenceType' error: type: string type: object InvoiceSettlementAsyncJobStatus: enum: - Pending - Processing - Processed - Error type: string InvoiceSettlementAsyncJobOperationType: enum: - AsyncCreditMemoApply - AsyncCreditMemoUnapply type: string InvoiceSettlementAsyncJobReferenceType: enum: - CreditMemo type: string AsyncApplyCreditMemoRequest: properties: effectiveDate: format: date type: string invoices: items: $ref: '#/components/schemas/AsyncApplyCreditMemoToInvoice' type: array type: object AsyncApplyCreditMemoToInvoice: properties: amount: type: number invoiceId: type: string required: - amount - invoiceId title: AppliedInvoice type: object AsyncUnapplyCreditMemoRequest: properties: effectiveDate: format: date type: string invoices: items: $ref: '#/components/schemas/AsyncUnapplyCreditMemoToInvoice' type: array type: object AsyncUnapplyCreditMemoToInvoice: properties: amount: type: number invoiceId: type: string required: - amount - invoiceId title: UnappliedInvoice GETDebitMemoCollectionType: properties: debitmemos: items: $ref: '#/components/schemas/GETDebitMemoTypewithSuccess' type: array nextPage: format: URL type: string success: type: boolean type: object GETDebitMemoTypewithSuccess: allOf: - properties: accountId: type: string accountNumber: type: string amount: format: double type: number autoPay: type: boolean balance: format: double type: number beAppliedAmount: format: double type: number billToContactId: type: string cancelledById: type: string nullable: true cancelledOn: format: date-time type: string nullable: true comment: type: string nullable: true createdById: type: string createdDate: format: date-time type: string currency: type: string nullable: true debitMemoDate: format: date type: string dueDate: format: date type: string einvoiceErrorCode: type: string nullable: true einvoiceErrorMessage: type: string nullable: true einvoiceFileId: type: string nullable: true einvoiceStatus: enum: - Processing - RetrieveTimeOut - Generated - Success - Failed - ConditionalSuccess - ApprovedByAuthority - Rejected type: string nullable: true id: type: string invoiceGroupNumber: type: string nullable: true latestPDFFileId: type: string number: type: string paymentTerm: type: string nullable: true postedById: type: string nullable: true postedOn: format: date-time type: string nullable: true reasonCode: type: string referredCreditMemoId: type: string nullable: true referredInvoiceId: type: string nullable: true sequenceSetId: type: string nullable: true communicationProfileId: type: string nullable: true sourceType: enum: - Subscription - Standalone - Order - Consolidation - Invoice - CreditMemo type: string status: enum: - Draft - Posted - Canceled - Error - PendingForTax - Generating - CancelInProgress type: string targetDate: format: date type: string nullable: true taxAmount: format: double type: number taxMessage: type: string nullable: true taxStatus: enum: - Complete - Error - UnknownError - DuplicateDoc - InvalidRequest - InvalidResponse - TaxEngineError - ConcurrentModify - InternalServerError - TaxCodeTemplateError - Voided type: string nullable: true totalTaxExemptAmount: format: double type: number transferredToAccounting: enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string updatedById: type: string updatedDate: format: date-time type: string type: object - $ref: '#/components/schemas/DebitMemoObjectNSFields' - $ref: '#/components/schemas/DebitMemoObjectCustomFields' title: debitmemos DebitMemoObjectNSFields: properties: IntegrationId__NS: maxLength: 255 type: string IntegrationStatus__NS: maxLength: 255 type: string SyncDate__NS: maxLength: 255 type: string title: debitMemoFieldsNS type: object DebitMemoObjectCustomFields: additionalProperties: {} title: debitMemoFieldsCustom type: object DebitMemoFromChargeRequest: allOf: - properties: accountId: type: string accountNumber: type: string autoPay: type: boolean autoPost: default: false type: boolean charges: items: $ref: '#/components/schemas/DebitMemoFromChargeDetailType' maxItems: 1000 type: array comment: maxLength: 255 minLength: 0 type: string currency: type: string customRates: items: $ref: '#/components/schemas/DebitMemoFromChargeCustomRatesType' maxItems: 2 type: array dueDate: format: date type: string effectiveDate: format: date type: string number: type: string maxLength: 32 reasonCode: type: string type: object - $ref: '#/components/schemas/DebitMemoObjectNSFields' - $ref: '#/components/schemas/DebitMemoObjectCustomFields' title: memos GETDebitMemoType: allOf: - properties: accountId: type: string accountNumber: type: string amount: format: double type: number autoPay: type: boolean balance: format: double type: number beAppliedAmount: format: double type: number billToContactId: type: string billToContactSnapshotId: type: string cancelledById: type: string nullable: true cancelledOn: format: date-time type: string nullable: true currency: type: string nullable: true comment: type: string nullable: true createdById: type: string createdDate: format: date-time type: string debitMemoDate: format: date type: string dueDate: format: date type: string einvoiceErrorCode: type: string nullable: true einvoiceErrorMessage: type: string nullable: true einvoiceFileId: type: string nullable: true einvoiceStatus: enum: - Processing - RetrieveTimeOut - Generated - Success - Failed - ConditionalSuccess - ApprovedByAuthority - Rejected type: string nullable: true excludeItemBillingFromRevenueAccounting: type: boolean id: type: string invoiceGroupNumber: type: string nullable: true latestPDFFileId: type: string number: type: string organizationLabel: type: string paymentTerm: type: string postedById: type: string nullable: true postedOn: format: date-time type: string nullable: true reasonCode: type: string referredCreditMemoId: type: string referredInvoiceId: type: string nullable: true sequenceSetId: type: string nullable: true communicationProfileId: type: string nullable: true soldToContactId: type: string nullable: true soldToContactSnapshotId: type: string nullable: true sourceType: enum: - Subscription - Standalone - Order - Consolidation - Invoice - CreditMemo type: string status: enum: - Draft - Posted - Canceled - Error - PendingForTax - Generating - CancelInProgress type: string success: type: boolean targetDate: format: date type: string nullable: true taxAmount: format: double type: number taxMessage: type: string nullable: true taxStatus: enum: - Complete - Error - UnknownError - DuplicateDoc - InvalidRequest - InvalidResponse - TaxEngineError - ConcurrentModify - InternalServerError - TaxCodeTemplateError - Voided type: string nullable: true totalTaxExemptAmount: format: double type: number transferredToAccounting: enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string updatedById: type: string updatedDate: format: date-time type: string type: object - $ref: '#/components/schemas/DebitMemoObjectNSFields' - $ref: '#/components/schemas/DebitMemoObjectCustomFields' title: memos DebitMemoFromChargeDetailType: allOf: - properties: amount: format: double type: number excludeItemBillingFromRevenueAccounting: default: false type: boolean financeInformation: properties: deferredRevenueAccountingCode: maxLength: 100 minLength: 0 type: string nullable: true recognizedRevenueAccountingCode: maxLength: 100 minLength: 0 type: string nullable: true revenueRecognitionRuleName: maxLength: 100 minLength: 0 type: string nullable: true type: object productRatePlanChargeId: type: string quantity: format: double type: number serviceEndDate: format: date type: string serviceStartDate: format: date type: string required: - productRatePlanChargeId type: object - $ref: '#/components/schemas/DebitMemoItemObjectCustomFields' title: charges DebitMemoFromChargeCustomRatesType: allOf: - properties: currency: type: string customFxRate: format: decimal type: number rateDate: format: date type: string required: - currency - customFxRate type: object - $ref: '#/components/schemas/DebitMemoItemObjectCustomFields' title: customRates DebitMemoItemObjectCustomFields: additionalProperties: {} title: debitMemoItemFieldsCustom type: object PUTBatchDebitMemosRequest: properties: debitMemos: items: $ref: '#/components/schemas/BatchDebitMemoType' type: array type: object BatchDebitMemoType: properties: dueDate: format: date type: string id: type: string title: debitMemos type: object POSTBulkDebitMemosRequestType: discriminator: propertyName: sourceType mapping: Invoice: '#/components/schemas/BulkCreateDebitMemosFromInvoiceRequest' Standalone: '#/components/schemas/BulkCreateDebitMemosFromChargeRequest' oneOf: - $ref: '#/components/schemas/BulkCreateDebitMemosFromInvoiceRequest' - $ref: '#/components/schemas/BulkCreateDebitMemosFromChargeRequest' BulkDebitMemosResponseType: allOf: - properties: memos: items: $ref: '#/components/schemas/GETDebitMemoType' maxItems: 50 type: array success: type: boolean type: object BulkCreateDebitMemosFromInvoiceRequest: properties: sourceType: type: string enum: - Invoice memos: items: $ref: '#/components/schemas/DebitMemoFromInvoiceRequest' maxItems: 50 type: array required: - sourceType type: object BulkCreateDebitMemosFromChargeRequest: properties: sourceType: type: string enum: - Standalone memos: items: $ref: '#/components/schemas/DebitMemoFromChargeRequest' maxItems: 50 type: array required: - sourceType type: object DebitMemoFromInvoiceRequest: allOf: - properties: autoPay: type: boolean autoPost: default: false type: boolean billToContactId: type: string comment: maxLength: 255 minLength: 0 type: string effectiveDate: format: date type: string invoiceId: type: string items: items: $ref: '#/components/schemas/DebitMemoItemFromInvoiceItemType' maxItems: 1000 type: array reasonCode: type: string soldToContactId: type: string soldToSameAsBillTo: type: boolean taxAutoCalculation: default: true type: boolean type: object required: - invoiceId - $ref: '#/components/schemas/DebitMemoObjectNSFields' - $ref: '#/components/schemas/DebitMemoObjectCustomFields' title: memos DebitMemoItemFromInvoiceItemType: allOf: - properties: amount: format: double type: number financeInformation: properties: deferredRevenueAccountingCode: maxLength: 100 minLength: 0 type: string recognizedRevenueAccountingCode: maxLength: 100 minLength: 0 type: string revenueRecognitionRuleName: maxLength: 100 minLength: 0 type: string type: object invoiceItemId: type: string quantity: format: double type: number serviceEndDate: format: date type: string serviceStartDate: format: date type: string skuName: type: string taxItems: items: $ref: '#/components/schemas/DebitMemoTaxItemFromInvoiceTaxItemType' type: array taxMode: default: TaxExclusive enum: - TaxExclusive - TaxInclusive type: string unitOfMeasure: type: string required: - skuName - amount type: object - $ref: '#/components/schemas/DebitMemoItemObjectCustomFields' title: items DebitMemoTaxItemFromInvoiceTaxItemType: properties: amount: format: double type: number financeInformation: properties: salesTaxPayableAccountingCode: maxLength: 100 minLength: 0 type: string type: object jurisdiction: type: string locationCode: type: string sourceTaxItemId: type: string taxCode: type: string taxCodeDescription: type: string taxDate: format: date type: string taxExemptAmount: format: double type: number taxName: type: string taxRate: format: double type: number taxRateDescription: type: string taxRateType: enum: - Percentage - FlatFee type: string required: - amount title: taxItems type: object PUTBulkDebitMemosRequestType: allOf: - properties: memos: items: $ref: '#/components/schemas/PUTDebitMemoWithIdType' maxItems: 50 title: memos type: array type: object PUTDebitMemoWithIdType: allOf: - properties: id: type: string type: object - $ref: '#/components/schemas/PUTDebitMemoType' PUTDebitMemoType: allOf: - properties: autoPay: type: boolean comment: maxLength: 255 minLength: 0 type: string dueDate: format: date type: string effectiveDate: format: date type: string items: items: $ref: '#/components/schemas/PUTDebitMemoItemType' type: array reasonCode: type: string transferredToAccounting: enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string type: object - $ref: '#/components/schemas/DebitMemoObjectNSFields' - $ref: '#/components/schemas/DebitMemoObjectCustomFields' PUTDebitMemoItemType: allOf: - properties: amount: format: double type: number comment: type: string delete: type: boolean excludeItemBillingFromRevenueAccounting: default: false type: boolean financeInformation: properties: deferredRevenueAccountingCode: maxLength: 100 minLength: 0 type: string recognizedRevenueAccountingCode: maxLength: 100 minLength: 0 type: string revenueRecognitionRuleName: maxLength: 100 minLength: 0 type: string type: object id: maxLength: 32 minLength: 32 type: string productRatePlanChargeId: type: string quantity: format: double type: number serviceEndDate: format: date type: string serviceStartDate: format: date type: string skuName: type: string taxItems: items: $ref: '#/components/schemas/PutDebitMemoTaxItemType' type: array unitOfMeasure: type: string type: object - $ref: '#/components/schemas/DebitMemoItemObjectCustomFields' title: items PutDebitMemoTaxItemType: allOf: - properties: amount: format: double type: number financeInformation: properties: salesTaxPayableAccountingCode: maxLength: 100 minLength: 0 type: string type: object id: type: string jurisdiction: type: string locationCode: type: string taxCode: type: string taxCodeDescription: type: string taxDate: format: date type: string taxExemptAmount: format: double type: number taxName: type: string taxRate: format: double type: number taxRateDescription: type: string taxRateType: enum: - Percentage - FlatFee type: string required: - id type: object - $ref: '#/components/schemas/DebitTaxationItemObjectCustomFields' title: taxItems DebitTaxationItemObjectCustomFields: additionalProperties: {} title: debitTaxationItemFieldsCustom type: object GetDebitMemoPdfStatusBatchResponse: properties: debitMemoFiles: items: $ref: '#/components/schemas/GetDebitMemoPdfStatusResponse' type: array success: type: boolean type: object title: debitMemoFiles GetDebitMemoPdfStatusResponse: allOf: - properties: debitMemoId: type: string debitMemoNumber: type: string pdfGenerationStatus: type: string enum: - None - Pending - Processing - Generated - Error - Obsolete createdOn: type: string updatedOn: type: string pdfFileURL: type: string errorCategory: type: string errorMessage: type: string type: object GetDebitMemoApplicationPartCollectionType: properties: applicationParts: items: $ref: '#/components/schemas/GetDebitMemoApplicationPartType' type: array nextPage: format: URL type: string success: type: boolean type: object GetDebitMemoApplicationPartType: properties: appliedAmount: format: double type: number createdById: format: uuid type: string createdDate: format: date-time type: string creditMemoId: format: uuid type: string paymentId: format: uuid type: string updatedById: format: uuid type: string updatedDate: format: date-time type: string title: applicationParts type: object GETTaxationItemsOfDebitMemoItemType: allOf: - properties: data: items: $ref: '#/components/schemas/GETDMTaxItemTypeNew' type: array nextPage: format: URL type: string success: type: boolean type: object GETDMTaxItemTypeNew: allOf: - properties: balance: format: double type: number creditAmount: format: double type: number exemptAmount: format: double type: number financeInformation: properties: salesTaxPayableAccountingCode: type: string salesTaxPayableAccountingCodeType: type: string type: object id: type: string jurisdiction: type: string locationCode: type: string name: type: string paymentAmount: format: double type: number sourceTaxItemId: type: string taxAmount: format: double type: number taxCode: type: string taxCodeDescription: type: string taxDate: format: date type: string taxRate: format: double type: number taxRateDescription: type: string taxRateType: enum: - Percentage - FlatFee type: string type: object - $ref: '#/components/schemas/DebitTaxationItemObjectCustomFields' title: data DebitMemoCollectRequest: properties: applicationOrder: items: type: string type: array applyCredit: default: false type: boolean collect: default: false type: boolean payment: properties: gatewayId: type: string paymentMethodId: type: string type: object type: object DebitMemoCollectResponse: allOf: - properties: appliedCreditMemos: items: $ref: '#/components/schemas/DebitMemoCollectResponseAppliedCreditMemos' type: array appliedPayments: items: $ref: '#/components/schemas/DebitMemoCollectResponseAppliedPayments' type: array debitMemo: properties: id: type: string number: type: string type: object organizationLabel: type: string processedPayment: properties: amount: format: double type: number gatewayId: type: string gatewayResponse: type: string gatewayResponseCode: type: string id: type: string number: type: string paymentMethodId: type: string status: enum: - Processing - Processed - Error - Canceled type: string type: object success: type: boolean type: object DebitMemoCollectResponseAppliedCreditMemos: allOf: - properties: appliedAmount: format: double type: number id: type: string number: type: string unappliedAmount: format: double type: number type: object DebitMemoCollectResponseAppliedPayments: allOf: - properties: appliedAmount: format: double type: number id: type: string number: type: string unappliedAmount: format: double type: number type: object PostDebitMemoEmailType: properties: emailAddresses: type: string includeAdditionalEmailAddresses: default: false enum: - true - false type: boolean pdfFileId: type: string useEmailTemplateSetting: default: false enum: - true - false type: boolean type: object GETDebitMemoFilesResponse: properties: debitMemoFiles: items: $ref: '#/components/schemas/DebitMemoFile' type: array nextPage: format: URL type: string success: type: boolean type: object DebitMemoFile: properties: id: type: string pdfFileUrl: type: string versionNumber: format: int64 type: integer title: debitMemoFile type: object GETDebitMemoItemCollectionType: properties: items: items: $ref: '#/components/schemas/GETDebitMemoItemTypewithSuccess' type: array nextPage: format: URL type: string success: type: boolean type: object GETDebitMemoItemTypewithSuccess: allOf: - properties: amount: format: double type: number amountWithoutTax: format: double type: number appliedToItemId: type: string balance: format: double type: number beAppliedAmount: format: double type: number createdById: type: string createdDate: format: date-time type: string excludeItemBillingFromRevenueAccounting: type: boolean financeInformation: properties: deferredRevenueAccountingCode: type: string deferredRevenueAccountingCodeType: type: string recognizedRevenueAccountingCode: type: string recognizedRevenueAccountingCodeType: type: string revenueRecognitionRuleName: type: string revenueScheduleNumber: type: string type: object id: type: string processingType: type: string quantity: format: double type: number reflectDiscountInNetAmount: type: boolean default: false serviceEndDate: format: date type: string serviceStartDate: format: date type: string sku: type: string skuName: type: string shipToContactId: type: string soldToContactId: type: string soldToContactSnapshotId: type: string sourceItemId: type: string sourceItemType: enum: - CreditMemoItem - SubscriptionComponent - InvoiceDetail - ProductRatePlanCharge type: string subscriptionId: type: string taxMode: enum: - TaxExclusive - TaxInclusive type: string taxationItems: properties: data: items: $ref: '#/components/schemas/GETDMTaxItemTypeNew' type: array nextPage: format: URL type: string type: object unitOfMeasure: type: string unitPrice: format: double type: number updatedById: type: string updatedDate: format: date-time type: string type: object - $ref: '#/components/schemas/DebitMemoItemObjectCustomFields' title: items GETDebitMemoItemType: allOf: - properties: amount: format: double type: number amountWithoutTax: format: double type: number appliedToItemId: type: string balance: format: double type: number beAppliedAmount: format: double type: number createdById: type: string createdDate: format: date-time type: string excludeItemBillingFromRevenueAccounting: type: boolean financeInformation: properties: deferredRevenueAccountingCode: type: string deferredRevenueAccountingCodeType: type: string recognizedRevenueAccountingCode: type: string recognizedRevenueAccountingCodeType: type: string revenueRecognitionRuleName: type: string revenueScheduleNumber: type: string type: object id: type: string processingType: type: string quantity: format: double type: number reflectDiscountInNetAmount: type: boolean default: false serviceEndDate: format: date type: string serviceStartDate: format: date type: string sku: type: string skuName: type: string shipToContactId: type: string soldToContactId: type: string soldToContactSnapshotId: type: string sourceItemId: type: string sourceItemType: enum: - CreditMemoItem - SubscriptionComponent - InvoiceDetail - ProductRatePlanCharge type: string subscriptionId: type: string success: type: boolean taxMode: enum: - TaxExclusive - TaxInclusive type: string taxationItems: properties: data: items: $ref: '#/components/schemas/GETDMTaxItemTypeNew' type: array nextPage: format: URL type: string type: object unitOfMeasure: type: string unitPrice: format: double type: number updatedById: type: string updatedDate: format: date-time type: string type: object - $ref: '#/components/schemas/DebitMemoItemObjectCustomFields' POSTTaxationItemListForDMType: properties: taxationItems: items: $ref: '#/components/schemas/POSTTaxationItemForDMType' type: array type: object POSTTaxationItemForDMType: allOf: - properties: exemptAmount: format: double type: number financeInformation: properties: salesTaxPayableAccountingCode: maxLength: 100 minLength: 0 type: string type: object jurisdiction: type: string locationCode: type: string memoItemId: type: string name: type: string sourceTaxItemId: type: string taxAmount: format: double type: number taxCode: type: string taxCodeDescription: type: string taxDate: format: date type: string taxRate: format: double type: number taxRateDescription: type: string taxRateType: enum: - Percentage - FlatFee type: string required: - taxRate - jurisdiction - name - taxRateType - taxAmount type: object - $ref: '#/components/schemas/TaxationItemObjectCustomFields' title: taxationItems PUTWriteOffDebitMemoRequest: allOf: - properties: comment: maxLength: 255 minLength: 0 type: string amount: type: number taxAutoCalculation: type: boolean revenueImpacting: enum: - 'Yes' - 'No' default: 'Yes' type: string nonRevenueWriteOffAccountingCode: type: string items: items: $ref: '#/components/schemas/DebitMemoItemFromWriteOffInvoice' type: array memoDate: format: date type: string reasonCode: type: string type: object - $ref: '#/components/schemas/CreditMemoObjectCustomFields' - $ref: '#/components/schemas/CreditMemoObjectNSFields' type: object PUTWriteOffDebitMemoResponse: properties: creditMemo: properties: id: type: string type: object success: type: boolean type: object DebitMemoItemFromWriteOffInvoice: allOf: - properties: comment: type: string amountWithoutTax: format: double type: number debitMemoItemId: type: string serviceEndDate: format: date type: string serviceStartDate: format: date type: string skuName: type: string unitOfMeasure: type: string excludeItemBillingFromRevenueAccounting: type: boolean taxationItems: items: properties: amount: type: number taxationItemId: type: string type: object type: array type: object - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields' title: items ListEInvoicingServiceProvidersResponse: properties: serviceProviders: items: $ref: '#/components/schemas/GetEInvoicingServiceProviderResponse' type: array success: type: boolean type: object GetEInvoicingServiceProviderResponse: allOf: - properties: companyIdentifier: type: string id: type: string name: maxLength: 100 type: string provider: enum: - Sovos - PEPPOL - Avalara type: string serviceProviderNumber: type: string test: type: boolean apiKey: type: string clientCertificate: type: string format: byte clientCertificateType: type: string default: PKCS12 title: serviceProviders type: object CreateEInvoicingServiceProviderRequest: allOf: - properties: companyIdentifier: type: string name: maxLength: 100 type: string provider: enum: - Sovos - PEPPOL - Avalara type: string test: type: boolean apiKey: type: string secretKey: type: string clientCertificate: type: string format: byte clientCertificateType: type: string default: PKCS12 clientCertificatePassword: type: string format: password required: - name - provider type: object UpdateEInvoicingServiceProviderRequest: allOf: - properties: companyIdentifier: type: string name: maxLength: 100 type: string test: type: boolean apiKey: type: string secretKey: type: string clientCertificate: type: string format: byte clientCertificateType: type: string default: PKCS12 clientCertificatePassword: type: string format: password type: object ListEInvoicingBusinessRegionsResponse: properties: regions: items: $ref: '#/components/schemas/GetEInvoicingBusinessRegionResponse' type: array success: type: boolean type: object GetEInvoicingBusinessRegionResponse: allOf: - properties: id: type: string country: type: string businessName: maxLength: 255 type: string businessNumber: type: string businessNumberSchemaId: type: string tradeName: maxLength: 100 type: string nullable: true endpointId: type: string endpointSchemeId: type: string taxRegisterNumber: type: string nullable: true state: type: string nullable: true city: type: string postalCode: type: string addressLine1: type: string nullable: true addressLine2: type: string nullable: true contactName: maxLength: 255 type: string nullable: true phoneNumber: type: string nullable: true email: type: string nullable: true serviceProviderId: type: string businessRegionNumber: type: string digitalSignatureEnable: default: false type: boolean digitalSignatureBoxEnable: default: false type: boolean digitalSignatureBoxPosX: type: number minimum: 0 digitalSignatureBoxPosY: type: number minimum: 0 responseMapping: type: object title: responseMapping additionalProperties: type: string processType: type: string enum: - Clearance - ClearanceWithCancellation - PEPPOLNetwork - Unknown invoiceEnabled: type: boolean default: false creditMemoEnabled: type: boolean default: false debitMemoEnabled: type: boolean default: false invoiceFilters: items: $ref: '#/components/schemas/InvoiceFiltersResponseType' type: array creditMemoFilters: items: $ref: '#/components/schemas/CreditMemoFiltersResponseType' type: array debitMemoFilters: items: $ref: '#/components/schemas/DebitMemoFiltersResponseType' type: array fileFormat: type: array items: type: string success: type: boolean title: regions type: object InvoiceFiltersResponseType: allOf: - properties: condition: $ref: '#/components/schemas/InvoiceFiltersCondition' type: object title: InvoiceFilters CreditMemoFiltersResponseType: allOf: - properties: condition: $ref: '#/components/schemas/CreditMemoFiltersCondition' type: object title: CreditMemoFilters DebitMemoFiltersResponseType: allOf: - properties: condition: $ref: '#/components/schemas/DebitMemoFiltersCondition' type: object title: DebitMemoFilters DebitMemoFiltersCondition: allOf: - properties: conditions: type: array items: $ref: '#/components/schemas/DebitMemoFiltersCondition' field: type: string operator: type: string enum: - eq - neq - gt - lt - gte - lte - lk - in - nl - nnl relation: type: string enum: - and - or value: type: string objectType: type: string enum: - DebitMemo - DebitMemoItem type: object title: Condition CreditMemoFiltersCondition: allOf: - properties: conditions: type: array items: $ref: '#/components/schemas/CreditMemoFiltersCondition' field: type: string operator: type: string enum: - eq - neq - gt - lt - gte - lte - lk - in - nl - nnl relation: type: string enum: - and - or value: type: string objectType: type: string enum: - CreditMemo - CreditMemoItem type: object title: Condition InvoiceFiltersCondition: allOf: - properties: conditions: type: array items: $ref: '#/components/schemas/InvoiceFiltersCondition' field: type: string operator: type: string enum: - eq - neq - gt - lt - gte - lte - lk - in - nl - nnl relation: type: string enum: - and - or value: type: string objectType: type: string enum: - Invoice - InvoiceItem type: object title: Condition CreateEInvoicingBusinessRegionRequest: allOf: - properties: addressLine1: type: string addressLine2: type: string businessName: maxLength: 255 type: string businessNumber: type: string businessNumberSchemaId: type: string city: type: string contactName: maxLength: 255 type: string country: type: string digitalSignatureEnable: default: false type: boolean digitalSignatureBoxEnable: default: false type: boolean digitalSignatureBoxPosX: type: number minimum: 0 digitalSignatureBoxPosY: type: number minimum: 0 email: type: string endpointId: type: string endpointSchemeId: type: string phoneNumber: type: string postalCode: type: string responseMapping: type: object title: responseMapping additionalProperties: type: string processType: type: string enum: - Clearance - ClearanceWithCancellation - PEPPOLNetwork invoiceEnabled: type: boolean default: false creditMemoEnabled: type: boolean default: false debitMemoEnabled: type: boolean default: false invoiceFilters: items: $ref: '#/components/schemas/InvoiceFiltersRequestType' type: array creditMemoFilters: items: $ref: '#/components/schemas/CreditMemoFiltersRequestType' type: array debitMemoFilters: items: $ref: '#/components/schemas/DebitMemoFiltersRequestType' type: array serviceProviderId: type: string state: type: string taxRegisterNumber: type: string tradeName: maxLength: 100 type: string fileFormat: type: array items: type: string required: - country - businessName type: object InvoiceFiltersRequestType: allOf: - properties: condition: $ref: '#/components/schemas/InvoiceFiltersCondition' required: - filterType type: object title: InvoiceFilters CreditMemoFiltersRequestType: allOf: - properties: condition: $ref: '#/components/schemas/CreditMemoFiltersCondition' required: - filterType type: object title: CreditMemoFilters DebitMemoFiltersRequestType: allOf: - properties: condition: $ref: '#/components/schemas/DebitMemoFiltersCondition' required: - filterType type: object title: DebitMemoFilters UpdateEInvoicingBusinessRegionRequest: allOf: - properties: addressLine1: type: string addressLine2: type: string businessName: maxLength: 255 type: string businessNumber: type: string businessNumberSchemaId: type: string city: type: string contactName: maxLength: 255 type: string country: type: string digitalSignatureEnable: default: false type: boolean digitalSignatureBoxEnable: default: false type: boolean digitalSignatureBoxPosX: type: number minimum: 0 digitalSignatureBoxPosY: type: number minimum: 0 email: type: string endpointId: type: string endpointSchemeId: type: string phoneNumber: type: string postalCode: type: string responseMapping: type: object title: responseMapping additionalProperties: type: string invoiceEnabled: type: boolean default: false creditMemoEnabled: type: boolean default: false debitMemoEnabled: type: boolean default: false invoiceFilters: items: $ref: '#/components/schemas/InvoiceFiltersRequestType' type: array creditMemoFilters: items: $ref: '#/components/schemas/CreditMemoFiltersRequestType' type: array debitMemoFilters: items: $ref: '#/components/schemas/DebitMemoFiltersRequestType' type: array serviceProviderId: type: string state: type: string taxRegisterNumber: type: string tradeName: maxLength: 100 type: string fileFormat: type: array items: type: string type: object EinvoiceFetchMandates: properties: data: items: $ref: '#/components/schemas/GETEinvoiceFetchMandates' type: array error: items: $ref: '#/components/schemas/GETEinvoiceFetchMandatesErrors' type: array type: object GETEinvoiceFetchMandates: allOf: - properties: countryCode: type: string nullable: false fileFormats: type: array items: type: string nullable: false category: type: string enum: - B2B - B2C - B2G processType: enum: - Clearance - ClearanceWithCancellation - PEPPOLNetwork - Unknown type: string defaultFileFormats: type: string GETEinvoiceFetchMandatesErrors: allOf: - properties: success: type: boolean processId: type: string reasons: items: $ref: '#/components/schemas/GETEinvoiceFetchMandatesErrorsReasons' requestId: type: string GETEinvoiceFetchMandatesErrorsReasons: allOf: - properties: code: type: string message: type: string EinvoiceInvoiceFetchMandate: properties: success: items: $ref: '#/components/schemas/GETEinvoiceInvoiceFetchMandate' type: array error: items: $ref: '#/components/schemas/GETEinvoiceInvoiceFetchMandatesError' type: array type: object GETEinvoiceInvoiceFetchMandate: allOf: - properties: countryCode: type: string nullable: false fileFormats: type: array items: type: string nullable: false category: type: string enum: - B2B - B2C - B2G processType: enum: - Clearance - ClearanceWithCancellation - PEPPOLNetwork - Unknown type: string defaultFileFormats: type: string GETEinvoiceInvoiceFetchMandatesError: allOf: - properties: success: type: boolean processId: type: string reasons: items: $ref: '#/components/schemas/GETEinvoiceInvoiceFetchMandatesErrorsReasons' requestId: type: string GETEinvoiceInvoiceFetchMandatesErrorsReasons: allOf: - properties: code: type: string message: type: string CreditMemosEinvoiceMandate: properties: success: items: $ref: '#/components/schemas/GETEinvoiceCreditMemosMandate' type: array error: items: $ref: '#/components/schemas/GETEinvoiceCreditMemosMandatesErrors' type: array type: object GETEinvoiceCreditMemosMandate: allOf: - properties: countryCode: type: string nullable: false fileFormats: type: array items: type: string nullable: false category: type: string enum: - B2B - B2C - B2G processType: enum: - Clearance - ClearanceWithCancellation - PEPPOLNetwork - Unknown type: string defaultFileFormats: type: string GETEinvoiceCreditMemosMandatesErrors: allOf: - properties: success: type: boolean processId: type: string reasons: items: $ref: '#/components/schemas/GETEinvoiceCreditMemosMandatesErrorsReasons' requestId: type: string GETEinvoiceCreditMemosMandatesErrorsReasons: allOf: - properties: code: type: string message: type: string DebitMemosEinvoiceMandate: properties: success: items: $ref: '#/components/schemas/GETEinvoiceDebitMemosMandates' type: array errors: items: $ref: '#/components/schemas/GETEinvoiceDebitMemosMandatesErrors' type: array type: object GETEinvoiceDebitMemosMandates: allOf: - properties: countryCode: type: string nullable: false fileFormats: type: array items: type: string nullable: false category: type: string enum: - B2B - B2C - B2G processType: enum: - Clearance - ClearanceWithCancellation - PEPPOLNetwork - Unknown type: string defaultFileFormats: type: string GETEinvoiceDebitMemosMandatesErrors: allOf: - properties: success: type: boolean processId: type: string reasons: items: $ref: '#/components/schemas/GETEinvoiceDebitMemosMandatesErrorsReasons' requestId: type: string GETEinvoiceDebitMemosMandatesErrorsReasons: allOf: - properties: code: type: string message: type: string EinvoiceDownload: properties: success: {} error: items: $ref: '#/components/schemas/GETEinvoiceDownload' type: array type: object GETEinvoiceDownload: allOf: - properties: success: type: boolean processId: type: string reasons: items: $ref: '#/components/schemas/GETEinvoiceDownloadErrors' requestId: type: string GETEinvoiceDownloadErrors: allOf: - properties: code: type: string message: type: string CreditMemosEinvoiceDownload: properties: success: {} error: items: $ref: '#/components/schemas/GETCreditMemosEinvoiceDownload' type: array type: object GETCreditMemosEinvoiceDownload: allOf: - properties: processId: type: string reasons: items: $ref: '#/components/schemas/GETCreditMemosEinvoiceDownloadErrors' requestId: type: string GETCreditMemosEinvoiceDownloadErrors: allOf: - properties: code: type: string message: type: string DebitMemosEinvoiceDownload: properties: success: {} error: items: $ref: '#/components/schemas/GETDebitMemosEinvoiceDownload' type: array type: object GETDebitMemosEinvoiceDownload: allOf: - properties: processId: type: string reasons: items: $ref: '#/components/schemas/GETEinvoiceDownloadErrors' requestId: type: string ListEInvoiceFileTemplatesResponse: properties: success: type: boolean templates: items: $ref: '#/components/schemas/GetEInvoiceFileTemplateResponse' type: array type: object GetEInvoiceFileTemplateResponse: allOf: - properties: content: type: string country: type: boolean documentType: enum: - Invoice - CreditMemo - DebitMemo type: string id: type: string name: maxLength: 255 type: string provider: enum: - Sovos type: string templateNumber: type: string title: templates type: object CreateEInvoiceFileTemplateRequest: allOf: - properties: content: type: string country: type: string documentType: enum: - Invoice - CreditMemo - DebitMemo type: string name: maxLength: 255 type: string provider: enum: - Sovos type: string required: - country - documentType - provider - content - name type: object UpdateEInvoiceFileTemplateRequest: allOf: - properties: content: type: string country: type: string documentType: enum: - Invoice - CreditMemo - DebitMemo type: string name: maxLength: 255 type: string provider: enum: - Sovos type: string type: object POSTCreateInvoiceScheduleRequest: allOf: - properties: accountKey: type: string additionalSubscriptionsToBill: items: type: string type: array invoiceSeparately: type: boolean notes: maxLength: 255 type: string orders: items: type: string type: array scheduleItems: items: $ref: '#/components/schemas/POSTScheduleItemType' type: array specificSubscriptions: items: $ref: '#/components/schemas/InvoiceScheduleSpecificSubscriptions' type: array type: object - $ref: '#/components/schemas/InvoiceScheduleCustomFields' - {} InvoiceScheduleResponses: allOf: - properties: accountId: type: string actualAmount: type: number additionalSubscriptionsToBill: items: type: string type: array billedAmount: type: number currency: type: string id: type: string invoiceSeparately: type: boolean nextRunDate: format: date type: string notes: maxLength: 255 type: string number: type: string orders: items: type: string type: array scheduleItems: items: $ref: '#/components/schemas/ScheduleItemsResponse' type: array specificSubscriptions: items: $ref: '#/components/schemas/InvoiceScheduleSpecificSubscriptions' type: array status: enum: - Pending - PartiallyProcessed - Paused - FullyProcessed type: string totalAmount: type: number unbilledAmount: type: number type: object - $ref: '#/components/schemas/InvoiceScheduleCustomFields' - {} ScheduleItemsResponse: allOf: - properties: actualAmount: format: number type: string amount: format: number type: string creditMemoId: type: string id: type: string invoiceId: type: string name: maxLength: 100 type: string percentage: {} runDate: format: date type: string status: enum: - Pending - Executing - Processed type: string targetDateForAdditionalSubscriptions: format: date type: string type: object - $ref: '#/components/schemas/InvoiceScheduleItemCustomFields' - {} title: scheduleItems InvoiceScheduleSpecificSubscriptions: properties: chargeNumbers: type: string orderKey: type: string subscriptionKey: type: string title: specificSubscriptions type: object InvoiceScheduleCustomFields: additionalProperties: {} title: invoiceScheduleCustomFields type: object InvoiceScheduleItemCustomFields: additionalProperties: {} title: invoiceScheduleItemCustomFields type: object POSTScheduleItemType: allOf: - properties: amount: type: number name: maxLength: 100 type: string percentage: type: number maximum: 100 runDate: format: date type: string targetDateForAdditionalSubscriptions: format: date type: string type: object - $ref: '#/components/schemas/InvoiceScheduleItemCustomFields' - {} title: scheduleItems PUTUpdateInvoiceScheduleRequest: allOf: - properties: additionalSubscriptionsToBill: items: type: string type: array invoiceSeparately: type: boolean nextRunDate: format: date type: string notes: maxLength: 255 type: string orders: items: type: string type: array scheduleItems: items: $ref: '#/components/schemas/UpdateScheduleItems' type: array specificSubscriptions: items: $ref: '#/components/schemas/InvoiceScheduleSpecificSubscriptions' type: array type: object - $ref: '#/components/schemas/InvoiceScheduleCustomFields' - {} UpdateScheduleItems: allOf: - properties: amount: format: number type: string id: type: string name: maxLength: 100 type: string percentage: {} runDate: format: date type: string targetDateForAdditionalSubscriptions: format: date type: string type: object - $ref: '#/components/schemas/InvoiceScheduleItemCustomFields' - {} title: scheduleItems POSTExecuteInvoiceScheduleRequest: allOf: - properties: scheduleItemId: type: string type: object - {} ExecuteInvoiceScheduleBillRunResponse: allOf: - properties: autoEmail: type: boolean autoPost: type: boolean autoRenewal: type: boolean batches: items: type: string type: array billCycleDay: type: string billRunFilters: items: $ref: '#/components/schemas/BillRunFilters' type: array billRunNumber: type: string chargeTypeToExclude: items: enum: - OneTime - Recurring - Usage type: string type: array createdById: type: string createdDate: format: date-time type: string id: type: string invoiceDate: format: date type: string invoiceDateOffset: type: integer noEmailForZeroAmountInvoice: type: boolean organizationLabels: items: properties: organizationId: type: string organizationName: type: string type: object type: array scheduledExecutionTime: format: date-time type: string status: enum: - Pending - Processing - Completed - Error - Canceled - Posted - PostInProgress - CancelInProgress - RemoveInProgress - Paused type: string targetDate: format: date type: string targetDateOffset: type: integer updatedById: type: string updatedDate: format: date-time type: string type: object - {} BillRunFilters: allOf: - properties: accountId: type: string filterType: enum: - Account - Subscription - InvoiceSchedule type: string subscriptionId: type: string type: object - {} title: billRunFilters DetachInvoiceScheduleRequest: properties: specificSubscriptions: items: type: object properties: chargeNumbers: type: string orderKey: type: string subscriptionKey: type: string title: specificSubscriptions type: array type: object AttachInvoiceScheduleRequest: properties: specificSubscriptions: items: type: object properties: chargeNumbers: type: string orderKey: type: string subscriptionKey: type: string title: specificSubscriptions type: array type: object ProxyCreateTaxationItem: allOf: - properties: AccountingCode: type: string ExemptAmount: format: double type: number InvoiceItemId: type: string Jurisdiction: type: string LocationCode: type: string Name: type: string TaxAmount: format: double type: number TaxCode: type: string TaxCodeDescription: type: string TaxDate: format: date type: string TaxRate: format: double type: number TaxRateDescription: type: string TaxRateType: type: string required: - InvoiceItemId - Jurisdiction - Name - TaxAmount - TaxRate - TaxDate - TaxRateType type: object - $ref: '#/components/schemas/TaxationItemObjectCustomFields' GETTaxationItemType: allOf: - properties: createdById: type: string createdDate: format: date-time type: string exemptAmount: format: double type: number financeInformation: properties: onAccountAccountingCode: type: string onAccountAccountingCodeType: type: string salesTaxPayableAccountingCode: type: string salesTaxPayableAccountingCodeType: type: string type: object id: type: string jurisdiction: type: string locationCode: type: string memoItemId: type: string name: type: string sourceTaxItemId: type: string success: type: boolean taxAmount: format: double type: number taxCode: type: string taxCodeDescription: type: string taxDate: format: date type: string taxRate: format: double type: number taxRateDescription: type: string taxRateType: enum: - Percentage - FlatFee type: string updatedById: type: string updatedDate: format: date-time type: string type: object - $ref: '#/components/schemas/TaxationItemObjectCustomFields' PUTTaxationItemType: allOf: - properties: exemptAmount: format: double type: number financeInformation: properties: onAccountAccountingCode: maxLength: 100 minLength: 0 type: string salesTaxPayableAccountingCode: maxLength: 100 minLength: 0 type: string type: object jurisdiction: type: string locationCode: type: string name: type: string taxAmount: format: double type: number taxCode: type: string taxCodeDescription: type: string taxDate: format: date type: string taxRate: format: double type: number taxRateDescription: type: string taxRateType: enum: - Percentage - FlatFee type: string type: object - $ref: '#/components/schemas/TaxationItemObjectCustomFields' GETSequenceSetsResponse: properties: sequenceSets: items: $ref: '#/components/schemas/GETSequenceSetResponse' type: array success: type: boolean type: object GETSequenceSetResponse: properties: creditMemo: $ref: '#/components/schemas/CreditMemoEntityPrefix' debitMemo: $ref: '#/components/schemas/DebitMemoEntityPrefix' id: type: string invoice: $ref: '#/components/schemas/InvoiceEntityPrefix' name: type: string payment: $ref: '#/components/schemas/PaymentEntityPrefix' refund: $ref: '#/components/schemas/RefundEntityPrefix' title: sequenceSets type: object CreditMemoEntityPrefix: properties: prefix: type: string startNumber: type: integer title: creditMemo type: object DebitMemoEntityPrefix: properties: prefix: type: string startNumber: type: integer title: debitMemo type: object InvoiceEntityPrefix: properties: prefix: type: string startNumber: type: integer title: Invoice type: object PaymentEntityPrefix: properties: prefix: type: string startNumber: type: integer title: payment type: object RefundEntityPrefix: properties: prefix: type: string startNumber: type: integer title: refund type: object POSTSequenceSetsRequest: properties: sequenceSets: items: $ref: '#/components/schemas/POSTSequenceSetRequest' type: array type: object POSTSequenceSetsResponse: properties: sequenceSets: items: $ref: '#/components/schemas/GETSequenceSetResponse' type: array success: type: boolean type: object POSTSequenceSetRequest: properties: creditMemo: $ref: '#/components/schemas/CreditMemoEntityPrefix' debitMemo: $ref: '#/components/schemas/DebitMemoEntityPrefix' invoice: $ref: '#/components/schemas/InvoiceEntityPrefix' name: type: string payment: $ref: '#/components/schemas/PaymentEntityPrefix' refund: $ref: '#/components/schemas/RefundEntityPrefix' required: - name - invoice - creditMemo - debitMemo title: sequenceSets type: object PUTSequenceSetRequest: properties: creditMemo: $ref: '#/components/schemas/CreditMemoEntityPrefix' debitMemo: $ref: '#/components/schemas/DebitMemoEntityPrefix' invoice: $ref: '#/components/schemas/InvoiceEntityPrefix' name: type: string payment: $ref: '#/components/schemas/PaymentEntityPrefix' refund: $ref: '#/components/schemas/RefundEntityPrefix' type: object PUTSequenceSetResponse: properties: success: type: boolean type: object PostBillingPreviewParam: properties: accountId: maxLength: 255 type: string accountNumber: type: string assumeRenewal: type: string chargeTypeToExclude: type: string includingDraftItems: type: boolean includingEvergreenSubscription: type: boolean targetDate: format: date type: string required: - targetDate type: object BillingPreviewResult: properties: accountId: type: string creditMemoItems: items: $ref: '#/components/schemas/POSTBillingPreviewCreditMemoItem' type: array invoiceItems: items: $ref: '#/components/schemas/POSTBillingPreviewInvoiceItem' type: array success: type: boolean type: object POSTBillingPreviewCreditMemoItem: properties: amount: format: double type: number amountWithoutTax: format: double type: number appliedToItemId: type: string nullable: true chargeDate: format: date-time type: string chargeNumber: type: string chargeType: type: string comment: type: string id: type: string numberOfDeliveries: type: number processingType: type: string quantity: format: decimal type: string ratePlanChargeId: type: string serviceEndDate: format: date type: string serviceStartDate: format: date type: string sku: type: string skuName: type: string subscriptionId: type: string subscriptionNumber: type: string unitOfMeasure: type: string title: creditMemoItems type: object POSTBillingPreviewInvoiceItem: properties: appliedToItemId: type: string nullable: true chargeAmount: format: decimal type: string chargeDate: format: date-time type: string chargeDescription: type: string chargeId: type: string chargeName: type: string chargeNumber: type: string chargeType: type: string id: type: string numberOfDeliveries: type: number processingType: type: string productName: type: string quantity: format: decimal type: string serviceEndDate: format: date type: string serviceStartDate: format: date type: string subscriptionId: type: string subscriptionName: type: string subscriptionNumber: type: string taxAmount: format: decimal type: string unitOfMeasure: type: string title: invoiceItems type: object POSTInvoiceCollectType: properties: accountKey: type: string documentDate: format: date type: string invoiceId: type: string paymentGateway: type: string targetDate: format: date type: string required: - accountKey type: object POSTInvoiceCollectResponseType: properties: amountCollected: format: double type: number creditMemos: items: $ref: '#/components/schemas/POSTInvoiceCollectCreditMemosType' type: array invoices: items: $ref: '#/components/schemas/POSTInvoiceCollectInvoicesType' type: array paymentId: type: string success: type: boolean type: object POSTInvoiceCollectCreditMemosType: properties: id: type: string totalAmount: format: double type: number memoNumber: type: string title: creditMemos type: object POSTInvoiceCollectInvoicesType: properties: invoiceAmount: format: decimal type: string invoiceId: type: string invoiceNumber: type: string title: invoices type: object GetOperationJobResponseType: properties: id: type: string objectId: type: string objectType: enum: - Invoice type: string operationType: enum: - Delete - Reverse type: string reasons: items: properties: code: type: string message: type: string type: object type: array status: enum: - Pending - Processing - Failed - Completed type: string success: type: boolean type: object POSTBulkPdfGenerationJobRequestType: allOf: - type: object required: - documents - fileName - indexFileFormat properties: documents: items: $ref: '#/components/schemas/DocumentList' type: array fileName: type: string maxLength: 32 name: type: string maxLength: 32 indexFileFormat: enum: - JSON - CSV type: string generateMissingPDF: type: boolean ignoreArchivedFiles: type: boolean persistIndexFile: type: boolean POSTBulkPdfGenerationJobResponseType: allOf: - $ref: '#/components/schemas/CommonResponse' - properties: jobId: type: string invalidIds: {} skippedDocuments: items: type: object properties: docType: enum: - Invoice - CreditMemo - DebitMemo type: string objectIds: type: array items: type: string type: array type: object DocumentList: properties: docType: enum: - Invoice - CreditMemo - DebitMemo type: string objectIds: items: type: string type: array type: object GETBulkpdfGenerationJobResponseType: properties: jobId: type: string jobName: type: string status: enum: - Submitted - Executing - Completed - Error - Aborted - Cancelled type: string stepStatus: enum: - JobCreated - TasksCreated - GenerateMissPDF - PdfToZip - PostProcessing type: string fileUrls: items: type: string type: array failedDocuments: items: $ref: '#/components/schemas/DocumentList' type: array createdOn: type: string createdBy: type: string success: type: boolean type: object POSTCreateBillRunRequestType: allOf: - properties: autoEmail: default: false type: boolean autoPost: default: false type: boolean autoRenewal: default: false type: boolean batches: items: type: string type: array billCycleDay: type: string billRunFilters: items: $ref: '#/components/schemas/BillRunFilterRequestType' type: array billRunType: type: string chargeTypeToExclude: items: enum: - OneTime - Recurring - Usage type: string type: array includeSubscriptions: default: true type: boolean includeOrderLineItems: default: true type: boolean invoiceDate: format: date type: string invoiceDateMonthOffset: type: integer invoiceDateDayOfMonth: type: integer maximum: 31 minimum: 1 name: type: string noEmailForZeroAmountInvoice: default: false type: boolean organizationLabels: items: properties: organizationId: type: string organizationName: type: string type: object type: array schedule: $ref: '#/components/schemas/BillRunScheduleRequestType' targetDate: format: date type: string targetDateMonthOffset: type: integer targetDateDayOfMonth: type: integer maximum: 31 minimum: 1 type: object GetBillRunResponseType: allOf: - properties: autoEmail: type: boolean autoPost: type: boolean autoRenewal: type: boolean batches: items: type: string type: array billCycleDay: type: string billRunFilters: items: $ref: '#/components/schemas/BillRunFilterResponseType' type: array billRunNumber: type: string chargeTypeToExclude: items: enum: - OneTime - Recurring - Usage type: string type: array createdById: type: string createdDate: format: date-time type: string includeSubscriptions: default: true type: boolean includeOrderLineItems: default: true type: boolean id: type: string invoiceDate: format: date type: string invoiceDateOffset: type: integer invoiceDateMonthOffset: type: integer invoiceDateDayOfMonth: type: integer maximum: 31 minimum: 1 name: type: string noEmailForZeroAmountInvoice: type: boolean organizationLabels: items: properties: organizationId: type: string organizationName: type: string type: object type: array schedule: $ref: '#/components/schemas/BillRunScheduleResponseType' scheduledExecutionTime: format: date-time type: string status: enum: - Pending - Processing - Completed - Error - Canceled - Posted - PostInProgress - CancelInProgress - RemoveInProgress - Paused type: string targetDate: format: date type: string targetDateOffset: type: integer targetDateMonthOffset: type: integer targetDateDayOfMonth: type: integer maximum: 31 minimum: 1 updatedById: type: string updatedDate: format: date-time type: string type: object BillRunFilterResponseType: allOf: - properties: accountId: type: string filterType: enum: - Account - Subscription - InvoiceSchedule - FilterCondition type: string condition: $ref: '#/components/schemas/Condition' objectType: type: string enum: - Account - Subscription - RatePlanCharge subscriptionId: type: string type: object title: billRunFilters BillRunScheduleResponseType: allOf: - properties: repeatFrom: format: date type: string repeatTo: format: date type: string repeatType: enum: - None - Daily - Weekly - Monthly type: string runTime: type: integer weeklyOnDay: items: enum: - Mon - Tue - Wed - Thu - Fri - Sat - Sun type: string type: array monthlyOnEndOfMonth: type: boolean type: object title: schedule Condition: allOf: - properties: conditions: type: array items: $ref: '#/components/schemas/Condition' field: type: string operator: type: string enum: - eq - neq - gt - lt - gte - lte - lk - in - nl - nnl relation: type: string enum: - and - or value: type: string type: object title: Condition BillRunFilterRequestType: allOf: - properties: accountId: type: string filterType: enum: - Account - Subscription - FilterCondition type: string condition: $ref: '#/components/schemas/Condition' objectType: type: string enum: - Account - Subscription - RatePlanCharge subscriptionId: type: string required: - accountId - filterType type: object title: billRunFilters BillRunScheduleRequestType: allOf: - properties: repeatFrom: format: date type: string repeatTo: format: date type: string repeatType: enum: - None - Daily - Weekly - Monthly type: string runTime: type: integer weeklyOnDay: items: enum: - Mon - Tue - Wed - Thu - Fri - Sat - Sun type: string type: array monthlyOnEndOfMonth: type: boolean required: - repeatFrom - repeatType - runTime type: object title: schedule CancelBillRunResponseType: allOf: - $ref: '#/components/schemas/GetBillRunResponseType' - properties: nextRun: $ref: '#/components/schemas/NextRunResponseType' type: object NextRunResponseType: allOf: - properties: autoEmail: type: boolean autoPost: type: boolean autoRenewal: type: boolean batches: items: type: string type: array billCycleDay: type: string billRunFilters: items: $ref: '#/components/schemas/BillRunFilterResponseType' type: array billRunNumber: type: string chargeTypeToExclude: items: enum: - OneTime - Recurring - Usage type: string type: array createdById: type: string createdDate: format: date-time type: string id: type: string invoiceDate: format: date type: string invoiceDateOffset: type: integer noEmailForZeroAmountInvoice: type: boolean schedule: $ref: '#/components/schemas/BillRunScheduleResponseType' scheduledExecutionTime: format: date-time type: string status: enum: - Pending - Processing - Completed - Error - Canceled - Posted - PostInProgress - CancelInProgress - RemoveInProgress - Paused type: string targetDate: format: date type: string targetDateOffset: type: integer updatedById: type: string updatedDate: format: date-time type: string type: object title: nextRun POSTEmailBillingDocfromBillRunType: properties: resend: default: false type: boolean type: object PostBillingPreviewRunParam: properties: assumeRenewal: type: string batches: maxLength: 1000 type: string chargeTypeToExclude: type: string includingDraftItems: type: boolean includingEvergreenSubscription: type: boolean organizationLabels: items: properties: organizationId: type: string organizationName: type: string type: object type: array storageOption: enum: - Csv - Database type: string storeDifference: type: boolean comparedBillingPreviewRunId: type: string targetDate: format: date type: string required: - targetDate type: object GetBillingPreviewRunResponse: properties: assumeRenewal: type: string batches: type: string chargeTypeToExclude: type: string createdById: type: string createdDate: format: datetime type: string endDate: format: datetime type: string errorMessage: type: string includingDraftItems: type: boolean includingEvergreenSubscription: type: boolean organizationLabels: items: properties: organizationId: type: string organizationName: type: string type: object type: array resultFileUrl: type: string runNumber: type: string startDate: format: datetime type: string status: type: string storageOption: enum: - Csv - Database type: string succeededAccounts: type: integer success: type: boolean targetDate: format: date type: string totalAccounts: format: int32 type: integer updatedById: type: string updatedDate: format: date-time type: string type: object POSTPaymentMethodResponse: allOf: - $ref: '#/components/schemas/CommonResponse' - properties: id: type: string reasons: items: properties: code: type: string message: type: string type: object type: array type: object POSTPaymentMethodDecryption: properties: accountID: type: string cardHolderInfo: $ref: '#/components/schemas/CreateApplePayPaymentMethodCardholderInfo' integrationType: type: string invoiceId: type: string merchantID: type: string mitConsentAgreementSrc: enum: - External type: string mitProfileAction: enum: - Activate - Persist type: string mitProfileType: enum: - Recurring - Unscheduled type: string paymentGateway: type: string paymentToken: type: object processPayment: type: boolean required: - integrationType - merchantID - paymentToken type: object POSTPaymentMethodResponseDecryption: properties: amount: type: string paymentId: type: string paymentMethodId: type: string success: type: boolean type: object CreateApplePayPaymentMethodCardholderInfo: properties: addressLine1: maxLength: 255 type: string addressLine2: maxLength: 255 type: string cardHolderName: maxLength: 50 type: string city: maxLength: 40 type: string country: type: string email: maxLength: 80 type: string phone: maxLength: 40 type: string state: type: string zipCode: maxLength: 20 type: string title: CardHolderInfo type: object GETPaymentMethodResponse: allOf: - properties: accountHolderInfo: $ref: '#/components/schemas/GETPMAccountHolderInfo' accountVerificationService: type: string accountVerificationStatus: enum: - Active - Expired - Expiring - Inactive type: string bankIdentificationNumber: type: string createdBy: type: string createdOn: format: date-time type: string creditCardMaskNumber: type: string creditCardType: type: string deviceSessionId: type: string existingMandate: enum: - 'Yes' - 'No' type: string id: type: string ipAddress: type: string isDefault: type: boolean lastFailedSaleTransactionDate: format: date-time type: string lastTransaction: type: string lastTransactionTime: format: date-time type: string mandateInfo: $ref: '#/components/schemas/POSTPMMandateInfo' maxConsecutivePaymentFailures: type: integer numConsecutiveFailures: format: int32 type: integer paymentRetryWindow: type: integer secondTokenId: type: string status: enum: - Active - Closed - Scrubbed type: string tokenId: type: string totalNumberOfErrorPayments: format: int32 type: integer totalNumberOfProcessedPayments: format: int32 type: integer type: type: string enum: - CreditCard - CreditCardReferenceTransaction - ACH - SEPA - Betalingsservice - Autogiro - Bacs - Becs - Becsnz - PAD - PayPalCP - PayPalEC - PayPalNativeEC - PayPalAdaptive - AdyenApplePay - AdyenGooglePay - GooglePay updatedBy: type: string updatedOn: format: date-time type: string useDefaultRetryRule: type: boolean cardBinInfo: properties: brand: type: string cardClass: type: string enum: - ChargeCard - Credit - Debit - DeferredDebit - Prepaid productType: type: string enum: - Commercial_or_Corporate_Card - Consumer_Card issuer: type: string issuingCountryCode: type: string type: object type: object - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' - $ref: '#/components/schemas/GETPaymentMethodResponseBankTransfer' - $ref: '#/components/schemas/GETPaymentMethodResponseACH' - $ref: '#/components/schemas/GETPaymentMethodResponseCreditCard' - $ref: '#/components/schemas/GETPaymentMethodResponsePayPal' - $ref: '#/components/schemas/GETPaymentMethodResponseGooglePay' - $ref: '#/components/schemas/GETPaymentMethodResponseApplePay' GETPMAccountHolderInfo: properties: accountHolderName: type: string addressLine1: type: string addressLine2: type: string city: type: string country: type: string email: type: string phone: type: string state: type: string zipCode: type: string title: accountHolderInfo type: object POSTPMMandateInfo: properties: existingMandateStatus: enum: - 'Yes' - 'No' type: string mandateCreationDate: format: date type: string mandateId: type: string mandateReason: type: string mandateReceivedStatus: enum: - 'Yes' - 'No' type: string mandateStatus: type: string mandateUpdateDate: format: date type: string mitConsentAgreementRef: type: string mitConsentAgreementSrc: enum: - External type: string mitProfileAction: enum: - Activate - Persist type: string mitProfileAgreedOn: format: date type: string mitProfileType: type: string mitTransactionId: maxLength: 128 type: string title: mandateInfo type: object GETPaymentMethodResponseBankTransfer: properties: IBAN: type: string accountNumber: type: string bankCode: type: string bankTransferType: type: string branchCode: type: string businessIdentificationCode: type: string identityNumber: type: string type: object GETPaymentMethodResponseACH: properties: bankABACode: type: string bankAccountName: type: string bankAccountNumber: type: string bankAccountType: enum: - BusinessChecking - Checking - Saving type: string bankName: type: string type: object GETPaymentMethodResponseCreditCard: properties: cardNumber: type: string expirationMonth: type: integer expirationYear: type: integer securityCode: type: string type: object GETPaymentMethodResponsePayPal: properties: BAID: type: string email: type: string preapprovalKey: type: string type: object GETPaymentMethodResponseGooglePay: properties: googleBIN: type: string googleCardNumber: type: string googleCardType: type: string googleExpiryDate: type: string googleGatewayToken: type: string type: object GETPaymentMethodResponseApplePay: properties: appleBIN: type: string appleCardNumber: type: string appleCardType: type: string appleExpiryDate: type: string appleGatewayToken: type: string type: object PUTPaymentMethodRequest: allOf: - properties: accountHolderInfo: $ref: '#/components/schemas/PUTPMAccountHolderInfo' accountKey: type: string authGateway: type: string currencyCode: type: string gatewayOptions: properties: key: type: string value: type: string type: object ipAddress: type: string mandateInfo: properties: mandateId: maxLength: 36 type: string mandateReason: maxLength: 64 type: string mandateStatus: maxLength: 64 type: string type: object processingOptions: properties: checkDuplicated: type: boolean type: object maxConsecutivePaymentFailures: type: integer minimum: 1 maximum: 100 nullable: true paymentRetryWindow: type: integer minimum: 1 maximum: 1000 nullable: true useDefaultRetryRule: type: boolean type: object - $ref: '#/components/schemas/PUTPMCreditCardInfo' - $ref: '#/components/schemas/PUTPaymentMethodObjectCustomFields' PUTPaymentMethodResponse: properties: id: type: string success: type: boolean type: object PUTPMAccountHolderInfo: properties: addressLine1: type: string addressLine2: type: string city: type: string country: type: string email: type: string phone: type: string state: type: string zipCode: type: string title: accountHolderInfo type: object PUTPMCreditCardInfo: properties: expirationMonth: type: integer expirationYear: type: integer securityCode: type: string type: object PUTPaymentMethodObjectCustomFields: additionalProperties: {} title: paymentMethodFieldsCustom type: object PUTVerifyPaymentMethodType: properties: currencyCode: type: string gatewayOptions: properties: key: type: string value: type: string type: object paymentGatewayName: type: string securityCode: type: string type: object PUTVerifyPaymentMethodResponseType: properties: paymentMethodId: type: string success: type: boolean type: object GetBankAccountBalanceResponse: properties: success: type: boolean currency: type: string availableBalance: type: number format: double currentBalance: type: number format: double type: object GetStoredCredentialProfilesResponse: properties: profiles: items: properties: activatedOn: format: date-time type: string agreedOn: format: date-time type: string brand: type: string cancelledOn: format: date-time type: string consentAgreementRef: maxLength: 128 type: string consentAgreementSrc: enum: - External type: string expiredOn: format: date-time type: string number: type: integer paymentMethodId: type: string status: enum: - Agreed - Active - Cancelled - Expired type: string type: enum: - Recurring - Unscheduled type: string type: array success: type: boolean type: object CreateStoredCredentialProfileRequest: properties: action: enum: - Activate - Persist type: string agreedOn: format: date type: string authGateway: type: string cardSecurityCode: type: string consentAgreementRef: maxLength: 128 type: string consentAgreementSrc: enum: - External type: string networkTransactionId: maxLength: 128 type: string status: enum: - Agreed - Active type: string type: enum: - Recurring - Unscheduled type: string required: - status - type - consentAgreementSrc type: object ModifiedStoredCredentialProfileResponse: properties: number: type: integer paymentMethodId: type: string success: type: boolean type: object GETListApplePayDomainsResponse: properties: domains: items: properties: createdBy: type: string createdOn: format: date-time type: string domainName: type: string domainVerified: type: boolean id: type: string updatedBy: type: string updatedOn: format: date-time type: string type: array success: type: boolean type: object POSTRegisterApplePayDomainRequest: properties: domainName: type: string required: - domainName type: object POSTRegisterApplePayDomainResponse: properties: domainName: type: string domainVerified: type: boolean id: type: string success: type: boolean type: object DELETEUnresigerApplePayDomainResponse: properties: success: type: boolean type: object POSTCreatePaymentSessionRequest: properties: accountId: type: string amount: type: number authAmount: type: number currency: type: string gatewayOptions: type: object title: GatewayOptions additionalProperties: type: string paymentGateway: type: string processPayment: type: boolean storePaymentMethod: type: boolean default: true invoices: items: type: object properties: invoiceNumber: type: string type: array required: - currency - processPayment - amount type: object POSTCreatePaymentSessionResponse: properties: token: type: string type: object PaymentCollectionResponseType: properties: nextPage: format: URL type: string payments: items: $ref: '#/components/schemas/GETARPaymentTypewithSuccess' type: array success: type: boolean type: object GETARPaymentTypewithSuccess: allOf: - properties: accountId: type: string accountNumber: type: string amount: format: double type: number appliedAmount: format: double type: number authTransactionId: type: string nullable: true bankIdentificationNumber: type: string nullable: true cancelledOn: format: date-time type: string nullable: true comment: type: string createdById: type: string createdDate: format: date-time type: string creditBalanceAmount: format: double type: number currency: type: string effectiveDate: format: date-time type: string financeInformation: properties: bankAccountAccountingCode: type: string nullable: true bankAccountAccountingCodeType: type: string nullable: true transferredToAccounting: enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string nullable: true unappliedPaymentAccountingCode: type: string nullable: true unappliedPaymentAccountingCodeType: type: string nullable: true type: object gatewayId: type: string nullable: true gatewayOrderId: type: string nullable: true gatewayReconciliationReason: type: string nullable: true gatewayReconciliationStatus: type: string nullable: true gatewayResponse: type: string nullable: true gatewayResponseCode: type: string nullable: true gatewayState: enum: - MarkedForSubmission - Submitted - Settled - NotSubmitted - FailedToSettle type: string id: type: string markedForSubmissionOn: format: date-time type: string nullable: true number: type: string organizationLabel: type: string paymentGatewayNumber: type: string paymentMethodId: type: string paymentMethodSnapshotId: type: string nullable: true paymentOption: items: $ref: '#/components/schemas/PaymentSchedulePaymentOptionFields' type: array paymentScheduleKey: type: string payoutId: type: string nullable: true prepayment: type: boolean referenceId: type: string nullable: true refundAmount: format: double type: number secondPaymentReferenceId: type: string nullable: true settledOn: format: date-time type: string nullable: true softDescriptor: type: string nullable: true softDescriptorPhone: type: string nullable: true standalone: default: false type: boolean status: enum: - Draft - Processing - Processed - Error - Canceled - Posted type: string submittedOn: format: date-time type: string nullable: true type: enum: - External - Electronic type: string unappliedAmount: format: double type: number updatedById: type: string updatedDate: format: date-time type: string type: object - $ref: '#/components/schemas/PaymentObjectNSFields' - $ref: '#/components/schemas/PaymentObjectCustomFields' title: payments PaymentSchedulePaymentOptionFields: properties: detail: properties: key: type: string value: type: string type: object type: type: string title: paymentOption type: object PaymentObjectNSFields: properties: IntegrationId__NS: maxLength: 255 type: string IntegrationStatus__NS: maxLength: 255 type: string Origin__NS: maxLength: 255 type: string SyncDate__NS: maxLength: 255 type: string Transaction__NS: maxLength: 255 type: string title: paymentFieldsNS type: object PaymentObjectCustomFields: additionalProperties: {} title: paymentFieldsCustom type: object CreatePaymentType: allOf: - properties: accountId: type: string accountNumber: type: string amount: format: double type: number authTransactionId: maxLength: 50 type: string comment: maxLength: 255 minLength: 0 type: string currency: type: string customRates: items: $ref: '#/components/schemas/PaymentWithCustomRatesType' maxItems: 2 type: array debitMemos: items: $ref: '#/components/schemas/PaymentDebitMemoApplicationCreateRequestType' type: array effectiveDate: format: date type: string financeInformation: properties: bankAccountAccountingCode: maxLength: 100 minLength: 0 type: string transferredToAccounting: enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string unappliedPaymentAccountingCode: maxLength: 100 minLength: 0 type: string type: object gatewayId: type: string gatewayOptions: properties: key: maxLength: 255 type: string value: maxLength: 255 type: string type: object gatewayOrderId: maxLength: 50 type: string invoices: items: $ref: '#/components/schemas/PaymentInvoiceApplicationCreateRequestType' type: array mitTransactionSource: enum: - C_Unscheduled - M_Recurring - M_Unscheduled - M_MOTO type: string paymentGatewayNumber: type: string paymentMethodId: type: string paymentMethodType: default: null type: string paymentOption: items: $ref: '#/components/schemas/PaymentSchedulePaymentOptionFields' type: array paymentScheduleKey: type: string prepayment: type: boolean referenceId: maxLength: 100 minLength: 0 type: string softDescriptor: maxLength: 35 type: string softDescriptorPhone: maxLength: 20 type: string standalone: default: false type: boolean type: enum: - External - Electronic type: string required: - amount - currency - type type: object - $ref: '#/components/schemas/PaymentObjectNSFields' - $ref: '#/components/schemas/PaymentObjectCustomFields' GETARPaymentTypeWithPaymentOption: allOf: - properties: accountId: type: string accountNumber: type: string amount: format: double type: number appliedAmount: format: double type: number authTransactionId: type: string bankIdentificationNumber: type: string cancelledOn: format: date-time type: string nullable: true comment: type: string nullable: true createdById: type: string createdDate: format: date-time type: string creditBalanceAmount: format: double type: number currency: type: string effectiveDate: format: date-time type: string financeInformation: properties: bankAccountAccountingCode: type: string nullable: true bankAccountAccountingCodeType: type: string nullable: true transferredToAccounting: enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string nullable: true unappliedPaymentAccountingCode: type: string nullable: true unappliedPaymentAccountingCodeType: type: string nullable: true type: object gatewayId: type: string nullable: true gatewayOrderId: type: string gatewayReconciliationReason: type: string nullable: true gatewayReconciliationStatus: type: string nullable: true gatewayResponse: type: string nullable: true gatewayResponseCode: type: string gatewayState: enum: - MarkedForSubmission - Submitted - Settled - NotSubmitted - FailedToSettle type: string id: type: string markedForSubmissionOn: format: date-time type: string number: type: string organizationLabel: type: string paymentGatewayNumber: type: string nullable: true paymentMethodId: type: string paymentMethodSnapshotId: type: string nullable: true paymentOption: items: $ref: '#/components/schemas/PaymentSchedulePaymentOptionFields' type: array paymentScheduleKey: type: string payoutId: type: string nullable: true prepayment: type: boolean referenceId: type: string nullable: true refundAmount: format: double type: number secondPaymentReferenceId: type: string nullable: true settledOn: format: date-time type: string nullable: true softDescriptor: type: string nullable: true softDescriptorPhone: type: string nullable: true standalone: default: false type: boolean status: enum: - Draft - Processing - Processed - Error - Canceled - Posted - Pending type: string submittedOn: format: date-time type: string success: type: boolean type: enum: - External - Electronic type: string unappliedAmount: format: double type: number updatedById: type: string updatedDate: format: date-time type: string type: object - $ref: '#/components/schemas/PaymentObjectNSFields' - $ref: '#/components/schemas/PaymentObjectCustomFields' PaymentWithCustomRatesType: allOf: - properties: currency: type: string customFxRate: format: decimal type: number rateDate: format: date type: string required: - currency - customFxRate type: object title: customRates PaymentDebitMemoApplicationCreateRequestType: properties: amount: format: double type: number debitMemoId: type: string items: items: $ref: '#/components/schemas/PaymentDebitMemoApplicationItemCreateRequestType' type: array title: debitMemos type: object PaymentInvoiceApplicationCreateRequestType: properties: amount: format: double type: number invoiceId: type: string items: items: $ref: '#/components/schemas/PaymentInvoiceApplicationItemCreateRequestType' type: array title: invoices type: object PaymentInvoiceApplicationItemCreateRequestType: properties: amount: format: double type: number invoiceItemId: type: string taxItemId: type: string required: - amount title: items type: object PaymentDebitMemoApplicationItemCreateRequestType: properties: amount: format: double type: number debitMemoItemId: type: string taxItemId: type: string required: - amount title: items type: object UpdatePaymentType: allOf: - properties: comment: maxLength: 255 minLength: 0 type: string financeInformation: properties: bankAccountAccountingCode: maxLength: 100 minLength: 0 type: string transferredToAccounting: enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string unappliedPaymentAccountingCode: maxLength: 100 minLength: 0 type: string type: object gatewayState: enum: - NotSubmitted - Submitted - Settled - FailedToSettle type: string paymentScheduleKey: type: string referenceId: maxLength: 100 minLength: 0 type: string type: object - $ref: '#/components/schemas/PaymentObjectNSFields' - $ref: '#/components/schemas/PaymentObjectCustomFields' GETARPaymentType: allOf: - properties: accountId: type: string accountNumber: type: string amount: format: double type: number appliedAmount: format: double type: number authTransactionId: type: string bankIdentificationNumber: type: string cancelledOn: format: date-time type: string comment: type: string nullable: true createdById: type: string createdDate: format: date-time type: string creditBalanceAmount: format: double type: number currency: type: string effectiveDate: format: date-time type: string financeInformation: properties: bankAccountAccountingCode: type: string bankAccountAccountingCodeType: type: string transferredToAccounting: enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string unappliedPaymentAccountingCode: type: string unappliedPaymentAccountingCodeType: type: string type: object gatewayId: type: string gatewayOrderId: type: string gatewayReconciliationReason: type: string gatewayReconciliationStatus: type: string gatewayResponse: type: string gatewayResponseCode: type: string gatewayState: enum: - MarkedForSubmission - Submitted - Settled - NotSubmitted - FailedToSettle type: string id: type: string markedForSubmissionOn: format: date-time type: string number: type: string organizationLabel: type: string paymentGatewayNumber: type: string paymentMethodId: type: string paymentMethodSnapshotId: type: string paymentScheduleKey: type: string payoutId: type: string prepayment: type: boolean referenceId: type: string refundAmount: format: double type: number secondPaymentReferenceId: type: string settledOn: format: date-time type: string softDescriptor: type: string softDescriptorPhone: type: string standalone: default: false type: boolean status: enum: - Draft - Processing - Processed - Error - Canceled - Posted type: string submittedOn: format: date-time type: string success: type: boolean type: enum: - External - Electronic type: string unappliedAmount: format: double type: number updatedById: type: string updatedDate: format: date-time type: string type: object - $ref: '#/components/schemas/PaymentObjectNSFields' - $ref: '#/components/schemas/PaymentObjectCustomFields' ApplyPaymentType: properties: debitMemos: items: $ref: '#/components/schemas/PaymentDebitMemoApplicationApplyRequestType' type: array effectiveDate: format: date type: string invoices: items: $ref: '#/components/schemas/PaymentInvoiceApplicationApplyRequestType' type: array type: object PaymentDebitMemoApplicationApplyRequestType: properties: amount: format: double type: number debitMemoId: type: string debitMemoNumber: type: string items: items: $ref: '#/components/schemas/PaymentDebitMemoApplicationItemApplyRequestType' type: array required: - amount title: debitMemos type: object PaymentInvoiceApplicationApplyRequestType: properties: amount: format: double type: number invoiceId: type: string invoiceNumber: type: string items: items: $ref: '#/components/schemas/PaymentInvoiceApplicationItemApplyRequestType' type: array required: - amount title: invoices type: object PaymentInvoiceApplicationItemApplyRequestType: properties: amount: format: double type: number invoiceItemId: type: string taxItemId: type: string required: - amount title: items type: object PaymentDebitMemoApplicationItemApplyRequestType: properties: amount: format: double type: number debitMemoItemId: type: string taxItemId: type: string required: - amount title: items type: object GETPaymentPartsCollectionType: properties: nextPage: format: URL type: string parts: items: $ref: '#/components/schemas/GETPaymentPartTypewithSuccess' type: array success: type: boolean type: object GETPaymentPartTypewithSuccess: properties: amount: format: double type: number createdById: type: string createdDate: format: date-time type: string debitMemoId: type: string id: type: string invoiceId: type: string organizationLabel: type: string updatedById: type: string updatedDate: format: date-time type: string title: parts type: object GETPaymentPartType: properties: amount: format: double type: number createdById: type: string createdDate: format: date-time type: string debitMemoId: type: string id: type: string invoiceId: type: string organizationLabel: type: string success: type: boolean updatedById: type: string updatedDate: format: date-time type: string type: object GETPaymentItemPartCollectionType: properties: itemParts: items: $ref: '#/components/schemas/GETPaymentItemPartTypewithSuccess' type: array nextPage: format: URL type: string success: type: boolean type: object GETPaymentItemPartTypewithSuccess: properties: amount: format: double type: number createdById: type: string createdDate: format: date-time type: string debitMemoItemId: type: string id: type: string invoiceItemId: type: string organizationLabel: type: string taxItemId: type: string updatedById: type: string updatedDate: format: date-time type: string title: itemParts type: object GETPaymentItemPartType: properties: amount: format: double type: number createdById: type: string createdDate: format: date-time type: string debitMemoItemId: type: string id: type: string invoiceItemId: type: string organizationLabel: type: string success: type: boolean taxItemId: type: string updatedById: type: string updatedDate: format: date-time type: string type: object PostRefundType: allOf: - properties: comment: maxLength: 255 minLength: 0 type: string customRates: items: $ref: '#/components/schemas/PaymentWithCustomRatesType' maxItems: 2 type: array financeInformation: properties: bankAccountAccountingCode: maxLength: 100 minLength: 0 type: string transferredToAccounting: enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string unappliedPaymentAccountingCode: maxLength: 100 minLength: 0 type: string type: object gatewayOptions: properties: key: type: string value: type: string type: object methodType: enum: - ACH - Cash - Check - CreditCard - PayPal - WireTransfer - DebitCard - CreditCardReferenceTransaction - BankTransfer - Other type: string reasonCode: type: string referenceId: maxLength: 100 minLength: 0 type: string refundDate: format: date type: string secondRefundReferenceId: maxLength: 100 minLength: 0 type: string softDescriptor: maxLength: 35 type: string softDescriptorPhone: maxLength: 20 type: string totalAmount: format: double type: number type: enum: - External - Electronic type: string refundTransactionType: enum: - Chargeback - PaymentReversal type: string required: - totalAmount - type type: object - $ref: '#/components/schemas/RefundObjectNSFields' - $ref: '#/components/schemas/RefundObjectCustomFields' GETRefundPaymentType: allOf: - properties: accountId: type: string amount: format: double type: number cancelledOn: format: date-time type: string nullable: true comment: type: string createdById: type: string createdDate: format: date-time type: string creditMemoId: type: string financeInformation: properties: bankAccountAccountingCode: type: string nullable: true bankAccountAccountingCodeType: type: string nullable: true transferredToAccounting: enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string unappliedPaymentAccountingCode: type: string nullable: true unappliedPaymentAccountingCodeType: type: string nullable: true type: object gatewayId: type: string gatewayReconciliationReason: type: string nullable: true gatewayReconciliationStatus: type: string nullable: true gatewayResponse: type: string gatewayResponseCode: type: string gatewayState: enum: - MarkedForSubmission - Submitted - Settled - NotSubmitted - FailedToSettle type: string id: type: string markedForSubmissionOn: format: date-time type: string nullable: true methodType: enum: - ACH - Cash - Check - CreditCard - PayPal - WireTransfer - DebitCard - CreditCardReferenceTransaction - BankTransfer - Other type: string number: type: string organizationLabel: type: string paymentGatewayNumber: type: string paymentId: type: string paymentMethodId: type: string paymentMethodSnapshotId: type: string payoutId: type: string nullable: true reasonCode: type: string referenceId: type: string nullable: true refundDate: format: date type: string refundTransactionTime: format: date-time type: string secondRefundReferenceId: type: string nullable: true settledOn: format: date-time type: string nullable: true softDescriptor: type: string nullable: true softDescriptorPhone: type: string nullable: true status: enum: - Processed - Canceled - Error - Processing type: string submittedOn: format: date-time type: string success: type: boolean type: enum: - External - Electronic type: string updatedById: type: string updatedDate: format: date-time type: string type: object - $ref: '#/components/schemas/RefundObjectNSFields' - $ref: '#/components/schemas/RefundObjectCustomFields' PostRefundwithAutoUnapplyType: allOf: - properties: comment: maxLength: 255 minLength: 0 type: string debitMemos: items: $ref: '#/components/schemas/PaymentDebitMemoApplicationApplyRequestType' type: array financeInformation: properties: bankAccountAccountingCode: maxLength: 100 minLength: 0 type: string transferredToAccounting: enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string unappliedPaymentAccountingCode: maxLength: 100 minLength: 0 type: string type: object gatewayOptions: properties: key: type: string value: type: string type: object invoices: items: $ref: '#/components/schemas/PaymentInvoiceApplicationApplyRequestType' type: array methodType: enum: - ACH - Cash - Check - CreditCard - PayPal - WireTransfer - DebitCard - CreditCardReferenceTransaction - BankTransfer - Other type: string reasonCode: type: string referenceId: maxLength: 100 minLength: 0 type: string refundDate: format: date type: string secondRefundReferenceId: maxLength: 100 minLength: 0 type: string softDescriptor: maxLength: 35 type: string softDescriptorPhone: maxLength: 20 type: string totalAmount: format: double type: number type: enum: - External - Electronic type: string refundTransactionType: enum: - Chargeback - PaymentReversal type: string writeOff: default: false type: boolean writeOffOptions: properties: comment: maxLength: 100 type: string memoDate: format: date type: string reasonCode: type: string taxAutoCalculation: type: boolean type: object required: - type type: object - $ref: '#/components/schemas/RefundObjectNSFields' - $ref: '#/components/schemas/RefundObjectCustomFields' GETRefundPaymentTypeAutoUnapply: allOf: - properties: accountId: type: string amount: format: double type: number cancelledOn: format: date-time type: string comment: type: string createdById: type: string createdDate: format: date-time type: string creditMemoId: type: string financeInformation: properties: bankAccountAccountingCode: type: string bankAccountAccountingCodeType: type: string transferredToAccounting: enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string unappliedPaymentAccountingCode: type: string unappliedPaymentAccountingCodeType: type: string type: object gatewayId: type: string gatewayReconciliationReason: type: string gatewayReconciliationStatus: type: string gatewayResponse: type: string gatewayResponseCode: type: string gatewayState: enum: - MarkedForSubmission - Submitted - Settled - NotSubmitted - FailedToSettle type: string id: type: string markedForSubmissionOn: format: date-time type: string methodType: enum: - ACH - Cash - Check - CreditCard - PayPal - WireTransfer - DebitCard - CreditCardReferenceTransaction - BankTransfer - Other type: string number: type: string paymentGatewayNumber: type: string paymentId: type: string paymentMethodId: type: string paymentMethodSnapshotId: type: string payoutId: type: string reasonCode: type: string referenceId: type: string refundDate: format: date type: string refundTransactionTime: format: date-time type: string secondRefundReferenceId: type: string settledOn: format: date-time type: string softDescriptor: type: string softDescriptorPhone: type: string status: enum: - Processed - Canceled - Error - Processing type: string submittedOn: format: date-time type: string success: type: boolean type: enum: - External - Electronic type: string updatedById: type: string updatedDate: format: date-time type: string writeOffResults: properties: errorMessage: type: string transactions: properties: appliedAmount: format: double type: number creditMemoAmount: type: string creditMemoNumber: type: string creditMemoStatus: enum: - Draft - Posted - Canceled - Error - PendingForTax - Generating - CancelInProgress type: string invoiceNumber: type: string title: transactions type: object type: object type: object - $ref: '#/components/schemas/RefundObjectNSFields' - $ref: '#/components/schemas/RefundObjectCustomFields' TransferPaymentType: properties: accountId: type: string type: object UnapplyPaymentType: properties: debitMemos: items: $ref: '#/components/schemas/PaymentDebitMemoApplicationUnapplyRequestType' type: array effectiveDate: format: date type: string invoices: items: $ref: '#/components/schemas/PaymentInvoiceApplicationUnapplyRequestType' type: array type: object PaymentDebitMemoApplicationUnapplyRequestType: properties: amount: format: double type: number debitMemoId: type: string debitMemoNumber: type: string items: items: $ref: '#/components/schemas/PaymentDebitMemoApplicationItemUnapplyRequestType' type: array required: - amount title: debitMemos type: object PaymentInvoiceApplicationUnapplyRequestType: properties: amount: format: double type: number invoiceId: type: string invoiceNumber: type: string items: items: $ref: '#/components/schemas/PaymentInvoiceApplicationItemUnapplyRequestType' type: array required: - amount title: invoices type: object PaymentInvoiceApplicationItemUnapplyRequestType: properties: amount: format: double type: number invoiceItemId: type: string taxItemId: type: string required: - amount title: items type: object PaymentDebitMemoApplicationItemUnapplyRequestType: properties: amount: format: double type: number debitMemoItemId: type: string taxItemId: type: string required: - amount title: items type: object SummaryStatementRunRequestType: type: object properties: runType: enum: - AdHoc type: string targetAccountCategory: enum: - SingleAccount - AllAccounts - AccountsWithOpenInvoices - AccountsWithOpenBalances - AccountsWithoutInvoices - AccountsWithoutInvoicesAndOpenBalances type: string accountKey: nullable: true type: string batchName: type: string billCycleDay: nullable: true type: string dateRangeType: enum: - Custom - PreviousThreeCalendarMonth - PreviousOneCalendarMonth type: string startDate: format: date type: string endDate: format: date type: string autoEmailEnabled: type: boolean required: - runType - targetAccountCategory - dateRangeType SummaryStatementRunResponse: properties: id: type: string statementRunNumber: type: string runType: enum: - AdHoc type: string targetAccountCategory: enum: - SingleAccount - AllAccounts - AccountsWithOpenInvoices - AccountsWithOpenBalances - AccountsWithoutInvoices - AccountsWithoutInvoicesAndOpenBalances type: string accountKey: type: string nullable: true batchName: type: string billCycleDay: type: string nullable: true dateRangeType: enum: - PreviousThreeCalendarMonth - PreviousOneCalendarMonth - PreviousOneCalendarMonth type: string startDate: format: date type: string endDate: format: date type: string autoEmailEnabled: type: boolean status: enum: - Pending - Processing - Completed - Error - Terminated type: string createdById: type: string createdDate: type: string format: dateTime success: type: boolean updatedById: type: string updatedDate: type: string format: dateTime type: object GETAccountingCodesType: properties: accountingCodes: items: $ref: '#/components/schemas/GETAccountingCodeItemWithoutSuccessType' type: array nextPage: format: URL type: string success: type: boolean type: object GETAccountingCodeItemWithoutSuccessType: allOf: - properties: category: enum: - Assets - Liabilities - Equity - Revenue - Expenses type: string createdBy: type: string createdOn: format: date-time type: string glAccountName: type: string glAccountNumber: type: string id: type: string name: type: string notes: type: string status: enum: - Active - Inactive type: string type: enum: - AccountsReceivable - On-Account Receivable - Cash - OtherAssets - CustomerCashOnAccount - DeferredRevenue - SalesTaxPayable - OtherLiabilities - SalesRevenue - SalesDiscounts - OtherRevenue - OtherEquity - BadDebt - OtherExpenses type: string updatedBy: type: string updatedOn: format: date-time type: string segmentConstantValues: $ref: '#/components/schemas/SegmentConstantValuesCustomFields' type: object - $ref: '#/components/schemas/AccountingCodeObjectCustomFields' title: accountingCodes SegmentConstantValuesCustomFields: title: segmentConstantValues type: object AccountingCodeObjectCustomFields: additionalProperties: {} title: accountingCodeFieldsCustom type: object POSTAccountingCodeType: allOf: - properties: glAccountName: type: string glAccountNumber: type: string name: type: string notes: type: string type: enum: - AccountsReceivable - On-Account Receivable - Cash - OtherAssets - CustomerCashOnAccount - DeferredRevenue - SalesTaxPayable - OtherLiabilities - SalesRevenue - SalesDiscounts - OtherRevenue - OtherEquity - BadDebt - OtherExpenses type: string segmentConstantValues: $ref: '#/components/schemas/SegmentConstantValuesCustomFields' required: - name - type type: object - $ref: '#/components/schemas/AccountingCodeObjectCustomFields' POSTAccountingCodeResponseType: properties: id: type: string success: type: boolean type: object GETAccountingCodeItemType: allOf: - properties: category: enum: - Assets - Liabilities - Equity - Revenue - Expenses type: string createdBy: type: string createdOn: format: date-time type: string glAccountName: type: string glAccountNumber: type: string id: type: string name: type: string notes: type: string status: enum: - Active - Inactive type: string success: type: boolean type: enum: - AccountsReceivable - On-Account Receivable - Cash - OtherAssets - CustomerCashOnAccount - DeferredRevenue - SalesTaxPayable - OtherLiabilities - SalesRevenue - SalesDiscounts - OtherRevenue - OtherEquity - BadDebt - OtherExpenses type: string updatedBy: type: string updatedOn: format: date-time type: string segmentConstantValues: $ref: '#/components/schemas/SegmentConstantValuesCustomFields' type: object - $ref: '#/components/schemas/AccountingCodeObjectCustomFields' PUTAccountingCodeType: allOf: - properties: glAccountName: type: string glAccountNumber: type: string name: type: string notes: type: string type: enum: - AccountsReceivable - On-Account Receivable - Cash - OtherAssets - CustomerCashOnAccount - DeferredRevenue - SalesTaxPayable - OtherLiabilities - SalesRevenue - SalesDiscounts - OtherRevenue - OtherEquity - BadDebt - OtherExpenses type: string segmentConstantValues: $ref: '#/components/schemas/SegmentConstantValuesCustomFields' type: object - $ref: '#/components/schemas/AccountingCodeObjectCustomFields' GETAccountingPeriodsType: properties: accountingPeriods: items: $ref: '#/components/schemas/GETAccountingPeriodWithoutSuccessType' type: array nextPage: format: URL type: string success: type: boolean type: object GETAccountingPeriodWithoutSuccessType: allOf: - properties: createdBy: type: string createdOn: format: date-time type: string endDate: format: date type: string fileIds: properties: accountsReceivableAccountAgingDetailExportFileId: type: string accountsReceivableInvoiceAgingDetailExportFileId: type: string arRollForwardDetailExportFileId: type: string fxRealizedGainAndLossDetailExportFileId: type: string fxUnrealizedGainAndLossDetailExportFileId: type: string revenueDetailCsvFileId: type: string revenueDetailExcelFileId: type: string unprocessedChargesFileId: type: string type: object fiscalYear: type: integer fiscalQuarter: type: integer id: type: string name: type: string notes: type: string organizationLabels: items: properties: organizationId: type: string organizationName: type: string type: object type: array runTrialBalanceEnd: format: date-time type: string runTrialBalanceErrorMessage: type: string runTrialBalanceStart: format: date-time type: string runTrialBalanceStatus: type: string startDate: format: date type: string status: type: string updatedBy: type: string updatedOn: format: date-time type: string type: object - $ref: '#/components/schemas/AccountingPeriodObjectCustomFields' title: accountingPeriods AccountingPeriodObjectCustomFields: additionalProperties: {} title: accountingPeriodFieldsCustom type: object POSTAccountingPeriodType: allOf: - properties: endDate: format: date type: string fiscalYear: type: integer fiscalQuarter: type: integer minimum: 1 maximum: 4 name: type: string notes: type: string organizationLabels: items: properties: organizationId: type: string organizationName: type: string type: object type: array startDate: format: date type: string required: - name - startDate - endDate - fiscalYear type: object - $ref: '#/components/schemas/AccountingPeriodObjectCustomFields' POSTAccountingPeriodResponseType: properties: id: type: string success: type: boolean type: object GETAccountingPeriodType: allOf: - properties: createdBy: type: string createdOn: format: date-time type: string endDate: format: date type: string fileIds: properties: accountsReceivableAccountAgingDetailExportFileId: type: string accountsReceivableInvoiceAgingDetailExportFileId: type: string accountsReceivableDebitMemoAgingDetailExportFileId: type: string arRollForwardDetailExportFileId: type: string fxRealizedGainAndLossDetailExportFileId: type: string fxUnrealizedGainAndLossDetailExportFileId: type: string revenueDetailCsvFileId: type: string revenueDetailExcelFileId: type: string unprocessedChargesFileId: type: string type: object fiscalYear: type: integer fiscalQuarter: type: integer id: type: string name: type: string notes: type: string organizationLabels: items: properties: organizationId: type: string organizationName: type: string type: object type: array runTrialBalanceEnd: format: date-time type: string runTrialBalanceErrorMessage: type: string runTrialBalanceStart: format: date-time type: string runTrialBalanceStatus: type: string startDate: format: date type: string status: type: string success: type: boolean updatedBy: type: string updatedOn: format: date-time type: string type: object - $ref: '#/components/schemas/AccountingPeriodObjectCustomFields' PUTAccountingPeriodType: allOf: - properties: endDate: format: date type: string fiscalYear: type: integer fiscalQuarter: type: integer minimum: 1 maximum: 4 name: type: string notes: type: string startDate: format: date type: string type: object - $ref: '#/components/schemas/AccountingPeriodObjectCustomFields' POSTJournalEntryType: allOf: - properties: accountingPeriodName: type: string currency: type: string journalEntryDate: format: date type: string journalEntryItems: items: $ref: '#/components/schemas/POSTJournalEntryItemType' type: array notes: type: string organizationLabel: type: string segments: items: $ref: '#/components/schemas/POSTJournalEntrySegmentType' type: array transferredToAccounting: enum: - 'No' - Processing - 'Yes' - Error - Ignore type: string required: - journalEntryDate - accountingPeriodName - currency - journalEntryItems type: object - $ref: '#/components/schemas/JournalEntryObjectCustomFields' POSTJournalEntryResponseType: properties: journalEntryNumber: type: string success: type: boolean type: object POSTJournalEntryItemType: allOf: - properties: accountingCodeName: type: string accountingCodeType: enum: - AccountsReceivable - On-Account Receivable - Cash - OtherAssets - CustomerCashOnAccount - DeferredRevenue - SalesTaxPayable - OtherLiabilities - SalesRevenue - SalesDiscounts - OtherRevenue - OtherEquity - BadDebt - OtherExpenses type: string amount: format: decimal type: string homeCurrencyAmount: format: decimal type: string type: enum: - Credit - Debit type: string required: - accountingCodeName - type - amount type: object - $ref: '#/components/schemas/JournalEntryItemObjectCustomFields' title: journalEntryItems POSTJournalEntrySegmentType: properties: segmentName: type: string segmentValue: type: string required: - segmentName - segmentValue title: segments type: object JournalEntryObjectCustomFields: additionalProperties: {} title: journalEntryFieldsCustom type: object JournalEntryItemObjectCustomFields: additionalProperties: {} title: journalEntryItemFieldsCustom type: object GETJournalEntriesInJournalRunType: properties: journalEntries: items: $ref: '#/components/schemas/GETJournalEntryDetailTypeWithoutSuccess' type: array nextPage: format: URL type: string success: type: boolean type: object GETJournalEntryDetailTypeWithoutSuccess: allOf: - properties: accountingPeriodName: type: string aggregateCurrency: type: boolean currency: type: string homeCurrency: type: string journalEntryDate: format: date type: string journalEntryItems: items: $ref: '#/components/schemas/GETJournalEntryItemType' type: array notes: type: string number: type: string organizationLabel: type: string segments: items: $ref: '#/components/schemas/GETJournalEntrySegmentType' type: array status: enum: - Created - Cancelled type: string timePeriodEnd: format: date type: string timePeriodStart: format: date type: string transactionType: type: string transferDateTime: format: date-time type: string transferredBy: type: string transferredToAccounting: enum: - 'No' - Processing - 'Yes' - Error - Ignore type: string type: object - $ref: '#/components/schemas/JournalEntryObjectCustomFields' title: journalEntries GETJournalEntryItemType: allOf: - properties: accountingCodeName: type: string accountingCodeType: enum: - AccountsReceivable - On-Account Receivable - Cash - OtherAssets - CustomerCashOnAccount - DeferredRevenue - SalesTaxPayable - OtherLiabilities - SalesRevenue - SalesDiscounts - OtherRevenue - OtherEquity - BadDebt - OtherExpenses type: string amount: format: decimal type: string glAccountName: type: string glAccountNumber: type: string homeCurrencyAmount: format: decimal type: string type: enum: - Credit - Debit type: string type: object - $ref: '#/components/schemas/JournalEntryItemObjectCustomFields' title: journalEntryItems GETJournalEntrySegmentType: properties: segmentName: type: string segmentValue: type: string title: segments type: object GETJournalEntryDetailType: allOf: - properties: accountingPeriodName: type: string aggregateCurrency: type: boolean currency: type: string homeCurrency: type: string journalEntryDate: format: date type: string journalEntryItems: items: $ref: '#/components/schemas/GETJournalEntryItemType' type: array notes: type: string number: type: string organizationLabel: type: string segments: items: $ref: '#/components/schemas/GETJournalEntrySegmentType' type: array status: enum: - Created - Cancelled type: string success: type: boolean timePeriodEnd: format: date type: string timePeriodStart: format: date type: string transactionType: type: string transferDateTime: format: date-time type: string transferredBy: type: string transferredToAccounting: enum: - 'No' - Processing - 'Yes' - Error - Ignore type: string type: object - $ref: '#/components/schemas/JournalEntryObjectCustomFields' PUTBasicSummaryJournalEntryType: allOf: - properties: journalEntryItems: items: $ref: '#/components/schemas/PUTJournalEntryItemType' type: array notes: type: string transferredToAccounting: enum: - 'No' - Processing - 'Yes' - Error - Ignore type: string type: object - $ref: '#/components/schemas/JournalEntryObjectCustomFields' PUTJournalEntryItemType: allOf: - properties: accountingCodeName: type: string accountingCodeType: enum: - AccountsReceivable - On-Account Receivable - Cash - OtherAssets - CustomerCashOnAccount - DeferredRevenue - SalesTaxPayable - OtherLiabilities - SalesRevenue - SalesDiscounts - OtherRevenue - OtherEquity - BadDebt - OtherExpenses type: string type: enum: - Credit - Debit type: string required: - accountingCodeName - type type: object - $ref: '#/components/schemas/JournalEntryItemObjectCustomFields' title: journalEntryItems POSTJournalRunType: properties: accountingPeriodName: type: string journalEntryDate: format: date type: string organizationLabels: properties: organizationId: type: string organizationName: type: string type: object targetEndDate: format: date type: string targetStartDate: format: date type: string transactionTypes: items: $ref: '#/components/schemas/POSTJournalRunTransactionType' type: array required: - transactionTypes - journalEntryDate type: object POSTJournalRunResponseType: properties: journalRunNumber: type: string success: type: boolean type: object POSTJournalRunTransactionType: properties: type: enum: - Invoice Item - Taxation Item - Invoice Item Adjustment (Invoice) - Invoice Item Adjustment (Tax) - Invoice Adjustment - Electronic Payment - External Payment - Electronic Refund - External Refund - Electronic Credit Balance Payment - External Credit Balance Payment - Electronic Credit Balance Refund - External Credit Balance Refund - Credit Balance Adjustment (Applied from Credit Balance) - Credit Balance Adjustment (Transferred to Credit Balance) - Revenue Event Item - Debit Memo Item (Charge) - Debit Memo Item (Tax) - Credit Memo Item (Charge) - Credit Memo Item (Tax) - Credit Memo Application Item - Electronic Payment Application - External Payment Application - Electronic Refund Application - External Refund Application - Electronic Payment Application Item - External Payment Application Item - Electronic Refund Application Item - External Refund Application Item type: string required: - type title: transactionTypes type: object GETJournalRunType: properties: aggregateCurrency: type: boolean executedOn: format: date-time type: string journalEntryDate: format: date type: string number: type: string organizationLabels: items: properties: organizationId: type: string organizationName: type: string type: object type: array segmentationRuleName: type: string status: enum: - Pending - Processing - Completed - Error - CancelInprogress - Cancelled - DeleteInprogress type: string success: type: boolean targetEndDate: format: date type: string targetStartDate: format: date type: string totalJournalEntryCount: format: int64 type: integer transactionTypes: items: $ref: '#/components/schemas/GETJournalRunTransactionType' type: array type: object GETJournalRunTransactionType: properties: type: enum: - Invoice Item - Taxation Item - Invoice Item Adjustment (Invoice) - Invoice Item Adjustment (Tax) - Invoice Adjustment - Electronic Payment - External Payment - Electronic Refund - External Refund - Electronic Credit Balance Payment - External Credit Balance Payment - Electronic Credit Balance Refund - External Credit Balance Refund - Credit Balance Adjustment (Applied from Credit Balance) - Credit Balance Adjustment (Transferred to Credit Balance) - Revenue Event Item - Debit Memo Item (Charge) - Debit Memo Item (Tax) - Credit Memo Item (Charge) - Credit Memo Item (Tax) - Credit Memo Application Item - Electronic Payment Application - External Payment Application - Electronic Refund Application - External Refund Application - Electronic Payment Application Item - External Payment Application Item - Electronic Refund Application Item - External Refund Application Item type: string title: transactionTypes type: object POSTMassUpdateResponseType: properties: bulkKey: type: string success: type: boolean type: object GETMassUpdateType: properties: actionType: type: string endedOn: format: date-time type: string errorCount: type: string inputSize: format: int64 type: integer outputSize: format: int64 type: integer outputType: type: string outputURL: type: string processedCount: type: string startedOn: format: date-time type: string status: type: string success: type: boolean successCount: type: string totalCount: type: string uploadedBy: type: string uploadedOn: format: date-time type: string type: object PostEventTriggerRequest: properties: active: type: boolean baseObject: maxLength: 100 minLength: 1 type: string condition: maxLength: 5000 minLength: 1 type: string eventType: $ref: '#/components/schemas/EventType' required: - baseObject - condition - eventType - active type: object EventTrigger: properties: active: type: boolean baseObject: maxLength: 100 minLength: 1 type: string condition: maxLength: 5000 minLength: 1 type: string eventType: $ref: '#/components/schemas/EventType' id: format: uuid type: string type: object EventType: properties: displayName: maxLength: 500 minLength: 1 type: string name: maxLength: 200 minLength: 1 type: string required: - name - displayName type: object PutEventTriggerRequest: properties: active: type: boolean condition: maxLength: 5000 minLength: 1 type: string eventType: properties: displayName: maxLength: 500 minLength: 1 type: string type: object type: object PostScheduledEventRequest: properties: active: default: true type: boolean apiField: type: string apiObject: type: string condition: maxLength: 65535 type: string displayName: maxLength: 500 minLength: 1 type: string hours: maximum: 23 minimum: 0 type: integer minutes: maximum: 59 minimum: 0 type: integer name: maxLength: 200 minLength: 1 type: string parameters: additionalProperties: properties: displayName: maxLength: 255 type: string options: items: type: string type: array valueType: enum: - STRING - BYTE - SHORT - CHARACTER - INTEGER - LONG - FLOAT - DOUBLE - BOOLEAN - BIG_INTEGER - BIG_DECIMAL - LOCAL_DATE - LOCAL_DATE_TIME - TIMESTAMP - BYTE_ARRAY - SHORT_ARRAY - CHARACTER_ARRAY - INTEGER_ARRAY - FLOAT_ARRAY - DOUBLE_ARRAY - BOOLEAN_ARRAY - STRING_ARRAY - BIG_INTEGER_ARRAY - BIG_DECIMAL_ARRAY - LOCAL_DATE_ARRAY - LOCAL_DATE_TIME_ARRAY - TIMESTAMP_ARRAY type: string type: object type: object required: - name - displayName - apiObject - apiField - hours - minutes type: object GetScheduledEventResponse: properties: active: type: boolean apiField: type: string apiObject: type: string condition: type: string cronExpression: type: string displayName: type: string id: format: uuid type: string name: type: string namespace: type: string parameters: additionalProperties: properties: displayName: maxLength: 255 type: string options: items: type: string type: array valueType: type: string type: object type: object title: ScheduledEvent type: object PutScheduledEventRequest: properties: active: type: boolean condition: maxLength: 65535 type: string displayName: maxLength: 500 minLength: 1 type: string hours: maximum: 23 minimum: 0 type: integer minutes: maximum: 59 minimum: 0 type: integer parameters: additionalProperties: properties: displayName: maxLength: 255 type: string options: items: type: string type: array valueType: enum: - STRING - BYTE - SHORT - CHARACTER - INTEGER - LONG - FLOAT - DOUBLE - BOOLEAN - BIG_INTEGER - BIG_DECIMAL - LOCAL_DATE - LOCAL_DATE_TIME - TIMESTAMP - BYTE_ARRAY - SHORT_ARRAY - CHARACTER_ARRAY - INTEGER_ARRAY - FLOAT_ARRAY - DOUBLE_ARRAY - BOOLEAN_ARRAY - STRING_ARRAY - BIG_INTEGER_ARRAY - BIG_DECIMAL_ARRAY - LOCAL_DATE_ARRAY - LOCAL_DATE_TIME_ARRAY - TIMESTAMP_ARRAY type: string type: object type: object type: object POSTPublicNotificationDefinitionRequest: properties: active: default: true type: boolean associatedAccount: type: string callout: oneOf: - $ref: '#/components/schemas/POSTPublicNotificationDefinitionCalloutCommon' - $ref: '#/components/schemas/POSTPublicNotificationDefinitionCalloutBasicAuthentication' - $ref: '#/components/schemas/POSTPublicNotificationDefinitionCalloutOauth2Authentication' calloutActive: default: false type: boolean calloutTemplateIds: items: type: string type: array communicationProfileId: type: string communicationProfileIds: items: type: string type: array emailActive: default: false type: boolean emailTemplateId: format: uuid type: string eventCategory: type: number eventTypeName: minLength: 1 type: string eventTypeNamespace: type: string enum: - user.notification - com.zuora.notification default: user.notification filterRule: properties: condition: type: string parameters: $ref: '#/components/schemas/FilterRuleParameterDefinitions' required: - condition - parameters type: object filterRuleParams: $ref: '#/components/schemas/FilterRuleParameterValues' name: maxLength: 255 type: string required: - name type: object GETPublicNotificationDefinitionResponse: properties: active: type: boolean associatedAccount: type: string callout: properties: active: default: true type: boolean calloutAuth: $ref: '#/components/schemas/CalloutAuth' calloutBaseurl: format: url minLength: 10 type: string calloutParams: $ref: '#/components/schemas/CalloutMergeFields' calloutRetry: default: true type: boolean eventTypeName: minLength: 1 type: string httpMethod: enum: - POST - GET - PUT - PATCH - DELETE type: string id: format: uuid type: string name: maxLength: 255 type: string oauth2ProviderId: type: string requiredAuth: type: boolean requiredOauth2: type: boolean type: object calloutActive: type: boolean calloutTemplateIds: items: type: string type: array communicationProfileId: format: uuid type: string communicationProfileIds: items: type: string type: array createdBy: format: uuid type: string createdOn: format: date-time type: string emailActive: type: boolean emailTemplateId: format: uuid type: string eventCategory: type: number eventId: type: string format: uuid eventTypeName: minLength: 1 type: string eventTypeNamespace: type: string enum: - user.notification - com.zuora.notification filterRule: properties: condition: type: string eventTypeName: minLength: 1 type: string id: format: uuid type: string parameters: $ref: '#/components/schemas/FilterRuleParameterDefinitions' type: object filterRuleParams: $ref: '#/components/schemas/FilterRuleParameterValues' id: format: uuid type: string name: maxLength: 255 type: string updatedBy: format: uuid type: string updatedOn: format: date-time type: string type: object CalloutAuth: properties: domain: type: string password: type: string preemptive: type: boolean username: type: string type: object nullable: true CalloutMergeFields: additionalProperties: type: string title: calloutParams type: object FilterRuleParameterDefinitions: additionalProperties: $ref: '#/components/schemas/FilterRuleParameterDefinition' title: parameters type: object FilterRuleParameterValues: additionalProperties: type: string title: filterRuleParams type: object FilterRuleParameterDefinition: properties: displayName: maxLength: 255 type: string options: items: type: string type: array valueType: enum: - STRING - BYTE - SHORT - CHARACTER - INTEGER - LONG - FLOAT - DOUBLE - BOOLEAN - BIG_INTEGER - BIG_DECIMAL - LOCAL_DATE - LOCAL_DATE_TIME - TIMESTAMP - BYTE_ARRAY - SHORT_ARRAY - CHARACTER_ARRAY - INTEGER_ARRAY - FLOAT_ARRAY - DOUBLE_ARRAY - BOOLEAN_ARRAY - STRING_ARRAY - BIG_INTEGER_ARRAY - BIG_DECIMAL_ARRAY - LOCAL_DATE_ARRAY - LOCAL_DATE_TIME_ARRAY - TIMESTAMP_ARRAY type: string title: parameter type: object POSTPublicNotificationDefinitionCalloutCommon: title: Callout - without authentication properties: active: default: true type: boolean calloutBaseurl: format: url minLength: 10 type: string calloutParams: $ref: '#/components/schemas/CalloutMergeFields' calloutRetry: default: true type: boolean eventTypeName: minLength: 1 type: string httpMethod: enum: - POST - GET - PUT - PATCH - DELETE type: string name: maxLength: 255 type: string required: - name - calloutBaseurl - httpMethod type: object POSTPublicNotificationDefinitionCalloutBasicAuthentication: title: Callout - Base authentication allOf: - $ref: '#/components/schemas/POSTPublicNotificationDefinitionCalloutCommon' - type: object properties: requiredAuth: type: boolean calloutAuth: $ref: '#/components/schemas/CalloutAuth' required: - requiredAuth POSTPublicNotificationDefinitionCalloutOauth2Authentication: title: Callout - OAuth 2.0 authentication allOf: - $ref: '#/components/schemas/POSTPublicNotificationDefinitionCalloutCommon' - type: object properties: requiredOauth2: type: boolean oauth2ProviderId: {} required: - requiredOauth2 PUTPublicNotificationDefinitionRequest: properties: active: default: true type: boolean associatedAccount: type: string callout: oneOf: - $ref: '#/components/schemas/PUTPublicNotificationDefinitionCalloutCommon' - $ref: '#/components/schemas/PUTPublicNotificationDefinitionCalloutBasicAuthentication' - $ref: '#/components/schemas/PUTPublicNotificationDefinitionCalloutOauth2Authentication' calloutActive: default: false type: boolean calloutTemplateIds: items: type: string type: array communicationProfileId: format: uuid type: string communicationProfileIds: items: type: string type: array emailActive: default: false type: boolean emailTemplateId: format: uuid type: string filterRule: properties: condition: type: string parameters: $ref: '#/components/schemas/FilterRuleParameterDefinitions' required: - eventTypeName - condition - parameters type: object filterRuleParams: $ref: '#/components/schemas/FilterRuleParameterValues' name: maxLength: 255 type: string type: object PUTPublicNotificationDefinitionCalloutCommon: title: Callout - without authentication properties: active: default: true type: boolean calloutBaseurl: format: url minLength: 10 type: string calloutParams: $ref: '#/components/schemas/CalloutMergeFields' calloutRetry: default: true type: boolean httpMethod: enum: - POST - GET - PUT - PATCH - DELETE type: string name: maxLength: 255 type: string type: object PUTPublicNotificationDefinitionCalloutBasicAuthentication: title: Callout - Base authentication allOf: - $ref: '#/components/schemas/PUTPublicNotificationDefinitionCalloutCommon' - type: object properties: requiredAuth: type: boolean calloutAuth: $ref: '#/components/schemas/CalloutAuth' PUTPublicNotificationDefinitionCalloutOauth2Authentication: title: Callout - OAuth 2.0 authentication allOf: - $ref: '#/components/schemas/PUTPublicNotificationDefinitionCalloutCommon' - type: object properties: requiredOauth2: type: boolean oauth2ProviderId: {} POSTCreateOrUpdateEmailTemplateRequest: properties: allowPartialSuccess: type: boolean emailTemplates: items: $ref: '#/components/schemas/POSTCreateOrUpdateEmailTemplateRequestFormat' type: array type: object CreateOrUpdateEmailTemplatesResponse: properties: reasons: items: type: string type: array type: object POSTCreateOrUpdateEmailTemplateRequestFormat: properties: active: default: true type: boolean bccEmailAddress: format: email type: string ccEmailAddress: type: string ccEmailType: default: SpecificEmails enum: - BillToContact - SoldToContact - ShipToContact - SpecificEmails - TenantAdmin - BillToAndSoldToContacts - RunOwner - AllContacts - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts type: string emailBody: type: string emailHeaders: type: object title: emailHeader additionalProperties: type: string emailSubject: type: string encodingType: default: UTF8 enum: - UTF8 - Shift_JIS - ISO_2022_JP - EUC_JP - X_SJIS_0213 type: string eventCategory: type: number eventTypeName: type: string eventTypeNamespace: type: string fromEmailAddress: type: string fromEmailType: enum: - TenantEmail - RunOwner - SpecificEmail type: string fromName: type: string id: type: string isHtml: default: false type: boolean name: maxLength: 255 type: string replyToEmailAddress: type: string replyToEmailType: enum: - TenantEmail - RunOwner - SpecificEmail type: string toEmailAddress: type: string toEmailType: enum: - BillToContact - SoldToContact - ShipToContact - SpecificEmails - TenantAdmin - BillToAndSoldToContacts - RunOwner - AllContacts - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts type: string required: - name - fromEmailType - emailSubject - emailBody - toEmailType type: object POSTPublicEmailTemplateRequest: properties: active: default: true type: boolean bccEmailAddress: format: email type: string ccEmailAddress: type: string ccEmailType: default: SpecificEmails enum: - BillToContact - SoldToContact - ShipToContact - SpecificEmails - TenantAdmin - BillToAndSoldToContacts - RunOwner - AllContacts - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts type: string emailBody: type: string emailHeaders: type: object title: emailHeader additionalProperties: type: string emailSubject: type: string encodingType: default: UTF8 enum: - UTF8 - Shift_JIS - ISO_2022_JP - EUC_JP - X_SJIS_0213 type: string eventCategory: type: number eventTypeName: type: string eventTypeNamespace: type: string fromEmailAddress: type: string fromEmailType: enum: - TenantEmail - RunOwner - SpecificEmail type: string fromName: type: string isHtml: default: false type: boolean name: maxLength: 255 type: string replyToEmailAddress: type: string replyToEmailType: enum: - TenantEmail - RunOwner - SpecificEmail type: string toEmailAddress: type: string toEmailType: enum: - BillToContact - SoldToContact - ShipToContact - SpecificEmails - TenantAdmin - BillToAndSoldToContacts - RunOwner - AllContacts - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts type: string required: - name - fromEmailType - emailSubject - emailBody - toEmailType type: object GETPublicEmailTemplateResponse: properties: active: type: boolean bccEmailAddress: format: email type: string ccEmailAddress: type: string ccEmailType: default: SpecificEmails enum: - BillToContact - SoldToContact - ShipToContact - SpecificEmails - TenantAdmin - BillToAndSoldToContacts - RunOwner - AllContacts - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts type: string createdBy: format: uuid type: string createdOn: format: date-time type: string emailBody: type: string emailHeaders: type: object title: emailHeader additionalProperties: type: string emailSubject: type: string encodingType: enum: - UTF8 - Shift_JIS - ISO_2022_JP - EUC_JP - X_SJIS_0213 type: string eventCategory: type: number eventTypeName: minLength: 1 type: string eventTypeNamespace: type: string fromEmailAddress: type: string fromEmailType: enum: - TenantEmail - RunOwner - SpecificEmail type: string fromName: maxLength: 50 type: string id: format: uuid type: string isHtml: type: boolean name: maxLength: 255 type: string replyToEmailAddress: type: string replyToEmailType: enum: - TenantEmail - RunOwner - SpecificEmail type: string toEmailAddress: type: string toEmailType: enum: - BillToContact - SoldToContact - ShipToContact - SpecificEmails - TenantAdmin - BillToAndSoldToContacts - RunOwner - AllContacts - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts type: string updatedBy: format: uuid type: string updatedOn: format: date-time type: string type: object PUTPublicEmailTemplateRequest: properties: active: type: boolean bccEmailAddress: format: email type: string ccEmailAddress: type: string ccEmailType: default: SpecificEmails enum: - BillToContact - SoldToContact - ShipToContact - SpecificEmails - TenantAdmin - BillToAndSoldToContacts - RunOwner - AllContacts - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts type: string emailBody: type: string emailHeaders: type: object title: emailHeader additionalProperties: type: string emailSubject: type: string encodingType: enum: - UTF8 - Shift_JIS - ISO_2022_JP - EUC_JP - X_SJIS_0213 type: string fromEmailAddress: type: string fromEmailType: enum: - TenantEmail - RunOwner - SpecificEmail type: string fromName: type: string isHtml: type: boolean name: maxLength: 255 type: string replyToEmailAddress: type: string replyToEmailType: enum: - TenantEmail - RunOwner - SpecificEmail type: string toEmailAddress: type: string toEmailType: enum: - BillToContact - SoldToContact - ShipToContact - SpecificEmails - TenantAdmin - BillToAndSoldToContacts - RunOwner - AllContacts - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts type: string type: object POSTCreateOrUpdateCalloutTemplateRequest: properties: allowPartialSuccess: type: boolean calloutTemplates: items: oneOf: - $ref: '#/components/schemas/POSTCreateOrUpdateCalloutTemplateRequestCommon' - $ref: '#/components/schemas/POSTCreateOrUpdateCalloutTemplateRequestBasicAuthentication' - $ref: '#/components/schemas/POSTCreateOrUpdateCalloutTemplateRequestOauth2Authentication' type: array type: object POSTCreateOrUpdateCalloutTemplateRequestCommon: title: Callout - without authentication properties: active: default: true type: boolean calloutBaseurl: format: url minLength: 10 type: string calloutHeaders: type: object title: calloutHeader additionalProperties: type: string calloutParams: type: object title: calloutParameter additionalProperties: type: string calloutRetry: default: true type: boolean certificate: type: string customRequestBody: type: string eventCategory: type: number eventTypeName: minLength: 1 type: string eventTypeNamespace: type: string enum: - user.notification - com.zuora.notification default: user.notification hmacAlgorithm: type: string enum: - MD5 - SHA-1 - SHA-224 - SHA-256 - SHA-384 - SHA-512 hmacData: type: string hmacKey: type: string hmacOutputFormat: type: string enum: - BASE64 - HEX hmacSecret: type: string hmacValue: type: string httpMethod: enum: - POST - GET - PUT - PATCH - DELETE type: string id: type: string name: maxLength: 255 type: string useCustomRequestBody: type: boolean required: - name - calloutBaseurl - httpMethod type: object POSTCreateOrUpdateCalloutTemplateRequestBasicAuthentication: title: Callout - Base authentication allOf: - $ref: '#/components/schemas/POSTCreateOrUpdateCalloutTemplateRequestCommon' - type: object properties: requiredAuth: type: boolean calloutAuth: $ref: '#/components/schemas/CalloutAuth' POSTCreateOrUpdateCalloutTemplateRequestOauth2Authentication: title: Callout - OAuth 2.0 authentication allOf: - $ref: '#/components/schemas/POSTCreateOrUpdateCalloutTemplateRequestCommon' - type: object properties: requiredOauth2: type: boolean oauth2ProviderId: {} POSTPublicCalloutTemplateRequest: oneOf: - $ref: '#/components/schemas/POSTPublicCalloutTemplateRequestCommon' - $ref: '#/components/schemas/POSTPublicCalloutTemplateRequestBasicAuthentication' - $ref: '#/components/schemas/POSTPublicCalloutTemplateRequestOauth2Authentication' GETPublicCalloutTemplateResponse: properties: active: type: boolean calloutAuth: $ref: '#/components/schemas/CalloutAuth' calloutBaseurl: format: url minLength: 10 type: string calloutHeaders: type: object title: calloutHeader additionalProperties: type: string nullable: true calloutParams: type: object title: calloutParameter additionalProperties: type: string nullable: true calloutRetry: type: boolean certificate: type: string nullable: true contentType: type: string createdBy: format: uuid type: string createdOn: format: date-time type: string customRequestBody: type: string nullable: true eventCategory: type: number eventTypeName: minLength: 1 type: string eventTypeNamespace: type: string enum: - user.notification - com.zuora.notification hmacAlgorithm: type: string nullable: true enum: - MD5 - SHA-1 - SHA-224 - SHA-256 - SHA-384 - SHA-512 - null hmacData: type: string nullable: true hmacKey: type: string nullable: true hmacOutputFormat: type: string nullable: true enum: - BASE64 - HEX - null hmacSecret: type: string nullable: true hmacValue: type: string nullable: true httpMethod: enum: - POST - GET - PUT - PATCH - DELETE type: string id: format: uuid type: string name: maxLength: 255 type: string oauth2ProviderId: type: string nullable: true requiredAuth: type: boolean requiredOauth2: type: boolean updatedBy: format: uuid type: string updatedOn: format: date-time type: string useCustomRequestBody: type: boolean type: object POSTPublicCalloutTemplateRequestCommon: title: Callout - without authentication properties: active: default: true type: boolean calloutBaseurl: format: url minLength: 10 type: string calloutHeaders: type: object title: calloutHeader additionalProperties: type: string calloutParams: type: object title: calloutParameter additionalProperties: type: string calloutRetry: default: true type: boolean certificate: type: string customRequestBody: type: string eventCategory: type: number eventTypeName: minLength: 1 type: string eventTypeNamespace: type: string enum: - user.notification - com.zuora.notification default: user.notification hmacAlgorithm: type: string enum: - MD5 - SHA-1 - SHA-224 - SHA-256 - SHA-384 - SHA-512 hmacData: type: string hmacKey: type: string hmacOutputFormat: type: string enum: - BASE64 - HEX hmacSecret: type: string hmacValue: type: string httpMethod: enum: - POST - GET - PUT - PATCH - DELETE type: string name: maxLength: 255 type: string useCustomRequestBody: type: boolean required: - name - calloutBaseurl - httpMethod type: object POSTPublicCalloutTemplateRequestBasicAuthentication: title: Callout - Base authentication allOf: - $ref: '#/components/schemas/POSTPublicCalloutTemplateRequestCommon' - type: object properties: requiredAuth: type: boolean calloutAuth: $ref: '#/components/schemas/CalloutAuth' required: - requiredAuth POSTPublicCalloutTemplateRequestOauth2Authentication: title: Callout - OAuth 2.0 authentication allOf: - $ref: '#/components/schemas/POSTPublicCalloutTemplateRequestCommon' - type: object properties: requiredOauth2: type: boolean oauth2ProviderId: {} required: - requiredOauth2 PUTPublicCalloutTemplateRequest: oneOf: - $ref: '#/components/schemas/PUTPublicCalloutTemplateRequestCommon' - $ref: '#/components/schemas/PUTPublicCalloutTemplateRequestBasicAuthentication' - $ref: '#/components/schemas/PUTPublicCalloutTemplateRequestOauth2Authentication' PUTPublicCalloutTemplateRequestCommon: title: Callout - without authentication properties: active: default: true type: boolean calloutBaseurl: format: url minLength: 10 type: string calloutHeaders: type: object title: calloutHeader additionalProperties: type: string calloutParams: type: object title: calloutParameter additionalProperties: type: string calloutRetry: default: true type: boolean certificate: type: string customRequestBody: type: string hmacAlgorithm: type: string enum: - MD5 - SHA-1 - SHA-224 - SHA-256 - SHA-384 - SHA-512 hmacData: type: string hmacKey: type: string hmacOutputFormat: type: string enum: - BASE64 - HEX hmacSecret: type: string hmacValue: type: string httpMethod: enum: - POST - GET - PUT - PATCH - DELETE type: string name: maxLength: 255 type: string useCustomRequestBody: type: boolean type: object PUTPublicCalloutTemplateRequestBasicAuthentication: title: Callout - Base authentication allOf: - $ref: '#/components/schemas/PUTPublicCalloutTemplateRequestCommon' - type: object properties: requiredAuth: type: boolean calloutAuth: $ref: '#/components/schemas/CalloutAuth' PUTPublicCalloutTemplateRequestOauth2Authentication: title: Callout - OAuth 2.0 authentication allOf: - $ref: '#/components/schemas/PUTPublicCalloutTemplateRequestCommon' - type: object properties: requiredOauth2: type: boolean oauth2ProviderId: {} CreateOrUpdateReusableBlockRequest: properties: allowPartialSuccess: type: boolean reusableBlocks: maxItems: 1000 minItems: 1 items: $ref: '#/components/schemas/CreateOrUpdateReusableBlockFormat' type: array type: object CreateOrUpdateReusableBlockResponse: properties: reasons: items: type: string type: array type: object CreateOrUpdateReusableBlockFormat: properties: active: default: true type: boolean category: type: string enum: - Headers - Footers - Other content: type: string id: type: string name: type: string number: type: string tags: items: type: string type: array required: - category - content - name type: object CreatePublicReusableBlockRequest: properties: active: default: true type: boolean category: type: string enum: - Headers - Footers - Other content: type: string name: type: string number: type: string tags: items: type: string type: array required: - category - content - name type: object GetPublicReusableBlockResponse: properties: active: default: true type: boolean category: type: string enum: - Headers - Footers - Other content: type: string createdBy: format: uuid type: string createdOn: format: date-time type: string id: format: uuid type: string name: type: string number: type: string tags: items: type: string type: array updatedBy: format: uuid type: string updatedOn: format: date-time type: string type: object UpdatePublicReusableBlockRequest: properties: active: default: true type: boolean category: type: string enum: - Headers - Footers - Other content: type: string name: type: string number: type: string tags: items: type: string type: array type: object UpdatePublicReusableBlockResponse: properties: active: default: true type: boolean category: type: string enum: - Headers - Footers - Other content: type: string createdBy: format: uuid type: string createdOn: format: date-time type: string id: format: uuid type: string name: type: string number: type: string tags: items: type: string type: array updatedBy: format: uuid type: string updatedOn: format: date-time type: string type: object NotificationsHistoryDeletionTaskResponse: properties: accountId: format: uuid type: string createdBy: format: uuid type: string createdOn: type: integer id: format: uuid type: string status: enum: - RUNNING - FINISHED - FAILED type: string tenantId: type: string type: object POSTResendCalloutNotifications: items: type: string type: array ResendCalloutNotificationsFailedResponse: additionalProperties: properties: code: type: string message: type: string type: object type: object POSTResendEmailNotifications: items: type: string type: array ResendEmailNotificationsFailedResponse: additionalProperties: properties: code: type: string message: type: string type: object type: object GETCalloutHistoryVOsType: properties: calloutHistories: items: $ref: '#/components/schemas/GETCalloutHistoryVOType' type: array nextPage: format: URL type: string success: type: boolean type: object GETCalloutHistoryVOType: properties: attemptedNum: type: string createTime: type: string eventCategory: type: string eventContext: type: string notification: type: string requestMethod: type: string requestUrl: type: string responseCode: type: string responseContent: type: string title: calloutHistories type: object GETEmailHistoryVOsType: properties: emailHistories: items: $ref: '#/components/schemas/GETEmailHistoryVOType' type: array nextPage: format: URL type: string success: type: boolean type: object GETEmailHistoryVOType: properties: accountId: type: string bcc: type: string cc: type: string errorMessage: type: string eventCategory: type: string fromEmail: type: string notification: type: string replyTo: type: string result: type: string sendTime: type: string subject: type: string toEmail: type: string title: emailHistories type: object PostCustomObjectDefinitionsRequest: properties: definitions: $ref: '#/components/schemas/PostCustomObjectDefinitionsRequestDefinitions' type: object GETAllCustomObjectDefinitionsInNamespaceResponse: properties: count: type: integer definitions: $ref: '#/components/schemas/CustomObjectDefinitions' type: object CustomObjectDefinitions: additionalProperties: $ref: '#/components/schemas/CustomObjectDefinition' title: customObjectDefinitions type: object CustomObjectDefinition: properties: CreatedById: format: uuid type: string CreatedDate: format: date-time type: string Id: format: uuid type: string UpdatedById: format: uuid type: string UpdatedDate: format: date-time type: string schema: properties: auditable: items: type: string type: array enableCreateRecordAuditing: type: boolean enableDeleteRecordAuditing: type: boolean filterable: items: type: string type: array label: type: string object: type: string properties: $ref: '#/components/schemas/CustomObjectAllFieldsDefinition' relationships: items: additionalProperties: false properties: cardinality: default: manyToOne enum: - manyToOne - oneToMany type: string fields: $ref: '#/components/schemas/FieldsAdditionalProperties' namespace: type: string object: type: string recordConstraints: properties: create: properties: enforceValidMapping: type: boolean type: object type: object type: object type: array required: items: type: string type: array type: enum: - object type: string unique: items: type: string type: array type: object type: type: string title: customObjectDefinition type: object CustomObjectAllFieldsDefinition: allOf: - properties: CreatedById: properties: format: enum: - uuid type: string label: type: string origin: enum: - system type: string type: enum: - string type: string type: object CreatedDate: properties: format: enum: - date-time type: string origin: enum: - system type: string type: enum: - string type: string type: object Id: properties: format: enum: - uuid type: string label: type: string origin: enum: - system type: string type: enum: - string type: string type: object UpdatedById: properties: format: enum: - uuid type: string label: type: string origin: enum: - system type: string type: enum: - string type: string type: object UpdatedDate: properties: format: enum: - date-time type: string origin: enum: - system type: string type: enum: - string type: string type: object type: object - $ref: '#/components/schemas/CustomObjectCustomFieldsDefinition' title: customObjectFieldDefinition FieldsAdditionalProperties: additionalProperties: type: string title: relationshipFieldMapping type: object CustomObjectCustomFieldsDefinition: additionalProperties: $ref: '#/components/schemas/CustomObjectCustomFieldDefinition' title: customObjectCustomFieldDefinition type: object CustomObjectCustomFieldDefinition: properties: displayName: type: boolean format: type: string label: type: string maxLength: type: integer multiselect: type: boolean origin: enum: - custom type: string type: type: string title: customObjectCustomFieldDefinition type: object PostCustomObjectDefinitionsRequestDefinitions: additionalProperties: $ref: '#/components/schemas/PostCustomObjectDefinitionsRequestDefinition' title: customObjectDefinitions type: object PostCustomObjectDefinitionsRequestDefinition: properties: auditable: items: type: string type: array enableCreateRecordAuditing: default: false type: boolean enableDeleteRecordAuditing: default: false type: boolean filterable: items: type: string type: array label: type: string object: type: string properties: $ref: '#/components/schemas/PostCustomObjectDefinitionFieldsDefinitionRequest' relationships: items: additionalProperties: false properties: cardinality: enum: - manyToOne type: string fields: $ref: '#/components/schemas/FieldsAdditionalPropertiesForPostDefinition' namespace: type: string object: type: string recordConstraints: properties: create: properties: enforceValidMapping: default: true type: boolean type: object type: object required: - namespace - object - fields type: object type: array required: items: type: string type: array unique: items: type: string type: array required: - object - label title: customObjectDefinition type: object PostCustomObjectDefinitionFieldsDefinitionRequest: additionalProperties: $ref: '#/components/schemas/PostCustomObjectDefinitionFieldDefinitionRequest' title: customObjectCustomFieldDefinitions type: object FieldsAdditionalPropertiesForPostDefinition: additionalProperties: type: string title: relationshipFieldMapping type: object PostCustomObjectDefinitionFieldDefinitionRequest: properties: displayName: type: boolean format: type: string label: type: string maxLength: type: integer multiselect: type: boolean type: type: string required: - type - label title: customObjectCustomFieldDefinition type: object MigrationUpdateCustomObjectDefinitionsRequest: additionalProperties: false properties: actions: items: $ref: '#/components/schemas/CustomObjectDefinitionUpdateActionRequest' maxItems: 1 minItems: 1 type: array required: - actions type: object MigrationUpdateCustomObjectDefinitionsResponse: additionalProperties: false properties: actions: items: $ref: '#/components/schemas/CustomObjectDefinitionUpdateActionResponse' maxItems: 1 minItems: 1 type: array type: object CustomObjectDefinitionUpdateActionResponse: properties: enableCreateRecordAuditing: type: boolean enableDeleteRecordAuditing: type: boolean field: $ref: '#/components/schemas/UpdateCustomObjectCusotmField' label: type: string namespace: type: string object: type: string relationship: additionalProperties: false properties: cardinality: default: manyToOne enum: - manyToOne - oneToMany type: string fields: $ref: '#/components/schemas/FieldsAdditionalProperties' namespace: type: string object: type: string recordConstraints: properties: create: properties: enforceValidMapping: default: true type: boolean type: object type: object type: object type: enum: - addField - deleteField - updateField - updateObject - renameField - addRelationship - deleteRelationship type: string type: object UpdateCustomObjectCusotmField: properties: auditable: type: boolean definition: $ref: '#/components/schemas/CustomObjectCustomFieldDefinitionUpdate' filterable: type: boolean name: type: string required: type: boolean targetName: type: string unique: type: boolean type: object CustomObjectCustomFieldDefinitionUpdate: properties: default: type: string displayName: type: boolean format: type: string label: type: string maxLength: type: integer multiselect: type: boolean origin: enum: - custom type: string type: type: string title: customObjectCustomFieldDefinition type: object CustomObjectDefinitionUpdateActionRequest: properties: enableCreateRecordAuditing: type: boolean enableDeleteRecordAuditing: type: boolean field: $ref: '#/components/schemas/UpdateCustomObjectCusotmField' label: type: string namespace: type: string object: type: string relationship: additionalProperties: false properties: cardinality: enum: - manyToOne type: string fields: $ref: '#/components/schemas/FieldsAdditionalProperties' namespace: type: string object: type: string recordConstraints: properties: create: properties: enforceValidMapping: default: true type: boolean type: object type: object required: - namespace - object - fields type: object type: enum: - addField - deleteField - updateField - updateObject - renameField - addRelationship - deleteRelationship type: string required: - type - namespace - object type: object PostCustomObjectRecordsRequest: properties: allowPartialSuccess: default: false type: boolean records: items: $ref: '#/components/schemas/CustomObjectRecordWithOnlyCustomFields' type: array required: - records type: object PostCustomObjectRecordsResponse: properties: error: $ref: '#/components/schemas/CustomObjectRecordsErrorResponse' records: items: $ref: '#/components/schemas/CustomObjectRecordWithAllFields' type: array type: object CustomObjectRecordsErrorResponse: properties: code: format: Int32 type: integer details: items: $ref: '#/components/schemas/CustomObjectRecordsWithError' type: array message: type: string type: object ErrorResponse401Record: properties: code: format: Int32 type: integer details: items: $ref: '#/components/schemas/Error401' type: array message: type: string type: object CustomObjectRecordsThrottledResponse: properties: code: format: Int32 type: integer details: items: $ref: '#/components/schemas/CustomObjectRecordsWithError' type: array message: type: string type: object CustomObjectRecordsWithError: properties: code: enum: - 71012520 - 71012521 - 71012522 - 71012523 - 71012524 - 71012525 - 71012526 - 71012530 format: Int32 type: integer message: type: string record: $ref: '#/components/schemas/CustomObjectRecordWithAllFields' type: object CustomObjectRecordWithAllFields: allOf: - properties: CreatedById: type: string CreatedDate: format: date-time type: string Id: format: uuid maxLength: 36 minLength: 36 type: string UpdatedById: type: string UpdatedDate: format: date-time type: string type: type: string - $ref: '#/components/schemas/CustomObjectRecordWithOnlyCustomFields' title: customObjectRecord type: object CustomObjectRecordWithOnlyCustomFields: additionalProperties: {} title: customObjectRecord type: object Error401: properties: code: format: Int32 type: integer message: type: string type: object QueryCustomObjectRecordsResponse: properties: count: type: integer records: items: $ref: '#/components/schemas/CustomObjectRecordWithAllFields' type: array required: - count - records type: object CustomObjectRecordBatchRequest: properties: action: $ref: '#/components/schemas/CustomObjectRecordBatchAction' required: - action type: object CustomObjectRecordsBatchUpdatePartialSuccessResponse: properties: error: $ref: '#/components/schemas/CustomObjectRecordsErrorResponse' type: object CustomObjectRecordBatchAction: properties: allowPartialSuccess: default: false type: boolean ids: items: format: uuid type: string type: array records: $ref: '#/components/schemas/CustomObjectRecordBatchUpdateMapping' type: enum: - delete - update type: string required: - type title: updateDeleteBatchAction type: object CustomObjectRecordBatchUpdateMapping: additionalProperties: type: object title: updateIdFieldsMapping type: object CustomObjectBulkJobRequest: properties: filter: $ref: '#/components/schemas/CustomObjectBulkDeleteFilter' namespace: enum: - default - com_zuora type: string object: type: string operation: enum: - delete - create - update type: string required: - operation - object - namespace type: object CustomObjectBulkJobResponse: properties: CreatedById: format: uuid type: string CreatedDate: format: date-time type: string Id: format: uuid type: string UpdatedById: format: uuid type: string UpdatedDate: format: date-time type: string error: properties: code: format: Int32 type: integer message: type: string type: object namespace: enum: - default - com_zuora type: string object: type: string operation: enum: - delete - create - update type: string processingTime: type: integer recordsProcessed: type: integer status: enum: - accepted - pending - in_progress - completed - failed - cancelled type: string type: object CustomObjectBulkDeleteFilter: properties: conditions: items: $ref: '#/components/schemas/CustomObjectBulkDeleteFilterCondition' type: array required: - conditions type: object CustomObjectBulkDeleteFilterCondition: properties: field: type: string operator: enum: - EQ - GT - LT - GE - LE type: string value: {} required: - field - operator - value type: object CustomObjectBulkJobResponseCollection: properties: count: type: integer cursor: type: string jobs: items: $ref: '#/components/schemas/CustomObjectBulkJobResponse' type: array required: - jobs type: object CustomObjectBulkJobErrorResponseCollection: properties: errors: items: $ref: '#/components/schemas/CustomObjectBulkJobErrorResponse' type: array required: - errors type: object CustomObjectBulkJobErrorResponse: properties: code: format: Int32 type: integer message: type: string record: $ref: '#/components/schemas/CustomObjectRecordWithAllFields' row: format: Int32 type: integer type: object GetDataQueryJobsResponse: properties: data: items: $ref: '#/components/schemas/DataQueryJob' type: array type: object DataQueryJob: allOf: - $ref: '#/components/schemas/DataQueryJobCommon' - properties: dataFile: format: URL type: string outputRows: type: integer processingTime: type: integer queryStatus: enum: - submitted - accepted - in_progress - completed - failed - cancelled type: string type: object title: queryJob DataQueryJobCommon: properties: createdBy: format: uuid maxLength: 64 minLength: 64 type: string id: format: uuid maxLength: 64 minLength: 64 type: string query: type: string remainingRetries: type: integer sourceData: type: string updatedOn: format: date-time type: string useIndexJoin: type: boolean type: object SubmitDataQueryRequest: properties: columnSeparator: type: string compression: enum: - NONE - GZIP - ZIP type: string encryptionKey: format: byte type: string output: properties: target: enum: - S3 type: string required: - target type: object outputFormat: enum: - JSON - CSV - TSV - DSV type: string query: type: string readDeleted: default: false type: boolean sourceData: enum: - LIVE - WAREHOUSE type: string useIndexJoin: type: boolean warehouseSize: enum: - xsmall - 'NULL' type: string required: - query - outputFormat - compression - output type: object SubmitDataQueryResponse: properties: data: $ref: '#/components/schemas/DataQueryJob' type: object DataQueryErrorResponse: properties: code: type: integer message: type: string type: object DeleteDataQueryJobResponse: properties: data: $ref: '#/components/schemas/DataQueryJobCancelled' type: object DataQueryJobCancelled: allOf: - $ref: '#/components/schemas/DataQueryJobCommon' - properties: queryStatus: enum: - cancelled type: string type: object title: cancelledQueryJob GetDataQueryJobResponse: properties: data: $ref: '#/components/schemas/DataQueryJob' type: object SubmitBatchQueryRequest: properties: dateTimeUtc: type: boolean format: enum: - csv - zip - gzip type: string incrementalTime: format: dateTime type: string name: type: string notifyUrl: type: string nullReplacement: type: string offset: default: 0 type: integer partner: type: string project: type: string queries: items: $ref: '#/components/schemas/BatchQuery' required: - name - query type: array sourceData: enum: - LIVE type: string useQueryLabels: type: boolean version: format: float type: number type: object SubmitBatchQueryResponse: properties: batches: items: $ref: '#/components/schemas/BatchesQueries' required: - name - query - status - batchId - batchType type: array encrypted: enum: - pgp - none type: string format: enum: - csv - zip - gzip type: string id: type: string incrementalTime: format: dateTime type: string name: type: string notifyUrl: type: string offset: default: 0 type: integer partner: type: string project: type: string sourceData: type: string status: enum: - submitted - executing - completed - error - aborted - cancelled type: string useLastCompletedJobQueries: type: boolean version: format: float type: number type: object BatchesQueries: properties: apiVersion: type: string batchId: type: string batchType: enum: - zoql - zoqlexport type: string deleted: items: properties: column: type: string format: type: string title: deletedRecord type: object type: array full: type: boolean name: type: string query: type: string recordCount: type: string status: enum: - submitted - pending - executing - completed - aborted - deleted_notallowed type: string title: batch BatchQuery: properties: apiVersion: type: string convertToCurrencies: type: string deleted: items: properties: column: type: string format: type: string title: deletedRecord type: object type: array name: type: string query: type: string type: enum: - zoql - zoqlexport type: string title: query GetAggregateQueryJobResponse: properties: batches: items: $ref: '#/components/schemas/BatchesQueriesById' required: - name - query - status - batchId - batchType type: array encrypted: enum: - pgp - none type: string format: enum: - csv - zip - gzip type: string id: type: string name: type: string partner: type: string project: type: string sourceData: type: string startTime: type: string status: enum: - submitted - executing - completed - error - aborted - cancelled type: string version: format: float type: number type: object BatchesQueriesById: properties: apiVersion: type: string batchId: type: string batchType: enum: - zoql - zoqlexport type: string fileId: type: string full: type: boolean message: maximum: 2048 type: string name: type: string query: type: string recordCount: type: string segments: type: array items: {} status: enum: - submitted - pending - executing - completed - aborted - deleted_notallowed type: string title: batch DeleteBatchQueryJobResponse: properties: batches: items: $ref: '#/components/schemas/BatchQueries' required: - name - query - status - batchId - batchType type: array format: enum: - csv - zip - gzip type: string id: type: string name: type: string sourceData: type: string status: enum: - submitted - executing - completed - error - aborted - cancelled type: string version: format: float type: number type: object BatchQueries: properties: batchId: type: string batchType: enum: - zoql - zoqlexport type: string fileId: type: string message: maximum: 2048 type: string name: type: string query: type: string recordCount: type: string segments: type: array items: {} status: enum: - submitted - pending - executing - completed - aborted - deleted_notallowed type: string title: batch JsonNode: title: JsonNode type: object ConfigTemplateErrorResponse: properties: reasons: items: properties: code: type: string message: type: string type: object type: array type: object CompareSchemaInfoResponse: properties: customFields: items: $ref: '#/components/schemas/CompareSchemaKeyValue' type: array customObjects: items: $ref: '#/components/schemas/CompareSchemaKeyValue' type: array dataAccessControl: items: $ref: '#/components/schemas/CompareSchemaKeyValue' type: array metaData: $ref: '#/components/schemas/JsonNode' notifications: items: $ref: '#/components/schemas/CompareSchemaKeyValue' type: array productCatalog: items: $ref: '#/components/schemas/CompareSchemaKeyValue' type: array settings: items: $ref: '#/components/schemas/CompareSchemaKeyValue' type: array workflows: items: $ref: '#/components/schemas/CompareSchemaKeyValue' type: array title: CompareSchemaInfoResponse type: object CompareSchemaKeyValue: properties: difference: additionalProperties: items: type: string type: array type: object response: items: $ref: '#/components/schemas/MigrationComponentContent' type: array segregationKeys: items: type: string type: array title: CompareSchemaKeyValue type: object MigrationComponentContent: properties: attribute: type: string componentType: type: string currentTargetResponse: $ref: '#/components/schemas/JsonNode' disabled: type: string errorMessage: type: string httpMethods: type: string id: type: string key: type: string migratedOn: format: date-time type: string migrationId: type: string pathPattern: type: string previousTargetResponse: $ref: '#/components/schemas/JsonNode' result: type: string segregationKey: type: string sourceResponse: $ref: '#/components/schemas/JsonNode' status: type: string updateStatus: type: string title: MigrationComponentContent type: object TemplateMigrationClientRequest: properties: comments: type: string emailIds: type: string entityUuid: type: string metaData: $ref: '#/components/schemas/JsonNode' name: type: string request: items: $ref: '#/components/schemas/MigrationComponentContent' type: array sendEmail: type: boolean required: - description - entityUuid - name - sendEmail title: TemplateMigrationClientRequest type: object MigrationClientResponse: properties: emailIds: type: string environment: type: string id: type: string migratedBy: type: string migrationDescription: type: string migrationEnd: type: string migrationName: type: string migrationStart: type: string response: items: $ref: '#/components/schemas/MigrationComponentContent' type: array sourceTenantDescription: type: string sourceTenantName: type: string status: type: string type: type: string required: - id - migratedBy - migrationDescription - migrationEnd - migrationName - migrationStart - sourceTenantDescription - sourceTenantName - status title: MigrationClientResponse type: object SettingSourceComponentResponse: properties: customFields: items: $ref: '#/components/schemas/SettingComponentKeyValue' type: array customObjects: items: $ref: '#/components/schemas/SettingComponentKeyValue' type: array dataAccessControl: items: $ref: '#/components/schemas/SettingComponentKeyValue' type: array notifications: items: $ref: '#/components/schemas/SettingComponentKeyValue' type: array productCatalog: items: $ref: '#/components/schemas/SettingComponentKeyValue' type: array settings: items: $ref: '#/components/schemas/SettingComponentKeyValue' type: array workflows: items: $ref: '#/components/schemas/SettingComponentKeyValue' type: array title: SettingSourceComponentResponse type: object SettingComponentKeyValue: properties: errors: items: type: string type: array originalPayload: $ref: '#/components/schemas/JsonNode' response: items: $ref: '#/components/schemas/ConfigurationTemplateContent' type: array segregationKeys: items: type: string type: array title: SettingComponentKeyValue type: object ConfigurationTemplateContent: properties: componentType: type: string error: type: string id: type: string key: type: string method: type: string payload: $ref: '#/components/schemas/JsonNode' result: type: string segregationKey: type: string templateId: type: string url: type: string title: ConfigurationTemplateContent type: object TemplateResponse: properties: templates: items: $ref: '#/components/schemas/TemplateDetailResponse' type: array title: TemplateResponse type: object TemplateDetailResponse: properties: active: type: boolean content: $ref: '#/components/schemas/SettingSourceComponentResponse' createdBy: type: string createdOn: type: string entityName: type: string environment: type: string errors: type: string id: type: string name: type: string status: type: string tenantName: type: string title: TemplateDetailResponse type: object CreateTemplateRequestContent: properties: content: $ref: '#/components/schemas/SettingSourceComponentResponse' customFields: type: boolean customObjects: type: boolean name: type: string notifications: type: boolean selectedComponents: items: $ref: '#/components/schemas/ConfigurationTemplateContent' type: array settings: type: boolean templateTenant: type: string workflows: type: boolean required: - description - name - templateTenant title: CreateTemplateRequestContent type: object SyncDeploymentTemplateRequest: type: object properties: templateId: type: string targetTenantId: type: string required: - templateId - targetTenantId DeploymentManagerResponse: type: object properties: id: type: string status: type: string enum: - DEPLOYING - REVERTING - PARTIALLY-REVERTED - FAILED - ROLLBACK-FAILED - REVERTED - COMPARING - SUBMITTED - SKIPPED - IDENTICAL - COMPARE-DONE - COMPARE-FAILED - CANCELLED BulkJobRequest: type: object required: - name - objectType properties: name: type: string objectType: type: string mappings: type: array items: type: object required: - source - target properties: source: type: string target: type: string type: type: string enum: - array - string - number - boolean arrayType: type: string enum: - string - number - boolean headers: type: array items: type: string rowIdHeader: type: string delimiter: type: string hasHeaders: type: boolean fileType: type: string enum: - csv - jsonl jobType: type: string enum: - Import - Delete - Update - Cancel isCustomObject: type: boolean customObjectNamespace: type: string dataSourceType: type: string readOnly: true enum: - UserUpload - Salesforce - Chargebee - Stripe systemType: type: string readOnly: true enum: - BILLING CreateResponse: type: object properties: id: type: string format: uuid uploadUrl: type: string uploadRequest: type: object properties: uri: type: string format: uri fields: type: object additionalProperties: type: string status: type: string enum: - Created - Submitted - In Progress - Aborting - Completed - Failed - Aborted - Cancelled - Downloading jobType: type: string enum: - Import - Delete - Update - Cancel SubmitBulkJobResponse: type: object properties: id: type: string format: uuid uploadUrl: type: string uploadRequest: $ref: '#/components/schemas/UploadRequest' status: type: string enum: - Created - Submitted - In Progress - Aborting - Completed - Failed - Aborted - Cancelled - Downloading jobType: type: string readOnly: true enum: - Import - Delete - Update - Cancel UploadRequest: type: object properties: uri: type: string format: uri fields: type: object additionalProperties: type: string QueryJobSummaryResponse: type: object properties: id: type: string format: uuid readOnly: true name: type: string readOnly: true createdAt: type: integer format: int64 readOnly: true createdBy: type: string readOnly: true status: type: string readOnly: true enum: - Created - Submitted - In Progress - Aborting - Completed - Failed - Aborted - Cancelled - Downloading rowCount: type: integer format: int32 readOnly: true rowsSucceeded: type: integer format: int32 readOnly: true rowsFailed: type: integer format: int32 readOnly: true lastUpdatedAt: type: integer format: int64 readOnly: true failureReason: type: string readOnly: true objectType: type: string readOnly: true jobType: type: string readOnly: true enum: - Import - Delete - Update - Cancel isCustomObject: type: boolean readOnly: true customObjectNamespace: type: string readOnly: true dataSourceType: type: string readOnly: true enum: - UserUpload - Salesforce - Chargebee - Stripe systemType: type: string readOnly: true enum: - BILLING fileType: type: string readOnly: true enum: - csv - jsonl IdStatusResponse: type: object properties: id: type: string format: uuid readOnly: true status: type: string readOnly: true enum: - Created - Submitted - In Progress - Aborting - Completed - Failed - Aborted - Cancelled - Downloading DownloadsResponse: type: object properties: jobId: type: string format: uuid readOnly: true status: type: string enum: - Created - Submitted - In Progress - Aborting - Completed - Failed - Aborted - Cancelled - Downloading readOnly: true sourceFile: type: string readOnly: true errorRowsFile: type: string readOnly: true successRowsFile: type: string readOnly: true delimiter: type: string readOnly: true GetSummariesResponse: type: object properties: data: type: array readOnly: true items: type: object properties: id: type: string format: uuid readOnly: true name: type: string readOnly: true status: type: string readOnly: true enum: - Created - Submitted - In Progress - Aborting - Completed - Failed - Aborted - Cancelled - Downloading createdAt: type: integer format: int64 readOnly: true createdBy: type: string readOnly: true submittedAt: type: integer format: int64 readOnly: true submittedBy: type: string readOnly: true rowCount: type: integer format: int32 readOnly: true rowsSucceeded: type: integer format: int32 readOnly: true rowsFailed: type: integer format: int32 readOnly: true lastUpdatedAt: type: integer format: int64 readOnly: true failureReason: type: string readOnly: true objectType: type: string readOnly: true jobType: type: string readOnly: true enum: - Import - Delete - Update - Cancel isCustomObject: type: boolean readOnly: true customObjectNamespace: type: string readOnly: true dataSourceType: type: string readOnly: true enum: - UserUpload - Salesforce - Chargebee - Stripe systemType: type: string readOnly: true enum: - BILLING fileType: type: string readOnly: true enum: - csv - jsonl nextPageCursor: type: string readOnly: true headers: GLOBAL_HEADER_RESPONSE_Zuora_TrackId: schema: type: string maxLength: 64 GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type: schema: type: string GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit: schema: type: integer GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining: schema: type: integer GLOBAL_HEADER_RESPONSE_Zuora_RequestId: schema: type: string minLength: 36 maxLength: 36 GLOBAL_HEADER_RESPONSE_Content_Encoding: schema: type: string GLOBAL_HEADER_RESPONSE_RateLimit_Limit: schema: type: string GLOBAL_HEADER_RESPONSE_RateLimit_Remaining: schema: type: number GLOBAL_HEADER_RESPONSE_RateLimit_Reset: schema: type: number x-tagGroups: - name: Authentication tags: - OAuth - name: Products tags: - Products - Catalog - Catalog Groups - Commerce - Product Rate Plans - Product Rate Plan Definitions - Product Rate Plan Charges - Product Charge Definitions - Product Rate Plan Charge Tiers - Zuora Revenue Integration - name: Customer Accounts tags: - Accounts - Contacts - Contact Snapshots - name: Orders and Subscriptions tags: - Sign Up - Orders - Order Actions - Order Line Items - Fulfillments - Ramps - Subscriptions - Omnichannel Subscriptions - Subscription Change History - Rate Plans - Commitments - name: Advanced Consumption Billing tags: - Prepaid with Drawdown - name: Usage tags: - Usage - name: Mediation tags: - Meters - name: Billing Documents tags: - Delivery Adjustments - Billing Documents - Invoices - Credit Memos - Debit Memos - E-Invoicing - Invoice Schedules - Taxation Items - Sequence Sets - Operations - Summary Statements - name: Bill Runs tags: - Bill Run - Billing Preview Run - name: Payment Methods tags: - Payment Methods - Custom Payment Method Types - Payment Method Updater - Payment Method Snapshots - Payment Method Transaction Logs - Hosted Pages - RSA Signatures - name: Payments tags: - Payment Authorization - Payment Gateways - Payment Gateway Reconciliation - Payments - Payment Transaction Logs - Payment Runs - Payment Schedules - Refunds - Payment Profiles - Configurable Payment Retry - name: Object Query tags: - Object Queries - name: Finance tags: - Accounting Codes - Accounting Periods - Summary Journal Entries - Journal Runs - Mass Updater - name: Events and Notifications tags: - Notifications - Custom Event Triggers - Custom Scheduled Events - name: Custom Objects tags: - Custom Object Definitions - Custom Object Records - Custom Object Jobs - name: System Health tags: - API Health - Bill Run Health - Electronic Payments Health - Tax Health - name: Workflow tags: - Workflows - name: Data Query tags: - Data Queries - name: AQuA tags: - Aggregate Queries - name: Deployment Manager tags: - Configuration Templates - Metadata - name: Data Loader tags: - Bulk Data - name: OneID tags: - SCIM - name: Multiple Organizations tags: - Data Labeling - name: Order to Revenue tags: - Data Backfill - Regenerate - name: Test Environments tags: - Test Environments - Test Environment Jobs - Test Environment Notifications - name: General-Purpose Operations tags: - Actions - Settings - Files - Imports - Custom Exchange Rates - Attachments - Describe