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:00.946Z'
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: Test Environments
  - name: Test Environment Jobs
  - name: Test Environment Notifications
  - name: Actions
  - name: Accounting Codes
  - name: Accounting Periods
  - name: Accounts
  - name: Delivery Adjustments
  - name: Aggregate Queries
  - name: API Health
  - name: Attachments
  - name: Bill Run Health
  - name: Bill Run
  - name: Billing Documents
  - name: Billing Preview Run
  - name: Catalog
  - name: Catalog Groups
  - name: Configuration Templates
  - name: Metadata
  - name: Bulk Data
  - name: Contact Snapshots
  - name: Configurable Payment Retry
  - name: Contacts
  - name: Credit Memos
  - name: Custom Event Triggers
  - name: Custom Exchange Rates
  - name: Custom Object Definitions
  - name: Custom Object Records
  - name: Custom Object Jobs
  - name: Custom Payment Method Types
  - name: Custom Scheduled Events
  - name: Data Backfill
  - name: Data Labeling
  - name: Data Queries
  - name: Debit Memos
  - name: Describe
  - name: E-Invoicing
  - name: Electronic Payments Health
  - name: Tax Health
  - name: Files
  - name: Fulfillments
  - name: Hosted Pages
  - name: Imports
  - name: Invoice Schedules
  - name: Invoices
  - name: Journal Runs
  - name: Mass Updater
  - name: Notifications
  - name: Meters
  - name: OAuth
  - name: SCIM
  - name: Object Queries
  - name: Operations
  - name: Orders
  - name: Order Actions
  - name: Order Line Items
  - name: Payment Gateways
  - name: Payment Gateway Reconciliation
  - name: Payment Method Snapshots
  - name: Payment Method Transaction Logs
  - name: Payment Methods
  - name: Payment Method Updater
  - name: Payment Runs
  - name: Payment Profiles
  - name: Payment Schedules
  - name: Payment Transaction Logs
  - name: Payment Authorization
  - name: Payments
  - name: Prepaid with Drawdown
  - name: Product Charge Definitions
  - name: Product Rate Plan Definitions
  - name: Product Rate Plan Charge Tiers
  - name: Product Rate Plan Charges
  - name: Product Rate Plans
  - name: Products
  - name: Ramps
  - name: Rate Plans
  - name: Refunds
  - name: Regenerate
  - name: RSA Signatures
  - name: Sequence Sets
  - name: Settings
  - name: Sign Up
  - name: Subscriptions
  - name: Omnichannel Subscriptions
  - name: Subscription Change History
  - name: Summary Journal Entries
  - name: Summary Statements
  - name: Taxation Items
  - name: Usage
  - name: Workflows
  - name: Zuora Revenue Integration
paths:
  /test-environments:
    get:
      tags:
        - Test Environments
      summary: List all test environments
      operationId: getAllTestEnvironments
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestEnvironmentArrayResponse'
        '400':
          content: {}
        '500':
          content: {}
  /test-environments/{id}:
    get:
      tags:
        - Test Environments
      summary: Retrieve a test environment response
      operationId: getTestEnvironment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestEnvironmentResponse'
        '404':
          content: {}
        '500':
          content: {}
  /test-environments/{id}/jobs:
    post:
      tags:
        - Test Environment Jobs
      summary: Create a test environment job
      operationId: createTestEnvironmentJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JobRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponse'
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponse'
        '400':
          content:
            application/json:
              schema:
                type: object
        '403':
          content: {}
        '500':
          content: {}
      x-codegen-request-body-name: jobRequest
    get:
      tags:
        - Test Environment Jobs
      summary: List all jobs of a test environment
      operationId: getAllJobsOfTestEnvironment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobArrayResponse'
        '400':
          content:
            application/json:
              schema:
                type: object
        '500':
          content: {}
  /test-environments/{id}/jobs/{jobId}:
    get:
      tags:
        - Test Environment Jobs
      summary: Retrieve a job of a test environment
      operationId: getJobOfTestEnvironment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - in: path
          name: id
          required: true
          schema:
            type: string
        - in: path
          name: jobId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponse'
        '404':
          content: {}
        '500':
          content: {}
  /test-environments/{id}/jobs/{jobId}/actions:
    post:
      tags:
        - Test Environment Jobs
      summary: Perform an action on a test environment job
      operationId: performActionOfJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - in: path
          name: id
          required: true
          schema:
            type: string
        - in: path
          name: jobId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JobActionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponse'
        '400':
          content: {}
        '404':
          content: {}
        '500':
          content: {}
      x-codegen-request-body-name: jobActionRequest
  /test-environments/{id}/notifications:
    post:
      tags:
        - Test Environment Notifications
      summary: Create a test environment notification
      operationId: createTestEnvironmentNotification
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestEnvironmentNotificationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestEnvironmentNotificationResponse'
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestEnvironmentNotificationResponse'
        '400':
          content:
            application/json:
              schema:
                type: object
        '500':
          content: {}
      x-codegen-request-body-name: notificationRequest
    get:
      tags:
        - Test Environment Notifications
      summary: List all email notifications of a test environment
      operationId: getAllEmailNotificationOfTestEnv
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestEnvironmentNotificationArrayResponse'
        '404':
          content: {}
        '500':
          content: {}
  /test-environments/{id}/notifications/{notificationId}:
    get:
      tags:
        - Test Environment Notifications
      summary: Retrieve a notification response of a test environment
      operationId: getTestEnvironmentNotification
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - in: path
          name: id
          required: true
          schema:
            type: string
        - in: path
          name: notificationId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestEnvironmentNotificationResponse'
        '404':
          content: {}
        '500':
          content: {}
    patch:
      tags:
        - Test Environment Notifications
      summary: Update a test environment notification
      operationId: updateTestEnvironmentNotification
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - in: path
          name: id
          required: true
          schema:
            type: string
        - in: path
          name: notificationId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestEnvironmentNotificationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestEnvironmentNotificationResponse'
        '400':
          content:
            application/json:
              schema:
                type: object
        '500':
          content: {}
      x-codegen-request-body-name: notificationRequest
    delete:
      tags:
        - Test Environment Notifications
      summary: Delete a notification of a test environment
      operationId: deleteTestEnvironmentNotification
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - in: path
          name: id
          required: true
          schema:
            type: string
        - in: path
          name: notificationId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestEnvironmentNotificationResponse'
        '404':
          content: {}
        '500':
          content: {}
  /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/catalog/products:
    get:
      operationId: GET_Catalog
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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_catalog'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETCatalogType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 products
      tags:
        - Catalog
  /v1/catalog/products/{product-key}:
    get:
      operationId: GET_Product
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: product-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETProductType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 product
      tags:
        - Catalog
  /v1/catalog-groups:
    post:
      operationId: POST_CreateCatalogGroup
      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/POSTCatalogGroupRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogGroupResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 catalog group
      tags:
        - Catalog Groups
    get:
      operationId: GET_ListAllCatalogGroups
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAllCatalogGroupsResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 catalog groups
      tags:
        - Catalog Groups
  /v1/catalog-groups/{catalog-group-key}:
    get:
      operationId: GET_RetrieveCatalogGroup
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: catalog-group-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogGroupResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 catalog group
      tags:
        - Catalog Groups
    put:
      operationId: PUT_UpdateCatalogGroup
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: catalog-group-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTCatalogGroup'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogGroupResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 catalog group
      tags:
        - Catalog Groups
    delete:
      operationId: DELETE_CatalogGroup
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: catalog-group-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 a catalog group
      tags:
        - Catalog Groups
  /v1/products/{product-key}/product-rate-plans:
    get:
      operationId: GET_ProductRatePlans
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: product-key
          required: true
          schema:
            type: string
        - in: query
          name: show-charge-definitions
          required: false
          schema:
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETProductRatePlansResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 product rate plans of a product
      tags:
        - Product Rate Plans
  /v1/product-rate-plans/{id}:
    get:
      operationId: GET_ProductRatePlan
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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/GETProductRatePlanWithExternalIdResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 product rate plan by ID
      tags:
        - Product Rate Plans
  /v1/product-rate-plans/external-id/{id}:
    get:
      operationId: GET_ProductRatePlansByExternalID
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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/GETProductRatePlanWithExternalIdMultiResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 product rate plans by external ID
      tags:
        - Product Rate Plans
  /v1/object/product-rate-plan:
    post:
      operationId: Object_POSTProductRatePlan
      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/ProxyCreateProductRatePlan'
        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 rate plan'
      tags:
        - Product Rate Plans
  /v1/object/product-rate-plan/{id}:
    get:
      operationId: Object_GETProductRatePlan
      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/ProxyGetProductRatePlan'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 rate plan'
      tags:
        - Product Rate Plans
    put:
      operationId: Object_PUTProductRatePlan
      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/ProxyModifyProductRatePlan'
        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 rate plan'
      tags:
        - Product Rate Plans
    delete:
      operationId: Object_DELETEProductRatePlan
      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 rate plan'
      tags:
        - Product Rate Plans
  /v1/product-rateplan-definitions:
    post:
      operationId: POST_CreateProductRatePlanDefinition
      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/POSTRatePlanDefinitionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/POSTRatePlanDefinitionResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 product rate plan definition
      tags:
        - Product Rate Plan Definitions
    get:
      operationId: GET_RetrieveProductRatePlanDefinitions
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $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: charge
          required: false
          schema:
            type: string
        - in: query
          name: rateplan
          required: false
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETProductRatePlanDefinitionsResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 product rate plan definitions
      tags:
        - Product Rate Plan Definitions
  /v1/product-rateplan-definitions/{product-rateplan-definition-key}:
    get:
      operationId: GET_RetrieveProductRatePlanDefinition
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $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: product-rateplan-definition-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETProductRatePlanDefinitionResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 product rate plan definition
      tags:
        - Product Rate Plan Definitions
    delete:
      operationId: DELETE_ProductRatePlanDefnition
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $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: product-rateplan-definition-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 a product rate plan definition
      tags:
        - Product Rate Plan Definitions
  /v1/product-rate-plan-charges/{product-rate-plan-charge-key}:
    get:
      operationId: GET_RetrieveProductRatePlanCharge
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $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: product-rate-plan-charge-key
          required: true
          schema:
            type: string
        - in: query
          name: show-charge-definitions
          required: false
          schema:
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETProductRatePlanChargeResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 a product rate plan charge
      tags:
        - Product Rate Plan Charges
  /v1/object/product-rate-plan-charge:
    post:
      operationId: Object_POSTProductRatePlanCharge
      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/ProxyCreateProductRatePlanCharge'
        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: Create a product rate plan charge'
      tags:
        - Product Rate Plan Charges
  /v1/object/product-rate-plan-charge/{id}:
    get:
      operationId: Object_GETProductRatePlanCharge
      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/ProxyGetProductRatePlanCharge'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 rate plan charge'
      tags:
        - Product Rate Plan Charges
    put:
      operationId: Object_PUTProductRatePlanCharge
      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/ProxyModifyProductRatePlanCharge'
        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'
        '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: Update a product rate plan charge'
      tags:
        - Product Rate Plan Charges
    delete:
      operationId: Object_DELETEProductRatePlanCharge
      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 rate plan charge'
      tags:
        - Product Rate Plan Charges
  /v1/product-charge-definitions:
    post:
      operationId: POST_CreateProductChargeDefinition
      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/POSTChargeDefinitionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/POSTChargeDefinitionResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 product charge definition
      tags:
        - Product Charge Definitions
    get:
      operationId: GET_RetrieveProductChargeDefinitions
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $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: charge
          required: false
          schema:
            type: string
        - in: query
          name: rateplan
          required: false
          schema:
            type: string
        - in: query
          name: hide-inherited-values
          required: false
          schema:
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETProductChargeDefinitionsResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 product charge definitions
      tags:
        - Product Charge Definitions
  /v1/product-charge-definitions/bulk:
    post:
      operationId: POST_CreateProductChargeDefinitionBulk
      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/POSTChargeDefinitionRequestBulk'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/POSTChargeDefinitionBulkResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 product charge definitions
      tags:
        - Product Charge Definitions
    put:
      operationId: PUT_UpdateProductChargeDefinitionBulk
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_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/PUTProductChargeDefinitionBulkRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETProductChargeDefinitionsResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 product charge definitions
      tags:
        - Product Charge Definitions
  /v1/product-charge-definitions/{product-charge-definition-key}:
    get:
      operationId: GET_RetrieveProductChargeDefinition
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $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: product-charge-definition-key
          required: true
          schema:
            type: string
        - in: query
          name: hide-inherited-values
          required: false
          schema:
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETProductChargeDefinitionResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 product charge definition
      tags:
        - Product Charge Definitions
    put:
      operationId: PUT_UpdateProductChargeDefinition
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $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: product-charge-definition-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTProductChargeDefinitionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETProductChargeDefinitionResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 product charge definition
      tags:
        - Product Charge Definitions
    delete:
      operationId: DELETE_ProductChargeDefnition
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $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: product-charge-definition-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 a product charge definition
      tags:
        - Product Charge Definitions
  /v1/object/product-rate-plan-charge-tier/{id}:
    get:
      operationId: Object_GETProductRatePlanChargeTier
      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/ProxyGetProductRatePlanChargeTier'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 rate plan charge tier'
      tags:
        - Product Rate Plan Charge Tiers
    put:
      operationId: Object_PUTProductRatePlanChargeTier
      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/ProxyModifyProductRatePlanChargeTier'
        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 rate plan charge tier'
      tags:
        - Product Rate Plan Charge Tiers
  /v1/revpro-accounting-codes:
    put:
      operationId: PUT_RevProAccountingCodes
      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_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RevproAccountingCodes'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PUTRevproAccCodeResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 Zuora Revenue accounting code
      tags:
        - Zuora Revenue Integration
  /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/sign-up:
    post:
      operationId: POST_SignUp
      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_Charge_Metrics_Accept'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignUpRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignUpResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Sign up
      tags:
        - Sign Up
  /v1/orders/preview:
    post:
      operationId: POST_PreviewOrder
      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'
        - name: summarizeInvoiceItem
          in: query
          required: false
          schema:
            type: boolean
            default: false
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTOrderPreviewRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostOrderPreviewResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 an order
      tags:
        - Orders
  /v1/async/orders/preview:
    post:
      operationId: POST_PreviewOrderAsynchronously
      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'
        - name: summarizeInvoiceItem
          in: query
          required: false
          schema:
            type: boolean
            default: false
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTOrderPreviewAsyncRequestType'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                properties:
                  jobId:
                    format: UUID
                    type: string
                type: object
          headers:
            Content-Encoding:
              schema:
                type: string
            Location:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Preview an order asynchronously
      tags:
        - Orders
  /v1/orders:
    get:
      operationId: GET_AllOrders
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: dateFilterOption
          required: false
          schema:
            type: string
        - in: query
          name: startDate
          required: false
          schema:
            format: date
            type: string
        - in: query
          name: endDate
          required: false
          schema:
            format: date
            type: string
        - in: query
          name: status
          required: false
          schema:
            enum:
              - all
              - cancelled
              - completed
              - draft
              - executing
              - failed
              - pending
              - scheduled
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllOrdersResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 orders
      tags:
        - Orders
    post:
      operationId: POST_Order
      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: returnIds
          required: false
          schema:
            default: false
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTOrderRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostOrderResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 order
      tags:
        - Orders
  /v1/async/orders:
    post:
      operationId: POST_CreateOrderAsynchronously
      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: returnIds
          required: false
          schema:
            default: false
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTOrderAsyncRequestType'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                properties:
                  jobId:
                    format: UUID
                    type: string
                  success:
                    type: boolean
                type: object
          headers:
            Content-Encoding:
              schema:
                type: string
            Location:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Create an order asynchronously
      tags:
        - Orders
  /v1/orders/{orderNumber}:
    delete:
      operationId: DELETE_Order
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: orderNumber
          required: true
          schema:
            format: string
            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 order
      tags:
        - Orders
    get:
      operationId: GET_Order
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: orderNumber
          required: true
          schema:
            format: string
            type: string
        - in: query
          name: getAccountDetails
          schema:
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrderResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 order
      tags:
        - Orders
    put:
      operationId: PUT_Order
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: orderNumber
          required: true
          schema:
            format: string
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTOrderRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutOrderResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 order
      tags:
        - Orders
  /v1/async/orders/{orderNumber}:
    delete:
      operationId: deleteOrderAsynchronously
      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'
        - in: path
          name: orderNumber
          required: true
          schema:
            format: string
            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/DeleteOrderAsyncResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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:
              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:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
            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: Delete an order asynchronously
      tags:
        - Orders
  /v1/async-jobs/{jobId}:
    get:
      operationId: GET_JobStatusAndResponse
      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: jobId
          required: true
          schema:
            format: UUID
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAsyncOrderJobResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 status and response of a job
      tags:
        - Orders
  /v1/orders/subscriptionOwner/{accountNumber}:
    get:
      operationId: GET_OrdersBySubscriptionOwner
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: accountNumber
          required: true
          schema:
            format: string
            type: string
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - in: query
          name: dateFilterOption
          required: false
          schema:
            type: string
        - in: query
          name: startDate
          required: false
          schema:
            format: date
            type: string
        - in: query
          name: endDate
          required: false
          schema:
            format: date
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrdersResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 orders of a subscription owner
      tags:
        - Orders
  /v1/orders/subscription/{subscriptionNumber}:
    get:
      operationId: GET_OrdersBySubscriptionNumber
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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:
            type: string
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - in: query
          name: dateFilterOption
          required: false
          schema:
            type: string
        - in: query
          name: startDate
          required: false
          schema:
            format: date
            type: string
        - in: query
          name: endDate
          required: false
          schema:
            format: date
            type: string
        - in: query
          name: status
          required: false
          schema:
            enum:
              - all
              - cancelled
              - completed
              - draft
              - executing
              - failed
              - pending
              - scheduled
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrdersResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 orders by subscription number
      tags:
        - Orders
  /v1/orders/invoiceOwner/{accountNumber}:
    get:
      operationId: GET_OrdersByInvoiceOwner
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: accountNumber
          required: true
          schema:
            format: string
            type: string
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - in: query
          name: dateFilterOption
          required: false
          schema:
            type: string
        - in: query
          name: startDate
          required: false
          schema:
            format: date
            type: string
        - in: query
          name: endDate
          required: false
          schema:
            format: date
            type: string
        - in: query
          name: status
          required: false
          schema:
            enum:
              - all
              - cancelled
              - completed
              - draft
              - executing
              - failed
              - pending
              - scheduled
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrdersResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 orders of an invoice owner
      tags:
        - Orders
  /v1/orders/{orderNumber}/customFields:
    put:
      operationId: PUT_UpdateOrderCustomFields
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: orderNumber
          required: true
          schema:
            format: string
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTOrderPatchRequestType'
        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 order custom fields
      tags:
        - Orders
  /v1/subscriptions/{subscriptionNumber}/customFields:
    put:
      operationId: PUT_UpdateSubscriptionCustomFields
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTSubscriptionPatchRequestType'
        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
      tags:
        - Orders
  /v1/orders/{orderNumber}/triggerDates:
    put:
      operationId: PUT_OrderTriggerDates
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: orderNumber
          required: true
          schema:
            format: string
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTOrderActionTriggerDatesRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PUTOrderTriggerDatesResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 order action trigger dates
      tags:
        - Orders
  /v1/orders/{orderNumber}/activate:
    put:
      operationId: PUT_OrderActivate
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: orderNumber
          required: true
          schema:
            format: string
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostOrderResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 order
      tags:
        - Orders
  /v1/orders/{orderNumber}/cancel:
    put:
      operationId: PUT_OrderCancel
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: orderNumber
          required: true
          schema:
            format: string
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                cancelReason:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutOrderCancelResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 an order
      tags:
        - Orders
  /v1/orders/{orderNumber}/revert:
    post:
      operationId: revertOrder
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: orderNumber
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RevertOrderRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RevertOrderResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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:
              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: Revert an order
      tags:
        - Orders
  /v1/orders/subscription/{subscription-key}/pending:
    get:
      operationId: GET_PendingOrdersBySubscriptionNumber
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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/GetAllOrdersResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 pending orders by subscription number
      tags:
        - Orders
  /v1/orderActions/{id}:
    put:
      operationId: PUT_OrderActions
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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/PUTOrderActionsRequestType'
        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 order action
      tags:
        - Order Actions
  /v1/order-line-items/{itemId}:
    get:
      operationId: GET_OrderLineItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: itemId
          required: true
          schema:
            format: UUID
            type: string
        - in: query
          name: fulfillment
          required: false
          schema:
            default: false
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrderLineItemResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 order line item
      tags:
        - Order Line Items
    put:
      operationId: PUT_OrderLineItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: itemId
          required: true
          schema:
            format: UUID
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTOrderLineItemRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutOrderLineItemResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 order line item
      tags:
        - Order Line Items
  /v1/order-line-items/bulk:
    post:
      operationId: Post_OrderLineItems
      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/PostOrderLineItemsRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrderLineItemResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 order line items
      tags:
        - Order Line Items
  /v1/fulfillments:
    post:
      operationId: Create_Fulfillment
      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/PostFulfillmentsRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostFulfillmentsResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 fulfillments
      tags:
        - Fulfillments
  /v1/fulfillments/{key}:
    delete:
      operationId: Delete_Fulfillment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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:
            format: UUID
            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 fulfillment
      tags:
        - Fulfillments
    get:
      operationId: GET_Fulfillment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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:
            format: UUID
            type: string
        - in: query
          name: fulfillment-items
          required: false
          schema:
            default: false
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFulfillmentResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 fulfillment
      tags:
        - Fulfillments
    put:
      operationId: PUT_Fulfillment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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:
            format: UUID
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutFulfillmentRequestType'
        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 fulfillment
      tags:
        - Fulfillments
  /v1/fulfillment-items:
    post:
      operationId: Create_FulfillmentItem
      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/PostFulfillmentItemsRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostFulfillmentItemsResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 fulfillment items
      tags:
        - Fulfillments
  /v1/fulfillment-items/{id}:
    delete:
      operationId: Delete_FulfillmentItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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
        - $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 fulfillment item
      tags:
        - Fulfillments
    get:
      operationId: GET_FulfillmentItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFulfillmentItemResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 fulfillment item
      tags:
        - Fulfillments
    put:
      operationId: PUT_FulfillmentItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutFulfillmentItemRequestType'
        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 fulfillment item
      tags:
        - Fulfillments
  /v1/ramps/{rampNumber}:
    get:
      operationId: GET_RampByRampNumber
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: rampNumber
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETRampByRampNumberResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 ramp
      tags:
        - Ramps
  /v1/ramps/{rampNumber}/ramp-metrics:
    get:
      operationId: GET_RampMetricsByRampNumber
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: rampNumber
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETRampMetricsByRampNumberResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 ramp metrics of a ramp
      tags:
        - Ramps
  /v1/subscriptions/{subscriptionKey}/ramps:
    get:
      operationId: GET_RampsBySubscriptionKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: subscriptionKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETRampsBySubscriptionKeyResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 ramp by subscription key
      tags:
        - Ramps
  /v1/subscriptions/{subscriptionKey}/ramp-metrics:
    get:
      operationId: GET_RampMetricsBySubscriptionKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: subscriptionKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETRampMetricsBySubscriptionKeyResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 ramp metrics by subscription key
      tags:
        - Ramps
  /v1/orders/{orderNumber}/ramp-metrics:
    get:
      operationId: GET_RampMetricsByOrderNumber
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: orderNumber
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETRampMetricsByOrderNumberResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 ramp metrics by order number
      tags:
        - Ramps
  /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/rateplans/{ratePlanId}:
    get:
      operationId: GET_RatePlan
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: ratePlanId
          required: true
          schema:
            format: string
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrderActionRatePlanResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 rate plan
      tags:
        - Rate Plans
  /v1/omni-channel-subscriptions:
    post:
      operationId: postOmnichannelSubscription
      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/CreateOmniChannelSubscriptionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateOmniChannelSubscriptionResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              schema:
                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'
            Concurrency-Limit-Type:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
            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'
            Concurrency-Limit-Type:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
            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: Create an omnichannel subscription
      tags:
        - Omnichannel Subscriptions
  /v1/omni-channel-subscriptions/{subscriptionKey}:
    get:
      operationId: getOmnichannelSubscription
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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_get_account_details'
        - in: path
          name: subscriptionKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOmniChannelSubscriptionResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              schema:
                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:
              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: Retrieve an omnichannel subscription
      tags:
        - Omnichannel Subscriptions
    delete:
      operationId: deleteOmnichannelSubscription
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: subscriptionKey
          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:
              $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'
            Concurrency-Limit-Type:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
            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: Delete an omnichannel subscription
      tags:
        - Omnichannel Subscriptions
  /v1/subscription-change-logs/{subscriptionNumber}:
    get:
      operationId: getSubscriptionChangeLogsBySubscriptionNumber
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSubscriptionChangeLogsResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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:
              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: List change histories of a subscription
      tags:
        - Subscription Change History
  /v1/subscription-change-logs/orders/{orderNumber}:
    get:
      operationId: getSubscriptionChangeLogsByOrderNumber
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: orderNumber
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSubscriptionChangeLogsResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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:
              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: List change histories of subscriptions by order number
      tags:
        - Subscription Change History
  /v1/subscription-change-logs/{subscriptionNumber}/versions/{version}:
    get:
      operationId: getSubscriptionChangelogByVersion
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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:
            type: string
        - in: path
          name: version
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSubscriptionChangeLogResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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:
              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 a change history of a subscription by version
      tags:
        - Subscription Change History
  /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
  /meters/run/{meterId}/{version}:
    post:
      tags:
        - Meters
      summary: Run a specific version of a meter
      operationId: runSpecificVersionOfMeter
      parameters:
        - name: meterId
          in: path
          required: true
          schema:
            type: string
        - name: version
          in: path
          required: true
          schema:
            type: string
        - name: Content-Type
          in: header
          required: true
          schema:
            type: string
            default: application/json
        - $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: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunMeterVersionRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunMeterVersionResponse'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /meters/debug/{meterId}/{version}:
    post:
      tags:
        - Meters
      summary: Test a specific version of a meter
      operationId: testSpecificVersionOfMeter
      parameters:
        - name: meterId
          in: path
          required: true
          schema:
            type: integer
        - name: version
          in: path
          required: true
          schema:
            type: string
        - name: Content-Type
          in: header
          required: true
          schema:
            type: string
            default: application/json
        - $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:
          application/json:
            schema:
              $ref: '#/components/schemas/TestSpecificMeterRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestSpecificMeterResponse'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediationErrorResponse'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /meters/{meterId}/{version}/runStatus:
    get:
      tags:
        - Meters
      summary: Retrieve the run status of a specific meter version
      operationId: getRunStatusOfSpecificMeterVersion
      parameters:
        - name: meterId
          in: path
          required: true
          schema:
            type: integer
        - name: version
          in: path
          required: true
          schema:
            type: string
        - name: Content-Type
          in: header
          required: true
          schema:
            type: string
            default: application/json
        - $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/RunStatusResponse'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediationErrorResponse'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /meters/export/{meterId}:
    get:
      tags:
        - Meters
      summary: Export details of a specific meter
      operationId: exportSpecificMeter
      parameters:
        - name: meterId
          in: path
          required: true
          schema:
            type: string
        - name: Content-Type
          in: header
          required: true
          schema:
            type: string
            default: application/json
        - $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/ExportMeterResponse'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediationErrorResponse'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /meters/import:
    post:
      tags:
        - Meters
      summary: Import a meter definition
      operationId: importMeterDefinition
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ImportMeterRequest'
      parameters:
        - in: header
          name: Content-Type
          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'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportMeterResponse'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediationErrorResponse'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /meters/files:
    post:
      tags:
        - Meters
      summary: Upload a file
      operationId: uploadMeteringFile
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              required:
                - file
              properties:
                file:
                  type: string
                  format: binary
                hasHeader:
                  type: boolean
                firstRow:
                  type: integer
                delimiter:
                  type: string
                sheet:
                  type: string
                dataRange:
                  type: string
                resolveFileNameConflict:
                  type: boolean
                targetFolder:
                  type: string
                overwriteExistingFile:
                  type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFileResponse'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /usage/bulk/{meterGlobalId}:
    post:
      summary: Ingest usage events for a meter
      tags:
        - Meters
      operationId: ingestUsageEvents
      parameters:
        - name: Content-Type
          in: header
          required: true
          schema:
            type: string
            default: application/json
        - $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: meterGlobalId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/StreamingEvent'
                - type: array
                  items:
                    $ref: '#/components/schemas/StreamingEvent'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamingIngestionSuccessResponse'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamingIngestionAuthError'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamingIngestionAuthError'
        '413':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamingIngestionAuthError'
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamingIngestionAuthError'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /meters/events/bulkDelete:
    post:
      tags:
        - Meters
      summary: Bulk delete events from an event store
      operationId: bulkDeleteEventsFromEventStore
      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/BulkDeleteEventRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkDeleteEventResponse'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /meters/events/stores/{id}/jobs/latest:
    get:
      tags:
        - Meters
      summary: Retrieve the latest query job of a specific event store
      operationId: getLatestQueryJobOfSpecificEventStore
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
        - name: Content-Type
          in: header
          required: true
          schema:
            type: string
            default: application/json
        - $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/LatestEventStoreJobResponse'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediationErrorResponse'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /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/object/payment-method-snapshot/{id}:
    get:
      operationId: Object_GETPaymentMethodSnapshot
      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/ProxyGetPaymentMethodSnapshot'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 payment method snapshot'
      tags:
        - Payment Method Snapshots
  /v1/object/payment-method-transaction-log/{id}:
    get:
      operationId: Object_GETPaymentMethodTransactionLog
      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/ProxyGetPaymentMethodTransactionLog'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 payment method transaction log'
      tags:
        - Payment Method Transaction Logs
  /v1/payment-method-updaters:
    get:
      operationId: GET_PaymentMethodUpdaterInstances
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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/GETPaymentMethodUpdaterInstancesResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 Method Updater instances
      tags:
        - Payment Method Updater
  /v1/payment-method-updaters/batches:
    post:
      operationId: POST_PaymentMethodUpdaterBatch
      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/POSTPaymentMethodUpdaterBatchRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/POSTPaymentMethodUpdaterResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 Updater batch asynchronously
      tags:
        - Payment Method Updater
  /v1/rsa-signatures:
    post:
      operationId: POST_RSASignatures
      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/POSTRSASignatureType'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/POSTRSASignatureResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 RSA signature
      tags:
        - RSA Signatures
  /v1/rsa-signatures/decrypt:
    post:
      operationId: POST_DecryptRSASignatures
      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/POSTDecryptionType'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/POSTDecryptResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Decrypt an RSA signature
      tags:
        - RSA Signatures
  /v1/hostedpages:
    get:
      operationId: Get_HostedPages
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: versionNumber
          required: false
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetHostedPagesType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 hosted pages
      tags:
        - Hosted Pages
  /open-payment-method-types:
    post:
      operationId: POST_CreateDraftOpenPaymentMethodType
      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/POSTCreateOpenPaymentMethodTypeRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/POSTCreateOpenPaymentMethodTypeResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 draft custom payment method type
      tags:
        - Custom Payment Method Types
  /open-payment-method-types/publish/{paymentMethodTypeName}:
    put:
      operationId: PUT_PublishOpenPaymentMethodType
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: paymentMethodTypeName
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PUTPublishOpenPaymentMethodTypeResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Publish a custom payment method type
      tags:
        - Custom Payment Method Types
  /open-payment-method-types/{paymentMethodTypeName}:
    put:
      operationId: PUT_UpdateOpenPaymentMethodType
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: paymentMethodTypeName
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTUpdateOpenPaymentMethodTypeRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PUTUpdateOpenPaymentMethodTypeResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 payment method type
      tags:
        - Custom Payment Method Types
  /open-payment-method-types/{paymentMethodTypeName}/draft/{revisionNumber}:
    get:
      operationId: GET_OpenPaymentMethodTypeRevision
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: paymentMethodTypeName
          required: true
          schema:
            type: string
        - in: path
          name: revisionNumber
          required: true
          schema:
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETOpenPaymentMethodTypeRevisionResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 specific draft revision of a custom payment method type
      tags:
        - Custom Payment Method Types
  /open-payment-method-types/{paymentMethodTypeName}/published:
    get:
      operationId: GET_OpenPaymentMethodTypePublish
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: paymentMethodTypeName
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETOpenPaymentMethodTypeRevisionResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 published custom payment method type
      tags:
        - Custom Payment Method Types
  /v1/payment-methods/{payment-method-id}/authorize:
    post:
      operationId: POST_CreateAuthorization
      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/POSTDelayAuthorizeCapture'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/POSTAuthorizeResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 authorization
      tags:
        - Payment Authorization
  /v1/payment-methods/{payment-method-id}/voidAuthorize:
    post:
      operationId: POST_CancelAuthorization
      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/POSTVoidAuthorize'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/POSTVoidAuthorizeResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 authorization
      tags:
        - Payment Authorization
  /v1/paymentgateways:
    get:
      operationId: GET_Paymentgateways
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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/GETPaymentGatwaysResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 gateways
      tags:
        - Payment Gateways
  /v1/payment-gateways/pre-debit-notification:
    post:
      operationId: triggerPreDebitNotification
      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/PostTriggerPreDebitNotificationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostTriggerPreDebitNotificationResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Trigger a pre-debit notification
      tags:
        - Payment Gateways
  /v1/gateway-settlement/payments/{payment-key}/chargeback:
    post:
      operationId: POST_ReversePayment
      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-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTReversePaymentRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/POSTReversePaymentResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 payment
      tags:
        - Payment Gateway Reconciliation
  /v1/gateway-settlement/payments/{payment-key}/reject:
    post:
      operationId: POST_RejectPayment
      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-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTRejectPaymentRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/POSTRejectPaymentResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Reject a payment
      tags:
        - Payment Gateway Reconciliation
  /v1/gateway-settlement/payments/{payment-key}/settle:
    post:
      operationId: POST_SettlePayment
      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-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTSettlePaymentRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/POSTSettlePaymentResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Settle a payment
      tags:
        - Payment Gateway Reconciliation
  /v1/refunds/{refund-key}/reconcile:
    post:
      operationId: POST_ReconcileRefund
      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: refund-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTReconcileRefundRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/POSTReconcileRefundResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Reconcile a refund
      tags:
        - Payment Gateway Reconciliation
  /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/object/payment-transaction-log/{id}:
    get:
      operationId: Object_GETPaymentTransactionLog
      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/ProxyGetPaymentTransactionLog'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 payment transaction log'
      tags:
        - Payment Transaction Logs
  /v1/payment-runs:
    get:
      operationId: GET_PaymentRuns
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: createdById
          required: false
          schema:
            type: string
        - in: query
          name: createdDate
          required: false
          schema:
            format: date-time
            type: string
        - in: query
          name: status
          required: false
          schema:
            enum:
              - Pending
              - Processing
              - Completed
              - Error
              - Canceled
            type: string
        - in: query
          name: targetDate
          required: false
          schema:
            format: date
            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
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETPaymentRunCollectionType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 payment runs
      tags:
        - Payment Runs
    post:
      operationId: POST_PaymentRun
      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/POSTPaymentRunRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETPaymentRunType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Create a payment run
      tags:
        - Payment Runs
  /v1/payment-runs/{paymentRunKey}:
    delete:
      operationId: DELETE_PaymentRun
      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: paymentRunKey
          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'
      summary: Delete a payment run
      tags:
        - Payment Runs
    get:
      operationId: GET_PaymentRun
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: paymentRunKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETPaymentRunType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 a payment run
      tags:
        - Payment Runs
    put:
      operationId: PUT_PaymentRun
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: paymentRunKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTPaymentRunRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETPaymentRunType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Update a payment run
      tags:
        - Payment Runs
  /v1/payment-runs/{paymentRunKey}/data:
    get:
      operationId: GET_PaymentRunData
      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: paymentRunKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETPaymentRunDataArrayResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 payment run data
      tags:
        - Payment Runs
  /v1/payment-runs/{paymentRunKey}/summary:
    get:
      operationId: GET_PaymentRunSummary
      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: paymentRunKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETPaymentRunSummaryResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 a payment run summary
      tags:
        - Payment Runs
  /v1/payment-schedule-items/retry-payment:
    post:
      operationId: POST_RetryPaymentScheduleItem
      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/POSTRetryPaymentScheduleItemRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/POSTRetryPaymentScheduleItemResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Retry failed payment schedule items
      tags:
        - Payment Schedules
  /v1/payment-schedule-items/{item-id}:
    get:
      operationId: GET_PaymentScheduleItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: item-id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETPaymentScheduleItemResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 schedule item
      tags:
        - Payment Schedules
    put:
      operationId: PUT_PaymentScheduleItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: item-id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTPaymentScheduleItemRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PUTPaymentScheduleItemResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 schedule item
      tags:
        - Payment Schedules
  /v1/payment-schedule-items/{item-id}/cancel:
    put:
      operationId: PUT_CancelPaymentScheduleItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: item-id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PUTPaymentScheduleItemResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 schedule item
      tags:
        - Payment Schedules
  /v1/payment-schedule-items/{item-id}/skip:
    put:
      operationId: PUT_SkipPaymentScheduleItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: item-id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PUTSkipPaymentScheduleItemResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Skip a payment schedule item
      tags:
        - Payment Schedules
  /v1/payment-schedule-items/{psi-id}:
    delete:
      operationId: deletePaymentScheduleItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: psi-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:
              $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: Delete a payment schedule item
      tags:
        - Payment Schedules
  /v1/payment-schedules:
    get:
      operationId: GET_PaymentSchedules
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: query
          name: lastProcessedItems
          required: false
          schema:
            type: integer
        - in: query
          name: nextPendingItems
          required: false
          schema:
            type: integer
        - in: query
          name: accountId
          required: false
          schema:
            type: string
        - in: query
          name: accountNumber
          required: false
          schema:
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETPaymentSchedulesResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 schedules by customer account
      tags:
        - Payment Schedules
    post:
      operationId: POST_PaymentSchedule
      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/POSTPaymentScheduleRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/POSTPaymentScheduleResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 schedule
      tags:
        - Payment Schedules
  /v1/payment-schedules/batch:
    post:
      operationId: POST_PaymentSchedules
      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/POSTPaymentSchedulesRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/POSTPaymentSchedulesResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 multiple payment schedules at once
      tags:
        - Payment Schedules
  /v1/payment-schedules/statistics/{yyyy-mm-dd}:
    get:
      operationId: GET_PaymentScheduleStatistic
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: yyyy-mm-dd
          required: true
          schema:
            format: date
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETPaymentScheduleStatisticResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 payment schedule statistic of a date
      tags:
        - Payment Schedules
  /v1/payment-schedules/{paymentScheduleKey}:
    get:
      operationId: GET_PaymentSchedule
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: query
          name: nextPendingItems
          required: false
          schema:
            type: integer
        - in: query
          name: lastProcessedItems
          required: false
          schema:
            type: integer
        - in: path
          name: paymentScheduleKey
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETPaymentScheduleResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 schedule
      tags:
        - Payment Schedules
    put:
      operationId: PUT_PaymentSchedule
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: paymentScheduleKey
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTPaymentScheduleRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETPaymentScheduleResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 schedule
      tags:
        - Payment Schedules
  /v1/payment-schedules/{key}:
    delete:
      operationId: deletePaymentSchedule
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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:
              $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: Delete a payment schedule
      tags:
        - Payment Schedules
  /v1/payment-schedules/{paymentScheduleKey}/cancel:
    put:
      operationId: PUT_CancelPaymentSchedule
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: paymentScheduleKey
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTCancelPaymentScheduleRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETPaymentScheduleResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 schedule
      tags:
        - Payment Schedules
  /v1/payment-schedules/{paymentScheduleKey}/items:
    post:
      operationId: POST_AddItemsToCustomPaymentSchedule
      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: paymentScheduleKey
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTAddItemsToPaymentScheduleRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETPaymentScheduleResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Add payment schedule items to a custom payment schedule
      tags:
        - Payment Schedules
  /v1/payment-schedules/{paymentScheduleKey}/preview:
    put:
      operationId: PUT_PaymentScheduleUpdatePreview
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: paymentScheduleKey
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTPreviewPaymentScheduleRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETPaymentScheduleResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 the result of payment schedule updates
      tags:
        - Payment Schedules
  /v1/refunds:
    get:
      operationId: GET_Refunds
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: createdById
          required: false
          schema:
            type: string
        - in: query
          name: createdDate
          required: false
          schema:
            format: date-time
            type: string
        - in: query
          name: methodType
          required: false
          schema:
            enum:
              - ACH
              - Cash
              - Check
              - CreditCard
              - PayPal
              - WireTransfer
              - DebitCard
              - CreditCardReferenceTransaction
              - BankTransfer
              - Other
            type: string
        - in: query
          name: number
          required: false
          schema:
            type: string
        - in: query
          name: paymentId
          required: false
          schema:
            type: string
        - in: query
          name: refundDate
          required: false
          schema:
            format: date
            type: string
        - in: query
          name: status
          required: false
          schema:
            enum:
              - Processed
              - Canceled
              - Error
              - Processing
            type: string
        - in: query
          name: type
          required: false
          schema:
            enum:
              - External
              - Electronic
            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
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETRefundCollectionType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 refunds
      tags:
        - Refunds
  /v1/refunds/{refundId}:
    put:
      operationId: PUT_UpdateRefund
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: refundId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTRefundType'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETRefundType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 refund
      tags:
        - Refunds
  /v1/refunds/{refundKey}:
    delete:
      operationId: DELETE_Refund
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: refundKey
          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 refund
      tags:
        - Refunds
    get:
      operationId: GET_Refund
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: refundKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETRefundType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 refund
      tags:
        - Refunds
  /v1/refunds/{refundKey}/cancel:
    put:
      operationId: PUT_CancelRefund
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: refundKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETRefundType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 refund
      tags:
        - Refunds
  /v1/refunds/{refundKey}/parts:
    get:
      operationId: GET_RefundParts
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: refundKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETRefundPartCollectionType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 refund
      tags:
        - Refunds
  /v1/refunds/{refundKey}/parts/{refundpartid}:
    get:
      operationId: GET_RefundPart
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: refundpartid
          required: true
          schema:
            type: string
        - in: path
          name: refundKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefundPartResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 refund part
      tags:
        - Refunds
  /v1/refunds/{refundKey}/parts/{refundpartid}/item-parts:
    get:
      operationId: GET_RefundItemParts
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: refundpartid
          required: true
          schema:
            type: string
        - in: path
          name: refundKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETRefundItemPartCollectionType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 refund part items
      tags:
        - Refunds
  /v1/refunds/{refundKey}/parts/{refundpartid}/item-parts/{itempartid}:
    get:
      operationId: GET_RefundItemPart
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: itempartid
          required: true
          schema:
            type: string
        - in: path
          name: refundpartid
          required: true
          schema:
            type: string
        - in: path
          name: refundKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETRefundItemPartType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 refund part item
      tags:
        - Refunds
  /v1/payment-profile:
    put:
      operationId: UpsertPaymentProfiles
      summary: Create or update payment profiles in bulk
      tags:
        - Payment Profiles
      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:
              type: object
              properties:
                bulkPaymentOptionItems:
                  type: array
                  items:
                    properties:
                      subscriptionId:
                        type: string
                        format: uuid
                      paymentMethodId:
                        type: string
                        format: uuid
                      paymentGatewayId:
                        type: string
                        format: uuid
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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'
  /api/v1/payments/active_invoice_cycle_information/{invoice_id}:
    get:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: getActiveInvoiceCycle
      summary: List the active retry cycles for an invoice
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: invoice_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETActiveInvoiceCycleResponse'
  /api/v1/payments/active_debit_memo_cycle_information/{debit_memo_id}:
    get:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: getActiveDebitMemoCycle
      summary: List the active retry cycles for a debit memo
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: debit_memo_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETActiveDebitMemoCycleResponse'
  /api/v1/payments/active_account_cycle_information/{account_id}:
    get:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: getActiveAccountCycle
      summary: List the active retry cycles for an account
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETActiveAccountCycleResponse'
  /api/v1/payments/invoice_cycle_history/{invoice_id}:
    get:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: getInvoiceCycleHistory
      summary: List the retry cycle history for an invoice
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: invoice_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETInvoiceCycleHistoryResponse'
  /api/v1/payments/debit_memo_cycle_history/{debit_memo_id}:
    get:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: getDebitMemoCycleHistory
      summary: List the retry cycle history for a debit memo.
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: debit_memo_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETDebitMemoCycleHistoryResponse'
  /api/v1/payments/account_cycle_history/{account_id}:
    get:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: getAccountCycleHistory
      summary: List the retry cycle history for an account
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETAccountCycleHistoryResponse'
  /api/v1/payments/execute_invoice_payment/{invoice_id}:
    put:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: putExecuteInvoicePayment
      summary: Execute the invoice payment
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: invoice_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
  /api/v1/payments/execute_debit_memo_payment/{debit_memo_id}:
    put:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: putExecuteDebitMemoPayment
      summary: Execute the debit memo payment
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: debit_memo_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
  /api/v1/payments/execute_account_payments/{account_id}:
    put:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: putExecuteAccountPayments
      summary: Execute the account payments
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
  /api/v1/payments/execute_payments:
    post:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: postExecutePayments
      summary: Execute payments
      tags:
        - Configurable Payment Retry
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                account_ids:
                  type: array
                  items:
                    type: string
                debit_memo_ids:
                  type: array
                  items:
                    type: string
                invoice_ids:
                  type: array
                  items:
                    type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
  /api/v1/payments/remove_invoice_from_retry_cycle/{invoice_id}:
    put:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: putRemoveInoviceFromCycle
      summary: Remove an invoice from retry cycle
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: invoice_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
  /api/v1/payments/remove_debit_memo_from_retry_cycle/{debit_memo_id}:
    put:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: putRemoveDebitMemoFromCycle
      summary: Remove a debit memo from retry cycle
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: debit_memo_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
  /api/v1/payments/remove_account_from_retry_cycle/{account_id}:
    put:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: putRemoveAccountFromCycle
      summary: Remove an account from retry cycle
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
  /api/v1/payments/submit_failed_payment:
    post:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: postSubmitPaymentToCycle
      summary: Submit a payment to retry cycle
      tags:
        - Configurable Payment Retry
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                payment_id:
                  type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
  /api/v1/metrics/baseline:
    get:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: getBaselineMetrics
      summary: List the baseline metrics
      tags:
        - Configurable Payment Retry
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETBaselineMetricsResponse'
  /api/v1/metrics/amount_recovered:
    get:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: getAmountRecovered
      summary: List the amount recovered metrics
      tags:
        - Configurable Payment Retry
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETAmountRecoveredResponse'
  /api/v1/metrics/customer_group_over_time:
    get:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: getDocumentSuccessRateByCustomerGroup
      summary: List the document success rate metrics by customer group
      tags:
        - Configurable Payment Retry
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETDocumentSuccessRateByCustomerGroupResponse'
  /api/v1/metrics/customer_group:
    get:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: getCustomerGroupMetrics
      summary: List the customer group metrics
      tags:
        - Configurable Payment Retry
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETCustomerGroupMetricsResponse'
  /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
  /scim/v2/Groups:
    get:
      operationId: getListGroups
      parameters:
        - name: Content-Type
          in: header
          required: true
          schema:
            type: string
        - name: count
          in: query
          required: false
          schema:
            type: integer
            format: int32
        - name: filter
          in: query
          required: false
          schema:
            type: string
        - name: startIndex
          in: query
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: integer
            RateLimit-Reset:
              schema:
                type: integer
            Zuora-Request-Id:
              schema:
                type: string
                minLength: 36
                maxLength: 36
            Zuora-Track-Id:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  id:
                    type: string
                    nullable: true
                  externalId:
                    type: string
                    nullable: true
                  meta:
                    type: object
                    nullable: true
                  totalResults:
                    type: integer
                  resources:
                    type: array
                    items:
                      type: object
                      properties:
                        schemas:
                          type: array
                          items:
                            type: string
                        id:
                          type: string
                        displayName:
                          type: string
                        members:
                          type: array
                          items:
                            type: object
                            properties:
                              value:
                                type: string
                        urn:zuora:scim:schemas:1.0:GroupExtension:
                          type: object
                          properties:
                            schemas:
                              type: array
                              items:
                                type: string
                            organizationId:
                              type: string
                            active:
                              type: boolean
                        meta:
                          type: object
                          nullable: true
                          properties:
                            resourceType:
                              type: string
                            location:
                              type: string
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  reasons:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                        code:
                          type: string
        '403':
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                  status:
                    type: string
                  error:
                    type: string
                  message:
                    type: string
                  path:
                    type: string
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  status:
                    type: string
                  detail:
                    type: string
      summary: List groups
      tags:
        - SCIM
    post:
      operationId: createANewGroup
      parameters:
        - name: Content-Type
          in: header
          required: true
          schema:
            type: string
        - name: count
          in: query
          required: false
          schema:
            type: integer
            format: int32
        - name: filter
          in: query
          required: false
          schema:
            type: string
        - name: startIndex
          in: query
          required: false
          schema:
            type: integer
            format: int32
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                schemas:
                  type: array
                  items:
                    type: string
                displayName:
                  type: string
                urn:zuora:scim:schemas:1.0:GroupExtension:
                  type: object
                  properties:
                    schemas:
                      type: array
                      items:
                        type: string
                    organizationId:
                      type: string
      responses:
        '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:
                type: string
                minLength: 36
                maxLength: 36
            Zuora-Track-Id:
              schema:
                type: string
                maxLength: 64
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  id:
                    type: string
                  displayName:
                    type: string
                  urn:zuora:scim:schemas:1.0:GroupExtension:
                    type: object
                    properties:
                      schemas:
                        type: array
                        items:
                          type: string
                      organizationId:
                        type: string
                      active:
                        type: boolean
                  meta:
                    type: object
                    properties:
                      resourceType:
                        type: string
                      location:
                        type: string
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  reasons:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                        code:
                          type: string
        '403':
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                  status:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                  path:
                    type: string
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  status:
                    type: string
                  detail:
                    type: string
      summary: Create a group
      tags:
        - SCIM
  /scim/v2/Groups/bulk:
    post:
      tags:
        - SCIM
      summary: Bulk create groups
      operationId: postBulkCreateGroups
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                required:
                  - schemas
                  - displayName
                  - urn:zuora:scim:schemas:1.0:GroupExtension
                  - meta
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  displayName:
                    type: string
                  urn:zuora:scim:schemas:1.0:GroupExtension:
                    type: object
                    properties:
                      schemas:
                        type: array
                        items:
                          type: string
                      organizationId:
                        type: string
                      active:
                        type: boolean
                  meta:
                    type: object
                    nullable: true
                    properties:
                      resourceType:
                        type: string
      responses:
        '200':
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: integer
            RateLimit-Reset:
              schema:
                type: integer
            Zuora-Request-Id:
              schema:
                type: string
                minLength: 36
                maxLength: 36
            Zuora-Track-Id:
              schema:
                type: string
                maxLength: 64
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  totalResults:
                    type: integer
                  id:
                    type: string
                    nullable: true
                  externalId:
                    type: string
                    nullable: true
                  meta:
                    type: string
                    nullable: true
                  resources:
                    type: array
                    items:
                      type: object
                      properties:
                        schemas:
                          type: array
                          items:
                            type: string
                        id:
                          type: string
                        displayName:
                          type: string
                        urn:zuora:scim:schemas:1.0:GroupExtension:
                          type: object
                          properties:
                            schemas:
                              type: array
                              items:
                                type: string
                            organizationId:
                              type: string
                            active:
                              type: boolean
                        meta:
                          type: object
                          nullable: true
                          properties:
                            resourceType:
                              type: string
                            location:
                              type: string
                  startIndex:
                    type: integer
                  itemsPerPage:
                    type: integer
        '201': {}
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  reasons:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                        code:
                          type: string
        '403':
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                  status:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                  path:
                    type: string
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  status:
                    type: string
                  detail:
                    type: string
    patch:
      tags:
        - SCIM
      summary: Bulk update groups
      operationId: patchBulkPatchGroups
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - schemas
                - operations
              properties:
                schemas:
                  type: array
                  items:
                    type: string
                operations:
                  type: array
                  items:
                    type: object
                    required:
                      - op
                      - path
                      - value
                    properties:
                      op:
                        type: string
                        enum:
                          - add
                          - remove
                      path:
                        type: string
                      value:
                        type: array
                        items:
                          type: object
                          properties:
                            value:
                              type: string
      responses:
        '200':
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: integer
            RateLimit-Reset:
              schema:
                type: integer
            Zuora-Request-Id:
              schema:
                type: string
                minLength: 36
                maxLength: 36
            Zuora-Track-Id:
              schema:
                type: string
                maxLength: 64
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  id:
                    type: string
                    nullable: true
                  externalId:
                    type: string
                    nullable: true
                  meta:
                    type: object
                    nullable: true
                    properties:
                      resourceType:
                        type: string
                      location:
                        type: string
                  totalResults:
                    type: integer
                  resources:
                    type: array
                    items:
                      type: object
                      properties:
                        schemas:
                          type: array
                          items:
                            type: string
                        id:
                          type: string
                        displayName:
                          type: string
                        members:
                          type: array
                          items:
                            type: object
                            properties:
                              value:
                                type: string
                              display:
                                type: string
                        urn:zuora:scim:schemas:1.0:GroupExtension:
                          type: object
                          properties:
                            schemas:
                              type: array
                              items:
                                type: string
                            organizationId:
                              type: string
                            active:
                              type: boolean
                        meta:
                          type: object
                          properties:
                            resourceType:
                              type: string
                            location:
                              type: string
                  startIndex:
                    type: integer
                  itemsPerPage:
                    type: integer
        '204': {}
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  reasons:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                        code:
                          type: string
        '403':
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                  status:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                  path:
                    type: string
  /scim/v2/Groups/delete:
    post:
      tags:
        - SCIM
      summary: Bulk delete groups
      operationId: postBulkDeleteGroups
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                schemas:
                  type: array
                  items:
                    type: string
                operations:
                  type: array
                  items:
                    type: object
                    properties:
                      op:
                        type: string
                        enum:
                          - add
                          - remove
                          - replace
                      path:
                        type: string
                      value:
                        type: array
                        items:
                          type: object
                          properties:
                            value:
                              type: string
              required:
                - schemas
                - operations
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            type: string
        - name: Accept-Encoding
          in: header
          required: false
          schema:
            type: string
        - name: Content-Encoding
          in: header
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          required: false
          schema:
            type: string
        - name: Zuora-Track-Id
          in: header
          required: false
          schema:
            type: string
            maxLength: 64
        - name: Zuora-Entity-Ids-Single
          in: header
          required: false
          schema:
            type: string
      responses:
        '200':
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: integer
            RateLimit-Reset:
              schema:
                type: integer
            Zuora-Request-Id:
              schema:
                type: string
                minLength: 36
                maxLength: 36
            Zuora-Track-Id:
              schema:
                type: string
                maxLength: 64
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  id:
                    type: string
                    nullable: true
                  externalId:
                    type: string
                    nullable: true
                  meta:
                    type: object
                    nullable: true
                    properties:
                      resourceType:
                        type: string
                      location:
                        type: string
                  totalResults:
                    type: integer
                  resources:
                    type: array
                    items:
                      type: object
                      properties:
                        schemas:
                          type: array
                          items:
                            type: string
                        id:
                          type: string
                        externalId:
                          type: string
                          nullable: true
                        displayName:
                          type: string
                        urn:zuora:scim:schemas:1.0:GroupExtension:
                          type: object
                          properties:
                            organizationId:
                              type: string
                            active:
                              type: boolean
                        meta:
                          type: object
                          properties:
                            resourceType:
                              type: string
                            location:
                              type: string
                  startIndex:
                    type: integer
                  itemsPerPage:
                    type: integer
        '201': {}
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  reasons:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                        code:
                          type: string
        '403':
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                  status:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                  path:
                    type: string
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  status:
                    type: string
                  detail:
                    type: string
  /scim/v2/Groups/{id}:
    get:
      tags:
        - SCIM
      summary: Retrieve a group
      operationId: getASpecificGroup
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - $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'
      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:
                type: string
                minLength: 36
                maxLength: 36
            Zuora-Track-Id:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  id:
                    type: string
                  displayName:
                    type: string
                  members:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        display:
                          type: string
                  urn:zuora:scim:schemas:1.0:GroupExtension:
                    type: object
                    properties:
                      schemas:
                        type: array
                        items:
                          type: string
                      organizationId:
                        type: string
                      active:
                        type: boolean
                  meta:
                    type: object
                    properties:
                      resourceType:
                        type: string
                        enum:
                          - Group
                      location:
                        type: string
        '401':
          content:
            application/json: {}
        '403':
          content:
            application/json: {}
        '404':
          content:
            application/json: {}
    put:
      tags:
        - SCIM
      summary: Update a group
      operationId: updateASpecificGroup
      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'
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                schemas:
                  type: array
                  items:
                    type: string
                operations:
                  type: array
                  items:
                    type: object
                    required:
                      - op
                      - path
                      - value
                    properties:
                      op:
                        type: string
                      path:
                        type: string
                      value:
                        type: array
                        items:
                          type: object
                          required:
                            - value
                          properties:
                            value:
                              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:
                type: string
                minLength: 36
                maxLength: 36
            Zuora-Track-Id:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  id:
                    type: string
                  displayName:
                    type: string
                  members:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        display:
                          type: string
                  urn:zuora:scim:schemas:1.0:GroupExtension:
                    type: object
                    properties:
                      schemas:
                        type: array
                        items:
                          type: string
                      organizationId:
                        type: string
                      active:
                        type: boolean
                  meta:
                    type: object
                    properties:
                      resourceType:
                        type: string
                        enum:
                          - Group
                      location:
                        type: string
        '201': {}
        '401':
          content:
            application/json: {}
        '403':
          content:
            application/json: {}
        '404':
          content:
            application/json: {}
    delete:
      tags:
        - SCIM
      summary: Delete a group
      operationId: deleteASpecificGroup
      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'
        - name: id
          in: path
          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:
                type: string
            Zuora-Track-Id:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  id:
                    type: string
                  displayName:
                    type: string
                  urn:zuora:scim:schemas:1.0:GroupExtension:
                    type: object
                    properties:
                      schemas:
                        type: array
                        items:
                          type: string
                      organizationId:
                        type: string
                      active:
                        type: boolean
                  meta:
                    type: object
                    properties:
                      resourceType:
                        type: string
                      location:
                        type: string
        '401':
          content:
            application/json: {}
        '403':
          content:
            application/json: {}
        '404':
          content:
            application/json: {}
    patch:
      tags:
        - SCIM
      summary: Partially update a group
      operationId: partiallyUpdateAspecificGroup
      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'
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                schemas:
                  type: array
                  items:
                    type: string
                operations:
                  type: array
                  items:
                    type: object
                    properties:
                      op:
                        type: string
                        enum:
                          - add
                          - remove
                          - replace
                      path:
                        type: string
                      value:
                        type: array
                        items:
                          type: object
                          properties:
                            value:
                              type: string
              required:
                - schemas
                - operations
      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:
                type: string
            Zuora-Track-Id:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  id:
                    type: string
                  displayName:
                    type: string
                  members:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        display:
                          type: string
                  urn:zuora:scim:schemas:1.0:GroupExtension:
                    type: object
                    properties:
                      schemas:
                        type: array
                        items:
                          type: string
                      organizationId:
                        type: string
                      active:
                        type: boolean
                  meta:
                    type: object
                    properties:
                      resourceType:
                        type: string
                      location:
                        type: string
        '204': {}
        '401':
          content:
            application/json: {}
        '403':
          content:
            application/json: {}
  /scim/v2/ResourceTypes:
    get:
      tags:
        - SCIM
      summary: List all resource types
      operationId: getTheRessourceType
      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'
      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:
                type: string
            Zuora-Track-Id:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  totalResults:
                    type: integer
                  resources:
                    type: array
                    items:
                      type: object
                      properties:
                        schemas:
                          type: array
                          items:
                            type: string
                        id:
                          type: string
                        name:
                          type: string
                        endpoint:
                          type: string
                        schema:
                          type: string
                        schemaExtensions:
                          type: array
                          items:
                            type: object
                            properties:
                              schema:
                                type: string
                              required:
                                type: boolean
                        meta:
                          type: object
                          properties:
                            resourceType:
                              type: string
                            location:
                              type: string
                  startIndex:
                    type: integer
                  itemsPerPage:
                    type: integer
        '401':
          content:
            application/json: {}
        '403':
          content:
            application/json: {}
        '404':
          content:
            application/json: {}
  /scim/v2/ResourceTypes/{id}:
    get:
      tags:
        - SCIM
      summary: Retrieve a resource type
      operationId: getASpecificResourceType
      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'
        - name: id
          in: path
          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:
                type: string
                minLength: 36
                maxLength: 36
            Zuora-Track-Id:
              schema:
                type: string
                maxLength: 64
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  id:
                    type: string
                  name:
                    type: string
                  endpoint:
                    type: string
                  schema:
                    type: string
                  schemaExtensions:
                    type: array
                    items:
                      type: object
                      properties:
                        schema:
                          type: string
                        required:
                          type: boolean
                  meta:
                    type: object
                    properties:
                      resourceType:
                        type: string
                      location:
                        type: string
        '401':
          content:
            application/json: {}
        '403':
          content:
            application/json: {}
        '404':
          content:
            application/json: {}
  /scim/v2/Schemas:
    get:
      tags:
        - SCIM
      summary: List all schemas of resources
      operationId: getSchemaOfSCIM
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            type: string
        - name: Accept-Encoding
          in: header
          required: false
          schema:
            type: string
        - name: Content-Encoding
          in: header
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          required: false
          schema:
            type: string
        - name: Zuora-Track-Id
          in: header
          required: false
          schema:
            type: string
        - name: Zuora-Entity-Ids-Single
          in: header
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  patch:
                    type: object
                    properties:
                      supported:
                        type: boolean
                  bulk:
                    type: object
                    properties:
                      supported:
                        type: boolean
                      maxOperations:
                        type: integer
                      maxPayloadSize:
                        type: integer
                  filter:
                    type: object
                    properties:
                      supported:
                        type: boolean
                      maxResults:
                        type: integer
                  changePassword:
                    type: object
                    properties:
                      supported:
                        type: boolean
                  sort:
                    type: object
                    properties:
                      supported:
                        type: boolean
                  etag:
                    type: object
                    properties:
                      supported:
                        type: boolean
                  authenticationSchemes:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        specUri:
                          type: string
                        type:
                          type: string
                        primary:
                          type: boolean
                  id:
                    type: string
                    nullable: true
                  externalId:
                    type: string
                    nullable: true
                  meta:
                    nullable: true
                    type: object
                    properties:
                      resourceType:
                        type: string
                      location:
                        type: string
                  totalResults:
                    type: integer
                  resources:
                    type: array
                    items:
                      type: object
                      properties:
                        schemas:
                          type: array
                          items:
                            type: string
                        id:
                          type: string
                        name:
                          type: string
                        attributes:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                              multiValued:
                                type: boolean
                              required:
                                type: boolean
                              caseExact:
                                type: boolean
                              mutability:
                                type: string
                              returned:
                                type: string
                              uniqueness:
                                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:
                type: string
                minLength: 36
                maxLength: 36
            Zuora-Track-Id:
              schema:
                type: string
                maxLength: 64
        '401':
          content:
            application/json: {}
        '403':
          content:
            application/json: {}
        '404':
          content:
            application/json: {}
  /scim/v2/Schemas/{id}:
    get:
      tags:
        - SCIM
      summary: List schemas of a resource
      operationId: getTheSchemaOfSpecificSCIM
      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'
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          headers:
            Content-Encoding:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  id:
                    type: string
                  name:
                    type: string
                  attributes:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        type:
                          type: string
                        multiValued:
                          type: boolean
                        required:
                          type: boolean
                        caseExact:
                          type: boolean
                        mutability:
                          type: string
                        returned:
                          type: string
                        uniqueness:
                          type: string
                  meta:
                    type: object
                    properties:
                      resourceType:
                        type: string
                      location:
                        type: string
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  reasons:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                        code:
                          type: string
        '403':
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    format: date-time
                  status:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                  path:
                    type: string
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  status:
                    type: string
                  detail:
                    type: string
  /scim/v2/ServiceProviderConfig:
    get:
      tags:
        - SCIM
      summary: Retrieve the service provider configuration
      operationId: getTheServiceProviderConfig
      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:
                type: string
                minLength: 36
                maxLength: 36
            Zuora-Track-Id:
              schema:
                type: string
                maxLength: 64
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  patch:
                    type: object
                    properties:
                      supported:
                        type: boolean
                  bulk:
                    type: object
                    properties:
                      supported:
                        type: boolean
                      maxOperations:
                        type: integer
                      maxPayloadSize:
                        type: integer
                  filter:
                    type: object
                    properties:
                      supported:
                        type: boolean
                      maxResults:
                        type: integer
                  changePassword:
                    type: object
                    properties:
                      supported:
                        type: boolean
                  sort:
                    type: object
                    properties:
                      supported:
                        type: boolean
                  etag:
                    type: object
                    properties:
                      supported:
                        type: boolean
                  authenticationSchemes:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        specUri:
                          type: string
                        type:
                          type: string
                        primary:
                          type: boolean
                  meta:
                    type: object
                    properties:
                      resourceType:
                        type: string
                      location:
                        type: string
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  reasons:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                        code:
                          type: string
        '403':
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    format: date-time
                  status:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                  path:
                    type: string
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  status:
                    type: string
                  detail:
                    type: string
  /scim/v2/Users:
    get:
      tags:
        - SCIM
      summary: List users
      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'
      operationId: getListOfUsers
      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:
                type: string
                minLength: 36
                maxLength: 36
            Zuora-Track-Id:
              schema:
                type: string
                maxLength: 64
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  totalResults:
                    type: integer
                  resources:
                    type: array
                    items:
                      type: object
                      properties:
                        schemas:
                          type: array
                          items:
                            type: string
                        id:
                          type: string
                        meta:
                          type: object
                          properties:
                            created:
                              type: string
                              format: date-time
                            resourceType:
                              type: string
                            location:
                              type: string
                        userName:
                          type: string
                        name:
                          type: object
                          properties:
                            formatted:
                              type: string
                            familyName:
                              type: string
                            givenName:
                              type: string
                        displayName:
                          type: string
                        preferredLanguage:
                          type: string
                        locale:
                          type: string
                        active:
                          type: boolean
                        emails:
                          type: array
                          items:
                            type: object
                            properties:
                              value:
                                type: string
                              display:
                                type: string
                              type:
                                type: string
                              primary:
                                type: boolean
                        roles:
                          type: array
                          items:
                            type: object
                            properties:
                              value:
                                type: string
                              display:
                                type: string
                        groups:
                          type: array
                          items:
                            type: object
                            properties:
                              value:
                                type: string
                              display:
                                type: string
                        urn:zuora:scim:schemas:1.0:UserExtension:
                          type: object
                          properties:
                            schemas:
                              type: array
                              items:
                                type: string
                            organizationId:
                              type: string
                            status:
                              type: string
                            ssoEnabled:
                              type: boolean
                            region:
                              type: string
                  startIndex:
                    type: integer
                  itemsPerPage:
                    type: integer
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  reasons:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                        code:
                          type: string
        '403':
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    format: date-time
                  status:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                  path:
                    type: string
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  status:
                    type: string
                  detail:
                    type: string
    post:
      tags:
        - SCIM
      summary: Create a user
      operationId: createAUser
      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'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                required:
                  - schemas
                  - name
                  - active
                  - emails
                  - roles
                  - externalId
                  - userName
                  - preferredLanguage
                  - locale
                  - urn:zuora:scim:schemas:1.0:UserExtension
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  name:
                    type: object
                    properties:
                      givenName:
                        type: string
                      familyName:
                        type: string
                      formatted:
                        type: string
                  active:
                    type: boolean
                  emails:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        type:
                          type: string
                        primary:
                          type: boolean
                  roles:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                  externalId:
                    type: string
                  userName:
                    type: string
                  preferredLanguage:
                    type: string
                  locale:
                    type: string
                  urn:zuora:scim:schemas:1.0:UserExtension:
                    type: object
                    properties:
                      schemas:
                        type: array
                        items:
                          type: string
                      organizationId:
                        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:
                type: string
                minLength: 36
                maxLength: 36
            Zuora-Track-Id:
              schema:
                type: string
                maxLength: 64
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  id:
                    type: string
                  externalId:
                    type: string
                  meta:
                    type: object
                    properties:
                      created:
                        type: string
                        format: date-time
                      resourceType:
                        type: string
                      location:
                        type: string
                  userName:
                    type: string
                  name:
                    type: object
                    properties:
                      formatted:
                        type: string
                      familyName:
                        type: string
                      givenName:
                        type: string
                  displayName:
                    type: string
                  preferredLanguage:
                    type: string
                  locale:
                    type: string
                  active:
                    type: boolean
                  emails:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        display:
                          type: string
                        type:
                          type: string
                        primary:
                          type: boolean
                  roles:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        display:
                          type: string
                  urn:zuora:scim:schemas:1.0:UserExtension:
                    type: object
                    properties:
                      schemas:
                        type: array
                        items:
                          type: string
                      organizationId:
                        type: string
                      status:
                        type: string
                      ssoEnabled:
                        type: boolean
                      region:
                        type: string
        '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:
                type: string
                minLength: 36
                maxLength: 36
            Zuora-Track-Id:
              schema:
                type: string
                maxLength: 64
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  id:
                    type: string
                  meta:
                    type: object
                    properties:
                      created:
                        type: string
                        format: date-time
                      resourceType:
                        type: string
                      location:
                        type: string
                  userName:
                    type: string
                  name:
                    type: object
                    properties:
                      formatted:
                        type: string
                      familyName:
                        type: string
                      givenName:
                        type: string
                  displayName:
                    type: string
                  preferredLanguage:
                    type: string
                  locale:
                    type: string
                  active:
                    type: boolean
                  emails:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        display:
                          type: string
                        type:
                          type: string
                        primary:
                          type: boolean
                  groups:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        display:
                          type: string
                  roles:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        display:
                          type: string
                  urn:zuora:scim:schemas:1.0:UserExtension:
                    type: object
                    properties:
                      schemas:
                        type: array
                        items:
                          type: string
                      organizationId:
                        type: string
                      status:
                        type: string
                      ssoEnabled:
                        type: boolean
                      region:
                        type: string
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  reasons:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                        code:
                          type: string
        '403':
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    format: date-time
                  status:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                  path:
                    type: string
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  status:
                    type: string
                  detail:
                    type: string
  /scim/v2/Users/bulk:
    post:
      tags:
        - SCIM
      summary: Bulk create users
      operationId: bulkCreateUsers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  name:
                    type: object
                    properties:
                      givenName:
                        type: string
                      familyName:
                        type: string
                      formatted:
                        type: string
                  emails:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        type:
                          type: string
                        primary:
                          type: boolean
                  roles:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        display:
                          type: string
                          nullable: true
                  userName:
                    type: string
                  preferredLanguage:
                    type: string
                  locale:
                    type: string
                  urn:zuora:scim:schemas:1.0:UserExtension:
                    type: object
                    properties:
                      schemas:
                        type: array
                        items:
                          type: string
                      organizationId:
                        type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  id:
                    type: string
                    nullable: true
                  externalId:
                    type: string
                    nullable: true
                  totalResults:
                    type: integer
                  resources:
                    type: array
                    items:
                      type: object
                      properties:
                        schemas:
                          type: array
                          items:
                            type: string
                        id:
                          type: string
                          nullable: true
                        externalId:
                          type: string
                          nullable: true
                        meta:
                          nullable: true
                          type: object
                          properties:
                            created:
                              type: string
                              format: date-time
                            resourceType:
                              type: string
                            location:
                              type: string
                        userName:
                          type: string
                        name:
                          type: object
                          properties:
                            formatted:
                              type: string
                            familyName:
                              type: string
                            givenName:
                              type: string
                        displayName:
                          type: string
                        preferredLanguage:
                          type: string
                        locale:
                          type: string
                        active:
                          type: boolean
                        emails:
                          type: array
                          items:
                            type: object
                            properties:
                              value:
                                type: string
                              display:
                                type: string
                              type:
                                type: string
                              primary:
                                type: boolean
                        roles:
                          type: array
                          items:
                            type: object
                            properties:
                              value:
                                type: string
                              display:
                                type: string
                                nullable: true
                        urn:zuora:scim:schemas:1.0:UserExtension:
                          type: object
                          properties:
                            schemas:
                              type: array
                              items:
                                type: string
                            organizationId:
                              type: string
                              format: uuid
                            status:
                              type: string
                            ssoEnabled:
                              type: boolean
                            region:
                              type: string
                  startIndex:
                    type: integer
                  itemsPerPage:
                    type: integer
        '201': {}
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  reasons:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                        code:
                          type: string
        '403':
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    format: date-time
                  status:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                  path:
                    type: string
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  status:
                    type: string
                  detail:
                    type: string
    patch:
      tags:
        - SCIM
      summary: Bulk update users
      operationId: bulkUpdateUsers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  id:
                    type: string
                  externalId:
                    type: string
                  meta:
                    type: object
                    properties:
                      created:
                        type: string
                        format: date-time
                      resourceType:
                        type: string
                      location:
                        type: string
                  userName:
                    type: string
                  name:
                    type: object
                    properties:
                      formatted:
                        type: string
                      familyName:
                        type: string
                      givenName:
                        type: string
                  displayName:
                    type: string
                  preferredLanguage:
                    type: string
                  locale:
                    type: string
                  active:
                    type: boolean
                  emails:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        display:
                          type: string
                        type:
                          type: string
                        primary:
                          type: boolean
                  roles:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        display:
                          type: string
                          nullable: true
                  urn:zuora:scim:schemas:1.0:UserExtension:
                    type: object
                    properties:
                      schemas:
                        type: array
                        items:
                          type: string
                      organizationId:
                        type: string
                      status:
                        type: string
                      ssoEnabled:
                        type: boolean
                      region:
                        type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  itemsPerPage:
                    type: integer
                  startIndex:
                    type: integer
                  schemas:
                    type: array
                    items:
                      type: string
                  id:
                    type: string
                    nullable: true
                  externalId:
                    type: string
                    nullable: true
                  meta:
                    type: object
                    nullable: true
                    properties:
                      created:
                        type: string
                        format: date-time
                      resourceType:
                        type: string
                      location:
                        type: string
                  totalResults:
                    type: integer
                  resources:
                    type: array
                    items:
                      type: object
                      properties:
                        schemas:
                          type: array
                          items:
                            type: string
                        id:
                          type: string
                          nullable: true
                        externalId:
                          type: string
                          nullable: true
                        meta:
                          type: object
                          properties:
                            created:
                              type: string
                              format: date-time
                            resourceType:
                              type: string
                            location:
                              type: string
                        userName:
                          type: string
                        name:
                          type: object
                          properties:
                            formatted:
                              type: string
                            familyName:
                              type: string
                            givenName:
                              type: string
                        displayName:
                          type: string
                        preferredLanguage:
                          type: string
                        locale:
                          type: string
                        active:
                          type: boolean
                        emails:
                          type: array
                          items:
                            type: object
                            properties:
                              value:
                                type: string
                              display:
                                type: string
                              type:
                                type: string
                              primary:
                                type: boolean
                        roles:
                          type: array
                          items:
                            type: object
                            properties:
                              value:
                                type: string
                              display:
                                type: string
                                nullable: true
                        urn:zuora:scim:schemas:1.0:UserExtension:
                          type: object
                          properties:
                            schemas:
                              type: array
                              items:
                                type: string
                            organizationId:
                              type: string
                              format: uuid
                            status:
                              type: string
                            ssoEnabled:
                              type: boolean
                            region:
                              type: string
        '204':
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  reasons:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                        code:
                          type: string
        '403':
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    format: date-time
                  status:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                  path:
                    type: string
  /scim/v2/Users/delete:
    post:
      tags:
        - SCIM
      summary: Delete a list of users
      operationId: deleteAListOfUsers
      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'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
                format: uuid
      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:
                type: string
                minLength: 36
            Zuora-Track-Id:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  resources:
                    type: array
                    items:
                      type: object
                      properties:
                        schemas:
                          type: array
                          items:
                            type: string
                        externalId:
                          type: string
                          nullable: true
                        id:
                          type: string
                          nullable: true
                        meta:
                          type: object
                          nullable: true
                          properties:
                            resourceType:
                              type: string
                            location:
                              type: string
                            created:
                              type: string
                              format: dateTime
                        schemaUrns:
                          type: array
                          items:
                            type: string
                  externalId:
                    type: string
                    nullable: true
                  id:
                    type: string
                    nullable: true
                  itemsPerPage:
                    type: integer
                    format: int32
                  meta:
                    nullable: true
                    type: object
                    properties:
                      resourceType:
                        type: string
                      location:
                        type: string
                  schemas:
                    type: array
                    uniqueItems: true
                    items:
                      type: string
                  startIndex:
                    type: integer
                    format: int32
                  totalResults:
                    type: integer
                    format: int64
        '201':
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  id:
                    type: string
                  meta:
                    type: object
                    properties:
                      created:
                        type: string
                        format: date-time
                      resourceType:
                        type: string
                      location:
                        type: string
                  userName:
                    type: string
                  name:
                    type: object
                    properties:
                      formatted:
                        type: string
                      familyName:
                        type: string
                      givenName:
                        type: string
                  displayName:
                    type: string
                  preferredLanguage:
                    type: string
                  locale:
                    type: string
                  active:
                    type: boolean
                  emails:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        display:
                          type: string
                        type:
                          type: string
                        primary:
                          type: boolean
                  groups:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        display:
                          type: string
                  roles:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        display:
                          type: string
                  urn:zuora:scim:schemas:1.0:UserExtension:
                    type: object
                    properties:
                      schemas:
                        type: array
                        items:
                          type: string
                      organizationId:
                        type: string
                      status:
                        type: string
                      ssoEnabled:
                        type: boolean
                      region:
                        type: string
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  reasons:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                        code:
                          type: string
        '403':
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    format: date-time
                  status:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                  path:
                    type: string
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                      enum:
                        - urn:ietf:params:scim:api:messages:2.0:Error
                  status:
                    type: string
                  detail:
                    type: string
  /scim/v2/Users/{id}:
    get:
      tags:
        - SCIM
      summary: Retrieve a user
      operationId: getASpecificUser
      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'
        - name: id
          in: path
          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:
                type: string
                minLength: 36
                maxLength: 36
            Zuora-Track-Id:
              schema:
                type: string
                maxLength: 64
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  id:
                    type: string
                  meta:
                    type: object
                    properties:
                      created:
                        type: string
                        format: date-time
                      resourceType:
                        type: string
                      location:
                        type: string
                  userName:
                    type: string
                  name:
                    type: object
                    properties:
                      formatted:
                        type: string
                      familyName:
                        type: string
                      givenName:
                        type: string
                  displayName:
                    type: string
                  preferredLanguage:
                    type: string
                  locale:
                    type: string
                  active:
                    type: boolean
                  emails:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        display:
                          type: string
                        type:
                          type: string
                        primary:
                          type: boolean
                  groups:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        display:
                          type: string
                  roles:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        display:
                          type: string
                  urn:zuora:scim:schemas:1.0:UserExtension:
                    type: object
                    properties:
                      schemas:
                        type: array
                        items:
                          type: string
                      organizationId:
                        type: string
                      status:
                        type: string
                      ssoEnabled:
                        type: boolean
                      region:
                        type: string
        '401':
          content:
            application/json: {}
        '403':
          content:
            application/json: {}
        '404':
          content:
            application/json: {}
    put:
      tags:
        - SCIM
      summary: Update a user
      operationId: updateASpecificUser
      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'
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                schemas:
                  type: array
                  items:
                    type: string
                id:
                  type: string
                  nullable: true
                externalId:
                  type: string
                meta:
                  type: object
                  properties:
                    created:
                      type: string
                      format: date-time
                    resourceType:
                      type: string
                    location:
                      type: string
                userName:
                  type: string
                name:
                  type: object
                  properties:
                    formatted:
                      type: string
                    familyName:
                      type: string
                    givenName:
                      type: string
                displayName:
                  type: string
                preferredLanguage:
                  type: string
                locale:
                  type: string
                active:
                  type: boolean
                emails:
                  type: array
                  items:
                    type: object
                    properties:
                      value:
                        type: string
                groups:
                  type: array
                  items:
                    type: object
                    properties:
                      value:
                        type: string
                      display:
                        type: string
                roles:
                  type: array
                  items:
                    type: object
                    properties:
                      value:
                        type: string
                      display:
                        type: string
                urn:zuora:scim:schemas:1.0:UserExtension:
                  type: object
                  properties:
                    schemas:
                      type: array
                      items:
                        type: string
                    organizationId:
                      type: string
                    status:
                      type: string
                    ssoEnabled:
                      type: boolean
                    region:
                      type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  userName:
                    type: string
                  displayName:
                    type: string
                  active:
                    type: boolean
                  emails:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        primary:
                          type: boolean
                  meta:
                    type: object
                    properties:
                      resourceType:
                        type: string
                      created:
                        type: string
                        format: date-time
                      lastModified:
                        type: string
                        format: date-time
        '401':
          content:
            application/json: {}
        '403':
          content:
            application/json: {}
        '404':
          content:
            application/json: {}
    delete:
      tags:
        - SCIM
      summary: Delete a user
      operationId: deleteASpecificUser
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
        - name: Accept-Encoding
          in: header
          required: false
          schema:
            type: string
        - name: Content-Encoding
          in: header
          required: false
          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:
                type: string
            Zuora-Track-Id:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  userName:
                    type: string
                  displayName:
                    type: string
                  active:
                    type: boolean
                  emails:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        primary:
                          type: boolean
                  meta:
                    type: object
                    properties:
                      resourceType:
                        type: string
                      created:
                        type: string
                        format: date-time
                      lastModified:
                        type: string
                        format: date-time
        '204':
          content:
            application/json:
              schema:
                type: object
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  reasons:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                        code:
                          type: string
        '403':
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    format: date-time
                  status:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                  path:
                    type: string
    patch:
      tags:
        - SCIM
      summary: Partially update a user
      operationId: partialUpdateASpecificUser
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - $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'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                schemas:
                  type: array
                  items:
                    type: string
                    enum:
                      - urn:ietf:params:scim:api:messages:2.0:PatchOp
                operations:
                  type: array
                  items:
                    type: object
                    properties:
                      op:
                        type: string
                        enum:
                          - replace
                          - add
                          - remove
                          - copy
                          - move
                          - test
                      path:
                        type: string
                      value:
                        type: object
                        properties:
                          emails:
                            type: array
                            items:
                              type: object
                              properties:
                                value:
                                  type: string
                                  format: email
                                display:
                                  type: string
                                type:
                                  type: string
                                  enum:
                                    - work
                                    - home
                                    - other
                                primary:
                                  type: boolean
              required:
                - schemas
                - operations
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                      enum:
                        - urn:zuora:scim:schemas:1.0:UserExtension
                        - urn:ietf:params:scim:schemas:core:2.0:User
                  id:
                    type: string
                  meta:
                    type: object
                    properties:
                      created:
                        type: string
                        format: date-time
                      resourceType:
                        type: string
                      location:
                        type: string
                  userName:
                    type: string
                  name:
                    type: object
                    properties:
                      formatted:
                        type: string
                      familyName:
                        type: string
                      givenName:
                        type: string
                  displayName:
                    type: string
                  preferredLanguage:
                    type: string
                  locale:
                    type: string
                  active:
                    type: boolean
                  emails:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        display:
                          type: string
                        type:
                          type: string
                        primary:
                          type: boolean
                  groups:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        display:
                          type: string
                  roles:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        display:
                          type: string
                  urn:zuora:scim:schemas:1.0:UserExtension:
                    type: object
                    properties:
                      schemas:
                        type: array
                        items:
                          type: string
                          enum:
                            - urn:zuora:scim:schemas:1.0:UserExtension
                      organizationId:
                        type: string
                      status:
                        type: string
                      ssoEnabled:
                        type: boolean
                      region:
                        type: string
        '204': {}
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  reasons:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                        code:
                          type: string
        '403':
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    format: date-time
                  status:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                  path:
                    type: string
  /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
  /system-health/api-requests/volume-summary:
    get:
      operationId: GET_SystemHealthApiVolumeSummary
      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: path
          required: false
          schema:
            type: string
        - in: query
          name: httpMethod
          required: false
          schema:
            type: string
        - in: query
          name: startTime
          required: true
          schema:
            format: date-time
            type: string
        - in: query
          name: endTime
          required: true
          schema:
            format: date-time
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiVolumeSummaryResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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/SystemHealthErrorResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 API volume summary records
      tags:
        - API Health
      x-code-samples:
        - label: Curl
          lang: curl
          source: |
            curl -i -X GET \
              'https://rest.zuora.com/system-health/api-requests/volume-summary?startTime=2022-09-22T09:07-0800&endTime=2022-09-25T09:07-0800' \ 
              -H 'Authorization: Bearer 7la16f1afa6f48099dc0605d7a175846'
  /system-health/api-requests/failures:
    get:
      operationId: getSystemHealthApiFailureRecords
      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_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - in: query
          name: path
          required: false
          schema:
            type: string
        - in: query
          name: httpMethod
          required: false
          schema:
            type: string
        - in: query
          name: responseCode
          required: false
          schema:
            type: string
        - in: query
          name: requestId
          required: false
          schema:
            type: string
        - in: query
          name: trackId
          required: false
          schema:
            type: string
        - in: query
          name: sort
          required: false
          schema:
            type: string
        - in: query
          name: startTime
          required: true
          schema:
            format: date-time
            type: string
        - in: query
          name: endTime
          required: true
          schema:
            format: date-time
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiFailureRecordResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: 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/SystemHealthErrorResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: 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 API failure records
      tags:
        - API Health
      x-code-samples:
        - label: cURL
          lang: curl
          source: |-
            curl -i -X GET 'https://rest.zuora.com/system-health/api-requests/failures?startTime=2024-09-22T09:07+0800&endTime=2024-09-23T09:07+0800&page=1&limit=10&sort=-timestamp' \
            -H 'Authorization: Bearer 2c129bd58623470a8a8b713d26477c97'
  /system-health/api-requests/details:
    get:
      operationId: getSystemHealthApiPerformanceRecords
      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_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - in: query
          name: path
          required: false
          schema:
            type: string
        - in: query
          name: httpMethod
          required: false
          schema:
            type: string
        - in: query
          name: responseCode
          required: false
          schema:
            type: string
        - in: query
          name: requestId
          required: false
          schema:
            type: string
        - in: query
          name: trackId
          required: false
          schema:
            type: string
        - in: query
          name: sort
          required: false
          schema:
            type: string
        - in: query
          name: startTime
          required: true
          schema:
            format: date-time
            type: string
        - in: query
          name: endTime
          required: true
          schema:
            format: date-time
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiPerformanceDetailResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: 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/SystemHealthErrorResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: 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 API usage detail records
      tags:
        - API Health
      x-code-samples:
        - label: cURL
          lang: curl
          source: |-
            curl -i -X GET 'https://rest.zuora.com/system-health/api-requests/details?startTime=2024-09-22T09:07+0800&endTime=2024-09-23T09:07+0800&page=1&limit=10&sort=-timestamp' \
            -H 'Authorization: Bearer 2c129bd58623470a8a8b713d26477c97'
  /system-health/billing-documents/volume-summary:
    get:
      operationId: GET_SystemHealthBillingDocVolumeSummary
      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: startTime
          required: true
          schema:
            format: date-time
            type: string
        - in: query
          name: endTime
          required: true
          schema:
            format: date-time
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBillingDocVolumeSummaryResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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/SystemHealthErrorResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 billing document volume summary records
      tags:
        - Bill Run Health
      x-code-samples:
        - label: Curl
          lang: curl
          source: |
            curl -i -X GET \
              'https://rest.zuora.com/system-health/billing-documents/volume-summary?startTime=2022-09-22T09:07-0800&endTime=2022-09-24T09:07-0800' \ 
              -H 'Authorization: Bearer 7la16f1afa6f48099dc0605d7a175846'
  /system-health/payments/volume-summary:
    get:
      operationId: GET_SystemHealthPaymentVolumeSummary
      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: paymentGatewayType
          required: false
          schema:
            type: string
        - in: query
          name: paymentMethodType
          required: false
          schema:
            type: string
        - in: query
          name: startTime
          required: true
          schema:
            format: date-time
            type: string
        - in: query
          name: endTime
          required: true
          schema:
            format: date-time
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentVolumeSummaryResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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/SystemHealthErrorResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 payment volume summary records
      tags:
        - Electronic Payments Health
      x-code-samples:
        - label: Curl
          lang: curl
          source: |
            curl -i -X GET \
              'https://rest.zuora.com/system-health/payments/volume-summary?paymentGatewayType=string&paymentMethodType=string&startTime=2022-09-22T09:07-0800&endTime=2022-09-25T09:07-0800' \
              -H 'Authorization: Bearer 7la16f1afa6f48099dc0605d7a175846'
  /system-health/payments/details:
    get:
      operationId: getSystemHealthPaymentRecords
      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_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - in: query
          name: paymentGatewayType
          required: false
          schema:
            type: string
        - in: query
          name: paymentMethodType
          required: false
          schema:
            type: string
        - in: query
          name: paymentStatus
          required: false
          schema:
            type: string
        - in: query
          name: paymentGatewayResponseCode
          required: false
          schema:
            type: string
        - in: query
          name: currency
          required: false
          schema:
            type: string
        - in: query
          name: sort
          required: false
          schema:
            type: string
        - in: query
          name: startTime
          required: true
          schema:
            format: date-time
            type: string
        - in: query
          name: endTime
          required: true
          schema:
            format: date-time
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentRecordsResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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/SystemHealthErrorResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 payment system health records
      tags:
        - Electronic Payments Health
      x-code-samples:
        - label: cURL
          lang: curl
          source: |-
            curl -i -X  'https://rest.zuora.com/system-health/payments/details?startTime=2024-09-22T09:07+0800&endTime=2024-09-23T09:07+0800&pageSize=1&sort=amount&page=3' \
            --header 'Authorization: Bearer bfc0f973d84d47cb4ddff1b1cd3a61b0'
  /system-health/tax/details:
    get:
      operationId: getSystemHealthTaxRecords
      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_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - in: query
          name: vendorName
          required: false
          schema:
            type: string
        - in: query
          name: eventType
          required: false
          schema:
            type: string
        - in: query
          name: status
          required: false
          schema:
            type: string
        - in: query
          name: sort
          required: false
          schema:
            type: string
        - in: query
          name: startTime
          required: true
          schema:
            format: date-time
            type: string
        - in: query
          name: endTime
          required: true
          schema:
            format: date-time
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTaxRecordsResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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/SystemHealthErrorResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 tax system health records
      tags:
        - Tax Health
      x-code-samples:
        - label: cURL
          lang: curl
          source: |
            curl -i -X GET \
              'https://rest.zuora.com/system-health/tax/details?startTime=2022-09-22T09:07-0800&endTime=2022-09-25T09:07-0800' \
              -H 'Authorization: Bearer 7la16g11ga6g47099dc0605d7a175836'
  /workflows/versions/{version_id}:
    delete:
      operationId: DELETE_WorkflowVersion
      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: version_id
          required: true
          schema:
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteWorkflowSuccess'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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/DeleteWorkflowError'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 workflow version
      tags:
        - Workflows
  /workflows:
    get:
      operationId: GET_Workflows
      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: callout_trigger
          required: false
          schema:
            type: boolean
        - in: query
          name: interval
          required: false
          schema:
            type: string
        - in: query
          name: name
          required: false
          schema:
            type: string
        - in: query
          name: ondemand_trigger
          required: false
          schema:
            type: boolean
        - in: query
          name: scheduled_trigger
          required: false
          schema:
            type: boolean
        - in: query
          name: page
          required: false
          schema:
            default: 1
            type: integer
        - in: query
          name: page_length
          required: false
          schema:
            default: 20
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkflowsResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 workflows
      tags:
        - Workflows
  /workflows/import:
    post:
      operationId: POST_WorkflowImport
      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'
        - in: query
          name: workflow_definition_id
          required: false
          schema:
            type: integer
        - in: query
          name: version
          required: false
          schema:
            type: string
        - in: query
          name: activate
          required: false
          schema:
            type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTWorkflowDefinitionImportRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workflow'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Import a workflow
      tags:
        - Workflows
  /workflows/metrics.json:
    get:
      operationId: GET_WorkflowsUsages
      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: startDate
          required: true
          schema:
            format: date
            type: string
        - in: query
          name: endDate
          required: true
          schema:
            format: date
            type: string
        - in: query
          name: metrics
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsagesResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 workflow task usage
      tags:
        - Workflows
  /workflows/tasks:
    get:
      operationId: GET_WorkflowsTasks
      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: id
          required: false
          schema:
            type: string
        - in: query
          name: name
          required: false
          schema:
            type: string
        - in: query
          name: instance
          required: false
          schema:
            type: boolean
        - in: query
          name: action_type
          required: false
          schema:
            type: string
        - in: query
          name: object
          required: false
          schema:
            type: string
        - in: query
          name: object_id
          required: false
          schema:
            type: string
        - in: query
          name: call_type
          required: false
          schema:
            type: string
        - in: query
          name: workflow_id
          required: false
          schema:
            type: string
        - explode: false
          in: query
          name: tags
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - in: query
          name: page
          required: false
          schema:
            default: 1
            type: integer
        - in: query
          name: page_length
          required: false
          schema:
            default: 20
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TasksResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 workflow tasks
      tags:
        - Workflows
  /workflows/tasks/batch_update:
    put:
      operationId: PUT_WorkflowsTasksUpdate
      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/PutTasksRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TasksResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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/BadRequestResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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/BadRequestResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 workflow tasks
      tags:
        - Workflows
  /workflows/tasks/{task_id}:
    get:
      operationId: GET_WorkflowsTask
      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: task_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 workflow task
      tags:
        - Workflows
  /workflows/tasks/{task_id}/rerun:
    post:
      operationId: POST_WorkflowsTaskRerun
      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: task_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Rerun a workflow task
      tags:
        - Workflows
  /workflows/workflow_runs/{workflow_run_id}:
    get:
      operationId: GET_Workflow_Run
      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: workflow_run_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkflowResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 workflow run
      tags:
        - Workflows
  /workflows/{workflow_id}:
    delete:
      operationId: DELETE_Workflow
      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: workflow_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteWorkflowSuccess'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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/DeleteWorkflowError'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 workflow
      tags:
        - Workflows
    get:
      operationId: GET_Workflow
      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: workflow_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowDefinition'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 workflow
      tags:
        - Workflows
    patch:
      operationId: PATCH_UpdateWorkflow
      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: workflow_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                active_workflow_version_id:
                  type: integer
                name:
                  type: string
                status:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowDefinition'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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/DeleteWorkflowError'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              schema:
                type: number
            Zuora-Request-Id:
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrors'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 workflow
      tags:
        - Workflows
  /workflows/{workflow_id}/export:
    get:
      operationId: GET_WorkflowExport
      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: workflow_id
          required: true
          schema:
            type: integer
        - in: query
          name: version
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportWorkflowVersionResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/WorkflowError'
                    type: array
                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:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/WorkflowError'
                    type: array
                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'
      summary: Export a workflow version
      tags:
        - Workflows
  /workflows/{workflow_id}/run:
    post:
      operationId: POST_Run_Workflow
      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: workflow_id
          required: true
          schema:
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowInstance'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/WorkflowError'
                    type: array
                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'
        '406':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/WorkflowError'
                    type: array
                  parameters: {}
                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'
        '409':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/WorkflowError'
                    type: array
                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:
              schema:
                maxLength: 64
                type: string
      summary: Run a workflow
      tags:
        - Workflows
  /workflows/{workflow_id}/versions:
    get:
      operationId: GET_WorkflowVersions
      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: workflow_id
          required: true
          schema:
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVersionsResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 versions of a workflow definition
      tags:
        - Workflows
  /workflows/{workflow_id}/versions/import:
    post:
      operationId: POST_WorkflowVersionsImport
      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'
        - in: path
          name: workflow_id
          required: true
          schema:
            type: integer
        - in: query
          name: version
          required: true
          schema:
            type: string
        - in: query
          name: activate
          required: false
          schema:
            type: boolean
      requestBody:
        content:
          application/json:
            schema:
              properties:
                linkages:
                  items:
                    $ref: '#/components/schemas/Linkage'
                  type: array
                tasks:
                  items:
                    $ref: '#/components/schemas/Task'
                  type: array
                workflow:
                  $ref: '#/components/schemas/DetailedWorkflow'
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowDefinition'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Import a workflow version
      tags:
        - Workflows
  /workflows/workflow_runs/{workflow_run_id}/stop:
    put:
      tags:
        - Workflows
      summary: Stop a workflow run
      operationId: PUT_StopWorkflowRun
      parameters:
        - name: Accept-Encoding
          in: header
          schema:
            type: string
        - name: Content-Encoding
          in: header
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
        - name: Zuora-Entity-Ids
          in: header
          schema:
            type: string
        - name: Zuora-Org-Ids
          in: header
          schema:
            type: string
        - name: Zuora-Track-Id
          in: header
          schema:
            maxLength: 64
            type: string
        - name: workflow_run_id
          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:
                $ref: '#/components/schemas/StopWorkflowRunSuccess'
        '404':
          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/StopWorkflowRunError'
  /object-query/accounts:
    get:
      summary: List accounts
      operationId: queryAccounts
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - billto
                - soldto
                - shipto
                - defaultpaymentmethod
                - subscriptions
                - payments
                - refunds
                - creditmemos
                - debitmemos
                - invoices
                - usages
                - paymentmethods
                - subscriptions.rateplans
                - subscriptions.rateplans.rateplancharges
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryAccountsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedAccount'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/accounts/{key}:
    get:
      summary: Retrieve an account
      operationId: queryAccountByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - billto
                - soldto
                - shipto
                - defaultpaymentmethod
                - subscriptions
                - payments
                - refunds
                - creditmemos
                - debitmemos
                - invoices
                - usages
                - paymentmethods
                - subscriptions.rateplans
                - subscriptions.rateplans.rateplancharges
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedAccount'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/amendments:
    get:
      summary: List amendments
      operationId: queryAmendments
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryAmendmentsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedAmendment'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/amendments/{key}:
    get:
      summary: Retrieve an amendment
      operationId: queryAmendmentByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedAmendment'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/billing-runs:
    get:
      summary: List bill runs
      operationId: queryBillingRuns
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryBillingRunsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedBillingRun'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/billing-runs/{key}:
    get:
      summary: Retrieve a bill run
      operationId: queryBillingRunByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedBillingRun'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/contacts:
    get:
      summary: List contacts
      operationId: queryContacts
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryContactsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedContact'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/contacts/{key}:
    get:
      summary: Retrieve a contact
      operationId: queryContactByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedContact'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/credit-memos:
    get:
      summary: List credit memos
      operationId: queryCreditMemos
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - billtocontact
                - billtocontactsnapshot
                - soldtocontactsnapshot
                - shiptocontactsnapshot
                - creditmemoitems
                - creditmemoitems.subscription
                - creditmemoitems.subscription.account
                - creditmemoapplications
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryCreditMemosResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedCreditMemo'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/credit-memos/{key}:
    get:
      summary: Retrieve a credit memo
      operationId: queryCreditMemoByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - billtocontact
                - billtocontactsnapshot
                - soldtocontactsnapshot
                - shiptocontactsnapshot
                - creditmemoitems
                - creditmemoitems.subscription
                - creditmemoitems.subscription.account
                - creditmemoapplications
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedCreditMemo'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/credit-memo-applications:
    get:
      summary: List credit memo applications
      operationId: queryCreditMemoApplications
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - creditmemo
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryCreditMemoApplicationsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedCreditMemoApplication'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/credit-memo-applications/{key}:
    get:
      summary: Retrieve a credit memo application
      operationId: queryCreditMemoApplicationByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - creditmemo
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedCreditMemoApplication'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/credit-memo-items:
    get:
      summary: List credit memo items
      operationId: queryCreditMemoItems
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - subscription
                - rateplancharge
                - subscriptionowner
                - credittaxationitems
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryCreditMemoItemsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedCreditMemoItem'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/credit-memo-items/{key}:
    get:
      summary: Retrieve a credit memo item
      operationId: queryCreditMemoItemByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - subscription
                - rateplancharge
                - subscriptionowner
                - credittaxationitems
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedCreditMemoItem'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/daily-consumption-summaries:
    get:
      summary: List daily consumption summaries
      operationId: queryDailyConsumptionSummaries
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryDebitMemoItemsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedDailyConsumptionSummary'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/daily-consumption-summaries/{key}:
    get:
      summary: Retrieve a daily consumption summary
      operationId: queryDailyConsumptionSummaryByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedDailyConsumptionSummary'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/debit-memos:
    get:
      summary: List debit memos
      operationId: queryDebitMemos
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - billtocontact
                - billtocontactsnapshot
                - soldtocontactsnapshot
                - shiptocontactsnapshot
                - debitmemoitems
                - debitmemoitems.subscription
                - debitmemoitems.subscription.account
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryDebitMemosResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedDebitMemo'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/debit-memos/{key}:
    get:
      summary: Retrieve a debit memo
      operationId: queryDebitMemoByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - billtocontact
                - billtocontactsnapshot
                - soldtocontactsnapshot
                - shiptocontactsnapshot
                - debitmemoitems
                - debitmemoitems.subscription
                - debitmemoitems.subscription.account
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedDebitMemo'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/debit-memo-items:
    get:
      summary: List debit memo items
      operationId: queryDebitMemoItems
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - subscription
                - rateplancharge
                - subscriptionowner
                - debittaxationitems
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryDebitMemoItemsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedDebitMemoItem'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/debit-memo-items/{key}:
    get:
      summary: Retrieve a debit memo item
      operationId: queryDebitMemoItemByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - subscription
                - rateplancharge
                - subscriptionowner
                - debittaxationitems
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedDebitMemoItem'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/delivery-adjustment:
    get:
      summary: List delivery adjustments
      operationId: queryDeliveryAdjustments
      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: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedDeliveryAdjustment'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/delivery-adjustment/{key}:
    get:
      summary: Retrieve a delivery adjustment
      operationId: queryDeliveryAdjustmentByKey
      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
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedDeliveryAdjustment'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/fulfillment:
    get:
      summary: List fulfillments
      operationId: queryFulfillments
      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: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedFulfillment'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/fulfillment/{key}:
    get:
      summary: Retrieve a fulfillment
      operationId: queryFulfillmentByKey
      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
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedFulfillment'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/invoices:
    get:
      summary: List invoices
      operationId: queryInvoices
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - account.billto
                - account.soldto
                - account.shipto
                - billtocontact
                - billtocontactsnapshot
                - soldtocontactsnapshot
                - shiptocontactsnapshot
                - invoiceitems
                - invoiceitems.subscription
                - invoiceitems.subscription.account
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryInvoicesResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedInvoice'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/invoices/{key}:
    get:
      summary: Retrieve an invoice
      operationId: queryInvoiceByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - account.billto
                - account.soldto
                - account.shipto
                - billtocontact
                - billtocontactsnapshot
                - soldtocontactsnapshot
                - shiptocontactsnapshot
                - invoiceitems
                - invoiceitems.subscription
                - invoiceitems.subscription.account
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedInvoice'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/invoice-items:
    get:
      summary: List invoice items
      operationId: queryInvoiceItems
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - invoice
                - subscription
                - subscriptionowner
                - taxationitems
                - rateplancharge
                - orderlineitem
        - in: query
          name: filter[]
          required: true
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryInvoiceItemsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedInvoiceItem'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/invoice-items/{key}:
    get:
      summary: Retrieve an invoice item
      operationId: queryInvoiceItemByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - invoice
                - subscription
                - subscriptionowner
                - taxationitems
                - rateplancharge
                - orderlineitem
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedInvoiceItem'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/invoice-schedules:
    get:
      summary: List invoice schedules
      operationId: queryInvoiceSchedules
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - invoicescheduleitems
                - invoicescheduleitems.invoice
                - invoicescheduleitems.creditmemo
                - invoiceschedulebookings
                - invoiceschedulebookings.order
                - invoiceschedulebookings.subscription
                - rateplancharges
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryInvoiceSchedulesResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedInvoiceSchedule'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/invoice-schedules/{key}:
    get:
      summary: Retrieve an invoice schedule
      operationId: queryInvoiceScheduleByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - invoicescheduleitems
                - invoicescheduleitems.invoice
                - invoicescheduleitems.creditmemo
                - invoiceschedulebookings
                - invoiceschedulebookings.order
                - invoiceschedulebookings.subscription
                - rateplancharges
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedInvoiceSchedule'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/order-actions:
    get:
      summary: List order actions
      operationId: queryOrderActions
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - subscription
                - order
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryOrderActionsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedOrderAction'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/order-actions/{key}:
    get:
      summary: Retrieve an order action
      operationId: queryOrderActionByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - subscription
                - order
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedOrderAction'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/order-line-items:
    get:
      summary: List order line items
      operationId: queryOrderLineItems
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - invoiceitems
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryOrderLineItemsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedOrderLineItem'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/order-line-items/{key}:
    get:
      summary: Retrieve an order line item
      operationId: queryOrderLineItemByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - invoiceitems
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedOrderLineItem'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/orders:
    get:
      summary: List orders
      operationId: queryOrders
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - orderlineitems
                - orderlineitems.invoiceitems
                - orderactions
                - orderactions.subscription
                - orderactions.subscription.rateplans
                - orderactions.subscription.rateplans.rateplancharges
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryOrdersResponse
                nullable: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedOrders'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/orders/{key}:
    get:
      summary: Retrieve an order
      operationId: queryOrdersByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - orderlineitems
                - orderlineitems.invoiceitems
                - orderactions
                - orderactions.subscription
                - orderactions.subscription.rateplans
                - orderactions.subscription.rateplans.rateplancharges
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedOrders'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payments:
    get:
      summary: List payments
      operationId: queryPayments
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - account.billto
                - account.soldto
                - paymentmethod
                - paymentapplications
                - paymentscheduleitempayments
                - paymentscheduleitempayments.paymentscheduleitem
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryPaymentsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedPayment'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payments/{key}:
    get:
      summary: Retrieve a payment
      operationId: queryPaymentByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - account.billto
                - account.soldto
                - paymentmethod
                - paymentapplications
                - paymentscheduleitempayments
                - paymentscheduleitempayments.paymentscheduleitem
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedPayment'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-applications:
    get:
      summary: List payment applications
      operationId: queryPaymentApplications
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - payment
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryPaymentApplicationsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedPaymentApplication'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-applications/{key}:
    get:
      summary: Retrieve a payment application
      operationId: queryPaymentApplicationByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - payment
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedPaymentApplication'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-methods:
    get:
      summary: List payment methods
      operationId: queryPaymentMethods
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryPaymentMethodsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedPaymentMethod'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-methods/{key}:
    get:
      summary: Retrieve a payment method
      operationId: queryPaymentMethodByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedPaymentMethod'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-method-snapshots:
    get:
      summary: List payment method snapshots
      operationId: queryPaymentMethodSnapshots
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: true
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryPaymentMethodSnapshotsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedPaymentMethodSnapshot'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-method-snapshots/{key}:
    get:
      summary: Retrieve a payment method snapshot
      operationId: queryPaymentMethodSnapshotByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedPaymentMethodSnapshot'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-runs:
    get:
      summary: List payment runs
      operationId: queryPaymentRuns
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryPaymentRunsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedPaymentRun'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-runs/{key}:
    get:
      summary: Retrieve a payment run
      operationId: queryPaymentRunByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedPaymentRun'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-schedules:
    get:
      summary: List payment schedules
      operationId: queryPaymentSchedules
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryPaymentSchedulesResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedPaymentSchedule'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-schedules/{key}:
    get:
      summary: Retrieve a payment schedule
      operationId: queryPaymentScheduleByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedPaymentSchedule'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-schedule-items:
    get:
      summary: List payment schedule items
      operationId: queryPaymentScheduleItems
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - paymentscheduleitempayments
                - paymentscheduleitempayments.payment
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryPaymentScheduleItemsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedPaymentScheduleItem'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-schedule-items/{key}:
    get:
      summary: Retrieve a payment schedule item
      operationId: queryPaymentScheduleItemByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - paymentscheduleitempayments
                - paymentscheduleitempayments.payment
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedPaymentScheduleItem'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/prepaid-balances:
    get:
      summary: List prepaid balances
      operationId: queryPrepaidBalances
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - origsubscription
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryPrepaidBalancesResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedPrepaidBalance'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/prepaid-balances/{key}:
    get:
      summary: Retrieve a prepaid balance
      operationId: queryPrepaidBalanceByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - origsubscription
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedPrepaidBalance'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/prepaid-balance-funds:
    get:
      summary: List prepaid balance funds
      operationId: queryPrepaidBalanceFunds
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - prepaidbalance
                - source
                - vpsummary
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryPrepaidBalanceFundsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedPrepaidBalanceFund'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/prepaid-balance-funds/{key}:
    get:
      summary: Retrieve a prepaid balance fund
      operationId: queryPrepaidBalanceFundByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - prepaidbalance
                - source
                - vpsummary
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedPrepaidBalanceFund'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/prepaid-balance-transactions:
    get:
      summary: List prepaid balance transactions
      operationId: queryPrepaidBalanceTransactions
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - prepaidbalance
                - fund
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryPrepaidBalanceTransactionsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedPrepaidBalanceTransaction'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/prepaid-balance-transactions/{key}:
    get:
      summary: Retrieve a prepaid balance transaction
      operationId: queryPrepaidBalanceTransactionByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - prepaidbalance
                - fund
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedPrepaidBalanceTransaction'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/processed-usages:
    get:
      summary: List processed usage records
      operationId: queryProcessedUsages
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - usage
                - invoiceitem
                - creditmemoitem
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryProcessedUsagesResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedProcessedUsage'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/processed-usages/{key}:
    get:
      summary: Retrieve a processed usage record
      operationId: queryProcessedUsageByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - usage
                - invoiceitem
                - creditmemoitem
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedProcessedUsage'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/products:
    get:
      summary: List products
      operationId: queryProducts
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - productrateplans
                - productrateplans.productrateplancharges
                - productrateplans.productrateplancharges.productrateplanchargetiers
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryProductsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedProduct'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/products/{key}:
    get:
      summary: Retrieve a product
      operationId: queryProductByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - productrateplans
                - productrateplans.productrateplancharges
                - productrateplans.productrateplancharges.productrateplanchargetiers
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedProduct'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/product-rate-plans:
    get:
      summary: List product rate plans
      operationId: queryProductRatePlans
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - product
                - productrateplancharges
                - productrateplancharges.productrateplanchargetiers
                - externalproductrateplans
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryProductRatePlansResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedProductRatePlan'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/product-rate-plans/{key}:
    get:
      summary: Retrieve a product rate plan
      operationId: queryProductRatePlanByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - product
                - productrateplancharges
                - productrateplancharges.productrateplanchargetiers
                - externalproductrateplans
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedProductRatePlan'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/product-rate-plan-charges:
    get:
      summary: List product rate plan charges
      operationId: queryProductRatePlanCharges
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - productrateplan
                - productrateplanchargetiers
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryProductRatePlanChargesResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedProductRatePlanCharge'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/product-rate-plan-charges/{key}:
    get:
      summary: Retrieve a product rate plan charge
      operationId: queryProductRatePlanChargeByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - productrateplan
                - productrateplanchargetiers
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedProductRatePlanCharge'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/product-rate-plan-charge-tiers:
    get:
      summary: List product rate plan charge tiers
      operationId: queryProductRatePlanChargeTiers
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - productrateplancharge
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryProductRatePlanChargeTiersResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedProductRatePlanChargeTier'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/product-rate-plan-charge-tiers/{key}:
    get:
      summary: Retrieve a product rate plan charge tier
      operationId: queryProductRatePlanChargeTierByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - productrateplancharge
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedProductRatePlanChargeTier'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/ramp:
    get:
      summary: List ramps
      operationId: queryRamps
      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: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedRamp'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/ramp/{key}:
    get:
      summary: Retrieve a ramp
      operationId: queryRampByKey
      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
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedRamp'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/rate-plans:
    get:
      summary: List rate plans
      operationId: queryRatePlans
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - subscription
                - productrateplan
                - rateplancharges
                - rateplancharges.rateplanchargetiers
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryRatePlansResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedRatePlan'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/rate-plans/{key}:
    get:
      summary: Retrieve a rate plan
      operationId: queryRatePlanByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - subscription
                - productrateplan
                - rateplancharges
                - rateplancharges.rateplanchargetiers
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedRatePlan'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/rate-plan-charges:
    get:
      summary: List rate plan charges
      operationId: queryRatePlanCharges
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - rateplan
                - productrateplancharge
                - rateplanchargetiers
        - in: query
          name: filter[]
          required: true
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryRatePlanChargesResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedRatePlanCharge'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/rate-plan-charges/{key}:
    get:
      summary: Retrieve a rate plan charge
      operationId: queryRatePlanChargeByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - rateplan
                - productrateplancharge
                - rateplanchargetiers
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedRatePlanCharge'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/rate-plan-charge-tiers:
    get:
      summary: List rate plan charge tiers
      operationId: queryRatePlanChargeTiers
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - rateplancharge
        - in: query
          name: filter[]
          required: true
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryRatePlanChargesResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedRatePlanChargeTier'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/rate-plan-charge-tiers/{key}:
    get:
      summary: Retrieve a rate plan charge tier
      operationId: queryRatePlanChargeTierByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - rateplancharge
        - in: query
          name: filter[]
          required: true
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedRatePlanChargeTier'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/rating-results:
    get:
      summary: List rating results
      operationId: queryRatingResults
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - rateplancharge
                - subscription
                - invoiceitem
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryRatingResultsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedRatingResult'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/rating-results/{key}:
    get:
      summary: Retrieve a rating result
      operationId: queryRatingResultByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - rateplancharge
                - subscription
                - invoiceitem
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedRatingResult'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/refunds:
    get:
      summary: List refunds
      operationId: queryRefunds
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - account.billto
                - account.soldto
                - paymentmethod
                - refundapplications
                - refundapplications.payment
                - refundapplications.refundapplicationitems
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryRefundsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedRefund'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/refunds/{key}:
    get:
      summary: Retrieve a refund
      operationId: queryRefundByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - account.billto
                - account.soldto
                - paymentmethod
                - refundapplications
                - refundapplications.payment
                - refundapplications.refundapplicationitems
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedRefund'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/refund-applications:
    get:
      summary: List refund applications
      operationId: queryRefundApplications
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - refund
                - payment
                - refundapplicationitems
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryRefundApplicationsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedRefundApplication'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/refund-applications/{key}:
    get:
      summary: Retrieve a refund application
      operationId: queryRefundApplicationByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - refund
                - payment
                - refundapplicationitems
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedRefundApplication'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/refund-application-items:
    get:
      summary: List refund application items
      operationId: queryRefundApplicationItems
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - refundapplication
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryRefundApplicationItemsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedRefundApplicationItem'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/refund-application-items/{key}:
    get:
      summary: Retrieve a refund application item
      operationId: queryRefundApplicationItemByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - refundapplication
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedRefundApplicationItem'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/summarystatementruns:
    get:
      summary: List summary statement runs
      operationId: getSummaryStatementRuns
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - endDate
                - startDate
                - statementRunNumber
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - accountId
                - id
                - startDate
                - statementRunNumber
                - status
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedSummaryStatementRun'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/summarystatementruns/{key}:
    get:
      summary: Retrieve a summary statement run
      operationId: getSummaryStatementRun
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - endDate
                - startDate
                - statementRunNumber
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - accountId
                - id
                - startDate
                - statementRunNumber
                - status
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedSummaryStatementRun'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/summarystatements:
    get:
      summary: List summary statements
      operationId: getSummaryStatements
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - endDate
                - statementDate
                - statementNumber
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - accountId
                - id
                - startDate
                - statementDate
                - statementNumber
                - statementRunId
                - status
                - emailStatus
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedSummaryStatement'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/summarystatements/{key}:
    get:
      summary: Retrieve a summary statement
      operationId: getSummaryStatement
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - createdById
                - createdDate
                - deleted
                - endDate
                - fileId
                - updatedById
                - updatedDate
                - errorCategory
                - errorMessage
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - accountId
                - id
                - startDate
                - statementDate
                - statementNumber
                - statementRunId
                - status
                - emailStatus
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedSummaryStatement'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/subscriptions:
    get:
      summary: List subscriptions
      operationId: querySubscriptions
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - invoiceowner
                - billtocontact
                - invoiceitems
                - rateplans
                - rateplans.rateplancharges
                - rateplans.rateplancharges.rateplanchargetiers
                - account.billto
                - account.soldto
                - account.paymentmethods
                - order
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QuerySubscriptionsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedSubscription'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/subscriptions/{key}:
    get:
      summary: Retrieve a subscription
      operationId: querySubscriptionByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - invoiceowner
                - billtocontact
                - invoiceitems
                - rateplans
                - rateplans.rateplancharges
                - rateplans.rateplancharges.rateplanchargetiers
                - account.billto
                - account.soldto
                - account.paymentmethods
                - order
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedSubscription'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/taxation-items:
    get:
      summary: List taxation items
      operationId: queryTaxationItems
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryTaxationItemsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedTaxationItem'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/taxation-items/{key}:
    get:
      summary: Retrieve a taxation item
      operationId: queryTaxationItemByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedTaxationItem'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/usages:
    get:
      summary: List usage records
      operationId: queryUsages
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryUsagesResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedUsage'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/usages/{key}:
    get:
      summary: Retrieve a usage record
      operationId: queryUsageByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedUsage'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/validity-period-summaries:
    get:
      summary: List validity period summaries
      operationId: queryValidityPeriodSummarys
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - prepaidbalance
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryValidityPeriodSummarysResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedValidityPeriodSummary'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/validity-period-summaries/{key}:
    get:
      summary: Retrieve a validity period summary
      operationId: queryValidityPeriodSummaryByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - prepaidbalance
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedValidityPeriodSummary'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/{custom-object-name}:
    get:
      summary: List custom object records
      operationId: queryCustomObjects
      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: custom-object-name
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryCustomObjectsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/{custom-object-name}/{key}:
    get:
      summary: Retrieve a custom object record
      operationId: queryCustomObjectBykey
      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: custom-object-name
          required: true
          schema:
            type: string
        - in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/contact-snapshots:
    get:
      summary: List contact snapshots
      operationId: queryContactSnapshots
      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: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryContactSnapshotsResponse
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedContactSnapshot'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/contact-snapshots/{key}:
    get:
      summary: Retrieve a contact snapshot
      operationId: queryContactSnapshotByKey
      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: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedContactSnapshot'
          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'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          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'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/rating-details:
    get:
      summary: List rating details
      operationId: queryRatingDetails
      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: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryRatingDetailsResponse'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/rating-details/{key}:
    get:
      summary: Retrieve a rating detail
      operationId: queryRatingDetailByKey
      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'
        - name: key
          in: path
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
        - in: query
          name: cursor
          required: false
          schema:
            type: string
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RatingDetails'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
      tags:
        - Object Queries
      x-accepts: application/json
  /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
  /v1/multi-organizations/data-labeling-job:
    post:
      operationId: POST_DataLabelingJob
      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_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitDataLabelingJobRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitDataLabelingJobResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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'
      summary: Submit a data labeling job
      tags:
        - Data Labeling
  /v1/multi-organizations/data-labeling-job/{job-id}:
    get:
      operationId: GET_DataLabelingJob
      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_Track_Id'
        - in: path
          name: job-id
          required: true
          schema:
            format: uuid
            maxLength: 32
            minLength: 32
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDataLabelingJobResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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'
        '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'
            Concurrency-Limit-Type:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
            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 a data labeling job
      tags:
        - Data Labeling
  /v1/uno-regenerate/booking-transaction:
    post:
      operationId: POST_RegenerateBookingTransaction
      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: onlyReSend
          required: false
          schema:
            type: boolean
        - in: query
          name: reMigrate
          required: false
          schema:
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegenerateBookingRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegenerateTransactionObjectResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Regenerate booking transactions
      tags:
        - Regenerate
  /v1/uno-regenerate/billing-transaction:
    post:
      operationId: POST_RegenerateBillingTransaction
      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: onlyReSend
          required: false
          schema:
            type: boolean
        - in: query
          name: reMigrate
          required: false
          schema:
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegenerateBillingRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegenerateTransactionObjectResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Regenerate billing transactions
      tags:
        - Regenerate
  /v1/uno-regenerate/rev-rec-events:
    post:
      operationId: POST_CreateRevRecEvents
      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: subscriptionNumber
          schema:
            type: string
        - in: query
          name: mode
          schema:
            default: Incremental
            enum:
              - Incremental
              - Full
            type: string
        - in: query
          name: forRevenueRecollect
          schema:
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegenerateRevRecEventsResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Regenerate revenue recognition events transactions for Delivery Schedule
      tags:
        - Regenerate
  /v1/uno-regenerate/rev-rec-events/daily-consumption:
    post:
      operationId: POST_GenerateRevRecEventsForDailyConsumption
      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: forRevenueRecollect
          schema:
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DailyConsumptionRevRecRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegenerateRevRecEventsResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Regenerate revenue recognition events transactions for Daily Consumption
      tags:
        - Regenerate
  /v1/uno/data-backfill/bookingdate/jobs:
    post:
      operationId: POST_CreateBookingDateBackfillJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $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'
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/CommonResponse'
                  - type: object
                    properties:
                      jobId:
                        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'
            Concurrency-Limit-Type:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
            Concurrency-Limit-Limit:
              $ref: '#/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 booking date backfill job
      tags:
        - Data Backfill
    get:
      operationId: GET_ListBookingDateBackfillJobs
      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_Zuora_Version'
      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'
            Concurrency-Limit-Type:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
            Concurrency-Limit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
            Concurrency-Limit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/CommonResponse'
                  - type: object
                    properties:
                      jobs:
                        type: array
                        items:
                          $ref: '#/components/schemas/GETAutoBackfillJobResponse'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              schema:
                type: number
            Zuora-Request-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 booking date backfill jobs
      tags:
        - Data Backfill
  /v1/uno/data-backfill/bookingdate/jobs/{jobId}:
    get:
      operationId: GET_BookingDateBackfillJobById
      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
            minLength: 32
            maxLength: 32
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      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'
            Concurrency-Limit-Type:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
            Concurrency-Limit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
            Concurrency-Limit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/CommonResponse'
                  - type: object
                    properties:
                      job:
                        $ref: '#/components/schemas/GETAutoBackfillJobResponse'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              schema:
                type: number
            Zuora-Request-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 booking date backfill job
      tags:
        - Data Backfill
    put:
      operationId: PUT_StopBookingDateBackfillJobById
      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
            minLength: 32
            maxLength: 32
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - Stopping
              required:
                - status
      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'
            Concurrency-Limit-Type:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
            Concurrency-Limit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
            Concurrency-Limit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              schema:
                type: number
            Zuora-Request-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 booking date backfill job
      tags:
        - Data Backfill
  /v1/uno/data-backfill/jobs:
    post:
      operationId: POST_CreateDataBackfillJob
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                type:
                  $ref: '#/components/schemas/DataBackfillJob'
                file:
                  type: string
                  format: binary
                checksum:
                  type: string
                  minLength: 32
                  maxLength: 32
              required:
                - file
                - type
        required: true
      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'
            Concurrency-Limit-Type:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
            Concurrency-Limit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
            Concurrency-Limit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/CommonResponse'
                  - type: object
                    properties:
                      jobId:
                        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 data backfill job
      tags:
        - Data Backfill
      x-code-samples:
        - label: cURL
          lang: curl
          source: 'curl -X POST -H ''Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1'' -F ''file=@"ProductRatePlanChargeBackfillFile.csv"'' -F ''type="ProductRatePlanCharge"'' ''https://rest.zuora.com/v1/uno/data-backfill/jobs'''
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
  /v1/uno/data-backfill/jobs/{jobId}:
    get:
      operationId: GET_DataBackfillJobById
      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
            minLength: 32
            maxLength: 32
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      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'
            Concurrency-Limit-Type:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
            Concurrency-Limit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
            Concurrency-Limit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/CommonResponse'
                  - type: object
                    properties:
                      job:
                        $ref: '#/components/schemas/DataBackfillJob'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              schema:
                type: number
            Zuora-Request-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 data backfill job
      tags:
        - Data Backfill
    put:
      operationId: PUT_StopDataBackfillJobById
      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
            minLength: 32
            maxLength: 32
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - Stopping
              required:
                - status
      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'
            Concurrency-Limit-Type:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
            Concurrency-Limit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
            Concurrency-Limit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              schema:
                type: number
            Zuora-Request-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 data backfill job
      tags:
        - Data Backfill
  /v1/uno/data-backfill/listjobs:
    get:
      operationId: GET_ListDataBackfillJobs
      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'
            Concurrency-Limit-Type:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
            Concurrency-Limit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
            Concurrency-Limit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/CommonResponse'
                  - type: object
                    properties:
                      jobs:
                        type: array
                        items:
                          $ref: '#/components/schemas/DataBackfillJob'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              schema:
                type: number
            Zuora-Request-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 data backfill jobs
      tags:
        - Data Backfill
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
  /v1/uno/data-backfill/jobs/{type}/template:
    get:
      operationId: GET_DataBackfillTemplate
      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: type
          required: true
          schema:
            $ref: '#/components/schemas/DataBackfillJobType'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            text/csv:
              schema:
                type: string
          headers:
            Content-Disposition:
              schema:
                type: string
            Zuora-Request-Id:
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Concurrency-Limit-Type:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
            Concurrency-Limit-Limit:
              $ref: '#/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 data backfill template file
      tags:
        - Data Backfill
  /v1/uno/data-backfill/propagation/jobs:
    get:
      summary: List all auto backfill jobs
      tags:
        - Data Backfill
      operationId: GET_listAutoBackfillJob
      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_Zuora_Version'
      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'
            Concurrency-Limit-Type:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
            Concurrency-Limit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
            Concurrency-Limit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/CommonResponse'
                  - type: object
                    properties:
                      jobs:
                        type: array
                        items:
                          $ref: '#/components/schemas/GETAutoBackfillJobResponse'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              schema:
                type: number
            Zuora-Request-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'
    post:
      summary: Create an auto backfill job
      tags:
        - Data Backfill
      operationId: POST_CreateAutoBackfillJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $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:
              type: object
              required:
                - type
              properties:
                type:
                  type: string
                  enum:
                    - RatePlanCharge
                    - OrderLineItem
                batchSize:
                  type: integer
                  format: int32
                  default: 1000
                  minimum: 1
                  maximum: 1000
                dryRun:
                  type: boolean
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/CommonResponse'
                  - type: object
                    properties:
                      jobId:
                        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'
            Concurrency-Limit-Type:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
            Concurrency-Limit-Limit:
              $ref: '#/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/uno/data-backfill/propagation/jobs/{jobId}:
    get:
      operationId: GET_AutoBackfillJobById
      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
            minLength: 32
            maxLength: 32
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      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'
            Concurrency-Limit-Type:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
            Concurrency-Limit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
            Concurrency-Limit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/CommonResponse'
                  - type: object
                    properties:
                      job:
                        $ref: '#/components/schemas/GETAutoBackfillJobResponse'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              schema:
                type: number
            Zuora-Request-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 auto backfill job
      tags:
        - Data Backfill
    put:
      operationId: PUT_StopAutoBackfillJobById
      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
            minLength: 32
            maxLength: 32
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - Stopping
              required:
                - status
      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'
            Concurrency-Limit-Type:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
            Concurrency-Limit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
            Concurrency-Limit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              schema:
                type: number
            Zuora-Request-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 an auto backfill job
      tags:
        - Data Backfill
  /v1/action/create:
    post:
      operationId: Action_POSTcreate
      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/ProxyActioncreateRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/SaveResult'
                type: array
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Create
      tags:
        - Actions
  /v1/action/delete:
    post:
      operationId: Action_POSTdelete
      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/ProxyActiondeleteRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/DeleteResult'
                type: array
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Delete
      tags:
        - Actions
  /v1/action/query:
    post:
      operationId: Action_POSTquery
      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/ProxyActionqueryRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyActionqueryResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Query
      tags:
        - Actions
  /v1/action/queryMore:
    post:
      operationId: Action_POSTqueryMore
      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/ProxyActionqueryMoreRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyActionqueryMoreResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: QueryMore
      tags:
        - Actions
  /v1/action/update:
    post:
      operationId: Action_POSTupdate
      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/ProxyActionupdateRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/SaveResult'
                type: array
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Update
      tags:
        - Actions
  /settings/batch-requests:
    post:
      operationId: POST_ProcessSettingsBatchRequest
      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/SettingsBatchRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettingsBatchResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 settings requests
      tags:
        - Settings
  /settings/listing:
    get:
      operationId: GET_ListAllSettings
      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: header
          name: Accept
          required: false
          schema:
            maxLength: 64
            type: string
      responses:
        '200':
          content:
            application/csv:
              schema:
                $ref: '#/components/schemas/ListAllSettingsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ListAllSettingsResponse'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 settings
      tags:
        - Settings
  /v1/files/{file-id}:
    get:
      operationId: GET_Files
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: file-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      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'
            Concurrency-Limit-Type:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
            Concurrency-Limit-Limit:
              $ref: '#/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 file
      tags:
        - Files
      x-code-samples:
        - label: Curl
          lang: curl
          source: |
            curl -X GET -H "Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3" -H "Accept: application/pdf" "https://rest.zuora.com/v1/files/2c92c08c55534cf00155581fb474314d" -o invoice.pdf
  /v1/files/{file-id}/restore:
    put:
      operationId: PUT_Files
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: file-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestoreFile'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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: Restore a file
      tags:
        - Files
      x-code-samples:
        - label: Curl
          lang: curl
          source: |-
            curl -i -X PUT \
              'https://rest.zuora.com/v1/files/402881888e89748b018e897a6a500025/restore' \ 
              -H 'Zuora-Tenant-Id: 17' \
              -H 'Zuora-Entity-Ids: 402881868d304631018d304a0f940226' \
              -H 'Authorization: Basic YmZkQHp1b3JhLmNvbtJjpdmFjOEw+YhmWy=='
  /v1/files/{file-id}/status:
    get:
      operationId: GET_FileStatus
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: file-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveFileStatus'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 file status
      tags:
        - Files
      x-code-samples:
        - label: Curl
          lang: curl
          source: |-
            curl -i -X GET \
              'https://rest.zuora.com/v1/files/402881888e89748b018e897a6a500025/status' \ 
              -H 'Zuora-Tenant-Id: 17' \
              -H 'Zuora-Entity-Ids: 402881868d304631018d304a0f940226' \
              -H 'Authorization: Basic YmZkQHp1b3JhLmNvbtJjpdmFjOEw+YhmWy=='
  /v1/object/import:
    post:
      operationId: Object_POSTImport
      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:
          multipart/form-data:
            schema:
              properties:
                File:
                  format: binary
                  type: string
                ImportType:
                  enum:
                    - Usage
                    - Payment
                    - Quote
                    - TaxationDetail
                    - UpdateAccountingCode
                    - CreateRevenueSchedule
                    - UpdateRevenueSchedule
                    - DeleteRevenueSchedule
                    - ImportFXRate
                  type: string
                Name:
                  type: string
              required:
                - ImportType
                - Name
                - File
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyPostImport'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 an import'
      tags:
        - Imports
      x-code-samples:
        - label: Curl
          lang: curl
          source: |
            curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "ImportType=Usage" -F "Name=UsageData.csv" -F "File=@UsageData.csv" "https://rest.zuora.com/v1/object/import"
  /v1/object/import/{id}:
    get:
      operationId: Object_GETImport
      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/ProxyGetImport'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 an import'
      tags:
        - Imports
  /v1/custom-exchange-rates/{currency}:
    get:
      operationId: GET_CustomExchangeRates
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: currency
          required: true
          schema:
            type: string
        - in: query
          name: startDate
          required: true
          schema:
            type: string
        - in: query
          name: endDate
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETCustomExchangeRatesType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 custom exchange rates by currency
      tags:
        - Custom Exchange Rates
      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/custom-exchange-rates/EUR?startDate=2019-04-28&endDate=2019-04-30"
  /v1/attachments:
    post:
      operationId: POST_Attachments
      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: description
          required: false
          schema:
            type: string
        - in: query
          name: associatedObjectType
          required: true
          schema:
            enum:
              - Account
              - Invoice
              - Subscription
              - CreditMemo
              - DebitMemo
            type: string
        - in: query
          name: associatedObjectKey
          required: true
          schema:
            type: string
        - $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/POSTAttachmentResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 attachment
      tags:
        - Attachments
      x-code-samples:
        - label: Curl
          lang: curl
          source: |
            curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@PODocument.pdf" "https://rest.zuora.com/v1/attachments/?description=Postal%20order&associatedObjectType=Subscription&associatedObjectKey=A-S00005714"
  /v1/attachments/{attachment-id}:
    delete:
      operationId: DELETE_Attachments
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: attachment-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 attachment
      tags:
        - Attachments
    get:
      operationId: GET_Attachments
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: attachment-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETAttachmentResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 attachment
      tags:
        - Attachments
    put:
      operationId: PUT_Attachments
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: attachment-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTAttachmentType'
      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 attachment
      tags:
        - Attachments
  /v1/attachments/{object-type}/{object-key}:
    get:
      operationId: GET_AttachmentsList
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: object-type
          required: true
          schema:
            enum:
              - account
              - invoice
              - subscription
              - creditmemo
              - debitmemo
            type: string
        - in: path
          name: object-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETAttachmentsResponseType'
          headers:
            Content-Encoding:
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              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 attachments by object type and key
      tags:
        - Attachments
  /v1/describe/{object}:
    get:
      operationId: GET_Describe
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/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: object
          required: true
          schema:
            type: string
        - in: query
          name: showCurrencyConversionInformation
          schema:
            type: string
        - in: query
          name: showRelationships
          schema:
            type: boolean
            default: false
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            text/xml:
              schema:
                properties:
                  object:
                    type: object
                    properties:
                      name:
                        type: string
                      label:
                        type: string
                      fields:
                        type: array
                        items:
                          type: object
                          title: field
                          properties:
                            name:
                              type: string
                            label:
                              type: string
                            type:
                              enum:
                                - boolean
                                - data
                                - datetime
                                - decimal
                                - integer
                                - picklist
                                - text
                                - timestamp
                                - ZOQL
                            contexts:
                              type: array
                              items:
                                title: context
                                type: object
                                properties:
                                  context:
                                    type: string
                      related-objects:
                        type: array
                        items:
                          type: object
                          title: object
                          properties:
                            name:
                              type: string
                            label:
                              type: string
                            cardinality:
                              type: string
                            direct-relationship:
                              type: boolean
                            path:
                              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'
            Concurrency-Limit-Type:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
            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:
            text/xml; charset=utf-8:
              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'
            Concurrency-Limit-Type:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
            Concurrency-Limit-Limit:
              $ref: '#/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'
      summary: Describe an object
      tags:
        - Describe
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    basicAuth:
      type: http
      scheme: basic
  parameters:
    GLOBAL_HEADER_Zuora_Entity_Ids_Single:
      name: Zuora-Entity-Ids
      in: header
      required: false
      schema:
        type: string
    GLOBAL_HEADER_Zuora_Track_Id:
      name: Zuora-Track-Id
      in: header
      required: false
      schema:
        type: string
        maxLength: 64
    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_HEADER_Idempotency_Key:
      name: Idempotency-Key
      in: header
      required: false
      schema:
        type: string
        maxLength: 255
    GLOBAL_REQUEST_rejectUnknownFields:
      name: rejectUnknownFields
      in: query
      required: false
      schema:
        type: boolean
        default: false
    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_catalog:
      name: pageSize
      in: query
      required: false
      schema:
        type: integer
        maximum: 40
        default: 10
    GLOBAL_REQUEST_pageSize:
      name: pageSize
      in: query
      required: false
      schema:
        type: integer
        maximum: 40
        default: 20
    GLOBAL_HEADER_Charge_Metrics_Accept:
      name: Accept
      in: header
      required: false
      schema:
        type: string
    GLOBAL_REQUEST_get_account_details:
      name: getAccountDetails
      in: query
      schema:
        type: boolean
    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:
    TestEnvironmentArrayResponse:
      title: ArrayResponse«TestEnvironmentResponse»
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/TestEnvironmentResponse'
        size:
          type: integer
          format: int32
    TestEnvironmentResponse:
      title: TestEnvironmentResponse
      type: object
      properties:
        createTime:
          type: string
          format: date-time
        createdById:
          type: string
        dataCopyType:
          type: string
          enum:
            - FULL
            - CONFIGURATION
        deactivationTime:
          type: string
          format: date-time
        environmentType:
          type: string
          enum:
            - TEST
            - ENTERPRISE
            - TRIAL
            - DEMO
            - DEVELOPER
        id:
          type: string
        lastRefreshTime:
          type: string
          format: date-time
        nextRefreshTime:
          type: string
          format: date-time
        provisionTime:
          type: string
          format: date-time
        revenueTenantId:
          type: string
        revenueTenantName:
          type: string
        sourceTenantId:
          type: string
        status:
          type: string
          enum:
            - ACTIVE
            - PROCESSING
            - INACTIVE
            - DEACTIVATED
            - DELETED
        tenantId:
          type: string
        tenantName:
          type: string
        updateTime:
          type: string
          format: date-time
        updatedById:
          type: string
    JobRequest:
      title: JobRequest
      required:
        - jobType
      type: object
      properties:
        jobType:
          type: string
          enum:
            - REFRESH
        scheduledRefreshTime:
          type: string
          format: date-time
    JobResponse:
      title: JobResponse
      type: object
      properties:
        createTime:
          type: string
          format: date-time
        createdById:
          type: string
        estimatedCompletionTime:
          type: string
          format: date-time
        id:
          type: string
        jobEndTime:
          type: string
          format: date-time
        jobStartTime:
          type: string
          format: date-time
        jobType:
          type: string
          enum:
            - REFRESH
            - CREATE
            - DELETE
        progressPercentage:
          type: integer
          format: int32
        scheduledRefreshTime:
          type: string
          format: date-time
        status:
          type: string
          enum:
            - NEW
            - SCHEDULED
            - QUEUED
            - INITIATED
            - PROVISIONING
            - DEPROVISIONING
            - EXPORTING
            - SCRUBBING
            - RESETTING
            - IMPORTING
            - FINALIZING
            - CANCELLING
            - COMPLETED
            - FAILED
            - CANCELLED
        testEnvironmentId:
          type: string
        updateTime:
          type: string
          format: date-time
        updatedById:
          type: string
    JobArrayResponse:
      title: ArrayResponse«JobResponse»
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/JobResponse'
        size:
          type: integer
          format: int32
    JobActionRequest:
      title: JobActionRequest
      required:
        - jobAction
      type: object
      properties:
        jobAction:
          type: string
          enum:
            - CANCEL
    TestEnvironmentNotificationRequest:
      title: TestEnvironmentNotificationRequest
      type: object
      properties:
        address:
          type: string
        name:
          type: string
    TestEnvironmentNotificationResponse:
      title: TestEnvironmentNotificationResponse
      type: object
      properties:
        address:
          type: string
        id:
          type: string
        name:
          type: string
        testEnvironmentId:
          type: string
    TestEnvironmentNotificationArrayResponse:
      title: ArrayResponse«TestEnvironmentNotificationResponse»
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/TestEnvironmentNotificationResponse'
        size:
          type: integer
          format: int32
    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
    GETCatalogType:
      properties:
        nextPage:
          format: URL
          type: string
        products:
          items:
            $ref: '#/components/schemas/GETProductType'
          type: array
        success:
          type: boolean
      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
    GETProductType:
      allOf:
        - properties:
            category:
              type: string
            effectiveEndDate:
              format: date
              type: string
            effectiveStartDate:
              format: date
              type: string
            id:
              type: string
            name:
              type: string
            organizationLabels:
              items:
                properties:
                  organizationId:
                    type: string
                  organizationName:
                    type: string
                type: object
              type: array
            productFeatures:
              items:
                $ref: '#/components/schemas/GetProductFeatureType'
              type: array
            productNumber:
              type: string
            productRatePlans:
              format: URL
              type: string
            sku:
              type: string
            tags:
              type: string
          type: object
        - $ref: '#/components/schemas/ProductObjectNSFields'
        - $ref: '#/components/schemas/ProductObjectCustomFields'
      title: products
    GetProductFeatureType:
      allOf:
        - properties:
            code:
              type: string
            id:
              type: string
            name:
              type: string
            status:
              type: string
          type: object
        - $ref: '#/components/schemas/ProductFeatureObjectCustomFields'
      title: productFeatures
    ProductFeatureObjectCustomFields:
      additionalProperties: {}
      title: productFeatureFieldsCustom
      type: object
    POSTCatalogGroupRequest:
      allOf:
        - properties:
            name:
              type: string
            productRatePlans:
              items:
                $ref: '#/components/schemas/POSTorPUTCatalogGroupAddProductRatePlan'
              type: array
            type:
              default: Grading
              enum:
                - Grading
                - Display
              type: string
          type: object
    CatalogGroupResponse:
      properties:
        catalogGroupNumber:
          type: string
        id:
          type: string
        name:
          type: string
        productRatePlans:
          items:
            $ref: '#/components/schemas/GETCatalogGroupProductRatePlanResponse'
          type: array
        type:
          enum:
            - Grading
            - Display
          type: string
      title: catalogGroups
      type: object
    GETCatalogGroupProductRatePlanResponse:
      properties:
        effectiveEndDate:
          type: string
        effectiveStartDate:
          type: string
        grade:
          type: number
        id:
          type: string
        name:
          type: string
        organizationLabels:
          items:
            properties:
              organizationId:
                type: string
              organizationName:
                type: string
            type: object
          type: array
        status:
          enum:
            - Active
            - Expired
            - NotStarted
          type: string
      title: productRatePlans
      type: object
    POSTorPUTCatalogGroupAddProductRatePlan:
      allOf:
        - properties:
            grade:
              type: number
            id:
              type: string
          type: object
      title: productRatePlans
    ListAllCatalogGroupsResponse:
      properties:
        catalogGroups:
          items:
            $ref: '#/components/schemas/CatalogGroupResponse'
          type: array
        nextPage:
          format: URL
          type: string
      type: object
    PUTCatalogGroup:
      allOf:
        - properties:
            add:
              items:
                $ref: '#/components/schemas/POSTorPUTCatalogGroupAddProductRatePlan'
              title: add
              type: array
            name:
              type: string
            remove:
              items:
                $ref: '#/components/schemas/PUTCatalogGroupRemoveProductRatePlan'
              type: array
          type: object
    PUTCatalogGroupRemoveProductRatePlan:
      allOf:
        - properties:
            id:
              type: string
          type: object
      title: remove
    GETProductRatePlansResponse:
      properties:
        nextPage:
          format: URL
          type: string
        productRatePlans:
          items:
            $ref: '#/components/schemas/GETProductRatePlanType'
          type: array
        success:
          type: boolean
      type: object
    GETProductRatePlanType:
      allOf:
        - properties:
            effectiveEndDate:
              format: date
              type: string
            effectiveStartDate:
              format: date
              type: string
            grade:
              type: number
            id:
              type: string
            name:
              type: string
            productRatePlanCharges:
              items:
                $ref: '#/components/schemas/GETProductRatePlanChargeType'
              type: array
            productRatePlanNumber:
              type: string
            status:
              enum:
                - Active
                - Expired
                - NotStarted
              type: string
          type: object
        - $ref: '#/components/schemas/ProductRatePlanObjectNSFields'
        - $ref: '#/components/schemas/ProductRatePlanObjectCustomFields'
      title: productRatePlans
    GETProductRatePlanChargeType:
      allOf:
        - properties:
            applyDiscountTo:
              type: string
            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
            chargeModelConfigurations:
              type: object
            creditOption:
              enum:
                - TimeBased
                - ConsumptionBased
                - FullCreditBack
              type: string
            defaultQuantity:
              format: decimal
              type: string
              nullable: true
            deliverySchedule:
              $ref: '#/components/schemas/GETProductRatePlanChargeDeliverySchedule'
            discountClass:
              type: string
              nullable: true
            discountLevel:
              type: string
              nullable: true
            drawdownRate:
              type: number
            drawdownUom:
              type: string
            endDateCondition:
              type: string
            excludeItemBillingFromRevenueAccounting:
              type: boolean
            excludeItemBookingFromRevenueAccounting:
              type: boolean
            financeInformation:
              properties:
                adjustmentLiabilityAccountingCode:
                  type: string
                adjustmentLiabilityAccountingCodeType:
                  type: string
                adjustmentRevenueAccountingCode:
                  type: string
                adjustmentRevenueAccountingCodeType:
                  type: string
                contractAssetAccountingCode:
                  type: string
                contractAssetAccountingCodeType:
                  type: string
                contractLiabilityAccountingCode:
                  type: string
                contractLiabilityAccountingCodeType:
                  type: string
                contractRecognizedRevenueAccountingCode:
                  type: string
                contractRecognizedRevenueAccountingCodeType:
                  type: string
                deferredRevenueAccountingCode:
                  type: string
                deferredRevenueAccountingCodeType:
                  type: string
                  nullable: true
                recognizedRevenueAccountingCode:
                  type: string
                recognizedRevenueAccountingCodeType:
                  type: string
                  nullable: true
                unbilledReceivablesAccountingCode:
                  type: string
                unbilledReceivablesAccountingCodeType:
                  type: string
              title: financeInformation
              type: object
            formula:
              type: string
            id:
              type: string
            includedUnits:
              format: decimal
              type: string
            isAllocationEligible:
              type: boolean
            isPrepaid:
              type: boolean
            isRollover:
              type: boolean
            isStackedDiscount:
              type: boolean
            isUnbilled:
              type: boolean
            listPriceBase:
              enum:
                - Per_Billing_Period
                - Per_Month
                - Per_Week
                - Per_Year
                - Per_Specific_Months
              type: string
            maxQuantity:
              format: decimal
              type: string
            minQuantity:
              format: decimal
              type: string
            model:
              type: string
            name:
              type: string
            numberOfPeriods:
              format: int64
              type: integer
              nullable: true
            overageCalculationOption:
              type: string
              nullable: true
            overageUnusedUnitsCreditOption:
              type: string
              nullable: true
            prepaidOperationType:
              enum:
                - topup
                - drawdown
                - null
              type: string
              nullable: true
            prepaidQuantity:
              type: number
              nullable: true
            prepaidTotalQuantity:
              type: number
              nullable: true
            prepaidUom:
              type: string
              nullable: true
            prepayPeriods:
              format: int64
              type: integer
              nullable: true
            priceChangeOption:
              type: string
              nullable: true
            priceIncreasePercentage:
              format: decimal
              type: string
              nullable: true
            pricing:
              items:
                $ref: '#/components/schemas/GETProductRatePlanChargePricingType'
              type: array
            pricingSummary:
              items:
                type: string
              type: array
            productChargeDefinitions:
              type: string
            productDiscountApplyDetails:
              items:
                $ref: '#/components/schemas/GETProductDiscountApplyDetailsType'
              type: array
            productRatePlanChargeNumber:
              type: string
            ratingGroup:
              type: string
              nullable: true
            revRecCode:
              maxLength: 70
              type: string
              nullable: true
            revRecTriggerCondition:
              enum:
                - ContractEffectiveDate
                - ServiceActivationDate
                - CustomerAcceptanceDate
                - null
              maxLength: 22
              type: string
              nullable: true
            revenueRecognitionRuleName:
              type: string
            rolloverApply:
              enum:
                - ApplyFirst
                - ApplyLast
              type: string
            rolloverPeriodLength:
              default: null
              type: integer
            rolloverPeriods:
              type: number
            smoothingModel:
              type: string
              nullable: true
            specificBillingPeriod:
              format: int64
              type: integer
              nullable: true
            specificListPriceBase:
              type: integer
              nullable: true
            taxCode:
              type: string
            taxMode:
              enum:
                - TaxExclusive
                - TaxInclusive
                - null
              type: string
              nullable: true
            taxable:
              type: boolean
            triggerEvent:
              type: string
            type:
              type: string
            uom:
              type: string
              nullable: true
            upToPeriods:
              format: int64
              type: integer
              nullable: true
            upToPeriodsType:
              enum:
                - Billing_Periods
                - Days
                - Weeks
                - Months
                - Years
                - null
              type: string
              nullable: true
            usageRecordRatingOption:
              type: string
              nullable: true
            useDiscountSpecificAccountingCode:
              type: boolean
              nullable: true
            useTenantDefaultForPriceChange:
              type: boolean
            validityPeriodType:
              enum:
                - SUBSCRIPTION_TERM
                - ANNUAL
                - SEMI_ANNUAL
                - QUARTER
                - MONTH
              type: string
          type: object
        - $ref: '#/components/schemas/ProductRatePlanChargeObjectNSFields'
        - $ref: '#/components/schemas/ProductRatePlanChargeObjectCustomFields'
      title: productRatePlanCharges
    ProductRatePlanObjectNSFields:
      properties:
        BillingPeriod__NS:
          enum:
            - Monthly
            - Quarterly
            - Annual
            - Semi-Annual
          type: string
        Class__NS:
          maxLength: 255
          type: string
        Department__NS:
          maxLength: 255
          type: string
        IncludeChildren__NS:
          enum:
            - 'Yes'
            - 'No'
          type: string
        IntegrationId__NS:
          maxLength: 255
          type: string
        IntegrationStatus__NS:
          maxLength: 255
          type: string
        ItemType__NS:
          enum:
            - Inventory
            - Non Inventory
            - Service
          type: string
        Location__NS:
          maxLength: 255
          type: string
        MultiCurrencyPrice__NS:
          maxLength: 255
          type: string
        Price__NS:
          maxLength: 255
          type: string
        Subsidiary__NS:
          maxLength: 255
          type: string
        SyncDate__NS:
          maxLength: 255
          type: string
      title: productRatePlanFieldsNS
      type: object
    ProductRatePlanObjectCustomFields:
      additionalProperties: {}
      title: ProductRatePlanCustomFields
      type: object
    GETProductRatePlanChargeDeliverySchedule:
      properties:
        frequency:
          enum:
            - Weekly
          type: string
        friday:
          type: boolean
        monday:
          type: boolean
        saturday:
          type: boolean
        sunday:
          type: boolean
        thursday:
          type: boolean
        tuesday:
          type: boolean
        wendesday:
          type: boolean
      title: deliverySchedule
      type: object
    GETProductRatePlanChargePricingType:
      properties:
        currency:
          type: string
        discountAmount:
          format: decimal
          type: string
        discountPercentage:
          format: decimal
          type: string
        includedUnits:
          format: decimal
          type: string
        overagePrice:
          format: decimal
          type: string
        price:
          format: decimal
          type: string
        tiers:
          items:
            $ref: '#/components/schemas/GETProductRatePlanChargePricingTierType'
          type: array
      title: pricing
      type: object
    GETProductDiscountApplyDetailsType:
      properties:
        appliedProductRatePlanChargeId:
          type: string
        appliedProductRatePlanId:
          type: string
      title: productDiscountApplyDetails
      type: object
    ProductRatePlanChargeObjectNSFields:
      properties:
        Class__NS:
          maxLength: 255
          type: string
        DeferredRevAccount__NS:
          maxLength: 255
          type: string
        Department__NS:
          maxLength: 255
          type: string
        IncludeChildren__NS:
          enum:
            - 'Yes'
            - 'No'
          type: string
        IntegrationId__NS:
          maxLength: 255
          type: string
        IntegrationStatus__NS:
          maxLength: 255
          type: string
        ItemType__NS:
          enum:
            - Inventory
            - Non Inventory
            - Service
          type: string
        Location__NS:
          maxLength: 255
          type: string
        RecognizedRevAccount__NS:
          maxLength: 255
          type: string
        RevRecEnd__NS:
          enum:
            - Charge Period Start
            - Rev Rec Trigger Date
            - Use NetSuite Rev Rec Template
          type: string
        RevRecStart__NS:
          enum:
            - Charge Period Start
            - Rev Rec Trigger Date
            - Use NetSuite Rev Rec Template
          type: string
        RevRecTemplateType__NS:
          maxLength: 255
          type: string
        Subsidiary__NS:
          maxLength: 255
          type: string
        SyncDate__NS:
          maxLength: 255
          type: string
      title: productRatePlanChargeFieldsNS
      type: object
    ProductRatePlanChargeObjectCustomFields:
      additionalProperties: {}
      title: productRatePlanChargeFieldsCustom
      type: object
    GETProductRatePlanChargePricingTierType:
      properties:
        endingUnit:
          format: decimal
          type: string
        price:
          format: decimal
          type: string
        priceFormat:
          type: string
        startingUnit:
          format: decimal
          type: string
        tier:
          format: int64
          type: integer
      title: tiers
      type: object
    GETProductRatePlanWithExternalIdResponse:
      properties:
        ExternalIdSourceSystem:
          type: string
        effectiveEndDate:
          format: date
          type: string
        effectiveStartDate:
          format: date
          type: string
        externallyManagedPlanIds:
          items:
            type: string
          type: array
        grade:
          type: number
        id:
          type: string
        name:
          type: string
        organizationLabels:
          items:
            properties:
              organizationId:
                type: string
              organizationName:
                type: string
            type: object
          type: array
        productRatePlanNumber:
          type: string
        status:
          enum:
            - Active
            - Expired
            - NotStarted
          type: string
        success:
          type: boolean
      type: object
    GETProductRatePlanWithExternalIdMultiResponse:
      type: object
      properties:
        productRatePlans:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              status:
                enum:
                  - Active
                  - Expired
                  - NotStarted
                type: string
              name:
                type: string
              effectiveStartDate:
                format: date
                type: string
              effectiveEndDate:
                format: date
                type: string
              externalIdSourceSystem:
                type: string
              externallyManagedPlanIds:
                type: array
                items:
                  type: string
              productRatePlanNumber:
                type: string
              grade:
                type: number
              organizationLabels:
                items:
                  properties:
                    organizationId:
                      type: string
                    organizationName:
                      type: string
                  type: object
                type: array
        success:
          type: boolean
    ProxyCreateProductRatePlan:
      allOf:
        - properties:
            ActiveCurrencies:
              items:
                type: string
              type: array
            Description:
              maxLength: 500
              type: string
            EffectiveEndDate:
              format: date
              maxLength: 29
              type: string
            EffectiveStartDate:
              format: date
              maxLength: 29
              type: string
            ExternalIdSourceSystem:
              type: string
            ExternalRatePlanIds:
              type: string
            Grade:
              type: number
            Name:
              maxLength: 255
              type: string
            ProductId:
              maxLength: 32
              type: string
            ProductRatePlanNumber:
              maxLength: 100
              type: string
          required:
            - Name
            - ProductId
          type: object
        - $ref: '#/components/schemas/ProductRatePlanObjectNSFields'
        - $ref: '#/components/schemas/ProductRatePlanObjectCustomFields'
    ProxyGetProductRatePlan:
      allOf:
        - properties:
            ActiveCurrencies:
              items:
                type: string
              type: array
            CreatedById:
              maxLength: 32
              type: string
            CreatedDate:
              format: date-time
              maxLength: 29
              type: string
            Description:
              maxLength: 500
              type: string
            EffectiveEndDate:
              format: date
              maxLength: 29
              type: string
            EffectiveStartDate:
              format: date
              maxLength: 29
              type: string
            Grade:
              type: number
            Id:
              type: string
            Name:
              maxLength: 255
              type: string
            ProductId:
              maxLength: 32
              type: string
            UpdatedById:
              maxLength: 32
              type: string
            UpdatedDate:
              format: date-time
              maxLength: 29
              type: string
          type: object
        - $ref: '#/components/schemas/ProductRatePlanObjectNSFields'
        - $ref: '#/components/schemas/ProductRatePlanObjectCustomFields'
    ProxyModifyProductRatePlan:
      allOf:
        - properties:
            ActiveCurrencies:
              items:
                type: string
              type: array
            Description:
              maxLength: 500
              type: string
            EffectiveEndDate:
              format: date
              maxLength: 29
              type: string
            EffectiveStartDate:
              format: date
              maxLength: 29
              type: string
            ExternalIdSourceSystem:
              type: string
            ExternalRatePlanIds:
              type: string
            Grade:
              type: number
            Name:
              maxLength: 255
              type: string
            ProductId:
              maxLength: 32
              type: string
            ProductRatePlanNumber:
              maxLength: 100
              type: string
          type: object
        - $ref: '#/components/schemas/ProductRatePlanObjectNSFields'
        - $ref: '#/components/schemas/ProductRatePlanObjectCustomFields'
    POSTRatePlanDefinitionRequest:
      properties:
        productRatePlanChargeId:
          type: string
        productRatePlanChargeNumber:
          type: string
        productRatePlanId:
          type: string
        productRatePlanNumber:
          type: string
      type: object
    POSTRatePlanDefinitionResponse:
      properties:
        id:
          type: string
        success:
          type: boolean
      type: object
    GETProductRatePlanDefinitionsResponse:
      properties:
        productRatePlanDefinitions:
          items:
            properties:
              id:
                type: string
              productRatePlanChargeId:
                type: string
              productRatePlanChargeName:
                type: string
              productRatePlanChargeNumber:
                type: string
              productRatePlanId:
                type: string
              productRatePlanName:
                type: string
              productRatePlanNumber:
                type: string
            title: productRatePlanDefinitions
            type: object
          type: array
        success:
          type: boolean
      type: object
    GETProductRatePlanDefinitionResponse:
      properties:
        id:
          type: string
        productRatePlanChargeId:
          type: string
        productRatePlanChargeName:
          type: string
        productRatePlanChargeNumber:
          type: string
        productRatePlanId:
          type: string
        productRatePlanName:
          type: string
        productRatePlanNumber:
          type: string
        success:
          type: boolean
      type: object
    GETProductRatePlanChargeResponse:
      properties:
        applyDiscountTo:
          enum:
            - ONETIME
            - RECURRING
            - USAGE
            - ONETIMERECURRING
            - ONETIMEUSAGE
            - RECURRINGUSAGE
            - ONETIMERECURRINGUSAGE
            - null
          type: string
          nullable: true
        billingDay:
          type: string
        billingPeriod:
          type: string
        billingPeriodAlignment:
          enum:
            - AlignToCharge
            - AlignToSubscriptionStart
            - AlignToTermStart
            - AlignToTermEnd
          type: string
        billingTiming:
          enum:
            - IN_ADVANCE
            - IN_ARREARS
          type: string
        chargeFunction:
          enum:
            - Standard
            - Prepayment
            - CommitmentTrueUp
            - Drawdown
            - CreditCommitment
            - DrawdownAndCreditCommitment
          type: string
        commitmentType:
          enum:
            - UNIT
            - CURRENCY
          type: string
        customFields:
          $ref: '#/components/schemas/ProductRatePlanChargeObjectCustomFields'
        defaultQuantity:
          type: number
          nullable: true
        deliverySchedule:
          $ref: '#/components/schemas/GETDeliverySchedule'
        discountClass:
          type: string
          nullable: true
        discountLevel:
          enum:
            - rateplan
            - subscription
            - account
            - null
          type: string
          nullable: true
        endDateCondition:
          enum:
            - Subscription_End
            - One_Time
            - Fixed_Period
            - Specific_End_Date
          type: string
        excludeItemBillingFromRevenueAccounting:
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          type: boolean
        isAllocationEligible:
          type: boolean
        isUnbilled:
          type: boolean
        productCategory:
          type: string
        productClass:
          type: string
        productFamily:
          type: string
        productLine:
          type: string
        prorationOption:
          enum:
            - NoProration
            - TimeBasedProration
            - DefaultFromTenantSetting
            - ChargeFullPeriod
          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
        numberOfPeriods:
          format: int64
          type: integer
          nullable: true
        financeInformation:
          properties:
            accountsReceivableAccountingCode:
              type: string
              nullable: true
            accountsReceivableAccountingCodeType:
              type: string
              nullable: true
            adjustmentLiabilityAccountingCode:
              type: string
              nullable: true
            adjustmentLiabilityAccountingCodeType:
              type: string
              nullable: true
            adjustmentRevenueAccountingCode:
              type: string
              nullable: true
            adjustmentRevenueAccountingCodeType:
              type: string
              nullable: true
            contractAssetAccountingCode:
              type: string
              nullable: true
            contractAssetAccountingCodeType:
              type: string
              nullable: true
            contractLiabilityAccountingCode:
              type: string
              nullable: true
            contractLiabilityAccountingCodeType:
              type: string
              nullable: true
            contractRecognizedRevenueAccountingCode:
              type: string
              nullable: true
            contractRecognizedRevenueAccountingCodeType:
              type: string
              nullable: true
            deferredRevenueAccountingCode:
              type: string
              nullable: true
            deferredRevenueAccountingCodeType:
              type: string
              nullable: true
            recognizedRevenueAccountingCode:
              type: string
              nullable: true
            recognizedRevenueAccountingCodeType:
              type: string
              nullable: true
            unbilledReceivablesAccountingCode:
              type: string
              nullable: true
            unbilledReceivablesAccountingCodeType:
              type: string
              nullable: true
          title: financeInformation
          type: object
        id:
          type: string
        isStackedDiscount:
          type: boolean
        listPriceBase:
          enum:
            - Per_Billing_Period
            - Per_Month
            - Per_Week
            - Per_Year
          type: string
        model:
          enum:
            - DiscountFixedAmount
            - DiscountPercentage
            - FlatFee
            - PerUnit
            - Overage
            - Tiered
            - TieredwithOverage
            - Volume
            - Delivery
            - MultiAttributePricing
            - PreratedPerUnit
            - PreratedPricing
            - HighWatermarkVolumePricing
            - HighWatermarkTieredPricing
          type: string
        name:
          type: string
        numberOfPeriod:
          format: int64
          type: integer
        overageCalculationOption:
          enum:
            - EndOfSmoothingPeriod
            - PerBillingPeriod
            - null
          type: string
          nullable: true
        overageUnusedUnitsCreditOption:
          enum:
            - NoCredit
            - CreditBySpecificRate
            - null
          type: string
          nullable: true
        priceChangeOption:
          default: NoChange
          enum:
            - NoChange
            - SpecificPercentageValue
            - UseLatestProductCatalogPricing
            - null
          type: string
          nullable: true
        priceIncreaseOption:
          enum:
            - FromTenantPercentageValue
            - SpecificPercentageValue
          type: string
        priceIncreasePercentage:
          format: double
          type: number
          nullable: true
        pricing:
          items:
            $ref: '#/components/schemas/GETRatePlanChargePricing'
          type: array
        pricingSummary:
          items:
            type: string
          type: array
        productChargeDefinitions:
          type: string
        productDiscountApplyDetails:
          items:
            $ref: '#/components/schemas/GETProductDiscountApplyDetailsType'
          type: array
        productRatePlanChargeNumber:
          type: string
          nullable: true
        ratingGroup:
          default: ByBillingPeriod
          enum:
            - ByBillingPeriod
            - ByUsageStartDate
            - ByUsageRecord
            - ByUsageUpload
            - ByGroupId
            - null
          type: string
          nullable: true
        recognizedRevenueAccount:
          maxLength: 100
          type: string
        revRecCode:
          maxLength: 70
          type: string
          nullable: true
        revRecTriggerCondition:
          enum:
            - ContractEffectiveDate
            - ServiceActivationDate
            - CustomerAcceptanceDate
            - null
          type: string
          nullable: true
        revenueRecognitionRuleName:
          enum:
            - Recognize upon invoicing
            - Recognize daily over time
          type: string
        smoothingModel:
          enum:
            - RollingWindow
            - Rollover
            - null
          type: string
          nullable: true
        specificBillingPeriod:
          type: number
          nullable: true
        specificListPriceBase:
          format: int32
          maximum: 200
          minimum: 1
          type: integer
          nullable: true
        success:
          type: boolean
        taxCode:
          maxLength: 64
          type: string
        taxMode:
          enum:
            - TaxExclusive
            - TaxInclusive
            - null
          type: string
          nullable: true
        taxable:
          type: boolean
        triggerEvent:
          enum:
            - ContractEffective
            - ServiceActivation
            - CustomerAcceptance
          type: string
        type:
          enum:
            - OneTime
            - Recurring
            - Usage
          type: string
        uom:
          type: string
          nullable: true
        upToPeriods:
          type: number
          nullable: true
        upToPeriodsType:
          enum:
            - Billing_Periods
            - Days
            - Weeks
            - Months
            - Years
            - null
          type: string
          nullable: true
        usageRecordRatingOption:
          default: EndOfBillingPeriod
          enum:
            - EndOfBillingPeriod
            - OnDemand
            - null
          type: string
          nullable: true
        useDiscountSpecificAccountingCode:
          type: boolean
          nullable: true
        useTenantDefaultForPriceChange:
          type: boolean
        applyToBillingPeriodPartially:
          type: boolean
        isPrepaid:
          type: boolean
        prepaidOperationType:
          enum:
            - topup
            - drawdown
            - null
          type: string
          nullable: true
        prepaidQuantity:
          type: number
          nullable: true
        prepaidTotalQuantity:
          type: number
          nullable: true
        prepaidUom:
          type: string
          nullable: true
        validityPeriodType:
          enum:
            - SUBSCRIPTION_TERM
            - ANNUAL
            - SEMI_ANNUAL
            - QUARTER
            - MONTH
          type: string
        drawdownRate:
          type: number
          nullable: true
        drawdownUom:
          type: string
          nullable: true
        creditOption:
          enum:
            - TimeBased
            - ConsumptionBased
            - FullCreditBack
          type: string
        isRollover:
          type: boolean
        rolloverApply:
          enum:
            - ApplyFirst
            - ApplyLast
          type: string
        rolloverPeriodLength:
          default: null
          type: integer
        rolloverPeriods:
          type: number
        formula:
          type: string
      type: object
    GETDeliverySchedule:
      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
      nullable: true
    GETRatePlanChargePricing:
      properties:
        currency:
          type: string
        discountAmount:
          format: double
          type: number
          nullable: true
        discountPercentage:
          format: double
          type: number
          nullable: true
        includedUnits:
          type: number
          nullable: true
        overagePrice:
          type: number
          nullable: true
        price:
          type: number
        tiers:
          items:
            $ref: '#/components/schemas/GETRatePlanChargePricingTier'
          type: array
          nullable: true
      type: object
    GETRatePlanChargePricingTier:
      items:
        properties:
          currency:
            type: string
          discountAmount:
            format: double
            type: number
          discountPercentage:
            format: double
            type: number
          endingUnit:
            format: double
            type: number
          overagePrice:
            format: double
            type: number
          price:
            format: double
            type: number
          startingUnit:
            format: double
            type: number
        type: object
      type: array
    ProxyCreateProductRatePlanCharge:
      allOf:
        - properties:
            AccountingCode:
              maxLength: 100
              type: string
            ApplyDiscountTo:
              enum:
                - ONETIME (1)
                - RECURRING (2)
                - USAGE (4)
                - ONETIMERECURRING (3)
                - ONETIMEUSAGE (5)
                - RECURRINGUSAGE (6)
                - ONETIMERECURRINGUSAGE (7)
              type: string
            BillCycleDay:
              format: int32
              type: integer
            BillCycleType:
              enum:
                - DefaultFromCustomer
                - SpecificDayofMonth
                - SubscriptionStartDay
                - ChargeTriggerDay
                - SpecificDayofWeek
                - TermStartDay
                - TermEndDay
              type: string
            BillingPeriod:
              enum:
                - Month
                - Quarter
                - Annual
                - Semi-Annual
                - Specific Months
                - Subscription Term
                - Week
                - Specific Weeks
                - Specific Days
              type: string
            BillingPeriodAlignment:
              enum:
                - AlignToCharge
                - AlignToSubscriptionStart
                - AlignToTermStart
                - AlignToTermEnd
              type: string
            BillingTiming:
              enum:
                - In Advance
                - In Arrears
              type: string
            ChargeFunction:
              enum:
                - Standard
                - Prepayment
                - CommitmentTrueUp
                - Drawdown
                - CreditCommitment
                - DrawdownAndCreditCommitment
              type: string
            CommitmentType:
              enum:
                - UNIT
                - CURRENCY
              type: string
            ChargeModel:
              enum:
                - Discount-Fixed Amount
                - Discount-Percentage
                - Flat Fee Pricing
                - Per Unit Pricing
                - Overage Pricing
                - Tiered Pricing
                - Tiered with Overage Pricing
                - Volume Pricing
                - Delivery Pricing
                - MultiAttributePricing
                - PreratedPerUnit
                - PreratedPricing`
                - HighWatermarkVolumePricing
                - HighWatermarkTieredPricing
              type: string
            ChargeModelConfiguration:
              $ref: '#/components/schemas/ProxyCreateOrModifyProductRatePlanChargeChargeModelConfiguration'
            ChargeType:
              enum:
                - OneTime
                - Recurring
                - Usage
              type: string
            CreditOption:
              enum:
                - TimeBased
                - ConsumptionBased
                - FullCreditBack
              type: string
            DefaultQuantity:
              format: double
              type: number
            DeferredRevenueAccount:
              maxLength: 100
              type: string
            DeliverySchedule:
              $ref: '#/components/schemas/ProxyCreateOrModifyDeliverySchedule'
            Description:
              maxLength: 500
              type: string
            DiscountLevel:
              enum:
                - rateplan
                - subscription
                - account
              type: string
            DrawdownRate:
              type: number
            DrawdownUom:
              type: string
            EndDateCondition:
              default: SubscriptionEnd
              enum:
                - SubscriptionEnd
                - FixedPeriod
              type: string
            ExcludeItemBillingFromRevenueAccounting:
              default: false
              type: boolean
            ExcludeItemBookingFromRevenueAccounting:
              default: false
              type: boolean
            IncludedUnits:
              format: double
              type: number
            IsAllocationEligible:
              type: boolean
            IsPrepaid:
              type: boolean
            IsRollover:
              type: boolean
            IsStackedDiscount:
              type: boolean
            IsUnbilled:
              type: boolean
            LegacyRevenueReporting:
              type: boolean
            ListPriceBase:
              enum:
                - Per Billing Period
                - Per Month
                - Per Week
                - Per Year
                - Per Specific Months
              type: string
            MaxQuantity:
              format: double
              type: number
            MinQuantity:
              format: double
              type: number
            Name:
              maxLength: 100
              type: string
            NumberOfPeriod:
              format: int64
              type: integer
            OverageCalculationOption:
              enum:
                - EndOfSmoothingPeriod
                - PerBillingPeriod
              type: string
            OverageUnusedUnitsCreditOption:
              enum:
                - NoCredit
                - CreditBySpecificRate
                - null
              type: string
              nullable: true
            PrepaidOperationType:
              enum:
                - topup
                - drawdown
              type: string
            PrepaidQuantity:
              type: number
            PrepaidTotalQuantity:
              type: number
            PrepaidUom:
              type: string
            PriceChangeOption:
              default: NoChange
              enum:
                - NoChange
                - SpecificPercentageValue
                - UseLatestProductCatalogPricing
              type: string
            PriceIncreaseOption:
              enum:
                - FromTenantPercentageValue
                - SpecificPercentageValue
              type: string
            PriceIncreasePercentage:
              format: double
              type: number
              nullable: true
            ProductCategory:
              type: string
            ProductClass:
              type: string
            ProductFamily:
              type: string
            ProductLine:
              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
            ProductRatePlanChargeNumber:
              maxLength: 100
              type: string
            ProductRatePlanChargeTierData:
              $ref: '#/components/schemas/ProxyCreateOrModifyProductRatePlanChargeTierData'
            ProductRatePlanId:
              maxLength: 32
              type: string
            ProrationOption:
              enum:
                - NoProration
                - TimeBasedProration
                - DefaultFromTenantSetting
                - ChargeFullPeriod
              type: string
            RatingGroup:
              default: ByBillingPeriod
              enum:
                - ByBillingPeriod
                - ByUsageStartDate
                - ByUsageRecord
                - ByUsageUpload
                - ByGroupId
                - null
              type: string
              nullable: true
            RecognizedRevenueAccount:
              maxLength: 100
              type: string
            RevRecCode:
              maxLength: 70
              type: string
              nullable: true
            RevRecTriggerCondition:
              enum:
                - ContractEffectiveDate
                - ServiceActivationDate
                - CustomerAcceptanceDate
                - null
              type: string
              nullable: true
            RevenueRecognitionRuleName:
              enum:
                - Recognize upon invoicing
                - Recognize daily over time
              type: string
            RolloverApply:
              enum:
                - ApplyFirst
                - ApplyLast
              type: string
            RolloverPeriods:
              type: number
            SmoothingModel:
              enum:
                - RollingWindow
                - Rollover
                - null
              type: string
              nullable: true
            SpecificBillingPeriod:
              format: int64
              type: integer
              nullable: true
            SpecificListPriceBase:
              format: int32
              maximum: 200
              minimum: 1
              type: integer
              nullable: true
            TaxCode:
              maxLength: 64
              type: string
            TaxMode:
              enum:
                - TaxExclusive
                - TaxInclusive
                - null
              type: string
              nullable: true
            Taxable:
              type: boolean
            TriggerEvent:
              enum:
                - ContractEffective
                - ServiceActivation
                - CustomerAcceptance
              type: string
            UOM:
              maxLength: 25
              type: string
              nullable: true
            UpToPeriods:
              format: int64
              type: integer
              nullable: true
            UpToPeriodsType:
              default: Billing Periods
              enum:
                - Billing Periods
                - Days
                - Weeks
                - Months
                - Years
                - null
              type: string
              nullable: true
            UsageRecordRatingOption:
              default: EndOfBillingPeriod
              enum:
                - EndOfBillingPeriod
                - OnDemand
                - null
              type: string
              nullable: true
            UseDiscountSpecificAccountingCode:
              type: boolean
              nullable: true
            UseTenantDefaultForPriceChange:
              type: boolean
            ValidityPeriodType:
              enum:
                - SUBSCRIPTION_TERM
                - ANNUAL
                - SEMI_ANNUAL
                - QUARTER
                - MONTH
              type: string
            WeeklyBillCycleDay:
              enum:
                - Sunday
                - Monday
                - Tuesday
                - Wednesday
                - Thursday
                - Friday
                - Saturday
              type: string
            ApplyToBillingPeriodPartially:
              type: boolean
            RolloverPeriodLength:
              default: null
              type: integer
            Formula:
              type: string
          required:
            - BillCycleType
            - BillingPeriod
            - ChargeModel
            - ChargeType
            - Name
            - ProductRatePlanChargeTierData
            - ProductRatePlanId
            - TriggerEvent
            - UseDiscountSpecificAccountingCode
          type: object
        - $ref: '#/components/schemas/ProductRatePlanChargeObjectNSFields'
        - $ref: '#/components/schemas/ProductRatePlanChargeObjectCustomFields'
    ProxyCreateOrModifyProductRatePlanChargeChargeModelConfiguration:
      properties:
        ConfigurationItem:
          items:
            $ref: '#/components/schemas/ProxyCreateOrModifyProductRatePlanChargeChargeModelConfigurationItem'
          type: array
      title: ChargeModelConfiguration
      type: object
    ProxyCreateOrModifyDeliverySchedule:
      properties:
        frequency:
          enum:
            - Weekly
          type: string
        friday:
          type: boolean
        monday:
          type: boolean
        saturday:
          type: boolean
        sunday:
          type: boolean
        thursday:
          type: boolean
        tuesday:
          type: boolean
        wendesday:
          type: boolean
      title: DeliverySchedule
      type: object
    ProxyCreateOrModifyProductRatePlanChargeTierData:
      properties:
        ProductRatePlanChargeTier:
          items:
            properties:
              Currency:
                type: string
              DiscountAmount:
                format: double
                type: number
              DiscountPercentage:
                format: double
                type: number
              EndingUnit:
                format: double
                type: number
              IsOveragePrice:
                type: boolean
              Price:
                format: double
                type: number
              PriceFormat:
                enum:
                  - Flat Fee
                  - Per Unit
                type: string
              StartingUnit:
                format: double
                type: number
            type: object
          type: array
      title: productRatePlanChargeTierData
      type: object
    ProxyCreateOrModifyProductRatePlanChargeChargeModelConfigurationItem:
      properties:
        Key:
          type: string
        Value:
          type: string
      required:
        - Key
        - Value
      title: ConfigurationItem
      type: object
    ProxyGetProductRatePlanCharge:
      allOf:
        - properties:
            AccountingCode:
              maxLength: 100
              type: string
            ApplyDiscountTo:
              enum:
                - ONETIME (1)
                - RECURRING (2)
                - USAGE (4)
                - ONETIMERECURRING (3)
                - ONETIMEUSAGE (5)
                - RECURRINGUSAGE (6)
                - ONETIMERECURRINGUSAGE (7)
              type: string
            BillCycleDay:
              format: int32
              type: integer
            BillCycleType:
              enum:
                - DefaultFromCustomer
                - SpecificDayofMonth
                - SubscriptionStartDay
                - ChargeTriggerDay
                - SpecificDayofWeek
                - TermStartDay
                - TermEndDay
              type: string
            BillingPeriod:
              enum:
                - Month
                - Quarter
                - Annual
                - Semi-Annual
                - Specific Months
                - Subscription Term
                - Week
                - Specific Weeks
                - Specific Days
              type: string
            BillingPeriodAlignment:
              enum:
                - AlignToCharge
                - AlignToSubscriptionStart
                - AlignToTermStart
                - AlignToTermEnd
              type: string
            BillingTiming:
              enum:
                - In Advance
                - In Arrears
              type: string
            ChargeFunction:
              enum:
                - Standard
                - Prepayment
                - CommitmentTrueUp
                - Drawdown
                - CreditCommitment
                - DrawdownAndCreditCommitment
              type: string
            CommitmentType:
              enum:
                - UNIT
                - CURRENCY
              type: string
            ChargeModel:
              enum:
                - Discount-Fixed Amount
                - Discount-Percentage
                - Flat Fee Pricing
                - Per Unit Pricing
                - Overage Pricing
                - Tiered Pricing
                - Tiered with Overage Pricing
                - Volume Pricing
                - Delivery Pricing
                - MultiAttributePricing
                - PreratedPerUnit
                - PreratedPricing`
                - HighWatermarkVolumePricing
                - HighWatermarkTieredPricing
              type: string
            ChargeType:
              enum:
                - OneTime
                - Recurring
                - Usage
              type: string
            CreatedById:
              maxLength: 32
              type: string
            CreatedDate:
              format: date-time
              maxLength: 29
              type: string
            DefaultQuantity:
              format: double
              type: number
            DeferredRevenueAccount:
              maxLength: 100
              type: string
            Description:
              maxLength: 500
              type: string
            DiscountLevel:
              enum:
                - rateplan
                - subscription
                - account
              type: string
            EndDateCondition:
              default: SubscriptionEnd
              enum:
                - SubscriptionEnd
                - FixedPeriod
              type: string
            ExcludeItemBillingFromRevenueAccounting:
              type: boolean
            ExcludeItemBookingFromRevenueAccounting:
              type: boolean
            Id:
              type: string
            IncludedUnits:
              format: double
              type: number
            LegacyRevenueReporting:
              type: boolean
            ListPriceBase:
              enum:
                - Per Billing Period
                - Per Month
                - Per Week
                - Per Year
                - Per Specific Months
              type: string
            MaxQuantity:
              format: double
              type: number
            MinQuantity:
              format: double
              type: number
            Name:
              maxLength: 100
              type: string
            NumberOfPeriod:
              format: int64
              type: integer
            OverageCalculationOption:
              enum:
                - EndOfSmoothingPeriod
                - PerBillingPeriod
                - null
              type: string
              nullable: true
            OverageUnusedUnitsCreditOption:
              enum:
                - NoCredit
                - CreditBySpecificRate
                - null
              type: string
              nullable: true
            PriceChangeOption:
              default: NoChange
              enum:
                - NoChange
                - SpecificPercentageValue
                - UseLatestProductCatalogPricing
                - null
              type: string
              nullable: true
            PriceIncreasePercentage:
              format: double
              type: number
              nullable: true
            ProductRatePlanId:
              maxLength: 32
              type: string
            ProrationOption:
              enum:
                - NoProration
                - TimeBasedProration
                - DefaultFromTenantSetting
                - ChargeFullPeriod
              type: string
            RatingGroup:
              enum:
                - ByBillingPeriod
                - ByUsageStartDate
                - ByUsageRecord
                - ByUsageUpload
                - ByGroupId
                - null
              type: string
              nullable: true
            RecognizedRevenueAccount:
              maxLength: 100
              type: string
            RevRecCode:
              maxLength: 70
              type: string
              nullable: true
            RevRecTriggerCondition:
              enum:
                - ContractEffectiveDate
                - ServiceActivationDate
                - CustomerAcceptanceDate
                - null
              type: string
              nullable: true
            RevenueRecognitionRuleName:
              enum:
                - Recognize upon invoicing
                - Recognize daily over time
              type: string
            SmoothingModel:
              enum:
                - RollingWindow
                - Rollover
                - null
              type: string
              nullable: true
            SpecificBillingPeriod:
              format: int64
              type: integer
              nullable: true
            SpecificListPriceBase:
              type: integer
              nullable: true
            TaxCode:
              maxLength: 64
              type: string
            TaxMode:
              enum:
                - TaxExclusive
                - TaxInclusive
                - null
              type: string
              nullable: true
            Taxable:
              type: boolean
            TriggerEvent:
              enum:
                - ContractEffective
                - ServiceActivation
                - CustomerAcceptance
              type: string
            UOM:
              maxLength: 25
              type: string
              nullable: true
            UpToPeriods:
              format: int64
              type: integer
              nullable: true
            UpToPeriodsType:
              default: Billing Periods
              enum:
                - Billing Periods
                - Days
                - Weeks
                - Months
                - Years
                - null
              type: string
              nullable: true
            UpdatedById:
              maxLength: 32
              type: string
            UpdatedDate:
              format: date-time
              maxLength: 29
              type: string
            UseDiscountSpecificAccountingCode:
              type: boolean
              nullable: true
            UseTenantDefaultForPriceChange:
              type: boolean
            WeeklyBillCycleDay:
              enum:
                - Sunday
                - Monday
                - Tuesday
                - Wednesday
                - Thursday
                - Friday
                - Saturday
              type: string
            IsAllocationEligible:
              type: boolean
            IsUnbilled:
              type: boolean
            ProductCategory:
              type: string
            ProductClass:
              type: string
            ProductFamily:
              type: string
            ProductLine:
              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
            ApplyToBillingPeriodPartially:
              type: boolean
            Formula:
              type: string
          type: object
        - $ref: '#/components/schemas/ProductRatePlanChargeObjectNSFields'
        - $ref: '#/components/schemas/ProductRatePlanChargeObjectCustomFields'
    ProxyModifyProductRatePlanCharge:
      allOf:
        - properties:
            AccountingCode:
              maxLength: 100
              type: string
            ApplyDiscountTo:
              enum:
                - ONETIME (1)
                - RECURRING (2)
                - USAGE (4)
                - ONETIMERECURRING (3)
                - ONETIMEUSAGE (5)
                - RECURRINGUSAGE (6)
                - ONETIMERECURRINGUSAGE (7)
              type: string
            BillCycleDay:
              format: int32
              type: integer
            BillCycleType:
              enum:
                - DefaultFromCustomer
                - SpecificDayofMonth
                - SubscriptionStartDay
                - ChargeTriggerDay
                - SpecificDayofWeek
                - TermStartDay
                - TermEndDay
              type: string
            BillingPeriod:
              enum:
                - Month
                - Quarter
                - Annual
                - Semi-Annual
                - Specific Months
                - Subscription Term
                - Week
                - Specific Weeks
                - Specific Days
              type: string
            BillingPeriodAlignment:
              enum:
                - AlignToCharge
                - AlignToSubscriptionStart
                - AlignToTermStart
                - AlignToTermEnd
              type: string
            BillingTiming:
              enum:
                - In Advance
                - In Arrears
              type: string
            ChargeFunction:
              enum:
                - Standard
                - Prepayment
                - CommitmentTrueUp
                - Drawdown
                - CreditCommitment
                - DrawdownAndCreditCommitment
              type: string
            CommitmentType:
              enum:
                - UNIT
                - CURRENCY
              type: string
            ChargeModel:
              enum:
                - Discount-Fixed Amount
                - Discount-Percentage
                - Flat Fee Pricing
                - Per Unit Pricing
                - Overage Pricing
                - Tiered Pricing
                - Tiered with Overage Pricing
                - Volume Pricing
                - Delivery Pricing
                - MultiAttributePricing
                - PreratedPerUnit
                - PreratedPricing`
                - HighWatermarkVolumePricing
                - HighWatermarkTieredPricing
              type: string
            ChargeModelConfiguration:
              $ref: '#/components/schemas/ProxyCreateOrModifyProductRatePlanChargeChargeModelConfiguration'
            CreditOption:
              enum:
                - TimeBased
                - ConsumptionBased
                - FullCreditBack
              type: string
            DefaultQuantity:
              format: double
              type: number
            DeferredRevenueAccount:
              maxLength: 100
              type: string
            DeliverySchedule:
              $ref: '#/components/schemas/ProxyCreateOrModifyDeliverySchedule'
            Description:
              maxLength: 500
              type: string
            DiscountLevel:
              enum:
                - rateplan
                - subscription
                - account
              type: string
            DrawdownRate:
              type: number
            DrawdownUom:
              type: string
            EndDateCondition:
              default: SubscriptionEnd
              enum:
                - SubscriptionEnd
                - FixedPeriod
              type: string
            ExcludeItemBillingFromRevenueAccounting:
              default: false
              type: boolean
            ExcludeItemBookingFromRevenueAccounting:
              default: false
              type: boolean
            IncludedUnits:
              format: double
              type: number
            IsAllocationEligible:
              type: boolean
            IsPrepaid:
              type: boolean
            IsRollover:
              type: boolean
            IsStackedDiscount:
              type: boolean
            IsUnbilled:
              type: boolean
            LegacyRevenueReporting:
              type: boolean
            ListPriceBase:
              enum:
                - Per Billing Period
                - Per Month
                - Per Week
                - Per Year
                - Per Specific Months
              type: string
            MaxQuantity:
              format: double
              type: number
            MinQuantity:
              format: double
              type: number
            Name:
              maxLength: 100
              type: string
            NumberOfPeriod:
              format: int64
              type: integer
            OverageCalculationOption:
              enum:
                - EndOfSmoothingPeriod
                - PerBillingPeriod
                - null
              type: string
              nullable: true
            OverageUnusedUnitsCreditOption:
              enum:
                - NoCredit
                - CreditBySpecificRate
                - null
              type: string
              nullable: true
            PrepaidQuantity:
              type: number
            PrepaidUom:
              type: string
            PriceChangeOption:
              default: NoChange
              enum:
                - NoChange
                - SpecificPercentageValue
                - UseLatestProductCatalogPricing
                - null
              type: string
              nullable: true
            PriceIncreaseOption:
              enum:
                - FromTenantPercentageValue
                - SpecificPercentageValue
              type: string
            PriceIncreasePercentage:
              format: double
              type: number
              nullable: true
            ProductCategory:
              type: string
            ProductClass:
              type: string
            ProductFamily:
              type: string
            ProductLine:
              type: string
            ProrationOption:
              enum:
                - NoProration
                - TimeBasedProration
                - DefaultFromTenantSetting
                - ChargeFullPeriod
              type: string
            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
            ProductRatePlanChargeNumber:
              maxLength: 100
              type: string
            ProductRatePlanChargeTierData:
              $ref: '#/components/schemas/ProxyCreateOrModifyProductRatePlanChargeTierData'
            ProductRatePlanId:
              maxLength: 32
              type: string
            RatingGroup:
              default: ByBillingPeriod
              enum:
                - ByBillingPeriod
                - ByUsageStartDate
                - ByUsageRecord
                - ByUsageUpload
                - ByGroupId
                - null
              type: string
              nullable: true
            RecognizedRevenueAccount:
              maxLength: 100
              type: string
            RevRecCode:
              maxLength: 70
              type: string
              nullable: true
            RevRecTriggerCondition:
              enum:
                - ContractEffectiveDate
                - ServiceActivationDate
                - CustomerAcceptanceDate
                - null
              type: string
              nullable: true
            RevenueRecognitionRuleName:
              enum:
                - Recognize upon invoicing
                - Recognize daily over time
              type: string
            RolloverApply:
              enum:
                - ApplyFirst
                - ApplyLast
              type: string
            RolloverPeriods:
              type: number
            SmoothingModel:
              enum:
                - RollingWindow
                - Rollover
                - null
              type: string
              nullable: true
            SpecificBillingPeriod:
              format: int64
              type: integer
              nullable: true
            SpecificListPriceBase:
              format: int32
              maximum: 200
              minimum: 1
              type: integer
              nullable: true
            TaxCode:
              maxLength: 64
              type: string
            TaxMode:
              enum:
                - TaxExclusive
                - TaxInclusive
                - null
              type: string
              nullable: true
            Taxable:
              type: boolean
            TriggerEvent:
              enum:
                - ContractEffective
                - ServiceActivation
                - CustomerAcceptance
              type: string
            UOM:
              maxLength: 25
              type: string
              nullable: true
            UpToPeriods:
              format: int64
              type: integer
              nullable: true
            UpToPeriodsType:
              default: Billing Periods
              enum:
                - Billing Periods
                - Days
                - Weeks
                - Months
                - Years
                - null
              type: string
              nullable: true
            UsageRecordRatingOption:
              default: EndOfBillingPeriod
              enum:
                - EndOfBillingPeriod
                - OnDemand
                - null
              type: string
              nullable: true
            UseDiscountSpecificAccountingCode:
              type: boolean
              nullable: true
            UseTenantDefaultForPriceChange:
              type: boolean
            ValidityPeriodType:
              enum:
                - SUBSCRIPTION_TERM
                - ANNUAL
                - SEMI_ANNUAL
                - QUARTER
                - MONTH
              type: string
            WeeklyBillCycleDay:
              enum:
                - Sunday
                - Monday
                - Tuesday
                - Wednesday
                - Thursday
                - Friday
                - Saturday
              type: string
            ApplyToBillingPeriodPartially:
              type: boolean
            RolloverPeriodLength:
              default: null
              type: integer
            Formula:
              type: string
          required:
            - BillCycleType
            - BillingPeriod
            - ChargeModel
            - ProductRatePlanChargeTierData
            - ProductRatePlanId
            - TriggerEvent
            - UseDiscountSpecificAccountingCode
          type: object
        - $ref: '#/components/schemas/ProductRatePlanChargeObjectNSFields'
        - $ref: '#/components/schemas/ProductRatePlanChargeObjectCustomFields'
    POSTChargeDefinitionRequest:
      properties:
        billingPeriod:
          type: string
        billingTiming:
          enum:
            - IN_ADVANCE
            - IN_ARREARS
          type: string
        chargeModel:
          enum:
            - DiscountFixedAmount
            - DiscountPercentage
            - FlatFee
            - PerUnit
            - Tiered
            - Volume
            - Delivery
          type: string
        defaultQuantity:
          type: number
          nullable: true
        effectiveEndDate:
          format: date-time
          type: string
        effectiveStartDate:
          format: date-time
          type: string
        listPriceBase:
          enum:
            - Per_Billing_Period
            - Per_Month
            - Per_Week
            - Per_Year
          type: string
        prices:
          items:
            $ref: '#/components/schemas/POSTProductChargeDefinitionPricing'
          type: array
        productRatePlanChargeId:
          type: string
        productRatePlanChargeNumber:
          type: string
        productRatePlanId:
          type: string
        productRatePlanNumber:
          type: string
        specificBillingPeriod:
          type: number
          nullable: true
        specificListPriceBase:
          format: int32
          maximum: 200
          minimum: 1
          type: integer
          nullable: true
        taxCode:
          maxLength: 64
          type: string
        taxMode:
          enum:
            - TaxExclusive
            - TaxInclusive
            - null
          type: string
          nullable: true
        taxable:
          type: boolean
        term:
          type: number
          nullable: true
        termPeriodType:
          enum:
            - Month
            - Year
            - Day
            - Week
            - null
          type: string
          nullable: true
        termType:
          enum:
            - TERMED
            - EVERGREEN
            - null
          type: string
          nullable: true
        uom:
          type: string
          nullable: true
      title: productChargeDefinitions
      type: object
    POSTChargeDefinitionResponse:
      properties:
        chargeDefinitionId:
          type: string
        chargeDefinitionNumber:
          type: string
        success:
          type: boolean
      type: object
    POSTProductChargeDefinitionPricing:
      properties:
        currency:
          type: string
        discountAmount:
          format: double
          type: number
        discountPercentage:
          format: double
          type: number
        price:
          type: number
        tiers:
          items:
            $ref: '#/components/schemas/POSTChargeDefinitionPricingTier'
          type: array
      title: prices
      type: object
    POSTChargeDefinitionPricingTier:
      items:
        properties:
          currency:
            type: string
          endingUnit:
            format: double
            type: number
          price:
            format: double
            type: number
          priceFormat:
            enum:
              - Flat Fee
              - Per Unit
            type: string
          startingUnit:
            format: double
            type: number
        type: object
      title: pricingTiers
      type: array
    GETProductChargeDefinitionsResponse:
      properties:
        chargeDefinitions:
          items:
            properties:
              applyDiscountTo:
                enum:
                  - ONETIME
                  - RECURRING
                  - USAGE
                  - ONETIMERECURRING
                  - ONETIMEUSAGE
                  - RECURRINGUSAGE
                  - ONETIMERECURRINGUSAGE
                  - null
                type: string
                nullable: true
              billingDay:
                type: string
              billingPeriod:
                type: string
              billingPeriodAlignment:
                enum:
                  - AlignToCharge
                  - AlignToSubscriptionStart
                  - AlignToTermStart
                  - AlignToTermEnd
                type: string
              billingTiming:
                enum:
                  - IN_ADVANCE
                  - IN_ARREARS
                type: string
              chargeModel:
                enum:
                  - DiscountFixedAmount
                  - DiscountPercentage
                  - FlatFee
                  - PerUnit
                  - Overage
                  - Tiered
                  - TieredWithOverage
                  - Volume
                  - Delivery
                  - MultiAttributePricing
                  - PreratedPerUnit
                  - PreratedPricing
                  - HighWatermarkVolumePricing
                  - HighWatermarkTieredPricing
                type: string
              chargeType:
                enum:
                  - OneTime
                  - Recurring
                  - Usage
                type: string
              customFields:
                $ref: '#/components/schemas/ProductChargeDefinitionObjectCustomFields'
              defaultQuantity:
                type: number
                nullable: true
              deliverySchedule:
                $ref: '#/components/schemas/GETDeliverySchedule'
              discountClass:
                type: string
                nullable: true
              discountLevel:
                enum:
                  - rateplan
                  - subscription
                  - account
                  - null
                type: string
                nullable: true
              effectiveEndDate:
                format: date-time
                type: string
              effectiveStartDate:
                format: date-time
                type: string
              endDateCondition:
                enum:
                  - Subscription_End
                  - One_Time
                  - Fixed_Period
                  - Specific_End_Date
                type: string
              excludeItemBillingFromRevenueAccounting:
                type: boolean
              excludeItemBookingFromRevenueAccounting:
                type: boolean
              isAllocationEligible:
                type: boolean
              isUnbilled:
                type: boolean
              productCategory:
                type: string
              productClass:
                type: string
              productFamily:
                type: string
              productLine:
                type: string
              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
              numberOfPeriods:
                format: int64
                type: integer
                nullable: true
              financeInformation:
                properties:
                  accountsReceivableAccountingCode:
                    type: string
                    nullable: true
                  accountsReceivableAccountingCodeType:
                    type: string
                    nullable: true
                  adjustmentLiabilityAccountingCode:
                    type: string
                  adjustmentLiabilityAccountingCodeType:
                    type: string
                    nullable: true
                  adjustmentRevenueAccountingCode:
                    type: string
                  adjustmentRevenueAccountingCodeType:
                    type: string
                    nullable: true
                  contractAssetAccountingCode:
                    type: string
                  contractAssetAccountingCodeType:
                    type: string
                  contractLiabilityAccountingCode:
                    type: string
                  contractLiabilityAccountingCodeType:
                    type: string
                  contractRecognizedRevenueAccountingCode:
                    type: string
                  contractRecognizedRevenueAccountingCodeType:
                    type: string
                  deferredRevenueAccountingCode:
                    type: string
                  deferredRevenueAccountingCodeType:
                    type: string
                    nullable: true
                  recognizedRevenueAccountingCode:
                    type: string
                  recognizedRevenueAccountingCodeType:
                    type: string
                    nullable: true
                  unbilledReceivablesAccountingCode:
                    type: string
                  unbilledReceivablesAccountingCodeType:
                    type: string
                title: financeInformation
                type: object
              isDefault:
                type: boolean
              isStackedDiscount:
                type: boolean
              listPriceBase:
                enum:
                  - Per_Billing_Period
                  - Per_Month
                  - Per_Week
                  - Per_Year
                type: string
              numberOfPeriod:
                format: int64
                type: integer
              overageCalculationOption:
                enum:
                  - EndOfSmoothingPeriod
                  - PerBillingPeriod
                  - null
                type: string
                nullable: true
              overageUnusedUnitsCreditOption:
                enum:
                  - NoCredit
                  - CreditBySpecificRate
                  - null
                type: string
                nullable: true
              priceChangeOption:
                default: NoChange
                enum:
                  - NoChange
                  - SpecificPercentageValue
                  - UseLatestProductCatalogPricing
                  - null
                type: string
                nullable: true
              priceIncreaseOption:
                enum:
                  - FromTenantPercentageValue
                  - SpecificPercentageValue
                type: string
              priceIncreasePercentage:
                format: double
                type: number
                nullable: true
              prices:
                items:
                  $ref: '#/components/schemas/GETProductChargeDefinitionPricing'
                type: array
              productChargeDefinitionId:
                type: string
              productChargeDefinitionNumber:
                type: string
              productDiscountApplyDetails:
                items:
                  $ref: '#/components/schemas/GETProductDiscountApplyDetailsType'
                type: array
              productRatePlanChargeId:
                type: string
              productRatePlanChargeNumber:
                type: string
                nullable: true
              productRatePlanId:
                type: string
                nullable: true
              productRatePlanName:
                type: string
                nullable: true
              productRatePlanNumber:
                type: string
                nullable: true
              ratingGroup:
                default: ByBillingPeriod
                enum:
                  - ByBillingPeriod
                  - ByUsageStartDate
                  - ByUsageRecord
                  - ByUsageUpload
                  - ByGroupId
                  - null
                type: string
                nullable: true
              recognizedRevenueAccount:
                maxLength: 100
                type: string
              revRecCode:
                maxLength: 70
                type: string
                nullable: true
              revRecTriggerCondition:
                enum:
                  - ContractEffectiveDate
                  - ServiceActivationDate
                  - CustomerAcceptanceDate
                  - null
                type: string
                nullable: true
              revenueRecognitionRuleName:
                enum:
                  - Recognize upon invoicing
                  - Recognize daily over time
                type: string
              smoothingModel:
                enum:
                  - RollingWindow
                  - Rollover
                  - null
                type: string
                nullable: true
              specificBillingPeriod:
                type: number
                nullable: true
              specificListPriceBase:
                format: int32
                maximum: 200
                minimum: 1
                type: integer
                nullable: true
              taxCode:
                maxLength: 64
                type: string
              taxMode:
                enum:
                  - TaxExclusive
                  - TaxInclusive
                  - null
                type: string
                nullable: true
              taxable:
                type: boolean
              term:
                type: number
                nullable: true
              termPeriodType:
                enum:
                  - Month
                  - Year
                  - Day
                  - Week
                  - null
                type: string
                nullable: true
              termType:
                enum:
                  - TERMED
                  - EVERGREEN
                  - null
                type: string
                nullable: true
              triggerEvent:
                enum:
                  - ContractEffective
                  - ServiceActivation
                  - CustomerAcceptance
                type: string
              uom:
                type: string
                nullable: true
              upToPeriods:
                type: number
                nullable: true
              upToPeriodsType:
                enum:
                  - Billing_Periods
                  - Days
                  - Weeks
                  - Months
                  - Years
                  - null
                type: string
                nullable: true
              usageRecordRatingOption:
                default: EndOfBillingPeriod
                enum:
                  - EndOfBillingPeriod
                  - OnDemand
                  - null
                type: string
                nullable: true
              useDiscountSpecificAccountingCode:
                type: boolean
                nullable: true
              useTenantDefaultForPriceChange:
                type: boolean
            title: chargeDefinitions
            type: object
          type: array
        success:
          type: boolean
      type: object
    ProductChargeDefinitionObjectCustomFields:
      additionalProperties: {}
      title: productChargeDefinitionFieldsCustom
      type: object
    GETProductChargeDefinitionPricing:
      properties:
        currency:
          type: string
        discountAmount:
          format: double
          type: number
        discountPercentage:
          format: double
          type: number
        includedUnits:
          type: number
        overagePrice:
          type: number
        price:
          type: number
        tiers:
          items:
            $ref: '#/components/schemas/GETChargeDefinitionPricingTier'
          type: array
      title: prices
      type: object
    GETChargeDefinitionPricingTier:
      items:
        properties:
          currency:
            type: string
          discountAmount:
            format: double
            type: number
          discountPercentage:
            format: double
            type: number
          endingUnit:
            format: double
            type: number
          overagePrice:
            format: double
            type: number
          price:
            format: double
            type: number
          startingUnit:
            format: double
            type: number
        type: object
      title: pricingTiers
      type: array
    POSTChargeDefinitionRequestBulk:
      properties:
        productChargeDefinitions:
          items:
            $ref: '#/components/schemas/POSTChargeDefinitionRequest'
          type: array
      type: object
    POSTChargeDefinitionBulkResponse:
      type: object
      properties:
        summary:
          type: object
          properties:
            successCount:
              type: integer
            failureCount:
              type: integer
            failures:
              type: array
              items:
                type: integer
          additionalProperties: false
        results:
          type: array
          items:
            type: object
            properties:
              success:
                type: boolean
              chargeDefinitionId:
                type: string
              chargeDefinitionNumber:
                type: string
              processId:
                type: string
              reasons:
                type: array
                items:
                  type: object
                  properties:
                    message:
                      type: string
                    code:
                      type: string
            additionalProperties: false
        success:
          type: boolean
      additionalProperties: false
    PUTProductChargeDefinitionBulkRequest:
      properties:
        productChargeDefinitions:
          items:
            $ref: '#/components/schemas/PUTBulkProductChargeDefinitionRequest'
          type: array
      type: object
    PUTBulkProductChargeDefinitionRequest:
      properties:
        billingPeriod:
          type: string
        billingTiming:
          enum:
            - IN_ADVANCE
            - IN_ARREARS
          type: string
        chargeModel:
          enum:
            - DiscountFixedAmount
            - DiscountPercentage
            - FlatFee
            - PerUnit
            - Tiered
            - Volume
            - Delivery
          type: string
        defaultQuantity:
          type: number
        listPriceBase:
          enum:
            - Per_Billing_Period
            - Per_Month
            - Per_Week
            - Per_Year
          type: string
        prices:
          items:
            $ref: '#/components/schemas/POSTProductChargeDefinitionPricing'
          type: array
        productChargeDefinitionKey:
          type: string
        specificBillingPeriod:
          type: number
          nullable: true
        specificListPriceBase:
          format: int32
          maximum: 200
          minimum: 1
          type: integer
          nullable: true
        taxCode:
          maxLength: 64
          type: string
        taxMode:
          enum:
            - TaxExclusive
            - TaxInclusive
            - null
          type: string
          nullable: true
        taxable:
          type: boolean
        term:
          type: number
          nullable: true
        termPeriodType:
          enum:
            - Month
            - Year
            - Day
            - Week
            - null
          type: string
          nullable: true
        termType:
          enum:
            - TERMED
            - EVERGREEN
            - null
          type: string
          nullable: true
        uom:
          type: string
          nullable: true
      type: object
    GETProductChargeDefinitionResponse:
      properties:
        applyDiscountTo:
          enum:
            - ONETIME
            - RECURRING
            - USAGE
            - ONETIMERECURRING
            - ONETIMEUSAGE
            - RECURRINGUSAGE
            - ONETIMERECURRINGUSAGE
            - null
          type: string
          nullable: true
        billingDay:
          type: string
        billingPeriod:
          type: string
        billingPeriodAlignment:
          enum:
            - AlignToCharge
            - AlignToSubscriptionStart
            - AlignToTermStart
            - AlignToTermEnd
          type: string
        billingTiming:
          enum:
            - IN_ADVANCE
            - IN_ARREARS
          type: string
        chargeModel:
          enum:
            - DiscountFixedAmount
            - DiscountPercentage
            - FlatFee
            - PerUnit
            - Overage
            - Tiered
            - TieredWithOverage
            - Volume
            - Delivery
            - MultiAttributePricing
            - PreratedPerUnit
            - PreratedPricing
            - HighWatermarkVolumePricing
            - HighWatermarkTieredPricing
          type: string
        chargeType:
          enum:
            - OneTime
            - Recurring
            - Usage
          type: string
        customFields:
          $ref: '#/components/schemas/ProductChargeDefinitionObjectCustomFields'
        defaultQuantity:
          type: number
          nullable: true
        deliverySchedule:
          $ref: '#/components/schemas/GETDeliverySchedule'
        discountClass:
          type: string
          nullable: true
        discountLevel:
          enum:
            - rateplan
            - subscription
            - account
            - null
          type: string
          nullable: true
        effectiveEndDate:
          format: date-time
          type: string
        effectiveStartDate:
          format: date-time
          type: string
        endDateCondition:
          enum:
            - Subscription_End
            - One_Time
            - Fixed_Period
            - Specific_End_Date
          type: string
        financeInformation:
          properties:
            accountsReceivableAccountingCode:
              type: string
              nullable: true
            accountsReceivableAccountingCodeType:
              type: string
              nullable: true
            adjustmentLiabilityAccountingCode:
              type: string
            adjustmentLiabilityAccountingCodeType:
              type: string
            adjustmentRevenueAccountingCode:
              type: string
            adjustmentRevenueAccountingCodeType:
              type: string
            contractAssetAccountingCode:
              type: string
            contractAssetAccountingCodeType:
              type: string
            contractLiabilityAccountingCode:
              type: string
            contractLiabilityAccountingCodeType:
              type: string
            contractRecognizedRevenueAccountingCode:
              type: string
            contractRecognizedRevenueAccountingCodeType:
              type: string
            deferredRevenueAccountingCode:
              type: string
            deferredRevenueAccountingCodeType:
              type: string
              nullable: true
            recognizedRevenueAccountingCode:
              type: string
            recognizedRevenueAccountingCodeType:
              type: string
              nullable: true
            unbilledReceivablesAccountingCode:
              type: string
            unbilledReceivablesAccountingCodeType:
              type: string
          title: financeInformation
          type: object
        isDefault:
          type: boolean
        isStackedDiscount:
          type: boolean
        numberOfPeriods:
          format: int64
          type: integer
          nullable: true
        listPriceBase:
          enum:
            - Per_Billing_Period
            - Per_Month
            - Per_Week
            - Per_Year
          type: string
        numberOfPeriod:
          format: int64
          type: integer
        overageCalculationOption:
          enum:
            - EndOfSmoothingPeriod
            - PerBillingPeriod
            - null
          type: string
          nullable: true
        overageUnusedUnitsCreditOption:
          enum:
            - NoCredit
            - CreditBySpecificRate
            - null
          type: string
          nullable: true
        priceChangeOption:
          default: NoChange
          enum:
            - NoChange
            - SpecificPercentageValue
            - UseLatestProductCatalogPricing
            - null
          type: string
          nullable: true
        priceIncreaseOption:
          enum:
            - FromTenantPercentageValue
            - SpecificPercentageValue
          type: string
        priceIncreasePercentage:
          format: double
          type: number
          nullable: true
        prices:
          items:
            $ref: '#/components/schemas/GETProductChargeDefinitionPricing'
          type: array
        productChargeDefinitionId:
          type: string
        productChargeDefinitionNumber:
          type: string
        productDiscountApplyDetails:
          items:
            $ref: '#/components/schemas/GETProductDiscountApplyDetailsType'
          type: array
        productRatePlanChargeId:
          type: string
        productRatePlanChargeNumber:
          type: string
          nullable: true
        productRatePlanId:
          type: string
          nullable: true
        productRatePlanName:
          type: string
          nullable: true
        productRatePlanNumber:
          type: string
          nullable: true
        ratingGroup:
          default: ByBillingPeriod
          enum:
            - ByBillingPeriod
            - ByUsageStartDate
            - ByUsageRecord
            - ByUsageUpload
            - ByGroupId
            - null
          type: string
          nullable: true
        recognizedRevenueAccount:
          maxLength: 100
          type: string
        revRecCode:
          maxLength: 70
          type: string
          nullable: true
        revRecTriggerCondition:
          enum:
            - ContractEffectiveDate
            - ServiceActivationDate
            - CustomerAcceptanceDate
            - null
          type: string
          nullable: true
        revenueRecognitionRuleName:
          enum:
            - Recognize upon invoicing
            - Recognize daily over time
          type: string
        smoothingModel:
          enum:
            - RollingWindow
            - Rollover
            - null
          type: string
          nullable: true
        specificBillingPeriod:
          type: number
          nullable: true
        specificListPriceBase:
          format: int32
          maximum: 200
          minimum: 1
          type: integer
          nullable: true
        success:
          type: boolean
        taxCode:
          maxLength: 64
          type: string
        taxMode:
          enum:
            - TaxExclusive
            - TaxInclusive
            - null
          type: string
          nullable: true
        taxable:
          type: boolean
        term:
          type: number
          nullable: true
        termPeriodType:
          enum:
            - Month
            - Year
            - Day
            - Week
            - null
          type: string
          nullable: true
        termType:
          enum:
            - TERMED
            - EVERGREEN
            - null
          type: string
          nullable: true
        triggerEvent:
          enum:
            - ContractEffective
            - ServiceActivation
            - CustomerAcceptance
          type: string
        uom:
          type: string
          nullable: true
        upToPeriods:
          type: number
          nullable: true
        upToPeriodsType:
          enum:
            - Billing_Periods
            - Days
            - Weeks
            - Months
            - Years
            - null
          type: string
          nullable: true
        usageRecordRatingOption:
          default: EndOfBillingPeriod
          enum:
            - EndOfBillingPeriod
            - OnDemand
            - null
          type: string
          nullable: true
        useDiscountSpecificAccountingCode:
          type: boolean
          nullable: true
        useTenantDefaultForPriceChange:
          type: boolean
        excludeItemBillingFromRevenueAccounting:
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          type: boolean
        isAllocationEligible:
          type: boolean
        isUnbilled:
          type: boolean
        productCategory:
          type: string
        productClass:
          type: string
        productFamily:
          type: string
        productLine:
          type: string
        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
      type: object
    PUTProductChargeDefinitionRequest:
      properties:
        billingPeriod:
          type: string
        billingTiming:
          enum:
            - IN_ADVANCE
            - IN_ARREARS
          type: string
        chargeModel:
          enum:
            - DiscountFixedAmount
            - DiscountPercentage
            - FlatFee
            - PerUnit
            - Tiered
            - Volume
            - Delivery
          type: string
        defaultQuantity:
          type: number
          nullable: true
        effectiveEndDate:
          format: date-time
          type: string
        effectiveStartDate:
          format: date-time
          type: string
        listPriceBase:
          enum:
            - Per_Billing_Period
            - Per_Month
            - Per_Week
            - Per_Year
          type: string
        prices:
          items:
            $ref: '#/components/schemas/POSTProductChargeDefinitionPricing'
          type: array
        specificBillingPeriod:
          type: number
          nullable: true
        specificListPriceBase:
          format: int32
          maximum: 200
          minimum: 1
          type: integer
          nullable: true
        taxCode:
          maxLength: 64
          type: string
        taxMode:
          enum:
            - TaxExclusive
            - TaxInclusive
            - null
          type: string
          nullable: true
        taxable:
          type: boolean
        term:
          type: number
          nullable: true
        termPeriodType:
          enum:
            - Month
            - Year
            - Day
            - Week
            - null
          type: string
          nullable: true
        termType:
          enum:
            - TERMED
            - EVERGREEN
            - null
          type: string
          nullable: true
        uom:
          type: string
          nullable: true
      type: object
    ProxyGetProductRatePlanChargeTier:
      properties:
        CreatedById:
          maxLength: 32
          type: string
        CreatedDate:
          format: date-time
          maxLength: 29
          type: string
        Currency:
          maxLength: 3
          type: string
        EndingUnit:
          format: double
          type: number
        Id:
          type: string
        Price:
          format: double
          type: number
        PriceFormat:
          maxLength: 8
          type: string
        StartingUnit:
          format: double
          type: number
        Tier:
          format: int32
          type: integer
        UpdatedById:
          maxLength: 32
          type: string
        UpdatedDate:
          format: date-time
          maxLength: 29
          type: string
      type: object
    ProxyModifyProductRatePlanChargeTier:
      properties:
        Price:
          type: number
          format: double
        PriceFormat:
          enum:
            - Flat Fee
            - Per Unit
          maxLength: 8
          type: string
        DiscountPercentage:
          minimum: -100
          exclusiveMinimum: true
          maximum: 100
          exclusiveMaximum: true
          type: number
          format: double
        DiscountAmount:
          type: number
          format: double
      type: object
    RevproAccountingCodes:
      properties:
        adjustmentLiabilityAccount:
          maxLength: 100
          type: string
        adjustmentRevenueAccount:
          maxLength: 100
          type: string
        contractAssetAccount:
          maxLength: 100
          type: string
        contractLiabilityAccount:
          maxLength: 100
          type: string
        productRatePlanChargeId:
          type: string
        recognizedRevenueAccount:
          maxLength: 100
          type: string
        unbilledReceivablesAccount:
          maxLength: 100
          type: string
      required:
        - productRatePlanChargeId
        - contractAssetAccount
        - contractLiabilityAccount
        - unbilledReceivablesAccount
        - adjustmentLiabilityAccount
        - recognizedRevenueAccount
        - adjustmentRevenueAccount
      type: object
    PUTRevproAccCodeResponse:
      properties:
        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
    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
    SignUpRequest:
      properties:
        accountData:
          $ref: '#/components/schemas/AccountData'
        accountIdentifierField:
          type: string
        customFields:
          $ref: '#/components/schemas/CustomFields'
        options:
          $ref: '#/components/schemas/Options'
        paymentData:
          $ref: '#/components/schemas/PaymentData'
        subscriptionData:
          $ref: '#/components/schemas/SubscriptionData'
      type: object
    SignUpResponse:
      properties:
        accountId:
          type: string
        accountNumber:
          type: string
        creditMemoId:
          type: string
        creditMemoNumber:
          type: string
        invoiceId:
          type: string
        invoiceNumber:
          type: string
        orderNumber:
          type: string
        paidAmount:
          type: string
        paymentId:
          type: string
        paymentNumber:
          type: string
        processId:
          type: string
        reasons:
          items:
            $ref: '#/components/schemas/SignUpResponse_reasons'
          type: array
        status:
          enum:
            - Completed
            - Pending
          type: string
        subscriptionId:
          type: string
        subscriptionNumber:
          type: string
        success:
          type: boolean
      type: object
    SignUpResponse_reasons:
      properties:
        code:
          type: string
        message:
          type: string
      type: object
    AccountData:
      properties:
        accountNumber:
          maxLength: 70
          type: string
        autoPay:
          type: boolean
        batch:
          type: string
        billCycleDay:
          maximum: 31
          minimum: 0
          type: integer
        billToContact:
          $ref: '#/components/schemas/ContactInfo'
        communicationProfileId:
          type: string
        creditMemoTemplateId:
          type: string
        crmId:
          maxLength: 100
          type: string
        currency:
          type: string
        customFields:
          $ref: '#/components/schemas/CustomFields'
        debitMemoTemplateId:
          type: string
        invoiceTemplateId:
          type: string
        name:
          maxLength: 255
          type: string
        notes:
          maxLength: 65535
          type: string
        organizationLabel:
          type: string
        paymentMethod:
          $ref: '#/components/schemas/SignUpPaymentMethod'
        paymentTerm:
          type: string
        purchaseOrderNumber:
          maxLength: 100
          type: string
        sequenceSetId:
          type: string
          nullable: true
        shipToContact:
          $ref: '#/components/schemas/ContactInfo'
        soldToContact:
          $ref: '#/components/schemas/ContactInfo'
        taxInfo:
          $ref: '#/components/schemas/SignUpTaxInfo'
      required:
        - billCycleDay
        - billToContact
        - currency
        - name
      type: object
    CustomFields:
      additionalProperties: {}
      title: CustomFields
      type: object
    Options:
      properties:
        billingTargetDate:
          format: date
          type: string
        collectPayment:
          type: boolean
        maxSubscriptionsPerAccount:
          type: number
        runBilling:
          type: boolean
      type: object
    PaymentData:
      properties:
        authTransactionId:
          type: string
        authorizedAmount:
          format: double
          type: number
        authorizedCurrency:
          type: string
      type: object
    SubscriptionData:
      properties:
        customFields:
          $ref: '#/components/schemas/CustomFields'
        invoiceSeparately:
          type: boolean
        notes:
          maxLength: 500
          type: string
        ratePlans:
          $ref: '#/components/schemas/RatePlans'
        startDate:
          format: date
          type: string
        subscriptionNumber:
          maxLength: 100
          type: string
        terms:
          $ref: '#/components/schemas/TermInfo'
      type: object
    RatePlans:
      items:
        $ref: '#/components/schemas/RatePlan'
      type: array
    TermInfo:
      properties:
        autoRenew:
          type: boolean
        initialTerm:
          $ref: '#/components/schemas/TermInfo_initialTerm'
        renewalSetting:
          enum:
            - RENEW_WITH_SPECIFIC_TERM
            - RENEW_TO_EVERGREEN
          type: string
        renewalTerms:
          $ref: '#/components/schemas/TermInfo_renewalTerms'
      required:
        - initialTerm
      type: object
    TermInfo_initialTerm:
      properties:
        period:
          type: integer
        periodType:
          enum:
            - Month
            - Year
            - Day
            - Week
          type: string
        startDate:
          format: date
          type: string
        termType:
          enum:
            - TERMED
            - EVERGREEN
          type: string
      required:
        - termType
      type: object
    TermInfo_renewalTerms:
      properties:
        period:
          type: integer
        periodType:
          enum:
            - Month
            - Year
            - Day
            - Week
          type: string
      type: object
    RatePlan:
      properties:
        customFields:
          $ref: '#/components/schemas/CustomFields'
        productRatePlanId:
          type: string
      type: object
    ContactInfo:
      allOf:
        - properties:
            address1:
              maxLength: 255
              type: string
            address2:
              maxLength: 255
              type: string
            city:
              maxLength: 40
              type: string
            contactDescription:
              maxLength: 100
              type: string
            country:
              maxLength: 64
              type: string
            county:
              maxLength: 32
              type: string
            customFields:
              $ref: '#/components/schemas/CustomFields'
            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:
              maxLength: 100
              type: string
            otherPhone:
              maxLength: 40
              type: string
            otherPhoneType:
              enum:
                - Work
                - Mobile
                - Home
                - Other
              type: string
            personalEmail:
              format: email
              maxLength: 80
              type: string
            postalCode:
              maxLength: 20
              type: string
            state:
              maxLength: 40
              type: string
            taxRegion:
              maxLength: 32
              type: string
            workEmail:
              format: email
              maxLength: 80
              type: string
            workPhone:
              maxLength: 40
              type: string
          required:
            - firstName
            - lastName
          type: object
        - {}
    SignUpPaymentMethod:
      allOf:
        - properties:
            type:
              enum:
                - PayPalEC
                - PayPalNativeEC
                - PayPalAdaptive
                - CreditCard
                - CreditCardReferenceTransaction
              type: string
          required:
            - type
          type: object
        - $ref: '#/components/schemas/SignUpCreatePaymentMethodCreditCardReferenceTransaction'
        - $ref: '#/components/schemas/SignUpCreatePMPayPalECPayPalNativeEC'
        - $ref: '#/components/schemas/SignUpCreatePaymentMethodPayPalAdaptive'
        - $ref: '#/components/schemas/SignUpCreatePaymentMethodCreditCard'
        - $ref: '#/components/schemas/SignUpCreatePaymentMethodCommon'
        - $ref: '#/components/schemas/SignUpPaymentMethodObjectCustomFields'
    SignUpTaxInfo:
      properties:
        VATId:
          maxLength: 25
          type: string
        companyCode:
          maxLength: 50
          type: string
        exemptCertificateId:
          maxLength: 32
          type: string
        exemptCertificateType:
          maxLength: 32
          type: string
        exemptDescription:
          maxLength: 500
          type: string
        exemptEffectiveDate:
          format: date
          type: string
        exemptExpirationDate:
          format: date
          type: string
        exemptIssuingJurisdiction:
          maxLength: 32
          type: string
        exemptStatus:
          default: 'No'
          enum:
            - 'No'
            - 'Yes'
            - PendingVerification
          type: string
      title: taxInfo
      type: object
    SignUpCreatePaymentMethodCreditCardReferenceTransaction:
      properties:
        secondTokenId:
          type: string
        tokenId:
          type: string
      type: object
    SignUpCreatePMPayPalECPayPalNativeEC:
      properties:
        BAID:
          type: string
        email:
          type: string
      type: object
    SignUpCreatePaymentMethodPayPalAdaptive:
      properties:
        preapprovalKey:
          type: string
      type: object
    SignUpCreatePaymentMethodCreditCard:
      properties:
        cardHolderInfo:
          $ref: '#/components/schemas/SignUpCreatePaymentMethodCardholderInfo'
        cardNumber:
          type: string
        cardType:
          type: string
        checkDuplicated:
          type: boolean
        expirationMonth:
          type: string
        expirationYear:
          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
          type: string
        securityCode:
          type: string
      type: object
    SignUpCreatePaymentMethodCommon:
      properties:
        accountKey:
          type: string
        authGateway:
          type: string
        ipAddress:
          type: string
        makeDefault:
          default: false
          type: boolean
      type: object
    SignUpPaymentMethodObjectCustomFields:
      additionalProperties: {}
      title: paymentMethodFieldsCustom
      type: object
    SignUpCreatePaymentMethodCardholderInfo:
      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
    POSTOrderPreviewRequestType:
      properties:
        category:
          default: NewSales
          enum:
            - NewSales
            - Return
          type: string
        customFields:
          $ref: '#/components/schemas/OrderObjectCustomFields'
        existingAccountId:
          type: string
        existingAccountNumber:
          maxLength: 70
          type: string
        orderDate:
          format: date
          type: string
        orderLineItems:
          items:
            $ref: '#/components/schemas/CreateOrderOrderLineItem'
          type: array
        orderNumber:
          maxLength: 100
          type: string
        previewAccountInfo:
          $ref: '#/components/schemas/PreviewAccountInfo'
        previewOptions:
          $ref: '#/components/schemas/PreviewOptions'
        reasonCode:
          maxLength: 255
          type: string
        subscriptions:
          items:
            properties:
              customFields:
                $ref: '#/components/schemas/SubscriptionObjectCustomFields'
              notes:
                type: string
                maxLength: 1000
              orderActions:
                items:
                  $ref: '#/components/schemas/PreviewOrderOrderAction'
                type: array
              quote:
                $ref: '#/components/schemas/QuoteObjectFields'
              ramp:
                $ref: '#/components/schemas/RampRequest'
              subscriptionNumber:
                type: string
            type: object
          type: array
      required:
        - orderDate
        - previewOptions
      type: object
    PostOrderPreviewResponseType:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            previewResult:
              $ref: '#/components/schemas/PreviewOrderResult'
          type: object
    PreviewOrderResult:
      properties:
        chargeMetrics:
          items:
            properties:
              charges:
                items:
                  $ref: '#/components/schemas/ChargePreviewMetrics'
                type: array
              subscriptionNumber:
                type: string
            type: object
          type: array
        creditMemos:
          items:
            properties:
              amount:
                type: number
              amountWithoutTax:
                type: number
              creditMemoItems:
                items:
                  $ref: '#/components/schemas/InvoiceItemPreviewResult'
                type: array
              targetDate:
                format: date
                type: string
              taxAmount:
                type: number
            type: object
          type: array
        invoices:
          items:
            properties:
              amount:
                type: number
              amountWithoutTax:
                type: number
              invoiceItems:
                items:
                  $ref: '#/components/schemas/InvoiceItemPreviewResult'
                type: array
              targetDate:
                format: date
                type: string
              taxAmount:
                type: number
              invoiceItemSummary:
                type: array
                items:
                  $ref: '#/components/schemas/InvoiceItemSummary'
            type: object
          type: array
        orderDeltaMetrics:
          properties:
            orderDeltaMrr:
              items:
                $ref: '#/components/schemas/OrderDeltaMrr'
              type: array
            orderDeltaTcb:
              items:
                $ref: '#/components/schemas/OrderDeltaTcb'
              type: array
            orderDeltaTcv:
              items:
                $ref: '#/components/schemas/OrderDeltaTcv'
              type: array
          type: object
        orderMetrics:
          items:
            properties:
              orderActions:
                items:
                  properties:
                    orderItems:
                      items:
                        $ref: '#/components/schemas/OrderItem'
                      type: array
                    orderMetrics:
                      items:
                        $ref: '#/components/schemas/orderMetric'
                      type: array
                    sequence:
                      type: string
                    type:
                      type: string
                  type: object
                type: array
              subscriptionNumber:
                type: string
            type: object
          type: array
        rampMetrics:
          items:
            $ref: '#/components/schemas/OrderRampMetrics'
          type: array
      type: object
    ChargePreviewMetrics:
      properties:
        chargeNumber:
          type: string
        cmrr:
          properties:
            discount:
              type: number
            discountDelta:
              type: number
            regular:
              type: number
            regularDelta:
              type: number
          type: object
        originRatePlanId:
          type: string
        productRatePlanChargeId:
          type: string
        productRatePlanId:
          type: string
        subscriptionRatePlanNumber:
          type: string
        tax:
          properties:
            discount:
              type: number
            discountDelta:
              type: number
            regular:
              type: number
            regularDelta:
              type: number
          type: object
        tcb:
          properties:
            discount:
              type: number
            discountDelta:
              type: number
            regular:
              type: number
            regularDelta:
              type: number
          type: object
        tcv:
          properties:
            discount:
              type: number
            discountDelta:
              type: number
            regular:
              type: number
            regularDelta:
              type: number
          type: object
      type: object
    InvoiceItemPreviewResult:
      properties:
        additionalInfo:
          properties:
            numberOfDeliveries:
              type: number
            quantity:
              type: number
            unitOfMeasure:
              type: string
          type: object
        amountWithoutTax:
          type: number
        appliedToChargeNumber:
          type: string
        chargeDescription:
          type: string
        chargeName:
          type: string
        chargeNumber:
          type: string
          nullable: true
        orderLineItemNumber:
          type: string
          nullable: true
        processingType:
          enum:
            - Charge
            - Discount
            - Tax
          type: string
        productName:
          type: string
        productRatePlanChargeId:
          type: string
        serviceEndDate:
          format: date
          type: string
        serviceStartDate:
          format: date
          type: string
        subscriptionNumber:
          type: string
          nullable: true
        taxAmount:
          type: number
        taxationItems:
          items:
            properties:
              exemptAmount:
                type: number
              id:
                type: string
              jurisdiction:
                type: string
              locationCode:
                type: string
              name:
                type: string
              taxAmount:
                type: number
              taxCode:
                type: string
              taxCodeDescription:
                type: string
              taxDate:
                type: string
              taxRate:
                type: number
              taxRateDescription:
                type: string
              taxRateType:
                enum:
                  - Percentage
                  - FlatFee
                type: string
            type: object
          type: array
        unitPrice:
          type: number
      type: object
    InvoiceItemSummary:
      type: object
      properties:
        previewInvoiceSequence:
          type: number
        subTotal:
          type: number
          format: double
        discountAmount:
          type: number
          format: double
        taxAmount:
          type: number
          format: double
        total:
          type: number
          format: double
        servicePeriodStartDate:
          type: string
          format: date
        servicePeriodEndDate:
          type: string
          format: date
    OrderDeltaMrr:
      allOf:
        - $ref: '#/components/schemas/OrderDeltaMetric'
      type: object
    OrderDeltaTcb:
      allOf:
        - $ref: '#/components/schemas/OrderDeltaMetric'
        - properties:
            orderLineItemId:
              format: UUID
              type: string
          type: object
      type: object
    OrderDeltaTcv:
      allOf:
        - $ref: '#/components/schemas/OrderDeltaMetric'
        - properties:
            orderLineItemId:
              format: UUID
              type: string
          type: object
      type: object
    OrderItem:
      properties:
        endDate:
          format: date
          type: string
        id:
          type: string
        orderActionId:
          type: string
        quantity:
          type: number
        scId:
          type: string
        startDate:
          format: date
          type: string
      type: object
    orderMetric:
      properties:
        chargeNumber:
          type: string
        elp:
          items:
            $ref: '#/components/schemas/TimeSlicedElpNetMetrics'
          type: array
        mrr:
          items:
            $ref: '#/components/schemas/TimeSlicedNetMetrics'
          type: array
        originRatePlanId:
          type: string
        productRatePlanChargeId:
          type: string
        productRatePlanId:
          type: string
        subscriptionRatePlanNumber:
          type: string
        quantity:
          items:
            $ref: '#/components/schemas/TimeSlicedMetrics'
          type: array
        tcb:
          items:
            $ref: '#/components/schemas/TimeSlicedTcbNetMetrics'
          type: array
        tcv:
          items:
            $ref: '#/components/schemas/TimeSlicedNetMetrics'
          type: array
      type: object
    OrderRampMetrics:
      properties:
        discountTcb:
          type: number
        discountTcv:
          type: number
        grossTcb:
          type: number
        grossTcv:
          type: number
        intervals:
          items:
            $ref: '#/components/schemas/OrderRampIntervalMetrics'
          type: array
        name:
          type: string
        netTcb:
          type: number
        netTcv:
          type: number
        number:
          type: string
      title: RampMetrics
      type: object
    OrderRampIntervalMetrics:
      properties:
        discountTcb:
          type: number
        discountTcv:
          type: number
        endDate:
          format: date
          type: string
        grossTcb:
          type: number
        grossTcv:
          type: number
        intervalDeltaMetrics:
          items:
            $ref: '#/components/schemas/RampIntervalChargeDeltaMetrics'
          type: array
        intervalMetrics:
          items:
            $ref: '#/components/schemas/RampIntervalChargeMetrics'
          type: array
        name:
          type: string
        netTcb:
          type: number
        netTcv:
          type: number
        startDate:
          format: date
          type: string
      title: RampIntervalMetrics
      type: object
    RampIntervalChargeDeltaMetrics:
      properties:
        chargeNumber:
          type: string
        deltaDiscountTcb:
          type: number
        deltaDiscountTcv:
          type: number
        deltaGrossTcb:
          type: number
        deltaGrossTcv:
          type: number
        deltaMrr:
          items:
            properties:
              discount:
                type: number
              endDate:
                format: date
                type: string
              gross:
                type: number
              net:
                type: number
              startDate:
                format: date
                type: string
            type: object
          type: array
        deltaNetTcb:
          type: number
        deltaNetTcv:
          type: number
        deltaQuantity:
          items:
            properties:
              amount:
                type: number
              endDate:
                format: date
                type: string
              startDate:
                format: date
                type: string
            type: object
          type: array
        productRatePlanChargeId:
          type: string
        subscriptionNumber:
          type: string
      title: intervalDeltaMetrics
      type: object
    RampIntervalChargeMetrics:
      properties:
        chargeNumber:
          type: string
        discountTcb:
          type: number
        discountTcv:
          type: number
        endDate:
          format: date
          type: string
        grossTcb:
          type: number
        grossTcv:
          type: number
        mrr:
          items:
            properties:
              discount:
                type: number
              endDate:
                format: date
                type: string
              gross:
                type: number
              net:
                type: number
              startDate:
                format: date
                type: string
            type: object
          type: array
        netTcb:
          type: number
        netTcv:
          type: number
        productRatePlanChargeId:
          type: string
        quantity:
          type: number
        ratePlanChargeId:
          type: string
        startDate:
          format: date
          type: string
        subscriptionNumber:
          type: string
      title: intervalMetrics
      type: object
    TimeSlicedElpNetMetrics:
      properties:
        amount:
          type: number
        endDate:
          format: date
          type: string
        generatedReason:
          enum:
            - IncreaseQuantity
            - DecreaseQuantity
            - ChangePrice
            - Extension
            - Contraction
          type: string
        invoiceOwner:
          type: string
        orderItemId:
          type: string
        startDate:
          format: date
          type: string
        subscriptionOwner:
          type: string
        tax:
          type: number
        termNumber:
          format: long
          type: number
        type:
          enum:
            - Regular
            - Discount
          type: string
      type: object
    TimeSlicedNetMetrics:
      properties:
        amount:
          type: number
        discountChargeNumber:
          type: string
        endDate:
          format: date
          type: string
        generatedReason:
          enum:
            - IncreaseQuantity
            - DecreaseQuantity
            - ChangePrice
            - Extension
            - Contraction
          type: string
        invoiceOwner:
          type: string
        orderItemId:
          type: string
        startDate:
          format: date
          type: string
        subscriptionOwner:
          type: string
        termNumber:
          format: long
          type: number
        type:
          enum:
            - Regular
            - Discount
          type: string
      type: object
    TimeSlicedMetrics:
      properties:
        amount:
          type: number
        endDate:
          format: date
          type: string
        generatedReason:
          enum:
            - IncreaseQuantity
            - DecreaseQuantity
            - ChangePrice
            - Extension
            - Contraction
          type: string
        invoiceOwner:
          type: string
        orderItemId:
          type: string
        startDate:
          format: date
          type: string
        subscriptionOwner:
          type: string
        termNumber:
          format: long
          type: number
      type: object
    TimeSlicedTcbNetMetrics:
      properties:
        amount:
          type: number
        discountChargeNumber:
          type: string
        endDate:
          format: date
          type: string
        generatedReason:
          enum:
            - IncreaseQuantity
            - DecreaseQuantity
            - ChangePrice
            - Extension
            - Contraction
          type: string
        invoiceOwner:
          type: string
        orderItemId:
          type: string
        startDate:
          format: date
          type: string
        subscriptionOwner:
          type: string
        tax:
          type: number
        termNumber:
          format: long
          type: number
        type:
          enum:
            - Regular
            - Discount
          type: string
      type: object
    OrderDeltaMetric:
      properties:
        chargeNumber:
          type: string
        currency:
          type: string
        endDate:
          format: date
          type: string
        grossAmount:
          type: number
        netAmount:
          type: number
        orderActionId:
          type: string
        orderActionSequence:
          type: string
        orderActionType:
          type: string
        orderLineItemNumber:
          type: string
        productRatePlanChargeId:
          type: string
        ratePlanChargeId:
          type: string
        startDate:
          format: date
          type: string
        subscriptionNumber:
          type: string
      type: object
    OrderObjectCustomFields:
      additionalProperties: {}
      title: OrderCustomFields
      type: object
    CreateOrderOrderLineItem:
      allOf:
        - $ref: '#/components/schemas/OrderLineItemCommonPostOrder'
    PreviewAccountInfo:
      properties:
        billCycleDay:
          maximum: 31
          minimum: 0
          type: integer
        currency:
          maxLength: 3
          type: string
        customFields:
          $ref: '#/components/schemas/AccountObjectCustomFields'
        shipToContact:
          $ref: '#/components/schemas/PreviewContactInfo'
        soldToContact:
          $ref: '#/components/schemas/PreviewContactInfo'
        taxInfo:
          $ref: '#/components/schemas/TaxInfo'
      required:
        - currency
        - billCycleDay
      title: previewAccountInfo
      type: object
    PreviewOptions:
      properties:
        previewNumberOfPeriods:
          minLength: 1
          type: integer
        previewThruType:
          enum:
            - SpecificDate
            - TermEnd
            - NumberOfPeriods
          type: string
        previewTypes:
          items:
            enum:
              - ChargeMetrics
              - BillingDocs
              - OrderDeltaMetrics
              - OrderMetrics
              - RampMetrics
              - RampDeltaMetrics
            type: string
          type: array
        specificPreviewThruDate:
          format: date
          type: string
        chargeTypeToExclude:
          items:
            type: string
            enum:
              - OneTime
              - Recurring
              - Usage
          type: array
      type: object
    PreviewOrderOrderAction:
      properties:
        addProduct:
          $ref: '#/components/schemas/PreviewOrderRatePlanOverride'
        cancelSubscription:
          $ref: '#/components/schemas/CancelSubscription'
        changePlan:
          $ref: '#/components/schemas/PreviewOrderCreateChangePlan'
        changeReason:
          type: string
        createSubscription:
          $ref: '#/components/schemas/PreviewOrderCreateSubscription'
        customFields:
          $ref: '#/components/schemas/OrderActionObjectCustomFields'
        ownerTransfer:
          $ref: '#/components/schemas/OwnerTransfer'
        removeProduct:
          $ref: '#/components/schemas/RemoveProduct'
        renewSubscription:
          $ref: '#/components/schemas/RenewSubscription'
        resume:
          $ref: '#/components/schemas/CreateOrderResume'
        suspend:
          $ref: '#/components/schemas/CreateOrderSuspend'
        termsAndConditions:
          $ref: '#/components/schemas/CreateOrderTermsAndConditions'
        triggerDates:
          items:
            $ref: '#/components/schemas/TriggerDate'
          type: array
        type:
          enum:
            - CreateSubscription
            - TermsAndConditions
            - AddProduct
            - UpdateProduct
            - RemoveProduct
            - RenewSubscription
            - CancelSubscription
            - OwnerTransfer
            - Suspend
            - Resume
            - ChangePlan
          type: string
        updateProduct:
          $ref: '#/components/schemas/PreviewOrderRatePlanUpdate'
      required:
        - type
      type: object
    QuoteObjectFields:
      properties:
        OpportunityCloseDate__QT:
          type: string
        OpportunityName__QT:
          type: string
        QuoteBusinessType__QT:
          type: string
        QuoteNumber__QT:
          type: string
        QuoteType__QT:
          type: string
      title: quote
      type: object
    RampRequest:
      properties:
        charges:
          items:
            $ref: '#/components/schemas/RampChargeRequest'
          type: array
        delete:
          type: boolean
        intervals:
          items:
            $ref: '#/components/schemas/RampIntervalRequest'
          type: array
        name:
          type: string
      title: Ramp
      type: object
    RampChargeRequest:
      properties:
        chargeNumber:
          type: string
        uniqueToken:
          type: string
      title: RampCharge
      type: object
    RampIntervalRequest:
      properties:
        endDate:
          format: date
          type: string
        name:
          type: string
        startDate:
          format: date
          type: string
      required:
        - startDate
        - endDate
      title: intervals
      type: object
    PreviewOrderRatePlanOverride:
      properties:
        chargeOverrides:
          items:
            $ref: '#/components/schemas/PreviewOrderChargeOverride'
          type: array
        clearingExistingFeatures:
          type: boolean
        customFields:
          $ref: '#/components/schemas/OrdersRatePlanObjectCustomFields'
        isAddingSubsetCharges:
          type: boolean
        isFromExternalCatalog:
          type: boolean
        productRatePlanId:
          type: string
        productRatePlanNumber:
          type: string
        ratePlanName:
          type: string
        subscriptionProductFeatures:
          items:
            $ref: '#/components/schemas/CreateOrderRatePlanFeatureOverride'
          type: array
        uniqueToken:
          maxLength: 50
          type: string
        subscriptionRatePlanNumber:
          maxLength: 50
          type: string
      required:
        - productRatePlanId
      title: ratePlan
      type: object
    CancelSubscription:
      properties:
        cancellationEffectiveDate:
          format: date
          type: string
        cancellationPolicy:
          enum:
            - EndOfCurrentTerm
            - EndOfLastInvoicePeriod
            - SpecificDate
          type: string
      required:
        - cancellationPolicy
      title: cancelSubscription
      type: object
    PreviewOrderCreateChangePlan:
      properties:
        effectivePolicy:
          enum:
            - EffectiveImmediately
            - EffectiveEndOfBillingPeriod
            - SpecificDate
          type: string
        externalCatalogPlanId:
          type: string
        newProductRatePlan:
          $ref: '#/components/schemas/PreviewOrderChangePlanRatePlanOverride'
        productRatePlanId:
          type: string
        productRatePlanNumber:
          type: string
        ratePlanId:
          type: string
        resetBcd:
          default: false
          type: boolean
        subType:
          enum:
            - Upgrade
            - Downgrade
            - Crossgrade
            - PlanChanged
          type: string
        subscriptionRatePlanNumber:
          type: string
      required:
        - newProductRatePlan
      title: createChangePlan
      type: object
    PreviewOrderCreateSubscription:
      properties:
        billToContactId:
          type: string
        currency:
          maxLength: 3
          type: string
        invoiceGroupNumber:
          type: string
          maxLength: 255
          nullable: true
        invoiceSeparately:
          type: boolean
        invoiceTemplateId:
          type: string
        newSubscriptionOwnerAccount:
          properties:
            accountNumber:
              maxLength: 70
              type: string
            additionalEmailAddresses:
              maxLength: 1200
              type: string
            allowInvoiceEdit:
              type: boolean
            autoPay:
              type: boolean
            batch:
              type: string
            billCycleDay:
              maximum: 31
              minimum: 0
              type: integer
            billToContact:
              $ref: '#/components/schemas/BillToContactPostOrder'
            communicationProfileId:
              type: string
            creditCard:
              $ref: '#/components/schemas/creditCard'
            creditMemoTemplateId:
              type: string
            crmId:
              maxLength: 100
              type: string
            currency:
              type: string
            customFields:
              $ref: '#/components/schemas/AccountObjectCustomFields'
            customerServiceRepName:
              maxLength: 50
              type: string
            debitMemoTemplateId:
              type: string
            hpmCreditCardPaymentMethodId:
              type: string
            invoiceDeliveryPrefsEmail:
              type: boolean
            invoiceDeliveryPrefsPrint:
              type: boolean
            invoiceTemplateId:
              type: string
            name:
              maxLength: 255
              type: string
            notes:
              maxLength: 65535
              type: string
            parentId:
              type: string
            paymentGateway:
              maxLength: 40
              type: string
            paymentMethod:
              $ref: '#/components/schemas/POSTPaymentMethodRequest'
            paymentTerm:
              type: string
            purchaseOrderNumber:
              maxLength: 100
              type: string
            salesRep:
              maxLength: 50
              type: string
            soldToContact:
              $ref: '#/components/schemas/SoldToContactPostOrder'
            taxInfo:
              $ref: '#/components/schemas/TaxInfo'
          required:
            - name
            - currency
            - billCycleDay
            - billToContact
          type: object
        notes:
          maxLength: 500
          type: string
        paymentTerm:
          type: string
        sequenceSetId:
          type: string
          nullable: true
        shipToContactId:
          type: string
        soldToContactId:
          type: string
        subscribeToRatePlans:
          items:
            $ref: '#/components/schemas/PreviewOrderRatePlanOverride'
          type: array
        subscriptionNumber:
          maxLength: 100
          type: string
        subscriptionOwnerAccountNumber:
          maxLength: 70
          type: string
        invoiceOwnerAccountNumber:
          maxLength: 70
          type: string
        terms:
          properties:
            autoRenew:
              type: boolean
            initialTerm:
              properties:
                period:
                  type: integer
                periodType:
                  enum:
                    - Month
                    - Year
                    - Day
                    - Week
                  type: string
                startDate:
                  format: date
                  type: string
                endDate:
                  format: date
                  type: string
                termType:
                  enum:
                    - TERMED
                    - EVERGREEN
                  type: string
              required:
                - termType
              type: object
            renewalSetting:
              enum:
                - RENEW_WITH_SPECIFIC_TERM
                - RENEW_TO_EVERGREEN
              type: string
            renewalTerms:
              items:
                $ref: '#/components/schemas/RenewalTerm'
              type: array
          required:
            - initialTerm
          type: object
      title: createSubscription
      type: object
    OrderActionObjectCustomFields:
      additionalProperties: {}
      title: orderActionFieldsCustom
      type: object
    OwnerTransfer:
      properties:
        billToContactId:
          type: string
        clearingExistingBillToContact:
          default: false
          type: boolean
        clearingExistingInvoiceGroupNumber:
          default: false
          type: boolean
        clearingExistingInvoiceTemplate:
          default: false
          type: boolean
        clearingExistingPaymentTerm:
          default: false
          type: boolean
        clearingExistingSequenceSet:
          default: false
          type: boolean
        clearingExistingShipToContact:
          default: false
          type: boolean
        clearingExistingSoldToContact:
          default: false
          type: boolean
        destinationAccountNumber:
          type: string
        destinationInvoiceAccountNumber:
          type: string
        invoiceGroupNumber:
          type: string
          maxLength: 255
          nullable: true
        invoiceTemplateId:
          type: string
        paymentProfile:
          properties:
            paymentGatewayId:
              type: string
            paymentMethodId:
              type: string
          type: object
        paymentTerm:
          type: string
        sequenceSetId:
          type: string
          nullable: true
        shipToContactId:
          type: string
        soldToContactId:
          type: string
      title: ownerTransfer
      type: object
    RemoveProduct:
      properties:
        externalCatalogPlanId:
          type: string
        productRatePlanNumber:
          type: string
        ratePlanId:
          type: string
        subscriptionRatePlanNumber:
          type: string
        uniqueToken:
          type: string
        customFields:
          additionalProperties:
            type: object
          title: RatePlanCustomFields
          type: object
        chargeUpdates:
          items:
            $ref: '#/components/schemas/OrderActionRatePlanChargeRemove'
          type: array
      title: removeProduct
      type: object
    RenewSubscription:
      properties:
        billToContactId:
          type: string
        clearingExistingBillToContact:
          default: false
          type: boolean
        clearingExistingInvoiceGroupNumber:
          default: false
          type: boolean
        clearingExistingInvoiceTemplate:
          default: false
          type: boolean
        clearingExistingPaymentTerm:
          default: false
          type: boolean
        clearingExistingSequenceSet:
          default: false
          type: boolean
        clearingExistingShipToContact:
          default: false
          type: boolean
        clearingExistingSoldToContact:
          default: false
          type: boolean
        invoiceGroupNumber:
          type: string
          maxLength: 255
          nullable: true
        invoiceTemplateId:
          type: string
          nullable: true
        paymentTerm:
          type: string
        sequenceSetId:
          type: string
          nullable: true
        shipToContactId:
          type: string
        soldToContactId:
          type: string
      title: RenewSubscription
      type: object
    CreateOrderResume:
      properties:
        extendsTerm:
          type: boolean
        resumePeriods:
          type: integer
        resumePeriodsType:
          enum:
            - Day
            - Week
            - Month
            - Year
          type: string
        resumePolicy:
          enum:
            - Today
            - FixedPeriodsFromSuspendDate
            - FixedPeriodsFromToday
            - SpecificDate
            - SuspendDate
          type: string
        resumeSpecificDate:
          format: date
          type: string
      required:
        - resumePolicy
      title: Resume
      type: object
    CreateOrderSuspend:
      properties:
        suspendPeriods:
          type: integer
        suspendPeriodsType:
          enum:
            - Day
            - Week
            - Month
            - Year
          type: string
        suspendPolicy:
          enum:
            - Today
            - EndOfLastInvoicePeriod
            - FixedPeriodsFromToday
            - SpecificDate
          type: string
        suspendSpecificDate:
          format: date
          type: string
      required:
        - suspendPolicy
      title: Suspend
      type: object
    CreateOrderTermsAndConditions:
      properties:
        autoRenew:
          type: boolean
        billToContactId:
          type: string
        clearingExistingBillToContact:
          default: false
          type: boolean
        clearingExistingInvoiceGroupNumber:
          default: false
          type: boolean
        clearingExistingInvoiceTemplate:
          default: false
          type: boolean
        clearingExistingPaymentTerm:
          default: false
          type: boolean
        clearingExistingSequenceSet:
          default: false
          type: boolean
        clearingExistingShipToContact:
          default: false
          type: boolean
        clearingExistingSoldToContact:
          default: false
          type: boolean
        communicationProfileId:
          type: string
        clearingExistingCommunicationProfile:
          default: false
          type: boolean
        invoiceGroupNumber:
          type: string
          maxLength: 255
          nullable: true
        invoiceSeparately:
          type: boolean
        invoiceTemplateId:
          type: string
        lastTerm:
          $ref: '#/components/schemas/LastTerm'
        paymentProfile:
          properties:
            paymentGatewayId:
              type: string
            paymentMethodId:
              type: string
          type: object
        paymentTerm:
          type: string
        renewalSetting:
          enum:
            - RENEW_WITH_SPECIFIC_TERM
            - RENEW_TO_EVERGREEN
          type: string
        renewalTerms:
          items:
            $ref: '#/components/schemas/RenewalTerm'
          type: array
        scheduledCancelDate:
          format: date
          type: string
        scheduledSuspendDate:
          format: date
          type: string
        scheduledResumeDate:
          format: date
          type: string
        clearingScheduledCancelDate:
          default: false
          type: boolean
        clearingScheduledSuspendDate:
          default: false
          type: boolean
        clearingScheduledResumeDate:
          default: false
          type: boolean
        sequenceSetId:
          type: string
        shipToContactId:
          type: string
        soldToContactId:
          type: string
      title: termsAndConditions
      type: object
    TriggerDate:
      properties:
        name:
          enum:
            - ContractEffective
            - ServiceActivation
            - CustomerAcceptance
          type: string
        triggerDate:
          format: date
          type: string
      title: triggerDate
      type: object
    PreviewOrderRatePlanUpdate:
      properties:
        chargeUpdates:
          items:
            $ref: '#/components/schemas/PreviewOrderChargeUpdate'
          type: array
        clearingExistingFeatures:
          type: boolean
        customFields:
          $ref: '#/components/schemas/OrdersRatePlanObjectCustomFields'
        isAddingSubsetCharges:
          type: boolean
        productRatePlanNumber:
          type: string
        ratePlanId:
          type: string
        specificUpdateDate:
          format: date
          type: string
        subscriptionProductFeatures:
          items:
            $ref: '#/components/schemas/CreateOrderRatePlanFeatureOverride'
          type: array
        subscriptionRatePlanNumber:
          type: string
        uniqueToken:
          type: string
      title: updateProduct
      type: object
    PreviewOrderChargeUpdate:
      properties:
        billing:
          $ref: '#/components/schemas/BillingUpdate'
        chargeNumber:
          type: string
        customFields:
          $ref: '#/components/schemas/RatePlanChargeObjectCustomFields'
        effectiveDate:
          $ref: '#/components/schemas/PreviewOrderTriggerParams'
        estimatedStartDate:
          type: string
          format: date
        negotiatedPriceTable:
          type: array
        items:
          type: object
          additionalProperties: true
        prepaidQuantity:
          type: number
        pricingAttributes:
          type: object
          additionalProperties: true
        pricing:
          allOf:
            - $ref: '#/components/schemas/PreviewOrderPricingUpdate'
        productRatePlanChargeId:
          type: string
        productRatePlanChargeNumber:
          type: string
        uniqueToken:
          type: string
      type: object
    OrdersRatePlanObjectCustomFields:
      additionalProperties: {}
      title: RatePlanCustomFields
      type: object
    CreateOrderRatePlanFeatureOverride:
      properties:
        customFields:
          $ref: '#/components/schemas/RatePlanFeatureOverrideCustomFields'
        featureId:
          type: string
      required:
        - featureId
      title: ratePlanFeature
      type: object
    RatePlanFeatureOverrideCustomFields:
      additionalProperties: {}
      title: ratePlanFeatureCustom
      type: object
    BillingUpdate:
      properties:
        billingPeriodAlignment:
          enum:
            - AlignToCharge
            - AlignToSubscriptionStart
            - AlignToTermStart
          type: string
      type: object
    PreviewOrderTriggerParams:
      properties:
        specificTriggerDate:
          format: date
          type: string
        triggerEvent:
          enum:
            - ContractEffective
            - ServiceActivation
            - CustomerAcceptance
            - SpecificDate
          type: string
      title: startDate
      type: object
    PreviewOrderPricingUpdate:
      properties:
        chargeModelData:
          allOf:
            - $ref: '#/components/schemas/ChargeModelDataOverride'
        discount:
          allOf:
            - $ref: '#/components/schemas/DiscountPricingUpdate'
        recurringFlatFee:
          allOf:
            - $ref: '#/components/schemas/RecurringFlatFeePricingUpdate'
        recurringPerUnit:
          allOf:
            - $ref: '#/components/schemas/RecurringPerUnitPricingUpdate'
        recurringTiered:
          allOf:
            - $ref: '#/components/schemas/RecurringTieredPricingUpdate'
        recurringVolume:
          allOf:
            - $ref: '#/components/schemas/RecurringVolumePricingUpdate'
      type: object
    ChargeModelDataOverride:
      properties:
        chargeModelConfiguration:
          properties:
            customFieldPerUnitRate:
              type: string
            customFieldTotalAmount:
              type: string
            formula:
              type: string
          type: object
        quantity:
          minimum: 0
          type: number
        tiers:
          items:
            $ref: '#/components/schemas/ChargeTier'
          type: array
      title: chargeModelData
      type: object
    DiscountPricingUpdate:
      properties:
        applyDiscountTo:
          enum:
            - ONETIME
            - RECURRING
            - USAGE
            - ONETIMERECURRING
            - ONETIMEUSAGE
            - RECURRINGUSAGE
            - ONETIMERECURRINGUSAGE
          type: string
        discountLevel:
          enum:
            - rateplan
            - subscription
            - account
          type: string
        discountPercentage:
          type: number
        priceChangeOption:
          enum:
            - NoChange
            - UseLatestProductCatalogPricing
          type: string
      type: object
    RecurringFlatFeePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            listPrice:
              type: number
            originalListPrice:
              type: number
          type: object
    RecurringPerUnitPricingUpdate:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            listPrice:
              type: number
            originalListPrice:
              type: number
            quantity:
              minimum: 0
              type: number
          type: object
    RecurringTieredPricingUpdate:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            quantity:
              minimum: 0
              type: number
            tiers:
              items:
                $ref: '#/components/schemas/ChargeTier'
              type: array
          type: object
    RecurringVolumePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            quantity:
              minimum: 0
              type: number
            tiers:
              items:
                $ref: '#/components/schemas/ChargeTier'
              type: array
          type: object
    PriceChangeParams:
      properties:
        priceChangeOption:
          enum:
            - NoChange
            - SpecificPercentageValue
            - UseLatestProductCatalogPricing
          type: string
        priceIncreasePercentage:
          minimum: -100
          type: number
      type: object
    ChargeTier:
      properties:
        endingUnit:
          type: number
        originalListPrice:
          type: number
        price:
          type: number
        priceFormat:
          enum:
            - FlatFee
            - PerUnit
          type: string
        startingUnit:
          type: number
        tier:
          minimum: 1
          type: integer
      required:
        - tier
        - startingUnit
        - price
        - priceFormat
      title: chargeTier
      type: object
    LastTerm:
      properties:
        period:
          minimum: 0
          type: integer
        periodType:
          enum:
            - Month
            - Year
            - Day
            - Week
          type: string
        startDate:
          format: date
          type: string
        endDate:
          format: date
          type: string
        termType:
          enum:
            - TERMED
            - EVERGREEN
          type: string
      required:
        - termType
      type: object
    RenewalTerm:
      properties:
        period:
          type: integer
        periodType:
          enum:
            - Month
            - Year
            - Day
            - Week
          type: string
      type: object
    OrderActionRatePlanChargeRemove:
      properties:
        chargeNumber:
          type: string
        productRatePlanChargeId:
          type: string
        productRatePlanNumber:
          type: string
        uniqueToken:
          type: string
        customFields:
          additionalProperties:
            type: object
          title: ratePlanChargeFieldsCustom
          type: object
      type: object
    BillToContactPostOrder:
      allOf:
        - properties:
            address1:
              maxLength: 255
              type: string
            address2:
              maxLength: 255
              type: string
            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: 40
              type: string
            nickname:
              maxLength: 100
              type: string
            otherPhone:
              maxLength: 40
              type: string
            otherPhoneType:
              enum:
                - Work
                - Mobile
                - Home
                - Other
              type: string
            personalEmail:
              format: email
              maxLength: 80
              type: string
            postalCode:
              maxLength: 20
              type: string
            state:
              maxLength: 40
              type: string
            taxRegion:
              maxLength: 32
              type: string
            workEmail:
              format: email
              maxLength: 80
              type: string
            workPhone:
              maxLength: 40
              type: string
          required:
            - firstName
            - lastName
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
    creditCard:
      properties:
        cardHolderInfo:
          $ref: '#/components/schemas/AccountCreditCardHolder'
        cardNumber:
          type: string
        cardType:
          enum:
            - Visa
            - MasterCard
            - AmericanExpress
            - Discover
            - JCB
            - Diners
            - CUP
            - Maestro
            - Electron
            - AppleVisa
            - AppleMasterCard
            - AppleAmericanExpress
            - AppleDiscover
            - AppleJCB
            - Elo
            - Hipercard
            - Naranja
            - Nativa
            - TarjetaShopping
            - Cencosud
            - Argencard
            - Cabal
          type: string
        expirationMonth:
          maximum: 12
          minimum: 1
          type: integer
        expirationYear:
          maximum: 2500
          minimum: 1980
          type: integer
        securityCode:
          type: string
      type: object
    SoldToContactPostOrder:
      allOf:
        - properties:
            address1:
              maxLength: 255
              type: string
            address2:
              maxLength: 255
              type: string
            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: 40
              type: string
            nickname:
              maxLength: 100
              type: string
            otherPhone:
              maxLength: 40
              type: string
            otherPhoneType:
              enum:
                - Work
                - Mobile
                - Home
                - Other
              type: string
            personalEmail:
              format: email
              maxLength: 80
              type: string
            postalCode:
              maxLength: 20
              type: string
            state:
              maxLength: 40
              type: string
            taxRegion:
              maxLength: 32
              type: string
            workEmail:
              format: email
              maxLength: 80
              type: string
            workPhone:
              maxLength: 40
              type: string
          required:
            - firstName
            - lastName
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
    TaxInfo:
      properties:
        VATId:
          maxLength: 25
          type: string
        companyCode:
          maxLength: 50
          type: string
        exemptCertificateId:
          maxLength: 32
          type: string
        exemptCertificateType:
          maxLength: 32
          type: string
        exemptDescription:
          maxLength: 500
          type: string
        exemptEffectiveDate:
          format: date
          type: string
        exemptExpirationDate:
          format: date
          type: string
        exemptIssuingJurisdiction:
          maxLength: 32
          type: string
        exemptStatus:
          default: 'No'
          enum:
            - 'No'
            - 'Yes'
            - PendingVerification
          type: string
      title: taxInfo
      type: object
    AccountCreditCardHolder:
      properties:
        addressLine1:
          maxLength: 255
          type: string
        addressLine2:
          maxLength: 255
          type: string
        cardHolderName:
          maxLength: 50
          type: string
        city:
          maxLength: 40
          type: string
        country:
          maxLength: 64
          type: string
        email:
          maxLength: 80
          type: string
        phone:
          maxLength: 40
          type: string
        state:
          maxLength: 50
          type: string
        zipCode:
          maxLength: 20
          type: string
      type: object
    PreviewOrderChangePlanRatePlanOverride:
      properties:
        chargeOverrides:
          items:
            $ref: '#/components/schemas/PreviewOrderChangePlanChargeOverride'
          type: array
        clearingExistingFeatures:
          type: boolean
        customFields:
          $ref: '#/components/schemas/OrdersRatePlanObjectCustomFields'
        externalCatalogPlanId:
          type: string
        externallyManagedPlanId:
          type: string
        subscriptionRatePlanNumber:
          maxLength: 50
          type: string
        isFromExternalCatalog:
          type: boolean
        productRatePlanId:
          type: string
        productRatePlanNumber:
          type: string
        ratePlanName:
          type: string
        subscriptionProductFeatures:
          items:
            $ref: '#/components/schemas/CreateOrderRatePlanFeatureOverride'
          type: array
        uniqueToken:
          maxLength: 50
          type: string
      title: ratePlan
      type: object
    PreviewOrderChangePlanChargeOverride:
      properties:
        accountReceivableAccountingCode:
          type: string
        adjustmentLiabilityAccountingCode:
          type: string
        adjustmentRevenueAccountingCode:
          type: string
        billing:
          properties:
            billCycleDay:
              maximum: 31
              minimum: 0
              type: integer
            billCycleType:
              enum:
                - DefaultFromCustomer
                - SpecificDayofMonth
                - SubscriptionStartDay
                - ChargeTriggerDay
                - SpecificDayofWeek
              type: string
            billingPeriod:
              enum:
                - Month
                - Quarter
                - Semi_Annual
                - Annual
                - Eighteen_Months
                - Two_Years
                - Three_Years
                - Five_Years
                - Specific_Months
                - Subscription_Term
                - Week
                - Specific_Weeks
                - Specific_Days
              type: string
            billingPeriodAlignment:
              enum:
                - AlignToCharge
                - AlignToSubscriptionStart
                - AlignToTermStart
              type: string
            billingTiming:
              enum:
                - IN_ADVANCE
                - IN_ARREARS
              type: string
            specificBillingPeriod:
              type: integer
            weeklyBillCycleDay:
              enum:
                - Sunday
                - Monday
                - Tuesday
                - Wednesday
                - Thursday
                - Friday
                - Saturday
              type: string
          type: object
        chargeFunction:
          enum:
            - CommitmentTrueUp
            - CreditCommitment
          type: string
        commitmentType:
          enum:
            - CURRENCY
          type: string
        creditOption:
          enum:
            - TimeBased
            - ConsumptionBased
            - FullCreditBack
          type: string
        chargeModel:
          type: string
        chargeNumber:
          maxLength: 50
          type: string
        chargeType:
          type: string
        contractAssetAccountingCode:
          type: string
        contractLiabilityAccountingCode:
          type: string
        contractRecognizedRevenueAccountingCode:
          type: string
        customFields:
          $ref: '#/components/schemas/RatePlanChargeObjectCustomFields'
        deferredRevenueAccountingCode:
          type: string
        drawdownRate:
          type: number
        endDate:
          $ref: '#/components/schemas/EndConditions'
        estimatedStartDate:
          type: string
          format: date
        excludeItemBillingFromRevenueAccounting:
          default: false
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          default: false
          type: boolean
        isAllocationEligible:
          type: boolean
        isRollover:
          type: boolean
        isUnbilled:
          type: boolean
        negotiatedPriceTable:
          type: array
        items:
          type: object
          additionalProperties: true
        name:
          type: string
        pobPolicy:
          type: string
        prepaidQuantity:
          type: number
        pricing:
          properties:
            chargeModelData:
              $ref: '#/components/schemas/ChargeModelDataOverride'
            discount:
              $ref: '#/components/schemas/DiscountPricingOverride'
            oneTimeFlatFee:
              $ref: '#/components/schemas/OneTimeFlatFeePricingOverride'
            oneTimePerUnit:
              $ref: '#/components/schemas/OneTimePerUnitPricingOverride'
            oneTimeTiered:
              $ref: '#/components/schemas/OneTimeTieredPricingOverride'
            oneTimeVolume:
              $ref: '#/components/schemas/OneTimeVolumePricingOverride'
            recurringDeliveryBased:
              $ref: '#/components/schemas/RecurringDeliveryPricingOverride'
            recurringFlatFee:
              $ref: '#/components/schemas/RecurringFlatFeePricingOverride'
            recurringPerUnit:
              $ref: '#/components/schemas/RecurringPerUnitPricingOverride'
            recurringTiered:
              $ref: '#/components/schemas/RecurringTieredPricingOverride'
            recurringVolume:
              $ref: '#/components/schemas/RecurringVolumePricingOverride'
          type: object
        pricingAttributes:
          type: object
          additionalProperties: true
        productCategory:
          type: string
        productClass:
          type: string
        productFamily:
          type: string
        productLine:
          type: string
        productRatePlanChargeId:
          type: string
        productRatePlanChargeNumber:
          type: string
        prorationOption:
          enum:
            - NoProration
            - TimeBasedProration
            - DefaultFromTenantSetting
            - ChargeFullPeriod
            - CustomizeProrationOptionOverrides
          type: string
        ratingPropertiesOverride:
          type: object
          properties:
            isProratePartialMonth:
              type: boolean
            prorationUnit:
              enum:
                - ProrateByDay
                - ProrateByMonthFirst
              type: string
            daysInMonth:
              enum:
                - UseActualDays
                - Assume30Days
                - Assume30DaysStrict
              type: string
        recognizedRevenueAccountingCode:
          type: string
        revRecCode:
          maxLength: 70
          type: string
        revRecTriggerCondition:
          enum:
            - Contract Effective Date
            - Service Activation Date
            - Customer Acceptance Date
          type: string
        revenueRecognitionRuleName:
          type: string
        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
        startDate:
          $ref: '#/components/schemas/CreateOrderTriggerParams'
        taxCode:
          type: string
        taxMode:
          type: string
        unBilledReceivablesAccountingCode:
          type: string
        uniqueToken:
          maxLength: 50
          type: string
        upsellOriginChargeNumber:
          type: string
        validityPeriodType:
          enum:
            - SUBSCRIPTION_TERM
            - ANNUAL
            - SEMI_ANNUAL
            - QUARTER
            - MONTH
          type: string
      required:
        - productRatePlanChargeId
      title: charge
      type: object
    EndConditions:
      properties:
        endDateCondition:
          enum:
            - Subscription_End
            - Fixed_Period
            - Specific_End_Date
          type: string
        endDatePolicy:
          enum:
            - AlignToApplyToCharge
            - SpecificEndDate
            - FixedPeriod
          type: string
        specificEndDate:
          format: date
          type: string
        upToPeriods:
          type: integer
        upToPeriodsType:
          enum:
            - Billing_Periods
            - Days
            - Weeks
            - Months
            - Years
          type: string
      title: endDate
      type: object
    DiscountPricingOverride:
      properties:
        applyDiscountTo:
          enum:
            - ONETIME
            - RECURRING
            - USAGE
            - ONETIMERECURRING
            - ONETIMEUSAGE
            - RECURRINGUSAGE
            - ONETIMERECURRINGUSAGE
          type: string
        applyToBillingPeriodPartially:
          type: boolean
        discountAmount:
          type: number
        discountApplyDetails:
          items:
            $ref: '#/components/schemas/DiscountApplyDetail'
          type: array
        discountClass:
          type: string
        discountLevel:
          enum:
            - rateplan
            - subscription
            - account
          type: string
        discountPercentage:
          type: number
        originalDiscountAmount:
          type: number
        originalDiscountPercentage:
          type: number
        priceChangeOption:
          enum:
            - NoChange
            - UseLatestProductCatalogPricing
          type: string
      title: discount
      type: object
    OneTimeFlatFeePricingOverride:
      properties:
        listPrice:
          type: number
        originalListPrice:
          type: number
      required:
        - listPrice
      title: oneTimeFlatFee
      type: object
    OneTimePerUnitPricingOverride:
      properties:
        listPrice:
          type: number
        originalListPrice:
          type: number
        quantity:
          minimum: 0
          type: number
        uom:
          type: number
      title: oneTimePerUnit
      type: object
    OneTimeTieredPricingOverride:
      properties:
        quantity:
          minimum: 0
          type: number
        tiers:
          items:
            $ref: '#/components/schemas/ChargeTier'
          type: array
        uom:
          type: number
      title: oneTimeTiered
      type: object
    OneTimeVolumePricingOverride:
      properties:
        quantity:
          minimum: 0
          type: number
        tiers:
          items:
            $ref: '#/components/schemas/ChargeTier'
          type: array
        uom:
          type: number
      title: oneTimeVolume
      type: object
    RecurringDeliveryPricingOverride:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            deliverySchedule:
              $ref: '#/components/schemas/DeliveryScheduleParams'
            listPrice:
              type: number
      title: recurringDelivery
    RecurringFlatFeePricingOverride:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            listPrice:
              type: number
            listPriceBase:
              enum:
                - Per_Billing_Period
                - Per_Month
                - Per_Week
                - Per_Year
                - Per_Specific_Months
              type: string
            originalListPrice:
              type: number
            specificListPriceBase:
              format: int32
              maximum: 200
              minimum: 1
              type: integer
          type: object
      title: recurringFlatFee
    RecurringPerUnitPricingOverride:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            listPrice:
              type: number
            listPriceBase:
              enum:
                - Per_Billing_Period
                - Per_Month
                - Per_Week
                - Per_Year
                - Per_Specific_Months
              type: string
            originalListPrice:
              type: number
            quantity:
              minimum: 0
              type: number
            specificListPriceBase:
              format: int32
              maximum: 200
              minimum: 1
              type: integer
            uom:
              type: number
          type: object
      title: recurringPerUnit
    RecurringTieredPricingOverride:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            listPriceBase:
              enum:
                - Per_Billing_Period
                - Per_Month
                - Per_Week
                - Per_Year
                - Per_Specific_Months
              type: string
            quantity:
              minimum: 0
              type: number
            specificListPriceBase:
              format: int32
              maximum: 200
              minimum: 1
              type: integer
            tiers:
              items:
                $ref: '#/components/schemas/ChargeTier'
              type: array
            uom:
              type: number
          type: object
      title: recurringTiered
    RecurringVolumePricingOverride:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            listPriceBase:
              enum:
                - Per_Billing_Period
                - Per_Month
                - Per_Week
                - Per_Year
                - Per_Specific_Months
              type: string
            quantity:
              minimum: 0
              type: number
            specificListPriceBase:
              format: int32
              maximum: 200
              minimum: 1
              type: integer
            tiers:
              items:
                $ref: '#/components/schemas/ChargeTier'
              type: array
            uom:
              type: number
          type: object
      title: recurringVolume
    CreateOrderTriggerParams:
      properties:
        periodsAfterChargeStart:
          type: integer
        specificTriggerDate:
          format: date
          type: string
        startDatePolicy:
          enum:
            - AlignToApplyToCharge
            - SpecificDate
            - EndOfLastInvoicePeriodOfApplyToCharge
            - FixedPeriodAfterApplyToChargeStartDate
          type: string
        startPeriodsType:
          enum:
            - Days
            - Weeks
            - Months
            - Years
          type: string
        triggerEvent:
          enum:
            - ContractEffective
            - ServiceActivation
            - CustomerAcceptance
            - SpecificDate
          type: string
      title: startDate
      type: object
    DeliveryScheduleParams:
      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
      type: object
    DiscountApplyDetail:
      properties:
        productRatePlanChargeId:
          type: string
        productRatePlanId:
          type: string
      required:
        - productRatePlanId
        - productRatePlanChargeId
      title: discountApplyDetail
      type: object
    PreviewOrderChargeOverride:
      properties:
        accountReceivableAccountingCode:
          type: string
        adjustmentLiabilityAccountingCode:
          type: string
        adjustmentRevenueAccountingCode:
          type: string
        billing:
          properties:
            billCycleDay:
              maximum: 31
              minimum: 0
              type: integer
            billCycleType:
              enum:
                - DefaultFromCustomer
                - SpecificDayofMonth
                - SubscriptionStartDay
                - ChargeTriggerDay
                - SpecificDayofWeek
              type: string
            billingPeriod:
              enum:
                - Month
                - Quarter
                - Semi_Annual
                - Annual
                - Eighteen_Months
                - Two_Years
                - Three_Years
                - Five_Years
                - Specific_Months
                - Subscription_Term
                - Week
                - Specific_Weeks
                - Specific_Days
              type: string
            billingPeriodAlignment:
              enum:
                - AlignToCharge
                - AlignToSubscriptionStart
                - AlignToTermStart
              type: string
            billingTiming:
              enum:
                - IN_ADVANCE
                - IN_ARREARS
              type: string
            specificBillingPeriod:
              type: integer
            weeklyBillCycleDay:
              enum:
                - Sunday
                - Monday
                - Tuesday
                - Wednesday
                - Thursday
                - Friday
                - Saturday
              type: string
          type: object
        chargeFunction:
          enum:
            - CommitmentTrueUp
            - CreditCommitment
          type: string
        commitmentType:
          enum:
            - CURRENCY
          type: string
        creditOption:
          enum:
            - TimeBased
            - ConsumptionBased
            - FullCreditBack
          type: string
        chargeModel:
          type: string
        chargeNumber:
          maxLength: 50
          type: string
        chargeType:
          type: string
        contractAssetAccountingCode:
          type: string
        contractLiabilityAccountingCode:
          type: string
        contractRecognizedRevenueAccountingCode:
          type: string
        customFields:
          $ref: '#/components/schemas/RatePlanChargeObjectCustomFields'
        deferredRevenueAccountingCode:
          type: string
        drawdownRate:
          type: number
        endDate:
          $ref: '#/components/schemas/EndConditions'
        estimatedStartDate:
          type: string
          format: date
        excludeItemBillingFromRevenueAccounting:
          default: false
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          default: false
          type: boolean
        isAllocationEligible:
          type: boolean
        isRollover:
          type: boolean
        isUnbilled:
          type: boolean
        name:
          type: string
        negotiatedPriceTable:
          type: array
        items:
          type: object
          additionalProperties: true
        pobPolicy:
          type: string
        prepaidQuantity:
          type: number
        pricing:
          properties:
            chargeModelData:
              $ref: '#/components/schemas/ChargeModelDataOverride'
            discount:
              $ref: '#/components/schemas/DiscountPricingOverride'
            oneTimeFlatFee:
              $ref: '#/components/schemas/OneTimeFlatFeePricingOverride'
            oneTimePerUnit:
              $ref: '#/components/schemas/OneTimePerUnitPricingOverride'
            oneTimeTiered:
              $ref: '#/components/schemas/OneTimeTieredPricingOverride'
            oneTimeVolume:
              $ref: '#/components/schemas/OneTimeVolumePricingOverride'
            recurringDeliveryBased:
              $ref: '#/components/schemas/RecurringDeliveryPricingOverride'
            recurringFlatFee:
              $ref: '#/components/schemas/RecurringFlatFeePricingOverride'
            recurringPerUnit:
              $ref: '#/components/schemas/RecurringPerUnitPricingOverride'
            recurringTiered:
              $ref: '#/components/schemas/RecurringTieredPricingOverride'
            recurringVolume:
              $ref: '#/components/schemas/RecurringVolumePricingOverride'
          type: object
        pricingAttributes:
          type: object
          additionalProperties: true
        productCategory:
          type: string
        productClass:
          type: string
        productFamily:
          type: string
        productLine:
          type: string
        productRatePlanChargeId:
          type: string
        productRatePlanChargeNumber:
          type: string
        prorationOption:
          enum:
            - NoProration
            - TimeBasedProration
            - DefaultFromTenantSetting
            - ChargeFullPeriod
            - CustomizeProrationOptionOverrides
          type: string
        ratingPropertiesOverride:
          type: object
          properties:
            isProratePartialMonth:
              type: boolean
            prorationUnit:
              enum:
                - ProrateByDay
                - ProrateByMonthFirst
              type: string
            daysInMonth:
              enum:
                - UseActualDays
                - Assume30Days
                - Assume30DaysStrict
              type: string
        recognizedRevenueAccountingCode:
          type: string
        revRecCode:
          maxLength: 70
          type: string
        revRecTriggerCondition:
          enum:
            - Contract Effective Date
            - Service Activation Date
            - Customer Acceptance Date
          type: string
        revenueRecognitionRuleName:
          type: string
        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
        startDate:
          $ref: '#/components/schemas/PreviewOrderTriggerParams'
        unBilledReceivablesAccountingCode:
          type: string
        uniqueToken:
          maxLength: 50
          type: string
        upsellOriginChargeNumber:
          type: string
        validityPeriodType:
          enum:
            - SUBSCRIPTION_TERM
            - ANNUAL
            - SEMI_ANNUAL
            - QUARTER
            - MONTH
          type: string
        taxCode:
          type: string
        taxMode:
          enum:
            - TaxInclusive
            - TaxExclusive
          type: string
        taxable:
          type: boolean
      required:
        - productRatePlanChargeId
      title: charge
      type: object
    PreviewContactInfo:
      properties:
        city:
          maxLength: 40
          type: string
        country:
          maxLength: 64
          type: string
        county:
          maxLength: 32
          type: string
        postalCode:
          maxLength: 20
          type: string
        state:
          maxLength: 40
          type: string
        taxRegion:
          maxLength: 32
          type: string
      type: object
    OrderLineItemCommonPostOrder:
      properties:
        UOM:
          type: string
        accountingCode:
          type: string
        adjustmentLiabilityAccountingCode:
          type: string
        adjustmentRevenueAccountingCode:
          type: string
        amountPerUnit:
          type: number
        billTargetDate:
          format: date
          type: string
        billTo:
          type: string
        billingRule:
          default: TriggerWithoutFulfillment
          enum:
            - TriggerWithoutFulfillment
            - TriggerAsFulfillmentOccurs
          type: string
        contractAssetAccountingCode:
          type: string
        contractLiabilityAccountingCode:
          type: string
        contractRecognizedRevenueAccountingCode:
          type: string
        currency:
          type: string
        customFields:
          $ref: '#/components/schemas/OrderLineItemCustomFields'
        deferredRevenueAccountingCode:
          type: string
        excludeItemBillingFromRevenueAccounting:
          default: false
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          default: false
          type: boolean
        inlineDiscountPerUnit:
          type: number
        inlineDiscountType:
          enum:
            - Percentage
            - FixedAmount
            - None
          type: string
        isAllocationEligible:
          type: boolean
        isUnbilled:
          type: boolean
        itemCategory:
          default: Sales
          enum:
            - Sales
            - Return
          type: string
        itemName:
          type: string
        itemNumber:
          type: string
        itemState:
          enum:
            - Executing
            - Booked
            - SentToBilling
            - Complete
            - Cancelled
          type: string
        itemType:
          enum:
            - Product
            - Fee
            - Services
          type: string
        listPricePerUnit:
          type: number
        originalOrderLineItemNumber:
          type: string
        originalOrderNumber:
          type: string
        ownerAccountNumber:
          type: string
        productCode:
          type: string
        productRatePlanChargeId:
          type: string
        purchaseOrderNumber:
          type: string
        quantity:
          type: number
        recognizedRevenueAccountingCode:
          type: string
        relatedSubscriptionNumber:
          type: string
        revenueRecognitionRule:
          type: string
        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
        invoiceGroupNumber:
          type: string
          maxLength: 255
          nullable: true
        sequenceSetId:
          type: string
        paymentTerm:
          type: string
        invoiceTemplateId:
          type: string
        shipTo:
          type: string
        soldTo:
          type: string
        taxCode:
          type: string
        taxMode:
          enum:
            - TaxInclusive
            - TaxExclusive
          type: string
        transactionEndDate:
          format: date
          type: string
        transactionStartDate:
          format: date
          type: string
        unbilledReceivablesAccountingCode:
          type: string
      title: OrderLineItem
      type: object
    OrderLineItemCustomFields:
      additionalProperties: {}
      title: OrderLineItemCustomFields
      type: object
    POSTOrderPreviewAsyncRequestType:
      properties:
        category:
          default: NewSales
          enum:
            - NewSales
            - Return
          type: string
        customFields:
          $ref: '#/components/schemas/OrderObjectCustomFields'
        existingAccountId:
          type: string
        existingAccountNumber:
          maxLength: 70
          type: string
        orderDate:
          format: date
          type: string
        orderLineItems:
          items:
            $ref: '#/components/schemas/CreateOrderOrderLineItem'
          type: array
        orderNumber:
          maxLength: 100
          type: string
        previewAccountInfo:
          $ref: '#/components/schemas/PreviewAccountInfo'
        previewOptions:
          $ref: '#/components/schemas/PreviewOptions'
        reasonCode:
          maxLength: 255
          type: string
        subscriptions:
          items:
            properties:
              customFields:
                $ref: '#/components/schemas/SubscriptionObjectCustomFields'
              notes:
                type: string
                maxLength: 1000
              orderActions:
                items:
                  $ref: '#/components/schemas/PreviewOrderOrderAction'
                type: array
              quote:
                $ref: '#/components/schemas/QuoteObjectFields'
              ramp:
                $ref: '#/components/schemas/RampRequest'
              subscriptionNumber:
                type: string
            type: object
          type: array
      required:
        - orderDate
        - previewOptions
      type: object
    GetAllOrdersResponseType:
      properties:
        nextPage:
          format: URL
          type: string
        orders:
          items:
            $ref: '#/components/schemas/Order'
          type: array
        success:
          type: boolean
      type: object
    Order:
      properties:
        category:
          default: NewSales
          enum:
            - NewSales
            - Return
          type: string
        commitments:
          items:
            $ref: '#/components/schemas/GetCommitmentOutput'
          type: array
        createdBy:
          type: string
        createdDate:
          format: datetime
          type: string
        currency:
          type: string
        customFields:
          $ref: '#/components/schemas/OrderObjectCustomFields'
        existingAccountNumber:
          type: string
        existingAccountDetails:
          properties:
            basicInfo:
              $ref: '#/components/schemas/GETAccountTypeBasicInfo'
            billToContact:
              $ref: '#/components/schemas/GETAccountTypeBillToContact'
          type: object
        invoiceScheduleId:
          type: integer
        orderDate:
          format: date
          type: string
        orderLineItems:
          items:
            $ref: '#/components/schemas/OrderLineItemRetrieveOrder'
          type: array
        orderNumber:
          type: string
        organizationLabel:
          type: string
        reasonCode:
          maxLength: 255
          type: string
        schedulingOptions:
          properties:
            scheduledDate:
              format: date
              type: string
            scheduledDatePolicy:
              enum:
                - SpecificDate
              type: string
          type: object
        scheduledOrderActivationResponse:
          $ref: '#/components/schemas/PostOrderResponseType'
        status:
          enum:
            - Draft
            - Pending
            - Completed
            - Cancelled
            - Scheduled
            - Executing
            - Failed
            - Reverted
          type: string
        subscriptions:
          items:
            properties:
              baseVersion:
                type: integer
              customFields:
                $ref: '#/components/schemas/SubscriptionObjectCustomFields'
              externallyManagedBy:
                enum:
                  - Amazon
                  - Apple
                  - Google
                  - Roku
                type: string
                nullable: true
              newVersion:
                type: integer
              notes:
                type: string
              orderActions:
                items:
                  $ref: '#/components/schemas/OrderAction'
                type: array
              quote:
                $ref: '#/components/schemas/QuoteObjectFields'
              ramp:
                items:
                  $ref: '#/components/schemas/RampResponse'
                type: object
              sequence:
                type: integer
              subscriptionNumber:
                type: string
              subscriptionOwnerAccountNumber:
                type: string
              subscriptionOwnerAccountDetails:
                properties:
                  basicInfo:
                    $ref: '#/components/schemas/GETAccountTypeBasicInfo'
                  soldToContact:
                    $ref: '#/components/schemas/GETAccountTypeSoldToContact'
                type: object
            type: object
          type: array
        updatedBy:
          type: string
        updatedDate:
          format: datetime
          type: string
      type: object
    GetCommitmentOutput:
      type: object
      allOf:
        - $ref: '#/components/schemas/CommitmentBaseAttributes'
        - $ref: '#/components/schemas/CommonRevenueAttributes'
        - $ref: '#/components/schemas/CommonTaxationAttributes'
        - properties:
            id:
              type: string
            version:
              type: integer
    OrderLineItemRetrieveOrder:
      allOf:
        - properties:
            amendedByOrderOn:
              type: string
            amount:
              type: number
            amountWithoutTax:
              type: number
            id:
              format: UUID
              type: string
            invoiceGroupNumber:
              type: string
              nullable: true
            sequenceSetId:
              type: string
            communicationProfileId:
              type: string
              nullable: true
            paymentTerm:
              type: string
            invoiceTemplateId:
              type: string
            itemNumber:
              type: string
            originalOrderDate:
              format: date
              type: string
            quantityFulfilled:
              type: number
            quantityPendingFulfillment:
              type: number
          type: object
        - $ref: '#/components/schemas/OrderLineItemCommonRetrieveOrder'
    PostOrderResponseType:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - $ref: '#/components/schemas/CreateOrderResult'
    OrderAction:
      properties:
        addProduct:
          $ref: '#/components/schemas/RatePlanOverride'
        cancelSubscription:
          $ref: '#/components/schemas/CancelSubscription'
        changePlan:
          $ref: '#/components/schemas/ChangePlan'
        changeReason:
          type: string
        createSubscription:
          $ref: '#/components/schemas/CreateSubscription'
        customFields:
          $ref: '#/components/schemas/OrderActionObjectCustomFields'
        id:
          type: string
        orderItems:
          items:
            $ref: '#/components/schemas/OrderItem'
          type: array
        orderMetrics:
          items:
            $ref: '#/components/schemas/orderMetric'
          type: array
        ownerTransfer:
          $ref: '#/components/schemas/OwnerTransfer'
        removeProduct:
          $ref: '#/components/schemas/RemoveProduct'
        renewSubscription:
          $ref: '#/components/schemas/RenewSubscription'
        resume:
          $ref: '#/components/schemas/GetOrderResume'
        sequence:
          type: integer
        suspend:
          $ref: '#/components/schemas/GetOrderSuspend'
        termsAndConditions:
          $ref: '#/components/schemas/TermsAndConditions'
        triggerDates:
          items:
            $ref: '#/components/schemas/TriggerDate'
          type: array
        type:
          enum:
            - CreateSubscription
            - TermsAndConditions
            - AddProduct
            - UpdateProduct
            - RemoveProduct
            - RenewSubscription
            - CancelSubscription
            - OwnerTransfer
            - Suspend
            - Resume
            - ChangePlan
          type: string
        updateProduct:
          $ref: '#/components/schemas/RatePlanUpdate'
      type: object
    RampResponse:
      properties:
        charges:
          items:
            $ref: '#/components/schemas/RampChargeResponse'
          type: array
        id:
          type: string
        intervals:
          items:
            $ref: '#/components/schemas/RampIntervalResponse'
          type: array
        name:
          type: string
        number:
          type: string
        subscriptionNumber:
          type: string
      title: Ramp
      type: object
    RampChargeResponse:
      properties:
        chargeNumber:
          type: string
      title: charges
      type: object
    RampIntervalResponse:
      properties:
        endDate:
          format: date
          type: string
        name:
          type: string
        startDate:
          format: date
          type: string
      title: intervals
      type: object
    RatePlanOverride:
      properties:
        chargeOverrides:
          items:
            $ref: '#/components/schemas/ChargeOverride'
          type: array
        clearingExistingFeatures:
          type: boolean
        customFields:
          $ref: '#/components/schemas/OrdersRatePlanObjectCustomFields'
        externallyManagedPlanId:
          type: string
        isFromExternalCatalog:
          type: boolean
        newRatePlanId:
          type: string
        productRatePlanId:
          type: string
        productRatePlanNumber:
          type: string
        ratePlanName:
          type: string
        subscriptionProductFeatures:
          items:
            $ref: '#/components/schemas/RatePlanFeatureOverride'
          type: array
        uniqueToken:
          maxLength: 50
          type: string
        subscriptionRatePlanNumber:
          maxLength: 50
          type: string
      required:
        - productRatePlanId
      title: ratePlan
      type: object
    ChangePlan:
      properties:
        effectivePolicy:
          enum:
            - EffectiveImmediately
            - EffectiveEndOfBillingPeriod
            - SpecificDate
          type: string
        newProductRatePlan:
          $ref: '#/components/schemas/ChangePlanRatePlanOverride'
        productRatePlanId:
          type: string
        productRatePlanNumber:
          type: string
        ratePlanId:
          type: string
        subType:
          enum:
            - Upgrade
            - Downgrade
            - Crossgrade
            - PlanChanged
          type: string
        subscriptionRatePlanNumber:
          type: string
      title: changePlan
      type: object
    CreateSubscription:
      properties:
        billToContactId:
          type: string
        currency:
          maxLength: 3
          type: string
        invoiceGroupNumber:
          type: string
          maxLength: 255
          nullable: true
        invoiceSeparately:
          type: boolean
        invoiceTemplateId:
          type: string
        newSubscriptionOwnerAccount:
          properties:
            accountNumber:
              maxLength: 70
              type: string
            autoPay:
              type: boolean
            batch:
              type: string
            billCycleDay:
              maximum: 31
              minimum: 0
              type: integer
            billToContact:
              $ref: '#/components/schemas/BillToContact'
            communicationProfileId:
              type: string
            creditCard:
              $ref: '#/components/schemas/creditCard'
            crmId:
              maxLength: 100
              type: string
            currency:
              type: string
            customFields:
              $ref: '#/components/schemas/AccountObjectCustomFields'
            hpmCreditCardPaymentMethodId:
              type: string
            invoiceDeliveryPrefsEmail:
              type: boolean
            invoiceDeliveryPrefsPrint:
              type: boolean
            invoiceTemplateId:
              type: string
            name:
              maxLength: 70
              type: string
            notes:
              maxLength: 65535
              type: string
            parentId:
              type: string
            paymentGateway:
              maxLength: 40
              type: string
            paymentMethod:
              $ref: '#/components/schemas/POSTPaymentMethodRequest'
            paymentTerm:
              type: string
            soldToContact:
              $ref: '#/components/schemas/SoldToContact'
            taxInfo:
              $ref: '#/components/schemas/TaxInfo'
          required:
            - name
            - currency
            - billCycleDay
            - billToContact
          type: object
        notes:
          maxLength: 500
          type: string
        paymentTerm:
          type: string
        sequenceSetId:
          type: string
          nullable: true
        shipToContactId:
          type: string
        soldToContactId:
          type: string
        subscribeToRatePlans:
          items:
            $ref: '#/components/schemas/RatePlanOverride'
          type: array
        subscriptionNumber:
          maxLength: 100
          type: string
        subscriptionOwnerAccountNumber:
          maxLength: 70
          type: string
        invoiceOwnerAccountNumber:
          maxLength: 70
          type: string
        terms:
          properties:
            autoRenew:
              type: boolean
            initialTerm:
              properties:
                period:
                  type: integer
                periodType:
                  enum:
                    - Month
                    - Year
                    - Day
                    - Week
                  type: string
                startDate:
                  format: date
                  type: string
                termType:
                  enum:
                    - TERMED
                    - EVERGREEN
                  type: string
              required:
                - termType
              type: object
            renewalSetting:
              enum:
                - RENEW_WITH_SPECIFIC_TERM
                - RENEW_TO_EVERGREEN
              type: string
            renewalTerms:
              items:
                $ref: '#/components/schemas/RenewalTerm'
              type: array
          required:
            - initialTerm
            - renewalTerms
          type: object
      title: createSubscription
      type: object
    GetOrderResume:
      properties:
        extendsTerm:
          type: boolean
        resumeDate:
          format: date
          type: string
        resumePeriods:
          type: integer
        resumePeriodsType:
          enum:
            - Day
            - Week
            - Month
            - Year
          type: string
        resumePolicy:
          enum:
            - Today
            - FixedPeriodsFromSuspendDate
            - FixedPeriodsFromToday
            - SpecificDate
            - SuspendDate
          type: string
        resumeSpecificDate:
          format: date
          type: string
          nullable: true
      title: Resume
      type: object
    GetOrderSuspend:
      properties:
        suspendDate:
          format: date
          type: string
        suspendPeriods:
          type: integer
          nullable: true
        suspendPeriodsType:
          enum:
            - Day
            - Week
            - Month
            - Year
          type: string
          nullable: true
        suspendPolicy:
          enum:
            - Today
            - EndOfLastInvoicePeriod
            - FixedPeriodsFromToday
            - SpecificDate
          type: string
          nullable: true
        suspendSpecificDate:
          format: date
          type: string
          nullable: true
      title: Suspend
      type: object
    TermsAndConditions:
      properties:
        autoRenew:
          type: boolean
        billToContactId:
          type: string
        clearingExistingBillToContact:
          default: false
          type: boolean
        clearingExistingInvoiceGroupNumber:
          default: false
          type: boolean
        clearingExistingInvoiceTemplate:
          default: false
          type: boolean
        clearingExistingPaymentTerm:
          default: false
          type: boolean
        clearingExistingSequenceSet:
          default: false
          type: boolean
        clearingExistingShipToContact:
          default: false
          type: boolean
        clearingExistingSoldToContact:
          default: false
          type: boolean
        initialTerm:
          $ref: '#/components/schemas/InitialTerm'
        communicationProfileId:
          type: string
          nullable: true
        clearingExistingCommunicationProfile:
          default: false
          type: boolean
        invoiceGroupNumber:
          type: string
          maxLength: 255
          nullable: true
        invoiceTemplateId:
          type: string
          nullable: true
        paymentTerm:
          type: string
        scheduledCancelDate:
          type: string
          format: date
        scheduledSuspendDate:
          type: string
          format: date
        scheduledResumeDate:
          type: string
          format: date
        clearingScheduledCancelDate:
          type: boolean
        clearingScheduledSuspendDate:
          type: boolean
        clearingScheduledResumeDate:
          type: boolean
        renewalSetting:
          enum:
            - RENEW_WITH_SPECIFIC_TERM
            - RENEW_TO_EVERGREEN
          type: string
        renewalTerms:
          items:
            $ref: '#/components/schemas/RenewalTerm'
          type: array
        sequenceSetId:
          type: string
          nullable: true
        shipToContactId:
          type: string
        soldToContactId:
          type: string
      title: termsAndConditions
      type: object
    RatePlanUpdate:
      properties:
        chargeUpdates:
          items:
            $ref: '#/components/schemas/ChargeUpdate'
          type: array
        clearingExistingFeatures:
          type: boolean
        customFields:
          $ref: '#/components/schemas/OrdersRatePlanObjectCustomFields'
        externallyManagedPlanId:
          type: string
        newRatePlanId:
          type: string
        productRatePlanNumber:
          type: string
        ratePlanId:
          type: string
        specificUpdateDate:
          format: date
          type: string
        subscriptionProductFeatures:
          items:
            $ref: '#/components/schemas/RatePlanFeatureOverride'
          type: array
        subscriptionRatePlanNumber:
          type: string
        uniqueToken:
          type: string
      title: updateProduct
      type: object
    ChargeUpdate:
      properties:
        billing:
          $ref: '#/components/schemas/BillingUpdate'
        chargeNumber:
          type: string
        customFields:
          $ref: '#/components/schemas/RatePlanChargeObjectCustomFields'
        effectiveDate:
          $ref: '#/components/schemas/TriggerParams'
        estimatedStartDate:
          type: string
          format: date
        pricing:
          allOf:
            - $ref: '#/components/schemas/PricingUpdate'
        uniqueToken:
          type: string
      type: object
    RatePlanFeatureOverride:
      properties:
        customFields:
          $ref: '#/components/schemas/RatePlanFeatureOverrideCustomFields'
        featureId:
          type: string
        id:
          type: string
      title: ratePlanFeature
      type: object
    TriggerParams:
      properties:
        periodsAfterChargeStart:
          type: integer
        specificTriggerDate:
          format: date
          type: string
        startDatePolicy:
          enum:
            - AlignToApplyToCharge
            - SpecificDate
            - EndOfLastInvoicePeriodOfApplyToCharge
            - FixedPeriodAfterApplyToChargeStartDate
          type: string
        startPeriodsType:
          enum:
            - Days
            - Weeks
            - Months
            - Years
          type: string
        triggerEvent:
          enum:
            - ContractEffective
            - ServiceActivation
            - CustomerAcceptance
            - SpecificDate
          type: string
      title: startDate
      type: object
    PricingUpdate:
      properties:
        chargeModelData:
          allOf:
            - $ref: '#/components/schemas/ChargeModelDataOverride'
        discount:
          allOf:
            - $ref: '#/components/schemas/DiscountPricingUpdate'
        recurringDelivery:
          allOf:
            - $ref: '#/components/schemas/RecurringDeliveryPricingUpdate'
        recurringFlatFee:
          allOf:
            - $ref: '#/components/schemas/RecurringFlatFeePricingUpdate'
        recurringPerUnit:
          allOf:
            - $ref: '#/components/schemas/RecurringPerUnitPricingUpdate'
        recurringTiered:
          allOf:
            - $ref: '#/components/schemas/RecurringTieredPricingUpdate'
        recurringVolume:
          allOf:
            - $ref: '#/components/schemas/RecurringVolumePricingUpdate'
        usageFlatFee:
          allOf:
            - $ref: '#/components/schemas/UsageFlatFeePricingUpdate'
        usageOverage:
          allOf:
            - $ref: '#/components/schemas/UsageOveragePricingUpdate'
        usagePerUnit:
          allOf:
            - $ref: '#/components/schemas/UsagePerUnitPricingUpdate'
        usageTiered:
          allOf:
            - $ref: '#/components/schemas/UsageTieredPricingUpdate'
        usageTieredWithOverage:
          allOf:
            - $ref: '#/components/schemas/UsageTieredWithOveragePricingUpdate'
        usageVolume:
          allOf:
            - $ref: '#/components/schemas/UsageVolumePricingUpdate'
      type: object
    RecurringDeliveryPricingUpdate:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            deliverySchedule:
              $ref: '#/components/schemas/DeliveryScheduleParams'
            listPrice:
              type: number
          type: object
    UsageFlatFeePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            listPrice:
              type: number
            originalListPrice:
              type: number
          type: object
    UsageOveragePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            includedUnits:
              type: number
            overagePrice:
              type: number
          type: object
    UsagePerUnitPricingUpdate:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            listPrice:
              type: number
            originalListPrice:
              type: number
          type: object
    UsageTieredPricingUpdate:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            tiers:
              items:
                $ref: '#/components/schemas/ChargeTier'
              type: array
          type: object
    UsageTieredWithOveragePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            overagePrice:
              type: number
            tiers:
              items:
                $ref: '#/components/schemas/ChargeTier'
              type: array
          type: object
    UsageVolumePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            tiers:
              items:
                $ref: '#/components/schemas/ChargeTier'
              type: array
          type: object
    InitialTerm:
      properties:
        period:
          minimum: 0
          type: integer
        periodType:
          enum:
            - Month
            - Year
            - Day
            - Week
          type: string
        startDate:
          format: date
          type: string
        termType:
          enum:
            - TERMED
            - EVERGREEN
          type: string
      required:
        - termType
      type: object
    BillToContact:
      allOf:
        - properties:
            address1:
              maxLength: 255
              type: string
            address2:
              maxLength: 255
              type: string
            city:
              maxLength: 40
              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: 40
              type: string
            nickname:
              maxLength: 100
              type: string
            otherPhone:
              maxLength: 40
              type: string
            otherPhoneType:
              enum:
                - Work
                - Mobile
                - Home
                - Other
              type: string
            personalEmail:
              format: email
              maxLength: 80
              type: string
            postalCode:
              maxLength: 20
              type: string
            state:
              maxLength: 40
              type: string
            taxRegion:
              maxLength: 32
              type: string
            workEmail:
              format: email
              maxLength: 80
              type: string
            workPhone:
              maxLength: 40
              type: string
          required:
            - firstName
            - lastName
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
    SoldToContact:
      allOf:
        - properties:
            address1:
              maxLength: 255
              type: string
            address2:
              maxLength: 255
              type: string
            city:
              maxLength: 40
              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: 40
              type: string
            nickname:
              maxLength: 100
              type: string
            otherPhone:
              maxLength: 40
              type: string
            otherPhoneType:
              enum:
                - Work
                - Mobile
                - Home
                - Other
              type: string
            personalEmail:
              format: email
              maxLength: 80
              type: string
            postalCode:
              maxLength: 20
              type: string
            state:
              maxLength: 40
              type: string
            taxRegion:
              maxLength: 32
              type: string
            workEmail:
              format: email
              maxLength: 80
              type: string
            workPhone:
              maxLength: 40
              type: string
          required:
            - firstName
            - lastName
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
    ChangePlanRatePlanOverride:
      properties:
        chargeOverrides:
          items:
            $ref: '#/components/schemas/ChangePlanChargeOverride'
          type: array
        clearingExistingFeatures:
          type: boolean
        customFields:
          $ref: '#/components/schemas/OrdersRatePlanObjectCustomFields'
        externallyManagedPlanId:
          type: string
        productRatePlanId:
          type: string
        productRatePlanNumber:
          type: string
        subscriptionProductFeatures:
          items:
            $ref: '#/components/schemas/RatePlanFeatureOverride'
          type: array
        uniqueToken:
          maxLength: 50
          type: string
      title: ratePlan
      type: object
    ChangePlanChargeOverride:
      properties:
        accountReceivableAccountingCode:
          type: string
        adjustmentLiabilityAccountingCode:
          type: string
        adjustmentRevenueAccountingCode:
          type: string
        billing:
          properties:
            billCycleDay:
              maximum: 31
              minimum: 0
              type: integer
            billCycleType:
              enum:
                - DefaultFromCustomer
                - SpecificDayofMonth
                - SubscriptionStartDay
                - ChargeTriggerDay
                - SpecificDayofWeek
              type: string
            billingPeriod:
              enum:
                - Month
                - Quarter
                - Semi_Annual
                - Annual
                - Eighteen_Months
                - Two_Years
                - Three_Years
                - Five_Years
                - Specific_Months
                - Subscription_Term
                - Week
                - Specific_Weeks
                - Specific_Days
              type: string
            billingPeriodAlignment:
              enum:
                - AlignToCharge
                - AlignToSubscriptionStart
                - AlignToTermStart
              type: string
            billingTiming:
              enum:
                - IN_ADVANCE
                - IN_ARREARS
              type: string
            specificBillingPeriod:
              type: integer
            weeklyBillCycleDay:
              enum:
                - Sunday
                - Monday
                - Tuesday
                - Wednesday
                - Thursday
                - Friday
                - Saturday
              type: string
          type: object
        chargeFunction:
          enum:
            - CommitmentTrueUp
            - CreditCommitment
          type: string
        commitmentType:
          enum:
            - CURRENCY
          type: string
        creditOption:
          enum:
            - TimeBased
            - ConsumptionBased
            - FullCreditBack
          type: string
        chargeModel:
          type: string
        chargeNumber:
          maxLength: 50
          type: string
        chargeType:
          type: string
        contractAssetAccountingCode:
          type: string
        contractLiabilityAccountingCode:
          type: string
        contractRecognizedRevenueAccountingCode:
          type: string
        customFields:
          $ref: '#/components/schemas/RatePlanChargeObjectCustomFields'
        deferredRevenueAccountingCode:
          type: string
        drawdownRate:
          type: number
        endDate:
          $ref: '#/components/schemas/EndConditions'
        estimatedStartDate:
          type: string
          format: date
        excludeItemBillingFromRevenueAccounting:
          default: false
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          default: false
          type: boolean
        isAllocationEligible:
          type: boolean
        isRollover:
          type: boolean
        isUnbilled:
          type: boolean
        name:
          type: string
        negotiatedPriceTable:
          type: array
        items:
          type: object
          additionalProperties: true
        pobPolicy:
          type: string
        prepaidQuantity:
          type: number
        pricing:
          properties:
            chargeModelData:
              $ref: '#/components/schemas/ChargeModelDataOverride'
            discount:
              $ref: '#/components/schemas/DiscountPricingOverride'
            oneTimeFlatFee:
              $ref: '#/components/schemas/OneTimeFlatFeePricingOverride'
            oneTimePerUnit:
              $ref: '#/components/schemas/OneTimePerUnitPricingOverride'
            oneTimeTiered:
              $ref: '#/components/schemas/OneTimeTieredPricingOverride'
            oneTimeVolume:
              $ref: '#/components/schemas/OneTimeVolumePricingOverride'
            recurringDeliveryBased:
              $ref: '#/components/schemas/RecurringDeliveryPricingOverride'
            recurringFlatFee:
              $ref: '#/components/schemas/RecurringFlatFeePricingOverride'
            recurringPerUnit:
              $ref: '#/components/schemas/RecurringPerUnitPricingOverride'
            recurringTiered:
              $ref: '#/components/schemas/RecurringTieredPricingOverride'
            recurringVolume:
              $ref: '#/components/schemas/RecurringVolumePricingOverride'
            usageFlatFee:
              $ref: '#/components/schemas/UsageFlatFeePricingOverride'
            usageOverage:
              $ref: '#/components/schemas/UsageOveragePricingOverride'
            usagePerUnit:
              $ref: '#/components/schemas/UsagePerUnitPricingOverride'
            usageTiered:
              $ref: '#/components/schemas/UsageTieredPricingOverride'
            usageTieredWithOverage:
              $ref: '#/components/schemas/UsageTieredWithOveragePricingOverride'
            usageVolume:
              $ref: '#/components/schemas/UsageVolumePricingOverride'
          type: object
        pricingAttributes:
          type: object
          additionalProperties: true
        productCategory:
          type: string
        productClass:
          type: string
        productFamily:
          type: string
        productLine:
          type: string
        productRatePlanChargeId:
          type: string
        productRatePlanChargeNumber:
          type: string
        prorationOption:
          enum:
            - NoProration
            - TimeBasedProration
            - DefaultFromTenantSetting
            - ChargeFullPeriod
            - CustomizeProrationOptionOverrides
          type: string
        ratingPropertiesOverride:
          type: object
          properties:
            isProratePartialMonth:
              type: boolean
            prorationUnit:
              enum:
                - ProrateByDay
                - ProrateByMonthFirst
              type: string
            daysInMonth:
              enum:
                - UseActualDays
                - Assume30Days
                - Assume30DaysStrict
              type: string
        recognizedRevenueAccountingCode:
          type: string
        revRecCode:
          maxLength: 70
          type: string
        revRecTriggerCondition:
          enum:
            - Contract Effective Date
            - Service Activation Date
            - Customer Acceptance Date
          type: string
        revenueRecognitionRuleName:
          type: string
        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
        startDate:
          $ref: '#/components/schemas/CreateOrderTriggerParams'
        taxCode:
          type: string
        taxMode:
          type: string
        unBilledReceivablesAccountingCode:
          type: string
        uniqueToken:
          maxLength: 50
          type: string
        upsellOriginChargeNumber:
          type: string
        validityPeriodType:
          enum:
            - SUBSCRIPTION_TERM
            - ANNUAL
            - SEMI_ANNUAL
            - QUARTER
            - MONTH
          type: string
      required:
        - productRatePlanChargeId
      title: charge
      type: object
    UsageFlatFeePricingOverride:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            listPrice:
              type: number
            originalListPrice:
              type: number
          type: object
      title: usageFlatFee
    UsageOveragePricingOverride:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            includedUnits:
              minimum: 0
              type: number
            numberOfPeriods:
              minimum: 1
              type: integer
            originalListPrice:
              type: number
            overagePrice:
              type: number
            overageUnusedUnitsCreditOption:
              enum:
                - NoCredit
                - CreditBySpecificRate
              type: string
            unusedUnitsCreditRates:
              type: number
          type: object
      title: usageOverage
    UsagePerUnitPricingOverride:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            listPrice:
              type: number
            originalListPrice:
              type: number
            ratingGroup:
              enum:
                - ByBillingPeriod
                - ByUsageStartDate
                - ByUsageRecord
                - ByUsageUpload
              type: string
            uom:
              type: number
          type: object
      title: usagePerUnit
    UsageTieredPricingOverride:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            ratingGroup:
              enum:
                - ByBillingPeriod
                - ByUsageStartDate
                - ByUsageRecord
                - ByUsageUpload
              type: string
            tiers:
              items:
                $ref: '#/components/schemas/ChargeTier'
              type: array
            uom:
              type: string
          type: object
      title: usageTiered
    UsageTieredWithOveragePricingOverride:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            numberOfPeriods:
              minimum: 1
              type: integer
            originalListPrice:
              type: number
            overagePrice:
              type: number
            overageUnusedUnitsCreditOption:
              enum:
                - NoCredit
                - CreditBySpecificRate
              type: string
            tiers:
              items:
                $ref: '#/components/schemas/ChargeTier'
              type: array
            unusedUnitsCreditRates:
              type: number
          type: object
      title: usageTieredWithOverage
    UsageVolumePricingOverride:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            ratingGroup:
              enum:
                - ByBillingPeriod
                - ByUsageStartDate
                - ByUsageRecord
                - ByUsageUpload
              type: string
            tiers:
              items:
                $ref: '#/components/schemas/ChargeTier'
              type: array
            uom:
              type: number
          type: object
      title: usageVolume
    ChargeOverride:
      properties:
        accountReceivableAccountingCode:
          type: string
        adjustmentLiabilityAccountingCode:
          type: string
        adjustmentRevenueAccountingCode:
          type: string
        billing:
          properties:
            billCycleDay:
              maximum: 31
              minimum: 0
              type: integer
            billCycleType:
              enum:
                - DefaultFromCustomer
                - SpecificDayofMonth
                - SubscriptionStartDay
                - ChargeTriggerDay
                - SpecificDayofWeek
              type: string
            billingPeriod:
              enum:
                - Month
                - Quarter
                - Semi_Annual
                - Annual
                - Eighteen_Months
                - Two_Years
                - Three_Years
                - Five_Years
                - Specific_Months
                - Subscription_Term
                - Week
                - Specific_Weeks
                - Specific_Days
              type: string
            billingPeriodAlignment:
              enum:
                - AlignToCharge
                - AlignToSubscriptionStart
                - AlignToTermStart
              type: string
            billingTiming:
              enum:
                - IN_ADVANCE
                - IN_ARREARS
              type: string
            specificBillingPeriod:
              type: integer
            weeklyBillCycleDay:
              enum:
                - Sunday
                - Monday
                - Tuesday
                - Wednesday
                - Thursday
                - Friday
                - Saturday
              type: string
          type: object
        chargeFunction:
          enum:
            - CommitmentTrueUp
            - CreditCommitment
          type: string
        commitmentType:
          enum:
            - CURRENCY
          type: string
        creditOption:
          enum:
            - TimeBased
            - ConsumptionBased
            - FullCreditBack
          type: string
        chargeModel:
          type: string
        chargeNumber:
          maxLength: 50
          type: string
        chargeType:
          type: string
        contractAssetAccountingCode:
          type: string
        contractLiabilityAccountingCode:
          type: string
        contractRecognizedRevenueAccountingCode:
          type: string
        customFields:
          $ref: '#/components/schemas/RatePlanChargeObjectCustomFields'
        deferredRevenueAccountingCode:
          type: string
        drawdownRate:
          type: number
        endDate:
          $ref: '#/components/schemas/EndConditions'
        estimatedStartDate:
          type: string
          format: date
        excludeItemBillingFromRevenueAccounting:
          default: false
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          default: false
          type: boolean
        isAllocationEligible:
          type: boolean
        isRollover:
          type: boolean
        isUnbilled:
          type: boolean
        name:
          type: string
        negotiatedPriceTable:
          type: array
        items:
          type: object
        pobPolicy:
          type: string
        prepaidQuantity:
          type: number
        pricing:
          properties:
            chargeModelData:
              $ref: '#/components/schemas/ChargeModelDataOverride'
            discount:
              $ref: '#/components/schemas/DiscountPricingOverride'
            oneTimeFlatFee:
              $ref: '#/components/schemas/OneTimeFlatFeePricingOverride'
            oneTimePerUnit:
              $ref: '#/components/schemas/OneTimePerUnitPricingOverride'
            oneTimeTiered:
              $ref: '#/components/schemas/OneTimeTieredPricingOverride'
            oneTimeVolume:
              $ref: '#/components/schemas/OneTimeVolumePricingOverride'
            recurringDelivery:
              $ref: '#/components/schemas/RecurringDeliveryPricingOverride'
            recurringFlatFee:
              $ref: '#/components/schemas/RecurringFlatFeePricingOverride'
            recurringPerUnit:
              $ref: '#/components/schemas/RecurringPerUnitPricingOverride'
            recurringTiered:
              $ref: '#/components/schemas/RecurringTieredPricingOverride'
            recurringVolume:
              $ref: '#/components/schemas/RecurringVolumePricingOverride'
            usageFlatFee:
              $ref: '#/components/schemas/UsageFlatFeePricingOverride'
            usageOverage:
              $ref: '#/components/schemas/UsageOveragePricingOverride'
            usagePerUnit:
              $ref: '#/components/schemas/UsagePerUnitPricingOverride'
            usageTiered:
              $ref: '#/components/schemas/UsageTieredPricingOverride'
            usageTieredWithOverage:
              $ref: '#/components/schemas/UsageTieredWithOveragePricingOverride'
            usageVolume:
              $ref: '#/components/schemas/UsageVolumePricingOverride'
          type: object
        pricingAttributes:
          type: object
          additionalProperties: true
        productCategory:
          type: string
        productClass:
          type: string
        productFamily:
          type: string
        productLine:
          type: string
        productRatePlanChargeNumber:
          type: string
        productRateplanChargeId:
          type: string
        prorationOption:
          enum:
            - NoProration
            - TimeBasedProration
            - DefaultFromTenantSetting
            - ChargeFullPeriod
            - CustomizeProrationOptionOverrides
          type: string
        ratingPropertiesOverride:
          type: object
          properties:
            isProratePartialMonth:
              type: boolean
            prorationUnit:
              enum:
                - ProrateByDay
                - ProrateByMonthFirst
              type: string
            daysInMonth:
              enum:
                - UseActualDays
                - Assume30Days
                - Assume30DaysStrict
              type: string
        recognizedRevenueAccountingCode:
          type: string
        revRecCode:
          maxLength: 70
          type: string
        revRecTriggerCondition:
          enum:
            - Contract Effective Date
            - Service Activation Date
            - Customer Acceptance Date
          type: string
        revenueRecognitionRuleName:
          type: string
        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
        startDate:
          $ref: '#/components/schemas/TriggerParams'
        taxCode:
          type: string
        taxMode:
          enum:
            - TaxExclusive
            - TaxInclusive
          type: string
        taxable:
          type: boolean
        unBilledReceivablesAccountingCode:
          type: string
        uniqueToken:
          maxLength: 50
          type: string
        validityPeriodType:
          enum:
            - SUBSCRIPTION_TERM
            - ANNUAL
            - SEMI_ANNUAL
            - QUARTER
            - MONTH
          type: string
      required:
        - productRateplanChargeId
      title: charge
      type: object
    CreateOrderResult:
      properties:
        accountId:
          maxLength: 32
          type: string
        accountNumber:
          maxLength: 50
          type: string
        commitments:
          items:
            $ref: '#/components/schemas/CommitmentOutput'
          type: array
        creditMemoIds:
          items:
            type: string
            maxLength: 32
          type: array
        creditMemoNumbers:
          items:
            type: string
            maxLength: 255
          type: array
        invoiceIds:
          items:
            type: string
            maxLength: 32
          type: array
        invoiceNumbers:
          items:
            type: string
            maxLength: 255
          type: array
        orderId:
          maxLength: 32
          type: string
        orderLineItems:
          items:
            properties:
              id:
                maxLength: 32
                type: string
              itemNumber:
                maxLength: 100
                type: string
            type: object
          type: array
        orderNumber:
          maxLength: 100
          type: string
        paidAmount:
          maxLength: 22
          minLength: 9
          type: string
        paymentId:
          maxLength: 32
          type: string
        paymentNumber:
          maxLength: 32
          type: string
        ramps:
          items:
            properties:
              rampNumber:
                maxLength: 50
                type: string
              subscriptionNumber:
                maxLength: 150
                type: string
            type: object
          type: array
        refunds:
          items:
            properties:
              number:
                maxLength: 32
                type: string
              refundInvoiceNumbers:
                items:
                  type: string
                  maxLength: 255
                type: array
              status:
                enum:
                  - Success
                  - Error
                type: string
            type: object
          type: array
        status:
          enum:
            - Draft
            - Pending
            - Completed
            - Scheduled
          type: string
        subscriptionIds:
          items:
            type: string
            maxLength: 32
          type: array
        subscriptions:
          items:
            properties:
              status:
                enum:
                  - Active
                  - Pending Activation
                  - Pending Acceptance
                  - Cancelled
                  - Suspended
                type: string
              subscriptionId:
                maxLength: 32
                type: string
              subscriptionNumber:
                maxLength: 150
                type: string
              subscriptionOwnerId:
                type: string
              subscriptionOwnerNumber:
                type: string
            type: object
        writeOff:
          items:
            properties:
              amount:
                maximum: 22
                minimum: 9
                type: number
              failedReason:
                type: string
              invoiceNumber:
                maxLength: 255
                type: string
              status:
                enum:
                  - Success
                  - Failed
                type: string
              writeOffCreditMemoNumber:
                maxLength: 255
                type: string
            type: object
          type: array
      type: object
    CommitmentOutput:
      type: object
      title: UpsertOrderCommitmentResponse
      properties:
        id:
          type: string
        commitmentNumber:
          type: string
        type:
          $ref: '#/components/schemas/CommitmentTypeEnum'
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        amount:
          type: number
          format: double
        periods:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              startDate:
                type: string
              endDate:
                type: string
              amount:
                type: number
                format: double
    CommitmentTypeEnum:
      type: string
      enum:
        - MinCommitment
        - MaxCommitment
    OrderLineItemCommonRetrieveOrder:
      properties:
        UOM:
          type: string
        accountingCode:
          type: string
        adjustmentLiabilityAccountingCode:
          type: string
        adjustmentRevenueAccountingCode:
          type: string
        amountPerUnit:
          type: number
        billTargetDate:
          format: date
          type: string
        billTo:
          type: string
        billToSnapshotId:
          type: string
        billingRule:
          enum:
            - TriggerWithoutFulfillment
            - TriggerAsFulfillmentOccurs
          type: string
        contractAssetAccountingCode:
          type: string
        contractLiabilityAccountingCode:
          type: string
        contractRecognizedRevenueAccountingCode:
          type: string
        currency:
          type: string
        customFields:
          $ref: '#/components/schemas/OrderLineItemCustomFields'
        deferredRevenueAccountingCode:
          type: string
        discount:
          type: number
        excludeItemBillingFromRevenueAccounting:
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          type: boolean
        inlineDiscountPerUnit:
          type: number
        inlineDiscountType:
          enum:
            - Percentage
            - FixedAmount
            - None
          type: string
        invoiceOwnerAccountId:
          type: string
        invoiceOwnerAccountName:
          type: string
        invoiceOwnerAccountNumber:
          type: string
        isAllocationEligible:
          type: boolean
        isUnbilled:
          type: boolean
        itemCategory:
          default: Sales
          enum:
            - Sales
            - Return
          type: string
        itemName:
          type: string
        itemState:
          enum:
            - Executing
            - Booked
            - SentToBilling
            - Complete
            - Cancelled
          type: string
        itemType:
          enum:
            - Product
            - Fee
            - Services
          type: string
        listPrice:
          type: number
        listPricePerUnit:
          type: number
        originalOrderId:
          type: string
        originalOrderLineItemId:
          type: string
        originalOrderLineItemNumber:
          type: string
        originalOrderNumber:
          type: string
        ownerAccountId:
          type: string
        ownerAccountName:
          type: string
        ownerAccountNumber:
          type: string
        productCode:
          type: string
        productRatePlanChargeId:
          type: string
        purchaseOrderNumber:
          type: string
        quantity:
          type: number
        quantityAvailableForReturn:
          type: number
        quantityFulfilled:
          type: number
        quantityPendingFulfillment:
          type: number
        recognizedRevenueAccountingCode:
          type: string
        relatedSubscriptionNumber:
          type: string
        requiresFulfillment:
          type: boolean
        revenueRecognitionRule:
          type: string
        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
        sequenceSetId:
          type: string
          nullable: true
        shipTo:
          type: string
        shipToSnapshotId:
          type: string
        soldTo:
          type: string
        soldToSnapshotId:
          type: string
        taxCode:
          type: string
        taxMode:
          enum:
            - TaxInclusive
            - TaxExclusive
          type: string
        transactionEndDate:
          format: date
          type: string
        transactionStartDate:
          format: date
          type: string
        unbilledReceivablesAccountingCode:
          type: string
      title: OrderLineItem
      type: object
    CommitmentBaseAttributes:
      type: object
      title: CommitmentBaseAttributes
      properties:
        commitmentNumber:
          type: string
          maxLength: 100
        id:
          type: string
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        amount:
          type: number
          format: double
        name:
          type: string
          maxLength: 255
        type:
          $ref: '#/components/schemas/CommitmentTypeEnum'
        priority:
          type: integer
        associationRules:
          $ref: '#/components/schemas/AssociationRuleRequest'
        customFields:
          type: object
          items:
            additionalProperties: true
          title: CommitmentCustomFields
        periods:
          type: array
          items:
            type: object
            properties:
              startDate:
                type: string
                format: date
              endDate:
                type: string
                format: date
              amount:
                type: number
                format: double
              id:
                type: string
          title: GetOrderCommitmentPeriod
    CommonRevenueAttributes:
      type: object
      properties:
        accountingCode:
          type: string
          maxLength: 100
        accountReceivableAccountingCode:
          type: string
          maxLength: 100
        adjustmentLiabilityAccountingCode:
          type: string
          maxLength: 100
        adjustmentRevenueAccountingCode:
          type: string
          maxLength: 100
        contractAssetAccountingCode:
          type: string
          maxLength: 100
        contractLiabilityAccountingCode:
          type: string
          maxLength: 100
        contractRecognizedRevenueAccountingCode:
          type: string
          maxLength: 100
        deferredRevenueAccountingCode:
          type: string
          maxLength: 100
        excludeItemBillingFromRevenueAccounting:
          type: boolean
        isAllocationEligible:
          type: boolean
        isUnbilled:
          type: boolean
        recognizedRevenueAccountingCode:
          type: string
          maxLength: 100
        revenueAmortizationMethod:
          type: string
          maxLength: 200
        revenueRecognitionRule:
          type: string
          maxLength: 255
        revenueRecoginitionTiming:
          type: string
          maxLength: 200
        unbilledReceivablesAccountingCode:
          type: string
          maxLength: 100
    CommonTaxationAttributes:
      type: object
      properties:
        taxable:
          type: boolean
        taxCode:
          type: string
          maxLength: 100
        taxMode:
          type: string
          enum:
            - TaxInclusive
            - TaxExclusive
    AssociationRuleRequest:
      type: array
      title: CommitmentAssociationRule
      items:
        type: object
        properties:
          condition:
            $ref: '#/components/schemas/CommitmentCondition'
            type: array
          objectType:
            type: string
            enum:
              - RatePlanCharge
        required:
          - condition
          - objectType
    CommitmentCondition:
      properties:
        field:
          type: string
          enum:
            - ChargeNumber
        operator:
          type: string
          enum:
            - in
        value:
          type: string
      type: object
      title: CommitmentCondition
    POSTOrderRequestType:
      properties:
        category:
          default: NewSales
          enum:
            - NewSales
            - Return
          type: string
        commitments:
          items:
            $ref: '#/components/schemas/UpsertCommitmentInput'
        customFields:
          $ref: '#/components/schemas/OrderObjectCustomFields'
        existingAccountId:
          type: string
        existingAccountNumber:
          maxLength: 70
          type: string
        newAccount:
          $ref: '#/components/schemas/CreateOrderNewAccount'
        orderDate:
          format: date
          type: string
        orderLineItems:
          items:
            $ref: '#/components/schemas/CreateOrderOrderLineItem'
          type: array
        orderNumber:
          maxLength: 100
          type: string
        processingOptions:
          $ref: '#/components/schemas/processingOptionsOrdersWithDelayedCapturePayment'
        reasonCode:
          maxLength: 255
          type: string
        schedulingOptions:
          properties:
            scheduledDate:
              format: date
              type: string
            scheduledDatePolicy:
              enum:
                - SpecificDate
              type: string
          type: object
        status:
          enum:
            - Draft
            - Pending
            - Completed
            - Scheduled
            - Executing
            - Failed
          type: string
        subscriptions:
          items:
            properties:
              customFields:
                $ref: '#/components/schemas/SubscriptionObjectCustomFields'
              notes:
                type: string
                maxLength: 1000
              orderActions:
                items:
                  $ref: '#/components/schemas/CreateOrderOrderAction'
                type: array
              quote:
                $ref: '#/components/schemas/QuoteObjectFields'
              ramp:
                $ref: '#/components/schemas/RampRequest'
              subscriptionNumber:
                type: string
            type: object
          type: array
      required:
        - orderDate
      type: object
    UpsertCommitmentInput:
      title: UpsertCommitmentInput
      type: object
      required:
        - action
      properties:
        action:
          $ref: '#/components/schemas/ActionType'
      oneOf:
        - $ref: '#/components/schemas/UpsertCreateCommitmentInput'
        - $ref: '#/components/schemas/UpsertUpdateCommitmentInput'
      discriminator:
        propertyName: action
        mapping:
          create: '#/components/schemas/UpsertCreateCommitmentInput'
          update: '#/components/schemas/UpsertUpdateCommitmentInput'
    CreateOrderNewAccount:
      allOf:
        - properties:
            accountNumber:
              maxLength: 70
              type: string
            additionalEmailAddresses:
              maxLength: 1200
              type: string
            allowInvoiceEdit:
              type: boolean
            autoPay:
              type: boolean
            batch:
              type: string
            billCycleDay:
              maximum: 31
              minimum: 0
              type: integer
            billToContact:
              $ref: '#/components/schemas/BillToContactPostOrder'
            communicationProfileId:
              type: string
            creditCard:
              $ref: '#/components/schemas/creditCard'
            creditMemoTemplateId:
              type: string
            crmId:
              maxLength: 100
              type: string
            currency:
              type: string
            customFields:
              $ref: '#/components/schemas/AccountObjectCustomFields'
            customerServiceRepName:
              maxLength: 50
              type: string
            debitMemoTemplateId:
              type: string
            hpmCreditCardPaymentMethodId:
              type: string
            invoiceDeliveryPrefsEmail:
              type: boolean
            invoiceDeliveryPrefsPrint:
              type: boolean
            invoiceTemplateId:
              type: string
            name:
              maxLength: 255
              type: string
            notes:
              maxLength: 65535
              type: string
            organizationLabel:
              type: string
            parentId:
              type: string
            partnerAccount:
              default: false
              type: boolean
            paymentGateway:
              maxLength: 40
              type: string
            paymentMethod:
              $ref: '#/components/schemas/POSTPaymentMethodRequest'
            paymentTerm:
              type: string
            purchaseOrderNumber:
              maxLength: 100
              type: string
            salesRep:
              maxLength: 50
              type: string
            sequenceSetId:
              type: string
              nullable: true
            shipToContact:
              $ref: '#/components/schemas/ShipToContactPostOrder'
            shipToSameAsBillTo:
              type: boolean
            soldToContact:
              $ref: '#/components/schemas/SoldToContactPostOrder'
            soldToSameAsBillTo:
              type: boolean
            taxInfo:
              $ref: '#/components/schemas/TaxInfo'
          required:
            - name
            - currency
            - billCycleDay
            - billToContact
          type: object
        - $ref: '#/components/schemas/DataAccessControlField'
    processingOptionsOrdersWithDelayedCapturePayment:
      properties:
        applicationOrder:
          items:
            type: string
          type: array
        applyCredit:
          type: boolean
        applyCreditBalance:
          type: boolean
        billingOptions:
          properties:
            creditMemoReasonCode:
              type: string
            documentDate:
              format: date
              type: string
            generateDraftInvoice:
              type: boolean
            targetDate:
              format: date
              type: string
            chargeTypeToExclude:
              items:
                type: string
                enum:
                  - OneTime
                  - Recurring
                  - Usage
              type: array
          type: object
        collectPayment:
          type: boolean
        electronicPaymentOptions:
          properties:
            authTransactionId:
              maxLength: 50
              type: string
            gatewayOrderId:
              maxLength: 50
              type: string
            paymentGatewayId:
              type: string
            paymentMethodId:
              type: string
            gatewayOptions:
              type: object
              title: gatewayOptions
              additionalProperties:
                type: string
            mitTransactionSource:
              enum:
                - C_Unscheduled
                - M_Recurring
                - M_Unscheduled
              type: string
          type: object
        refund:
          type: boolean
        refundAmount:
          type: number
        refundReasonCode:
          type: string
        runBilling:
          type: boolean
        writeOff:
          type: boolean
        writeOffBehavior:
          properties:
            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
          type: object
      type: object
    CreateOrderOrderAction:
      properties:
        addProduct:
          $ref: '#/components/schemas/CreateOrderRatePlanOverride'
        cancelSubscription:
          $ref: '#/components/schemas/CancelSubscription'
        changePlan:
          $ref: '#/components/schemas/CreateChangePlan'
        changeReason:
          maxLength: 255
          type: string
        createSubscription:
          $ref: '#/components/schemas/CreateOrderCreateSubscription'
        customFields:
          $ref: '#/components/schemas/OrderActionObjectCustomFields'
        ownerTransfer:
          $ref: '#/components/schemas/OwnerTransfer'
        removeProduct:
          $ref: '#/components/schemas/RemoveProduct'
        renewSubscription:
          $ref: '#/components/schemas/RenewSubscription'
        resume:
          $ref: '#/components/schemas/CreateOrderResume'
        suspend:
          $ref: '#/components/schemas/CreateOrderSuspend'
        termsAndConditions:
          $ref: '#/components/schemas/CreateOrderTermsAndConditions'
        triggerDates:
          items:
            $ref: '#/components/schemas/TriggerDate'
          type: array
        type:
          enum:
            - CreateSubscription
            - TermsAndConditions
            - AddProduct
            - UpdateProduct
            - RemoveProduct
            - RenewSubscription
            - CancelSubscription
            - OwnerTransfer
            - Suspend
            - Resume
            - ChangePlan
          type: string
        updateProduct:
          $ref: '#/components/schemas/CreateOrderRatePlanUpdate'
      required:
        - type
      type: object
    CreateOrderRatePlanOverride:
      properties:
        chargeOverrides:
          items:
            $ref: '#/components/schemas/CreateOrderChargeOverride'
          type: array
        clearingExistingFeatures:
          type: boolean
        customFields:
          $ref: '#/components/schemas/OrdersRatePlanObjectCustomFields'
        externalCatalogPlanId:
          type: string
        externallyManagedPlanId:
          type: string
        isAddingSubsetCharges:
          type: boolean
        isFromExternalCatalog:
          type: boolean
        productRatePlanId:
          type: string
        productRatePlanNumber:
          type: string
        ratePlanName:
          type: string
        subscriptionProductFeatures:
          items:
            $ref: '#/components/schemas/CreateOrderRatePlanFeatureOverride'
          type: array
        subscriptionRatePlanNumber:
          maxLength: 50
          type: string
        uniqueToken:
          maxLength: 50
          type: string
      title: ratePlan
      type: object
    CreateChangePlan:
      properties:
        effectivePolicy:
          enum:
            - EffectiveImmediately
            - EffectiveEndOfBillingPeriod
            - SpecificDate
          type: string
        externalCatalogPlanId:
          type: string
        newProductRatePlan:
          $ref: '#/components/schemas/CreateOrderChangePlanRatePlanOverride'
        productRatePlanId:
          type: string
        productRatePlanNumber:
          type: string
        ratePlanId:
          type: string
        resetBcd:
          default: false
          type: boolean
        subType:
          enum:
            - Upgrade
            - Downgrade
            - Crossgrade
            - PlanChanged
          type: string
        subscriptionRatePlanNumber:
          type: string
      required:
        - newProductRatePlan
      title: createChangePlan
      type: object
    CreateOrderCreateSubscription:
      properties:
        billToContactId:
          type: string
        currency:
          maxLength: 3
          type: string
        invoiceGroupNumber:
          type: string
          maxLength: 255
          nullable: true
        invoiceSeparately:
          type: boolean
        invoiceTemplateId:
          type: string
        newSubscriptionOwnerAccount:
          $ref: '#/components/schemas/CreateOrderCreateSubscriptionNewSubscriptionOwnerAccount'
        notes:
          maxLength: 500
          type: string
        paymentProfile:
          properties:
            paymentGatewayId:
              type: string
            paymentMethodId:
              type: string
          type: object
        paymentTerm:
          type: string
        sequenceSetId:
          type: string
          nullable: true
        shipToContactId:
          type: string
        soldToContactId:
          type: string
        subscribeToRatePlans:
          items:
            $ref: '#/components/schemas/CreateOrderRatePlanOverride'
          type: array
        subscriptionNumber:
          maxLength: 100
          type: string
        subscriptionOwnerAccountNumber:
          maxLength: 70
          type: string
        invoiceOwnerAccountNumber:
          maxLength: 70
          type: string
        terms:
          properties:
            autoRenew:
              type: boolean
            initialTerm:
              properties:
                period:
                  type: integer
                periodType:
                  enum:
                    - Month
                    - Year
                    - Day
                    - Week
                  type: string
                startDate:
                  format: date
                  type: string
                endDate:
                  format: date
                  type: string
                termType:
                  enum:
                    - TERMED
                    - EVERGREEN
                  type: string
              required:
                - termType
              type: object
            renewalSetting:
              enum:
                - RENEW_WITH_SPECIFIC_TERM
                - RENEW_TO_EVERGREEN
              type: string
            renewalTerms:
              items:
                $ref: '#/components/schemas/RenewalTerm'
              type: array
          required:
            - initialTerm
          type: object
      title: createSubscription
      type: object
    CreateOrderRatePlanUpdate:
      properties:
        chargeUpdates:
          items:
            $ref: '#/components/schemas/CreateOrderChargeUpdate'
          type: array
        clearingExistingFeatures:
          type: boolean
        customFields:
          $ref: '#/components/schemas/OrdersRatePlanObjectCustomFields'
        externalCatalogPlanId:
          type: string
        isAddingSubsetCharges:
          type: boolean
        productRatePlanNumber:
          type: string
        ratePlanId:
          type: string
        specificUpdateDate:
          format: date
          type: string
        subscriptionProductFeatures:
          items:
            $ref: '#/components/schemas/CreateOrderRatePlanFeatureOverride'
          type: array
        subscriptionRatePlanNumber:
          type: string
        uniqueToken:
          type: string
      title: updateRateplan
      type: object
    CreateOrderChargeUpdate:
      properties:
        billing:
          $ref: '#/components/schemas/BillingUpdate'
        chargeNumber:
          type: string
        estimatedStartDate:
          type: string
          format: date
        negotiatedPriceTable:
          type: array
        items:
          type: object
          additionalProperties: true
        pricingAttributes:
          type: object
          additionalProperties: true
        productRatePlanChargeId:
          type: string
        productRatePlanChargeNumber:
          type: string
        customFields:
          $ref: '#/components/schemas/RatePlanChargeObjectCustomFields'
        effectiveDate:
          $ref: '#/components/schemas/CreateOrderUpdateProductTriggerParams'
        prepaidQuantity:
          type: number
        pricing:
          allOf:
            - $ref: '#/components/schemas/CreateOrderPricingUpdate'
        uniqueToken:
          type: string
      type: object
    CreateOrderUpdateProductTriggerParams:
      properties:
        specificTriggerDate:
          format: date
          type: string
        triggerEvent:
          enum:
            - ContractEffective
            - ServiceActivation
            - CustomerAcceptance
            - SpecificDate
          type: string
      title: startDate
      type: object
    CreateOrderPricingUpdate:
      properties:
        chargeModelData:
          allOf:
            - $ref: '#/components/schemas/ChargeModelDataOverride'
        discount:
          allOf:
            - $ref: '#/components/schemas/DiscountPricingUpdate'
        recurringDeliveryBased:
          allOf:
            - $ref: '#/components/schemas/RecurringDeliveryPricingUpdate'
        recurringFlatFee:
          allOf:
            - $ref: '#/components/schemas/RecurringFlatFeePricingUpdate'
        recurringPerUnit:
          allOf:
            - $ref: '#/components/schemas/RecurringPerUnitPricingUpdate'
        recurringTiered:
          allOf:
            - $ref: '#/components/schemas/RecurringTieredPricingUpdate'
        recurringVolume:
          allOf:
            - $ref: '#/components/schemas/RecurringVolumePricingUpdate'
        usageFlatFee:
          allOf:
            - $ref: '#/components/schemas/UsageFlatFeePricingUpdate'
        usageOverage:
          allOf:
            - $ref: '#/components/schemas/UsageOveragePricingUpdate'
        usagePerUnit:
          allOf:
            - $ref: '#/components/schemas/UsagePerUnitPricingUpdate'
        usageTiered:
          allOf:
            - $ref: '#/components/schemas/UsageTieredPricingUpdate'
        usageTieredWithOverage:
          allOf:
            - $ref: '#/components/schemas/UsageTieredWithOveragePricingUpdate'
        usageVolume:
          allOf:
            - $ref: '#/components/schemas/UsageVolumePricingUpdate'
      type: object
    CreateOrderCreateSubscriptionNewSubscriptionOwnerAccount:
      allOf:
        - properties:
            accountNumber:
              maxLength: 70
              type: string
            additionalEmailAddresses:
              maxLength: 1200
              type: string
            allowInvoiceEdit:
              type: boolean
            autoPay:
              type: boolean
            batch:
              type: string
            billCycleDay:
              maximum: 31
              minimum: 0
              type: integer
            billToContact:
              $ref: '#/components/schemas/BillToContactPostOrder'
            communicationProfileId:
              type: string
            creditCard:
              $ref: '#/components/schemas/creditCard'
            creditMemoTemplateId:
              type: string
            crmId:
              maxLength: 100
              type: string
            currency:
              type: string
            customFields:
              $ref: '#/components/schemas/AccountObjectCustomFields'
            customerServiceRepName:
              maxLength: 50
              type: string
            debitMemoTemplateId:
              type: string
            hpmCreditCardPaymentMethodId:
              type: string
            invoiceDeliveryPrefsEmail:
              type: boolean
            invoiceDeliveryPrefsPrint:
              type: boolean
            invoiceTemplateId:
              type: string
            name:
              maxLength: 255
              type: string
            notes:
              maxLength: 65535
              type: string
            parentId:
              type: string
            paymentGateway:
              maxLength: 40
              type: string
            paymentMethod:
              $ref: '#/components/schemas/POSTPaymentMethodRequest'
            paymentTerm:
              type: string
            purchaseOrderNumber:
              maxLength: 100
              type: string
            salesRep:
              maxLength: 50
              type: string
            soldToContact:
              $ref: '#/components/schemas/SoldToContactPostOrder'
            taxInfo:
              $ref: '#/components/schemas/TaxInfo'
          required:
            - name
            - currency
            - billCycleDay
            - billToContact
          type: object
        - $ref: '#/components/schemas/DataAccessControlField'
    DataAccessControlField:
      additionalProperties:
        type: string
      title: dataAccessControlField
      type: object
    CreateOrderChangePlanRatePlanOverride:
      properties:
        chargeOverrides:
          items:
            $ref: '#/components/schemas/ChangePlanChargeOverride'
          type: array
        clearingExistingFeatures:
          type: boolean
        customFields:
          $ref: '#/components/schemas/OrdersRatePlanObjectCustomFields'
        externalCatalogPlanId:
          type: string
        externallyManagedPlanId:
          type: string
        subscriptionRatePlanNumber:
          maxLength: 50
          type: string
        isFromExternalCatalog:
          type: boolean
        productRatePlanId:
          type: string
        productRatePlanNumber:
          type: string
        ratePlanName:
          type: string
        subscriptionProductFeatures:
          items:
            $ref: '#/components/schemas/CreateOrderRatePlanFeatureOverride'
          type: array
        uniqueToken:
          maxLength: 50
          type: string
      title: ratePlan
      type: object
    CreateOrderChargeOverride:
      properties:
        accountReceivableAccountingCode:
          type: string
        adjustmentLiabilityAccountingCode:
          type: string
        adjustmentRevenueAccountingCode:
          type: string
        billing:
          properties:
            billCycleDay:
              maximum: 31
              minimum: 0
              type: integer
            billCycleType:
              enum:
                - DefaultFromCustomer
                - SpecificDayofMonth
                - SubscriptionStartDay
                - ChargeTriggerDay
                - SpecificDayofWeek
              type: string
            billingPeriod:
              enum:
                - Month
                - Quarter
                - Semi_Annual
                - Annual
                - Eighteen_Months
                - Two_Years
                - Three_Years
                - Five_Years
                - Specific_Months
                - Subscription_Term
                - Week
                - Specific_Weeks
                - Specific_Days
              type: string
            billingPeriodAlignment:
              enum:
                - AlignToCharge
                - AlignToSubscriptionStart
                - AlignToTermStart
              type: string
            billingTiming:
              enum:
                - IN_ADVANCE
                - IN_ARREARS
              type: string
            specificBillingPeriod:
              type: integer
            weeklyBillCycleDay:
              enum:
                - Sunday
                - Monday
                - Tuesday
                - Wednesday
                - Thursday
                - Friday
                - Saturday
              type: string
          type: object
        chargeFunction:
          enum:
            - CommitmentTrueUp
            - CreditCommitment
          type: string
        commitmentType:
          enum:
            - CURRENCY
          type: string
        creditOption:
          enum:
            - TimeBased
            - ConsumptionBased
            - FullCreditBack
          type: string
        chargeModel:
          type: string
        chargeNumber:
          maxLength: 50
          type: string
        chargeType:
          type: string
        contractAssetAccountingCode:
          type: string
        contractLiabilityAccountingCode:
          type: string
        contractRecognizedRevenueAccountingCode:
          type: string
        customFields:
          $ref: '#/components/schemas/RatePlanChargeObjectCustomFields'
        deferredRevenueAccountingCode:
          type: string
        drawdownRate:
          type: number
        endDate:
          $ref: '#/components/schemas/EndConditions'
        estimatedStartDate:
          type: string
          format: date
        excludeItemBillingFromRevenueAccounting:
          default: false
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          default: false
          type: boolean
        isAllocationEligible:
          type: boolean
        isRollover:
          type: boolean
        isUnbilled:
          type: boolean
        name:
          type: string
        negotiatedPriceTable:
          type: array
        items:
          type: object
          additionalProperties: true
        pobPolicy:
          type: string
        prepaidQuantity:
          type: number
        pricing:
          properties:
            chargeModelData:
              $ref: '#/components/schemas/ChargeModelDataOverride'
            discount:
              $ref: '#/components/schemas/DiscountPricingOverride'
            oneTimeFlatFee:
              $ref: '#/components/schemas/OneTimeFlatFeePricingOverride'
            oneTimePerUnit:
              $ref: '#/components/schemas/OneTimePerUnitPricingOverride'
            oneTimeTiered:
              $ref: '#/components/schemas/OneTimeTieredPricingOverride'
            oneTimeVolume:
              $ref: '#/components/schemas/OneTimeVolumePricingOverride'
            recurringDeliveryBased:
              $ref: '#/components/schemas/RecurringDeliveryPricingOverride'
            recurringFlatFee:
              $ref: '#/components/schemas/RecurringFlatFeePricingOverride'
            recurringPerUnit:
              $ref: '#/components/schemas/RecurringPerUnitPricingOverride'
            recurringTiered:
              $ref: '#/components/schemas/RecurringTieredPricingOverride'
            recurringVolume:
              $ref: '#/components/schemas/RecurringVolumePricingOverride'
            usageFlatFee:
              $ref: '#/components/schemas/UsageFlatFeePricingOverride'
            usageOverage:
              $ref: '#/components/schemas/UsageOveragePricingOverride'
            usagePerUnit:
              $ref: '#/components/schemas/UsagePerUnitPricingOverride'
            usageTiered:
              $ref: '#/components/schemas/UsageTieredPricingOverride'
            usageTieredWithOverage:
              $ref: '#/components/schemas/UsageTieredWithOveragePricingOverride'
            usageVolume:
              $ref: '#/components/schemas/UsageVolumePricingOverride'
          type: object
        pricingAttributes:
          type: object
          additionalProperties: true
        productCategory:
          type: string
        productClass:
          type: string
        productFamily:
          type: string
        productLine:
          type: string
        productRatePlanChargeId:
          type: string
        productRatePlanChargeNumber:
          type: string
        prorationOption:
          enum:
            - NoProration
            - TimeBasedProration
            - DefaultFromTenantSetting
            - ChargeFullPeriod
            - CustomizeProrationOptionOverrides
          type: string
        ratingPropertiesOverride:
          type: object
          properties:
            isProratePartialMonth:
              type: boolean
            prorationUnit:
              enum:
                - ProrateByDay
                - ProrateByMonthFirst
              type: string
            daysInMonth:
              enum:
                - UseActualDays
                - Assume30Days
                - Assume30DaysStrict
              type: string
        recognizedRevenueAccountingCode:
          type: string
        revRecCode:
          maxLength: 70
          type: string
        revRecTriggerCondition:
          enum:
            - Contract Effective Date
            - Service Activation Date
            - Customer Acceptance Date
          type: string
        revenueRecognitionRuleName:
          type: string
        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
        startDate:
          $ref: '#/components/schemas/CreateOrderTriggerParams'
        taxCode:
          type: string
        taxMode:
          enum:
            - TaxExclusive
            - TaxInclusive
          type: string
        taxable:
          type: boolean
        unBilledReceivablesAccountingCode:
          type: string
        uniqueToken:
          maxLength: 50
          type: string
        upsellOriginChargeNumber:
          type: string
        validityPeriodType:
          enum:
            - SUBSCRIPTION_TERM
            - ANNUAL
            - SEMI_ANNUAL
            - QUARTER
            - MONTH
          type: string
      required:
        - productRatePlanChargeId
      title: charge
      type: object
    ShipToContactPostOrder:
      allOf:
        - properties:
            address1:
              maxLength: 255
              type: string
            address2:
              maxLength: 255
              type: string
            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: 40
              type: string
            nickname:
              maxLength: 100
              type: string
            otherPhone:
              maxLength: 40
              type: string
            otherPhoneType:
              enum:
                - Work
                - Mobile
                - Home
                - Other
              type: string
            personalEmail:
              format: email
              maxLength: 80
              type: string
            postalCode:
              maxLength: 20
              type: string
            state:
              maxLength: 40
              type: string
            taxRegion:
              maxLength: 32
              type: string
            workEmail:
              format: email
              maxLength: 80
              type: string
            workPhone:
              maxLength: 40
              type: string
          required:
            - firstName
            - lastName
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
    UpsertCreateCommitmentInput:
      type: object
      title: UpsertCreateCommitmentInput
      allOf:
        - type: object
          properties:
            action:
              $ref: '#/components/schemas/ActionType'
        - $ref: '#/components/schemas/CommitmentInput'
      required:
        - action
    UpsertUpdateCommitmentInput:
      type: object
      required:
        - action
        - commitmentNumber
      properties:
        action:
          $ref: '#/components/schemas/ActionType'
        commitmentNumber:
          type: string
        name:
          type: string
        customFields:
          type: object
          additionalProperties: true
          title: CommitmentSegmentCustomFields
        periods:
          $ref: '#/components/schemas/CommitmentPeriodsRequest'
          periods:
            type: array
            items:
              $ref: ./UpsertCommitmentPeriodInput.yaml
    ActionType:
      type: string
      enum:
        - create
        - update
    CommitmentPeriodsRequest:
      type: array
      items:
        type: object
        properties:
          startDate:
            type: string
            format: date
          endDate:
            type: string
            format: date
          amount:
            type: number
            format: double
          action:
            $ref: actiontypecreate.yaml
        required:
          - startDate
          - endDate
          - amount
      title: CommitmentPeriodInput
    CommitmentInput:
      type: object
      title: CreateCommitmentRequest
      allOf:
        - $ref: '#/components/schemas/CommitmentBaseAttributesRequest'
        - $ref: '#/components/schemas/CommonRevenueAttributes'
        - $ref: '#/components/schemas/CommonTaxationAttributes'
        - properties:
            currency:
              type: string
      required:
        - currency
    CommitmentBaseAttributesRequest:
      type: object
      title: UpsertOrderCommitmentBaseAttributes
      properties:
        commitmentNumber:
          type: string
          maxLength: 100
        name:
          type: string
          maxLength: 255
        type:
          $ref: '#/components/schemas/CommitmentTypeEnum'
        priority:
          type: integer
        associationRules:
          $ref: '#/components/schemas/AssociationRuleRequest'
        customFields:
          type: object
          additionalProperties: true
          title: CommitmentCustomFields
        periods:
          $ref: '#/components/schemas/CommitmentPeriodsRequest'
      required:
        - associationRules
        - name
        - type
        - priority
        - periods
    POSTOrderAsyncRequestType:
      properties:
        category:
          default: NewSales
          enum:
            - NewSales
            - Return
          type: string
        customFields:
          $ref: '#/components/schemas/OrderObjectCustomFields'
        existingAccountId:
          type: string
        existingAccountNumber:
          maxLength: 70
          type: string
        externallyManagedBy:
          enum:
            - Amazon
            - Apple
            - Google
            - Roku
          type: string
        newAccount:
          $ref: '#/components/schemas/CreateOrderNewAccount'
        orderDate:
          format: date
          type: string
        orderLineItems:
          items:
            $ref: '#/components/schemas/CreateOrderOrderLineItem'
          type: array
        orderNumber:
          maxLength: 100
          type: string
        processingOptions:
          $ref: '#/components/schemas/processingOptionsOrdersAsync'
        reasonCode:
          maxLength: 255
          type: string
        subscriptions:
          items:
            properties:
              customFields:
                $ref: '#/components/schemas/SubscriptionObjectCustomFields'
              notes:
                type: string
                maxLength: 1000
              orderActions:
                items:
                  $ref: '#/components/schemas/CreateOrderOrderAction'
                type: array
              quote:
                $ref: '#/components/schemas/QuoteObjectFields'
              ramp:
                $ref: '#/components/schemas/RampRequest'
              subscriptionNumber:
                type: string
            type: object
          type: array
      required:
        - orderDate
      type: object
    processingOptionsOrdersAsync:
      properties:
        applicationOrder:
          items:
            type: string
          type: array
        applyCredit:
          type: boolean
        applyCreditBalance:
          type: boolean
        billingOptions:
          properties:
            creditMemoReasonCode:
              type: string
            documentDate:
              format: date
              type: string
            generateDraftInvoice:
              type: boolean
            targetDate:
              format: date
              type: string
            chargeTypeToExclude:
              items:
                type: string
                enum:
                  - OneTime
                  - Recurring
                  - Usage
              type: array
          type: object
        collectPayment:
          type: boolean
        electronicPaymentOptions:
          properties:
            paymentGatewayId:
              type: string
            paymentMethodId:
              type: string
            gatewayOptions:
              type: object
              title: gatewayOptions
              additionalProperties:
                type: string
          type: object
        runBilling:
          type: boolean
      type: object
    GetOrderResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            order:
              $ref: '#/components/schemas/Order'
          type: object
    PUTOrderRequestType:
      properties:
        category:
          default: NewSales
          enum:
            - NewSales
            - Return
          type: string
        commitments:
          items:
            $ref: '#/components/schemas/UpsertCommitmentInput'
          type: array
        customFields:
          $ref: '#/components/schemas/OrderObjectCustomFields'
        existingAccountId:
          type: string
        existingAccountNumber:
          maxLength: 70
          type: string
        orderDate:
          format: date
          type: string
        orderNumber:
          maxLength: 100
          type: string
        processingOptions:
          $ref: '#/components/schemas/processingOptionsOrders'
        reasonCode:
          maxLength: 255
          type: string
        schedulingOptions:
          properties:
            scheduledDate:
              format: date
              type: string
            scheduledDatePolicy:
              enum:
                - SpecificDate
              type: string
          type: object
        status:
          enum:
            - Draft
            - Pending
            - Completed
            - Scheduled
            - Executing
            - Failed
          type: string
        subscriptions:
          items:
            properties:
              customFields:
                $ref: '#/components/schemas/SubscriptionObjectCustomFields'
              orderActions:
                items:
                  $ref: '#/components/schemas/CreateOrderOrderAction'
                type: array
              quote:
                $ref: '#/components/schemas/QuoteObjectFields'
              ramp:
                $ref: '#/components/schemas/RampRequest'
              subscriptionNumber:
                type: string
            type: object
          type: array
      required:
        - orderDate
      type: object
    PutOrderResponseType:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            accountId:
              maxLength: 32
              type: string
            accountNumber:
              maxLength: 50
              type: string
            creditMemoIds:
              items:
                type: string
                maxLength: 32
              type: array
            creditMemoNumbers:
              items:
                type: string
                maxLength: 255
              type: array
            invoiceIds:
              items:
                type: string
                maxLength: 32
              type: array
            invoiceNumbers:
              items:
                type: string
                maxLength: 255
              type: array
            orderId:
              maxLength: 32
              type: string
            orderNumber:
              maxLength: 100
              type: string
            paidAmount:
              maxLength: 22
              minLength: 9
              type: string
            paymentId:
              maxLength: 32
              type: string
            paymentNumber:
              maxLength: 32
              type: string
            ramps:
              items:
                properties:
                  rampNumber:
                    maxLength: 50
                    type: string
                  subscriptionNumber:
                    maxLength: 150
                    type: string
                type: object
              type: array
            refunds:
              items:
                properties:
                  number:
                    maxLength: 32
                    type: string
                  refundInvoiceNumbers:
                    items:
                      type: string
                      maxLength: 255
                    type: array
                  status:
                    enum:
                      - Success
                      - Error
                    type: string
                type: object
              type: array
            status:
              enum:
                - Draft
                - Pending
                - Completed
                - Scheduled
              type: string
            subscriptionIds:
              items:
                type: string
                maxLength: 32
              type: array
            subscriptionOwnerId:
              type: string
            subscriptionOwnerNumber:
              type: string
            subscriptions:
              items:
                properties:
                  status:
                    enum:
                      - Active
                      - Pending Activation
                      - Pending Acceptance
                      - Cancelled
                      - Suspended
                    type: string
                  subscriptionId:
                    maxLength: 32
                    type: string
                  subscriptionNumber:
                    maxLength: 150
                    type: string
                type: object
              type: array
            writeOff:
              items:
                properties:
                  amount:
                    maximum: 22
                    minimum: 9
                    type: number
                  failedReason:
                    type: string
                  invoiceNumber:
                    maxLength: 255
                    type: string
                  status:
                    enum:
                      - Success
                      - Failed
                    type: string
                  writeOffCreditMemoNumber:
                    maxLength: 255
                    type: string
                type: object
              type: array
            commitments:
              $ref: ./Commitment/CommitmentOutput.yaml
          type: object
    processingOptionsOrders:
      properties:
        applicationOrder:
          items:
            type: string
          type: array
        applyCredit:
          type: boolean
        applyCreditBalance:
          type: boolean
        billingOptions:
          properties:
            creditMemoReasonCode:
              type: string
            documentDate:
              format: date
              type: string
            generateDraftInvoice:
              type: boolean
            targetDate:
              format: date
              type: string
          type: object
        collectPayment:
          type: boolean
        electronicPaymentOptions:
          properties:
            paymentGatewayId:
              type: string
            paymentMethodId:
              type: string
            gatewayOptions:
              type: object
              title: gatewayOptions
              additionalProperties:
                type: string
          type: object
        refund:
          type: boolean
        refundAmount:
          type: number
        refundReasonCode:
          type: string
        runBilling:
          type: boolean
        writeOff:
          type: boolean
        writeOffBehavior:
          properties:
            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
          type: object
      type: object
    DeleteOrderAsyncResponse:
      properties:
        jobId:
          type: string
        success:
          type: boolean
      type: object
    GetAsyncOrderJobResponse:
      properties:
        errors:
          type: string
          nullable: true
        result:
          $ref: '#/components/schemas/GetAsyncOrderJobResponseResult'
        status:
          enum:
            - Processing
            - Failed
            - Completed
          type: string
        success:
          type: boolean
      type: object
    GetAsyncOrderJobResponseResult:
      oneOf:
        - $ref: '#/components/schemas/GetAsyncCreateOrderJobResponse'
        - $ref: '#/components/schemas/GetAsyncPreviewOrderJobResponse'
      discriminator:
        propertyName: jobType
        mapping:
          AsyncCreateOrder: '#/components/schemas/GetAsyncCreateOrderJobResponse'
          AsyncPreviewOrder: '#/components/schemas/GetAsyncPreviewOrderJobResponse'
    GetAsyncCreateOrderJobResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - $ref: '#/components/schemas/CreateOrderResult'
        - type: object
          properties:
            jobType:
              type: string
              enum:
                - AsyncCreateOrder
              default: AsyncCreateOrder
    GetAsyncPreviewOrderJobResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - $ref: '#/components/schemas/PreviewOrderResult'
        - type: object
          properties:
            jobType:
              type: string
              enum:
                - AsyncPreviewOrder
              default: AsyncPreviewOrder
    GetOrdersResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            nextPage:
              format: URL
              type: string
            orders:
              items:
                $ref: '#/components/schemas/Order'
              type: array
          type: object
    PUTOrderPatchRequestType:
      properties:
        customFields:
          $ref: '#/components/schemas/OrderObjectCustomFields'
        subscriptions:
          items:
            properties:
              orderActions:
                items:
                  properties:
                    customFields:
                      $ref: '#/components/schemas/OrderActionObjectCustomFields'
                    orderActionId:
                      type: string
                    sequence:
                      type: integer
                  type: object
                type: array
              subscriptionNumber:
                type: string
            type: object
          type: array
      type: object
    PUTSubscriptionPatchRequestType:
      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/OrdersRatePlanObjectCustomFields'
              ratePlanId:
                type: string
            type: object
          type: array
      type: object
    PUTOrderActionTriggerDatesRequestType:
      properties:
        subscriptions:
          items:
            properties:
              orderActions:
                items:
                  properties:
                    charges:
                      items:
                        properties:
                          chargeNumber:
                            type: string
                          specificTriggerDate:
                            format: date
                            type: string
                        type: object
                      type: array
                    sequence:
                      type: integer
                    triggerDates:
                      items:
                        properties:
                          name:
                            enum:
                              - ServiceActivation
                              - CustomerAcceptance
                            type: string
                          triggerDate:
                            format: date
                            type: string
                        type: object
                      type: array
                  required:
                    - sequence
                  type: object
                type: array
              subscriptionNumber:
                maxLength: 100
                type: string
            required:
              - subscriptionNumber
            type: object
          type: array
      type: object
    PUTOrderTriggerDatesResponseType:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            accountNumber:
              type: string
            orderNumber:
              type: string
            status:
              enum:
                - Completed
                - Pending
              type: string
            subscriptions:
              items:
                properties:
                  status:
                    enum:
                      - Active
                      - Pending Activation
                      - Pending Acceptance
                    type: string
                  subscriptionNumber:
                    type: string
                type: object
              type: array
          type: object
    PutOrderCancelResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            accountNumber:
              type: string
            cancelReason:
              type: string
            orderNumber:
              type: string
            status:
              enum:
                - Cancelled
              type: string
          type: object
    RevertOrderRequest:
      properties:
        orderDate:
          format: date
          type: string
      required:
        - orderDate
      title: RevertOrderRequest
      type: object
    RevertOrderResponse:
      allOf:
        - properties:
            accountNumber:
              type: string
            orderNumber:
              type: string
            subscriptionNumbers:
              items:
                type: string
              type: array
            success:
              type: boolean
            status:
              enum:
                - Completed
              type: string
          type: object
    PUTOrderActionsRequestType:
      type: object
      allOf:
        - $ref: '#/components/schemas/OrderActionCommon'
    OrderActionCommon:
      properties:
        changeReason:
          type: string
        customFields:
          $ref: '#/components/schemas/OrderActionCustomFields'
      title: OrderAction
      type: object
    OrderActionCustomFields:
      additionalProperties: {}
      title: OrderActionCustomFields
      type: object
    GetOrderLineItemResponseType:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            orderLineItem:
              $ref: '#/components/schemas/OrderLineItem'
          type: object
    OrderLineItem:
      allOf:
        - properties:
            amount:
              type: number
            amountWithoutTax:
              type: number
            id:
              format: UUID
              type: string
            invoiceGroupNumber:
              type: string
              maxLength: 255
              nullable: true
            quantityFulfilled:
              type: number
            quantityPendingFulfillment:
              type: number
          type: object
        - $ref: '#/components/schemas/OrderLineItemCommonRetrieveOrderLineItem'
        - properties:
            fulfillments:
              items:
                $ref: '#/components/schemas/FulfillmentGet'
              type: array
          type: object
    OrderLineItemCommonRetrieveOrderLineItem:
      properties:
        UOM:
          type: string
        accountingCode:
          type: string
        adjustmentLiabilityAccountingCode:
          type: string
        adjustmentRevenueAccountingCode:
          type: string
        amendedByOrderOn:
          format: date
          type: string
        amountPerUnit:
          type: number
        billTargetDate:
          format: date
          type: string
        billTo:
          type: string
        billToSnapshotId:
          type: string
        billingRule:
          enum:
            - TriggerWithoutFulfillment
            - TriggerAsFulfillmentOccurs
          type: string
        contractAssetAccountingCode:
          type: string
        contractLiabilityAccountingCode:
          type: string
        contractRecognizedRevenueAccountingCode:
          type: string
        currency:
          type: string
        customFields:
          $ref: '#/components/schemas/OrderLineItemCustomFieldsRetrieveOrderLineItem'
        deferredRevenueAccountingCode:
          type: string
        discount:
          type: number
        excludeItemBillingFromRevenueAccounting:
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          type: boolean
        inlineDiscountPerUnit:
          type: number
        inlineDiscountType:
          enum:
            - Percentage
            - FixedAmount
            - None
          type: string
        invoiceOwnerAccountId:
          type: string
        invoiceOwnerAccountName:
          type: string
        invoiceOwnerAccountNumber:
          type: string
        isAllocationEligible:
          type: boolean
        isUnbilled:
          type: boolean
        itemCategory:
          default: Sales
          enum:
            - Sales
            - Return
          type: string
        itemName:
          type: string
        itemNumber:
          type: string
        itemState:
          enum:
            - Executing
            - Booked
            - SentToBilling
            - Complete
            - Cancelled
          type: string
        itemType:
          enum:
            - Product
            - Fee
            - Services
          type: string
        listPrice:
          type: number
        listPricePerUnit:
          type: number
        originalOrderDate:
          format: date
          type: string
        originalOrderId:
          type: string
        originalOrderLineItemId:
          type: string
        originalOrderLineItemNumber:
          type: string
        originalOrderNumber:
          type: string
        ownerAccountId:
          type: string
        ownerAccountName:
          type: string
        ownerAccountNumber:
          type: string
        productCode:
          type: string
        productRatePlanChargeId:
          type: string
        purchaseOrderNumber:
          type: string
        quantity:
          type: number
        quantityAvailableForReturn:
          type: number
        quantityFulfilled:
          type: number
        quantityPendingFulfillment:
          type: number
        recognizedRevenueAccountingCode:
          type: string
        relatedSubscriptionNumber:
          type: string
        requiresFulfillment:
          type: boolean
        revenueRecognitionRule:
          type: string
        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
        sequenceSetId:
          type: string
          nullable: true
        communicationProfileId:
          type: string
          nullable: true
        shipTo:
          type: string
        shipToSnapshotId:
          type: string
        soldTo:
          type: string
        soldToSnapshotId:
          type: string
        taxCode:
          type: string
        taxMode:
          enum:
            - TaxInclusive
            - TaxExclusive
          type: string
        transactionEndDate:
          format: date
          type: string
        transactionStartDate:
          format: date
          type: string
        unbilledReceivablesAccountingCode:
          type: string
      title: OrderLineItem
      type: object
    FulfillmentGet:
      allOf:
        - properties:
            fulfillmentNumber:
              type: string
            id:
              format: UUID
              type: string
          type: object
        - $ref: '#/components/schemas/FulfillmentCommon'
    FulfillmentCommon:
      properties:
        billTargetDate:
          format: date
          type: string
        carrier:
          type: string
        customFields:
          $ref: '#/components/schemas/FulfillmentCustomFields'
        excludeItemBillingFromRevenueAccounting:
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          type: boolean
        externalId:
          type: string
        fulfillmentDate:
          format: date
          type: string
        fulfillmentLocation:
          type: string
        fulfillmentSystem:
          type: string
        fulfillmentType:
          enum:
            - Delivery
            - Return
          type: string
        orderLineItemId:
          format: UUID
          type: string
        quantity:
          type: number
        state:
          enum:
            - Executing
            - Booked
            - SentToBilling
            - Complete
            - Cancelled
          type: string
        trackingNumber:
          type: string
      title: Fulfillment
      type: object
    FulfillmentCustomFields:
      additionalProperties: {}
      title: FulfillmentCustomFields
      type: object
    OrderLineItemCustomFieldsRetrieveOrderLineItem:
      additionalProperties: {}
      title: OrderLineItemCustomFields
      type: object
    PUTOrderLineItemRequestType:
      allOf:
        - $ref: '#/components/schemas/PutOrderLineItemUpdateType'
    PutOrderLineItemResponseType:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
    PutOrderLineItemUpdateType:
      allOf:
        - $ref: '#/components/schemas/OrderLineItemCommon'
    OrderLineItemCommon:
      properties:
        UOM:
          type: string
        accountingCode:
          type: string
        adjustmentLiabilityAccountingCode:
          type: string
        adjustmentRevenueAccountingCode:
          type: string
        amountPerUnit:
          type: number
        billTargetDate:
          format: date
          type: string
        billTo:
          type: string
        billingRule:
          default: TriggerWithoutFulfillment
          enum:
            - TriggerWithoutFulfillment
            - TriggerAsFulfillmentOccurs
          type: string
        contractAssetAccountingCode:
          type: string
        contractLiabilityAccountingCode:
          type: string
        contractRecognizedRevenueAccountingCode:
          type: string
        customFields:
          $ref: '#/components/schemas/OrderLineItemCustomFields'
        deferredRevenueAccountingCode:
          type: string
        excludeItemBillingFromRevenueAccounting:
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          type: boolean
        inlineDiscountPerUnit:
          type: number
        inlineDiscountType:
          enum:
            - Percentage
            - FixedAmount
            - None
          type: string
        isAllocationEligible:
          type: boolean
        isUnbilled:
          type: boolean
        itemName:
          type: string
        itemState:
          enum:
            - Executing
            - Booked
            - SentToBilling
            - Complete
            - Canceled
          type: string
        itemType:
          enum:
            - Product
            - Fee
            - Services
          type: string
        listPricePerUnit:
          type: number
        ownerAccountNumber:
          type: string
        productCode:
          type: string
        purchaseOrderNumber:
          type: string
        quantity:
          type: number
        recognizedRevenueAccountingCode:
          type: string
        relatedSubscriptionNumber:
          type: string
        revenueRecognitionRule:
          type: string
        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
        invoiceGroupNumber:
          type: string
          maxLength: 255
          nullable: true
        sequenceSetId:
          type: string
        paymentTerm:
          type: string
        invoiceTemplateId:
          type: string
        shipTo:
          type: string
        soldTo:
          type: string
        taxCode:
          type: string
        taxMode:
          enum:
            - TaxInclusive
            - TaxExclusive
          type: string
        transactionEndDate:
          format: date
          type: string
        transactionStartDate:
          format: date
          type: string
        unbilledReceivablesAccountingCode:
          type: string
      title: OrderLineItem
      type: object
    PostOrderLineItemsRequestType:
      properties:
        orderLineItems:
          items:
            $ref: '#/components/schemas/PostOrderLineItemUpdateType'
          type: array
        processingOptions:
          $ref: '#/components/schemas/ProcessingOptions'
      type: object
    PostOrderLineItemUpdateType:
      allOf:
        - properties:
            id:
              format: UUID
              type: string
          required:
            - id
          type: object
        - $ref: '#/components/schemas/OrderLineItemCommon'
    ProcessingOptions:
      properties:
        billingOptions:
          $ref: '#/components/schemas/BillingOptions'
        runBilling:
          type: boolean
      type: object
    BillingOptions:
      properties:
        documentDate:
          format: date
          type: string
        targetDate:
          format: date
          type: string
      type: object
    PostFulfillmentsRequestType:
      properties:
        fulfillments:
          items:
            $ref: '#/components/schemas/FulfillmentPost'
          type: array
        processingOptions:
          $ref: '#/components/schemas/ProcessingOptions'
      type: object
    PostFulfillmentsResponseType:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            creditMemoNumbers:
              items:
                type: string
              type: array
            fulfillments:
              items:
                properties:
                  fulfillmentItems:
                    items:
                      properties:
                        id:
                          format: UUID
                          type: string
                      type: object
                    type: array
                  fulfillmentNumber:
                    type: string
                  id:
                    format: UUID
                    type: string
                type: object
              type: array
            invoiceNumbers:
              items:
                type: string
              type: array
            paidAmount:
              type: number
            paymentNumber:
              type: string
          type: object
    FulfillmentPost:
      allOf:
        - properties:
            orderLineItemId:
              format: UUID
              type: string
          type: object
        - $ref: '#/components/schemas/FulfillmentCommon'
        - properties:
            fulfillmentItems:
              items:
                $ref: '#/components/schemas/FulfillmentItemPostFromFulfillmentPost'
              type: array
          type: object
    FulfillmentItemPostFromFulfillmentPost:
      allOf:
        - $ref: '#/components/schemas/FulfillmentItemCommon'
    FulfillmentItemCommon:
      properties:
        customFields:
          $ref: '#/components/schemas/FulfillmentItemCustomFields'
        itemIdentifier:
          type: string
      title: FulfillmentItem
      type: object
    FulfillmentItemCustomFields:
      additionalProperties: {}
      title: FulfillmentItemCustomFields
      type: object
    GetFulfillmentResponseType:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            fulfillment:
              $ref: '#/components/schemas/FulfillmentGet'
          type: object
    PutFulfillmentRequestType:
      properties:
        billTargetDate:
          format: date
          type: string
        carrier:
          type: string
        customFields:
          $ref: '#/components/schemas/FulfillmentCustomFields'
        externalId:
          type: string
        fulfillmentDate:
          format: date
          type: string
        fulfillmentLocation:
          type: string
        fulfillmentSystem:
          type: string
        quantity:
          type: number
        state:
          enum:
            - Executing
            - Booked
            - SentToBilling
            - Complete
            - Cancelled
          type: string
        trackingNumber:
          type: string
      type: object
    PostFulfillmentItemsRequestType:
      properties:
        fulfillmentItems:
          items:
            $ref: '#/components/schemas/FulfillmentItemPost'
          type: array
      type: object
    PostFulfillmentItemsResponseType:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            fulfillmentItems:
              items:
                properties:
                  id:
                    format: UUID
                    type: string
                type: object
              type: array
          type: object
    FulfillmentItemPost:
      allOf:
        - properties:
            fulfillmentNumber:
              type: string
          type: object
        - $ref: '#/components/schemas/FulfillmentItemCommon'
    GetFulfillmentItemResponseType:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            fulfillmentItem:
              $ref: '#/components/schemas/FulfillmentItemGet'
          type: object
    FulfillmentItemGet:
      allOf:
        - properties:
            fulfillmentId:
              format: UUID
              type: string
            id:
              format: UUID
              type: string
          type: object
        - $ref: '#/components/schemas/FulfillmentItemCommon'
    PutFulfillmentItemRequestType:
      properties:
        customFields:
          $ref: '#/components/schemas/FulfillmentItemCustomFields'
        itemIdentifier:
          type: string
      type: object
    GETRampByRampNumberResponseType:
      allOf:
        - properties:
            ramp:
              $ref: '#/components/schemas/RampResponse'
          type: object
        - $ref: '#/components/schemas/CommonResponse'
    GETRampMetricsByRampNumberResponseType:
      allOf:
        - properties:
            rampMetrics:
              $ref: '#/components/schemas/RampMetrics'
          type: object
        - $ref: '#/components/schemas/CommonResponse'
    RampMetrics:
      properties:
        discountTcb:
          type: number
        discountTcv:
          type: number
        grossTcb:
          type: number
        grossTcv:
          type: number
        intervals:
          items:
            $ref: '#/components/schemas/RampIntervalMetrics'
          type: array
        name:
          type: string
        netTcb:
          type: number
        netTcv:
          type: number
        number:
          type: string
      type: object
    RampIntervalMetrics:
      properties:
        discountTcb:
          type: number
        discountTcv:
          type: number
        endDate:
          format: date
          type: string
        grossTcb:
          type: number
        grossTcv:
          type: number
        intervalMetrics:
          items:
            $ref: '#/components/schemas/RampIntervalChargeMetrics'
          type: array
        name:
          type: string
        netTcb:
          type: number
        netTcv:
          type: number
        startDate:
          format: date
          type: string
      type: object
    GETRampsBySubscriptionKeyResponseType:
      allOf:
        - properties:
            ramps:
              items:
                $ref: '#/components/schemas/RampResponse'
              type: array
          type: object
        - $ref: '#/components/schemas/CommonResponse'
    GETRampMetricsBySubscriptionKeyResponseType:
      allOf:
        - properties:
            rampMetrics:
              $ref: '#/components/schemas/RampMetrics'
          type: object
        - $ref: '#/components/schemas/CommonResponse'
    GETRampMetricsByOrderNumberResponseType:
      allOf:
        - properties:
            rampMetrics:
              items:
                $ref: '#/components/schemas/OrderRampMetrics'
              type: array
          type: object
        - $ref: '#/components/schemas/CommonResponse'
    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
    GetOrderActionRatePlanResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            amendment:
              $ref: '#/components/schemas/OrderActionRatePlanAmendment'
            externallyManagedPlanId:
              type: string
            id:
              type: string
            lastChangeType:
              type: string
            order:
              $ref: '#/components/schemas/OrderActionRatePlanOrder'
            productId:
              type: string
            productName:
              type: string
            productRatePlanId:
              type: string
            productSku:
              type: string
            ratePlanName:
              type: string
            subscriptionId:
              type: string
            subscriptionVersion: {}
          type: object
    OrderActionRatePlanAmendment:
      properties:
        code:
          type: string
        contractEffectiveDate:
          format: date
          type: string
        createdBy:
          type: string
        createdDate:
          format: datetime
          type: string
        customerAcceptanceDate:
          format: date
          type: string
        effectiveDate:
          format: date
          type: string
        id:
          type: string
        name:
          type: string
        serviceActivationDate:
          format: date
          type: string
        type:
          type: string
        updatedBy:
          type: string
        updatedDate:
          format: datetime
          type: string
        customFields:
          additionalProperties: {}
          type: object
    OrderActionRatePlanOrder:
      properties:
        id:
          type: string
        orderActions:
          items:
            $ref: '#/components/schemas/OrderActionRatePlanOrderAction'
          type: array
        orderNumber:
          type: string
      type: object
    OrderActionRatePlanOrderAction:
      properties:
        addProduct:
          $ref: '#/components/schemas/OrderActionRatePlanRatePlanOverride'
        id:
          type: string
        removeProduct:
          $ref: '#/components/schemas/OrderActionRatePlanRemoveProduct'
        type:
          enum:
            - AddProduct
            - UpdateProduct
            - RemoveProduct
          type: string
        updateProduct:
          $ref: '#/components/schemas/OrderActionRatePlanRatePlanUpdate'
        customFields:
          $ref: '#/components/schemas/OrderActionRatePlanOrderActionObjectCustomFields'
      type: object
    OrderActionRatePlanRatePlanOverride:
      properties:
        chargeOverrides:
          items:
            $ref: '#/components/schemas/OrderActionRatePlanChargeOverride'
          type: array
        customFields:
          $ref: '#/components/schemas/OrderActionRatePlanRatePlanObjectCustomFields'
        newRatePlanId:
          type: string
        productRatePlanId:
          type: string
        uniqueToken:
          maxLength: 50
          type: string
      required:
        - productRatePlanId
      title: ratePlan
      type: object
    OrderActionRatePlanRemoveProduct:
      properties:
        ratePlanId:
          type: string
        uniqueToken:
          type: string
      title: removeProduct
      type: object
    OrderActionRatePlanRatePlanUpdate:
      properties:
        chargeUpdates:
          items:
            $ref: '#/components/schemas/OrderActionRatePlanChargeUpdate'
          type: array
        customFields:
          $ref: '#/components/schemas/OrderActionRatePlanRatePlanObjectCustomFields'
        newRatePlanId:
          type: string
        ratePlanId:
          type: string
        specificUpdateDate:
          format: date
          type: string
        uniqueToken:
          type: string
      title: updateProduct
      type: object
    OrderActionRatePlanOrderActionObjectCustomFields:
      additionalProperties: {}
      title: orderActionFieldsCustom
      type: object
    OrderActionRatePlanChargeUpdate:
      properties:
        billing:
          allOf:
            - $ref: '#/components/schemas/OrderActionRatePlanBillingUpdate'
        chargeNumber:
          type: string
        customFields:
          $ref: '#/components/schemas/OrderActionRatePlanRatePlanChargeObjectCustomFields'
        effectiveDate:
          $ref: '#/components/schemas/OrderActionRatePlanTriggerParams'
        pricing:
          allOf:
            - $ref: '#/components/schemas/OrderActionRatePlanPricingUpdate'
        uniqueToken:
          type: string
      type: object
    OrderActionRatePlanRatePlanObjectCustomFields:
      additionalProperties: {}
      title: RatePlanCustomFields
      type: object
    OrderActionRatePlanBillingUpdate:
      properties:
        billingPeriodAlignment:
          enum:
            - AlignToCharge
            - AlignToSubscriptionStart
            - AlignToTermStart
          type: string
      type: object
    OrderActionRatePlanRatePlanChargeObjectCustomFields:
      additionalProperties: {}
      title: ratePlanChargeFieldsCustom
      type: object
    OrderActionRatePlanTriggerParams:
      properties:
        specificTriggerDate:
          format: date
          type: string
        triggerEvent:
          enum:
            - ContractEffective
            - ServiceActivation
            - CustomerAcceptance
          type: string
      title: startDate
      type: object
    OrderActionRatePlanPricingUpdate:
      properties:
        chargeModelData:
          allOf:
            - $ref: '#/components/schemas/OrderActionRatePlanChargeModelDataOverride'
        discount:
          allOf:
            - $ref: '#/components/schemas/OrderActionRatePlanDiscountPricingUpdate'
        recurringDelivery:
          allOf:
            - $ref: '#/components/schemas/OrderActionRatePlanRecurringDeliveryPricingUpdate'
        recurringFlatFee:
          allOf:
            - $ref: '#/components/schemas/OrderActionRatePlanRecurringFlatFeePricingUpdate'
        recurringPerUnit:
          allOf:
            - $ref: '#/components/schemas/OrderActionRatePlanRecurringPerUnitPricingUpdate'
        recurringTiered:
          allOf:
            - $ref: '#/components/schemas/OrderActionRatePlanRecurringTieredPricingUpdate'
        recurringVolume:
          allOf:
            - $ref: '#/components/schemas/OrderActionRatePlanRecurringVolumePricingUpdate'
        usageFlatFee:
          allOf:
            - $ref: '#/components/schemas/OrderActionRatePlanUsageFlatFeePricingUpdate'
        usageOverage:
          allOf:
            - $ref: '#/components/schemas/OrderActionRatePlanUsageOveragePricingUpdate'
        usagePerUnit:
          allOf:
            - $ref: '#/components/schemas/OrderActionRatePlanUsagePerUnitPricingUpdate'
        usageTiered:
          allOf:
            - $ref: '#/components/schemas/OrderActionRatePlanUsageTieredPricingUpdate'
        usageTieredWithOverage:
          allOf:
            - $ref: '#/components/schemas/OrderActionRatePlanUsageTieredWithOveragePricingUpdate'
        usageVolume:
          allOf:
            - $ref: '#/components/schemas/OrderActionRatePlanUsageVolumePricingUpdate'
      type: object
    OrderActionRatePlanChargeModelDataOverride:
      properties:
        chargeModelConfiguration:
          properties:
            customFieldPerUnitRate:
              type: string
            customFieldTotalAmount:
              type: string
            formula:
              type: string
          type: object
        tiers:
          items:
            $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
          type: array
      title: chargeModelData
      type: object
    OrderActionRatePlanDiscountPricingUpdate:
      properties:
        applyDiscountTo:
          enum:
            - ONETIME
            - RECURRING
            - USAGE
            - ONETIMERECURRING
            - ONETIMEUSAGE
            - RECURRINGUSAGE
            - ONETIMERECURRINGUSAGE
          type: string
        discountLevel:
          enum:
            - rateplan
            - subscription
            - account
          type: string
        discountPercentage:
          type: number
        priceChangeOption:
          enum:
            - NoChange
            - UseLatestProductCatalogPricing
          type: string
      type: object
    OrderActionRatePlanRecurringDeliveryPricingUpdate:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            deliverySchedule:
              $ref: '#/components/schemas/DeliveryScheduleParams'
            listPrice:
              type: number
          type: object
    OrderActionRatePlanRecurringFlatFeePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            listPrice:
              type: number
          type: object
    OrderActionRatePlanRecurringPerUnitPricingUpdate:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            listPrice:
              type: number
            quantity:
              minimum: 0
              type: number
          type: object
    OrderActionRatePlanRecurringTieredPricingUpdate:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            quantity:
              minimum: 0
              type: number
            tiers:
              items:
                $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
              type: array
          type: object
    OrderActionRatePlanRecurringVolumePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            quantity:
              minimum: 0
              type: number
            tiers:
              items:
                $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
              type: array
          type: object
    OrderActionRatePlanUsageFlatFeePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            listPrice:
              type: number
          type: object
    OrderActionRatePlanUsageOveragePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            includedUnits:
              type: number
            overagePrice:
              type: number
          type: object
    OrderActionRatePlanUsagePerUnitPricingUpdate:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            listPrice:
              type: number
          type: object
    OrderActionRatePlanUsageTieredPricingUpdate:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            tiers:
              items:
                $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
              type: array
          type: object
    OrderActionRatePlanUsageTieredWithOveragePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            overagePrice:
              type: number
            tiers:
              items:
                $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
              type: array
          type: object
    OrderActionRatePlanUsageVolumePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            tiers:
              items:
                $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
              type: array
          type: object
    OrderActionRatePlanPriceChangeParams:
      properties:
        priceChangeOption:
          enum:
            - NoChange
            - SpecificPercentageValue
            - UseLatestProductCatalogPricing
          type: string
        priceIncreasePercentage:
          minimum: -100
          type: number
      type: object
    OrderActionRatePlanChargeTier:
      properties:
        endingUnit:
          type: number
        price:
          type: number
        priceFormat:
          enum:
            - FlatFee
            - PerUnit
          type: string
        startingUnit:
          type: number
        tier:
          minimum: 1
          type: integer
      required:
        - tier
        - startingUnit
        - price
        - priceFormat
      title: chargeTier
      type: object
    OrderActionRatePlanChargeOverride:
      properties:
        billing:
          properties:
            billCycleDay:
              maximum: 31
              minimum: 0
              type: integer
            billCycleType:
              enum:
                - DefaultFromCustomer
                - SpecificDayofMonth
                - SubscriptionStartDay
                - ChargeTriggerDay
                - SpecificDayofWeek
              type: string
            billingPeriod:
              enum:
                - Month
                - Quarter
                - Semi_Annual
                - Annual
                - Eighteen_Months
                - Two_Years
                - Three_Years
                - Five_Years
                - Specific_Months
                - Subscription_Term
                - Week
                - Specific_Weeks
              type: string
            billingPeriodAlignment:
              enum:
                - AlignToCharge
                - AlignToSubscriptionStart
                - AlignToTermStart
              type: string
            billingTiming:
              enum:
                - IN_ADVANCE
                - IN_ARREARS
              type: string
            specificBillingPeriod:
              type: integer
            weeklyBillCycleDay:
              enum:
                - Sunday
                - Monday
                - Tuesday
                - Wednesday
                - Thursday
                - Friday
                - Saturday
              type: string
          type: object
        chargeNumber:
          maxLength: 50
          type: string
        customFields:
          $ref: '#/components/schemas/OrderActionRatePlanRatePlanChargeObjectCustomFields'
        endDate:
          $ref: '#/components/schemas/OrderActionRatePlanEndConditions'
        pricing:
          properties:
            chargeModelData:
              $ref: '#/components/schemas/OrderActionRatePlanChargeModelDataOverride'
            discount:
              $ref: '#/components/schemas/OrderActionRatePlanDiscountPricingOverride'
            oneTimeFlatFee:
              $ref: '#/components/schemas/OrderActionRatePlanOneTimeFlatFeePricingOverride'
            oneTimePerUnit:
              $ref: '#/components/schemas/OrderActionRatePlanOneTimePerUnitPricingOverride'
            oneTimeTiered:
              $ref: '#/components/schemas/OrderActionRatePlanOneTimeTieredPricingOverride'
            oneTimeVolume:
              $ref: '#/components/schemas/OrderActionRatePlanOneTimeVolumePricingOverride'
            recurringDelivery:
              $ref: '#/components/schemas/OrderActionRatePlanRecurringDeliveryPricingOverride'
            recurringFlatFee:
              $ref: '#/components/schemas/OrderActionRatePlanRecurringFlatFeePricingOverride'
            recurringPerUnit:
              $ref: '#/components/schemas/OrderActionRatePlanRecurringPerUnitPricingOverride'
            recurringTiered:
              $ref: '#/components/schemas/OrderActionRatePlanRecurringTieredPricingOverride'
            recurringVolume:
              $ref: '#/components/schemas/OrderActionRatePlanRecurringVolumePricingOverride'
            usageFlatFee:
              $ref: '#/components/schemas/OrderActionRatePlanUsageFlatFeePricingOverride'
            usageOverage:
              $ref: '#/components/schemas/OrderActionRatePlanUsageOveragePricingOverride'
            usagePerUnit:
              $ref: '#/components/schemas/OrderActionRatePlanUsagePerUnitPricingOverride'
            usageTiered:
              $ref: '#/components/schemas/OrderActionRatePlanUsageTieredPricingOverride'
            usageTieredWithOverage:
              $ref: '#/components/schemas/OrderActionRatePlanUsageTieredWithOveragePricingOverride'
            usageVolume:
              $ref: '#/components/schemas/OrderActionRatePlanUsageVolumePricingOverride'
          type: object
        productRatePlanChargeId:
          type: string
        revRecCode:
          maxLength: 70
          type: string
        revRecTriggerCondition:
          enum:
            - Contract Effective Date
            - Service Activation Date
            - Customer Acceptance Date
          type: string
        revenueRecognitionRuleName:
          enum:
            - Recognize upon invoicing
            - Recognize daily over time
          type: string
        startDate:
          $ref: '#/components/schemas/OrderActionRatePlanTriggerParams'
        uniqueToken:
          maxLength: 50
          type: string
      required:
        - productRatePlanChargeId
      title: charge
      type: object
    OrderActionRatePlanEndConditions:
      properties:
        endDateCondition:
          enum:
            - Subscription_End
            - Fixed_Period
            - Specific_End_Date
          type: string
        specificEndDate:
          format: date
          type: string
        upToPeriods:
          type: integer
        upToPeriodsType:
          enum:
            - Billing_Periods
            - Days
            - Weeks
            - Months
            - Years
          type: string
      title: endDate
      type: object
    OrderActionRatePlanDiscountPricingOverride:
      properties:
        applyDiscountTo:
          enum:
            - ONETIME
            - RECURRING
            - USAGE
            - ONETIMERECURRING
            - ONETIMEUSAGE
            - RECURRINGUSAGE
            - ONETIMERECURRINGUSAGE
          type: string
        discountAmount:
          type: number
        discountLevel:
          enum:
            - rateplan
            - subscription
            - account
          type: string
        discountPercentage:
          type: number
        priceChangeOption:
          enum:
            - NoChange
            - UseLatestProductCatalogPricing
          type: string
      title: discount
      type: object
    OrderActionRatePlanOneTimeFlatFeePricingOverride:
      properties:
        listPrice:
          type: number
      required:
        - listPrice
      title: oneTimeFlatFee
      type: object
    OrderActionRatePlanOneTimePerUnitPricingOverride:
      properties:
        listPrice:
          type: number
        quantity:
          minimum: 0
          type: number
      title: oneTimePerUnit
      type: object
    OrderActionRatePlanOneTimeTieredPricingOverride:
      properties:
        quantity:
          minimum: 0
          type: number
        tiers:
          items:
            $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
          type: array
      title: oneTimeTiered
      type: object
    OrderActionRatePlanOneTimeVolumePricingOverride:
      properties:
        quantity:
          minimum: 0
          type: number
        tiers:
          items:
            $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
          type: array
      title: oneTimeVolume
      type: object
    OrderActionRatePlanRecurringDeliveryPricingOverride:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            deliverySchedule:
              $ref: '#/components/schemas/DeliveryScheduleParams'
            listPrice:
              type: number
          type: object
      title: recurringDelivery
    OrderActionRatePlanRecurringFlatFeePricingOverride:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            listPrice:
              type: number
            listPriceBase:
              enum:
                - Per_Billing_Period
                - Per_Month
                - Per_Week
                - Per_Year
                - Per_Specific_Months
              type: string
            specificListPriceBase:
              format: int32
              maximum: 200
              minimum: 1
              type: integer
          type: object
      title: recurringFlatFee
    OrderActionRatePlanRecurringPerUnitPricingOverride:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            listPrice:
              type: number
            listPriceBase:
              enum:
                - Per_Billing_Period
                - Per_Month
                - Per_Week
                - Per_Year
                - Per_Specific_Months
              type: string
            quantity:
              minimum: 0
              type: number
            specificListPriceBase:
              format: int32
              maximum: 200
              minimum: 1
              type: integer
          type: object
      title: recurringPerUnit
    OrderActionRatePlanRecurringTieredPricingOverride:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            listPriceBase:
              enum:
                - Per_Billing_Period
                - Per_Month
                - Per_Week
                - Per_Year
                - Per_Specific_Months
              type: string
            quantity:
              minimum: 0
              type: number
            specificListPriceBase:
              format: int32
              maximum: 200
              minimum: 1
              type: integer
            tiers:
              items:
                $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
              type: array
          type: object
      title: recurringTiered
    OrderActionRatePlanRecurringVolumePricingOverride:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            listPriceBase:
              enum:
                - Per_Billing_Period
                - Per_Month
                - Per_Week
                - Per_Year
                - Per_Specific_Months
              type: string
            quantity:
              minimum: 0
              type: number
            specificListPriceBase:
              format: int32
              maximum: 200
              minimum: 1
              type: integer
            tiers:
              items:
                $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
              type: array
          type: object
      title: recurringVolume
    OrderActionRatePlanUsageFlatFeePricingOverride:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            listPrice:
              type: number
          type: object
      title: usageFlatFee
    OrderActionRatePlanUsageOveragePricingOverride:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            includedUnits:
              minimum: 0
              type: number
            numberOfPeriods:
              minimum: 1
              type: integer
            overagePrice:
              type: number
            overageUnusedUnitsCreditOption:
              enum:
                - NoCredit
                - CreditBySpecificRate
              type: string
            unusedUnitsCreditRates:
              type: number
          type: object
      title: usageOverage
    OrderActionRatePlanUsagePerUnitPricingOverride:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            listPrice:
              type: number
            ratingGroup:
              enum:
                - ByBillingPeriod
                - ByUsageStartDate
                - ByUsageRecord
                - ByUsageUpload
              type: string
          type: object
      title: usagePerUnit
    OrderActionRatePlanUsageTieredPricingOverride:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            ratingGroup:
              enum:
                - ByBillingPeriod
                - ByUsageStartDate
                - ByUsageRecord
                - ByUsageUpload
              type: string
            tiers:
              items:
                $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
              type: array
          type: object
      title: usageTiered
    OrderActionRatePlanUsageTieredWithOveragePricingOverride:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            numberOfPeriods:
              minimum: 1
              type: integer
            overagePrice:
              type: number
            overageUnusedUnitsCreditOption:
              enum:
                - NoCredit
                - CreditBySpecificRate
              type: string
            tiers:
              items:
                $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
              type: array
            unusedUnitsCreditRates:
              type: number
          type: object
      title: usageTieredWithOverage
    OrderActionRatePlanUsageVolumePricingOverride:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            ratingGroup:
              enum:
                - ByBillingPeriod
                - ByUsageStartDate
                - ByUsageRecord
                - ByUsageUpload
              type: string
            tiers:
              items:
                $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
              type: array
          type: object
      title: usageVolume
    CreateOmniChannelSubscriptionRequest:
      allOf:
        - properties:
            accountId:
              type: string
            externalSubscriptionId:
              type: string
            externalTransactionReason:
              type: string
            externalSourceSystem:
              type: string
            externalState:
              type: string
            state:
              type: string
            externalProductId:
              type: string
            externalReplaceByProductId:
              type: string
              nullable: true
            externalInAppOwnershipType:
              type: string
            externalQuantity:
              default: 1
              type: integer
            currency:
              type: string
            autoRenew:
              default: false
              type: boolean
            externalPurchaseDate:
              type: string
              format: datetime
            externalActivationDate:
              type: string
              format: datetime
            externalExpirationDate:
              type: string
              format: datetime
            externalApplicationId:
              type: string
            externalBundleId:
              type: string
            externalSubscriberId:
              type: string
            externalPrice:
              type: number
            externalPurchaseType:
              type: string
            externalLastRenewalDate:
              type: string
              format: datetime
            externalNextRenewalDate:
              type: string
              format: datetime
            accountIdentifierField:
              type: string
            accountData:
              $ref: '#/components/schemas/OmniChannelAccountData'
          required:
            - externalSubscriptionId
          type: object
        - $ref: '#/components/schemas/SubscriptionObjectCustomFields'
    CreateOmniChannelSubscriptionResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            subscriptionId:
              type: string
            subscriptionNumber:
              type: string
            accountId:
              type: string
            accountNumber:
              type: string
    OmniChannelAccountData:
      properties:
        accountNumber:
          maxLength: 70
          type: string
        name:
          maxLength: 255
          type: string
        currency:
          type: string
        notes:
          maxLength: 65535
          type: string
        billToContact:
          $ref: '#/components/schemas/ContactInfo'
        soldToContact:
          $ref: '#/components/schemas/ContactInfo'
        customFields:
          additionalProperties: true
          title: CustomFields
          type: object
      required:
        - billToContact
        - currency
        - name
      type: object
    GetOmniChannelSubscriptionResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            id:
              type: string
            subscriptionNumber:
              type: string
            accountId:
              type: string
            externalSubscriptionId:
              type: string
            externalTransactionReason:
              type: string
            externalSourceSystem:
              type: string
            externalState:
              type: string
            state:
              type: string
            externalProductId:
              type: string
            externalReplaceByProductId:
              type: string
              nullable: true
            externalInAppOwnershipType:
              type: string
            externalQuantity:
              default: 1
              type: integer
            currency:
              type: string
            autoRenew:
              default: false
              type: boolean
            originalPurchaseDate:
              type: string
              format: datetime
            externalPurchaseDate:
              type: string
              format: datetime
            externalActivationDate:
              type: string
              format: datetime
            externalExpirationDate:
              type: string
              format: datetime
            externalApplicationId:
              type: string
            externalBundleId:
              type: string
            externalSubscriberId:
              type: string
            externalPrice:
              type: number
            externalPurchaseType:
              type: string
            externalLastRenewalDate:
              type: string
              format: datetime
            externalNextRenewalDate:
              type: string
              format: datetime
          type: object
        - $ref: '#/components/schemas/SubscriptionObjectCustomFields'
      title: OmniChannelSubscription
    GetSubscriptionChangeLogsResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            subscriptions:
              items:
                $ref: '#/components/schemas/SubscriptionChangeLog'
              type: array
          type: object
    SubscriptionChangeLog:
      properties:
        subscriptionNumber:
          type: string
        accountNumber:
          type: string
        invoiceOwnerAccountNumber:
          type: string
        currency:
          type: string
        orderNumber:
          type: string
        version:
          format: int64
          type: integer
        changedTime:
          type: string
        type:
          type: string
          enum:
            - Standard
            - OmniChannel
        externalSubscriptionId:
          type: string
          nullable: true
        subscriptionStartDate:
          type: string
        subscriptionEndDate:
          type: string
        termStartDate:
          type: string
        termEndDate:
          type: string
        ratePlans:
          items:
            $ref: '#/components/schemas/RatePlanChangeLog'
          type: array
        fields:
          items:
            $ref: '#/components/schemas/ChangeLogField'
          type: array
      type: object
      title: Subscription
    RatePlanChangeLog:
      properties:
        ratePlanNumber:
          type: string
        ratePlanCharges:
          items:
            $ref: '#/components/schemas/RatePlanChargeChangeLog'
          type: array
        fields:
          items:
            $ref: '#/components/schemas/ChangeLogField'
          type: array
      type: object
      title: SubscriptionRatePlan
    ChangeLogField:
      properties:
        fieldName:
          type: string
        oldValue:
          type: string
          nullable: true
        newValue:
          type: string
      type: object
      title: ChangedField
    RatePlanChargeChangeLog:
      properties:
        chargeNumber:
          type: string
        ratePlanChargeId:
          type: string
        effectiveStartDate:
          type: string
        effectiveEndDate:
          type: string
        fields:
          items:
            $ref: '#/components/schemas/ChangeLogField'
          type: array
      type: object
      title: SubscriptionRatePlanCharge
    GetSubscriptionChangeLogResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            subscription:
              $ref: '#/components/schemas/SubscriptionChangeLog'
          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'
    RunMeterVersionRequest:
      type: object
      properties:
        sourceOptions:
          type: array
          items:
            type: object
            properties:
              processorId:
                type: string
              localFileId:
                type: string
        eventStoreSourceOptions:
          type: array
          items:
            type: object
            required:
              - processorId
            properties:
              processorId:
                type: string
              startDate:
                type: string
                format: date
              endDate:
                type: string
                format: date
    RunMeterVersionResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            id:
              type: string
            sessionId:
              type: string
            jobId:
              type: string
            meterId:
              type: integer
            version:
              type: string
            revision:
              type: integer
            runType:
              type: integer
              minimum: 1
              maximum: 2
            runTypeDescription:
              type: string
            startTime:
              type: string
              format: date-time
            endTime:
              type: string
              format: date-time
              nullable: true
            status:
              type: integer
              minimum: 1
              maximum: 13
            statusDescription:
              type: string
            canExportSummary:
              type: boolean
            hasLineageEnabled:
              type: boolean
    TestSpecificMeterRequest:
      type: object
      properties:
        sourceOptions:
          type: array
          items:
            $ref: '#/components/schemas/SourceOption'
        eventStoreSourceOptions:
          type: array
          items:
            $ref: '#/components/schemas/EventStoreSourceOption'
    TestSpecificMeterResponse:
      type: object
      properties:
        id:
          type: string
        sessionId:
          type: string
        jobId:
          type: string
        meterId:
          type: integer
        version:
          type: string
        revision:
          type: integer
        runType:
          type: integer
          minimum: 1
          maximum: 2
        runTypeDescription:
          type: string
        startTime:
          type: string
        endTime:
          type: string
        runStatus:
          type: string
        runStatusDescription:
          type: string
        canExportSummary:
          type: boolean
        hasLineageEnabled:
          type: boolean
    MediationErrorResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            id:
              type: string
            sessionId:
              type: string
            jobId:
              type: string
            meterId:
              type: integer
            version:
              type: string
            revision:
              type: string
            runType:
              type: integer
            runTypeDescription:
              type: string
            startTime:
              type: string
            status:
              type: integer
            statusDescription:
              type: string
            canExportSummary:
              type: boolean
            hasLineageEnabled:
              type: boolean
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
    SourceOption:
      type: object
      properties:
        processorId:
          type: string
        sampleFileId:
          type: integer
        localFileId:
          type: integer
        testData:
          type: array
          items:
            type: object
            properties:
              Amount:
                type: number
              Quantity:
                type: number
              UsageDate:
                type: string
                format: date
              CostCenter:
                type: string
              CustomerId:
                type: string
              UsageIdentifier:
                type: string
        saveTestData:
          type: boolean
        testDataName:
          type: string
        testDataId:
          type: integer
    EventStoreSourceOption:
      type: object
      properties:
        processorId:
          type: string
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
    RunStatusResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            runStatus:
              type: integer
              minimum: 1
              maximum: 13
            runStatusDescription:
              type: string
    ExportMeterResponse:
      type: object
      properties:
        name:
          type: string
        type:
          type: string
        typeDefinition:
          $ref: '#/components/schemas/MeterTypeDefinition'
        latestVersion:
          type: string
        versions:
          type: array
          items:
            $ref: '#/components/schemas/MeterVersionExportResult'
        schemas:
          type: array
          items:
            $ref: '#/components/schemas/EventSchemaExportResult'
    MeterTypeDefinition:
      type: object
      properties:
        sourceType:
          type: string
        schemaId:
          type: string
        fieldMappings:
          type: array
          items:
            $ref: '#/components/schemas/UsageFieldMapping'
        configs:
          type: object
          additionalProperties: true
    MeterVersionExportResult:
      type: object
      properties:
        version:
          type: string
        versionDetail:
          type: string
        metadata:
          type: string
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/MeterTask'
    EventSchemaExportResult:
      type: object
      properties:
        name:
          type: string
        type:
          type: integer
          minimum: 1
          maximum: 2
        schema:
          type: object
          properties:
            type:
              type: string
              enum:
                - object
            title:
              type: string
            required:
              type: array
              items:
                type: string
            properties:
              type: object
              additionalProperties:
                type: object
                properties:
                  type:
                    type: string
    MeterTask:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        nodeType:
          type: string
        operatorType:
          type: string
        metadata:
          type: object
          additionalProperties: true
        predecessors:
          type: array
          items:
            $ref: '#/components/schemas/TransitionNode'
        extraConfig:
          type: object
          additionalProperties: true
        setting:
          type: object
          additionalProperties: true
    TransitionNode:
      type: object
      properties:
        id:
          type: string
    UsageFieldMapping:
      type: object
      properties:
        name:
          type: string
        field:
          type: string
        required:
          type: boolean
        dateFormat:
          type: string
    ImportMeterRequest:
      type: object
      required:
        - file
      properties:
        file:
          type: string
          format: binary
        globalId:
          type: string
    ImportMeterResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            type:
              type: string
            typeDefinition:
              $ref: '#/components/schemas/MeterTypeDefinition'
            latestVersion:
              type: string
            globalId:
              type: string
            uniqueUploadUrl:
              type: string
            activeVersionRunStatus:
              type: integer
            activeVersionRunStatusDescription:
              type: string
            latestVersionRunStatus:
              type: integer
            latestVersionRunStatusDescription:
              type: string
            createdAt:
              type: string
            updatedAt:
              type: string
    CreateFileResponse:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        resourceId:
          type: string
        format:
          type: string
        hasHeader:
          type: boolean
        firstRow:
          type: integer
        delimiter:
          type: string
        sheet:
          type: string
        dataRange:
          type: string
        lines:
          type: integer
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    StreamingEvent:
      type: object
      properties:
        CustomerId:
          type: string
        UsageIdentifier:
          type: string
        UsageDate:
          type: string
          format: date-time
        Quantity:
          type: number
      required:
        - CustomerId
        - UsageIdentifier
        - UsageDate
        - Quantity
    StreamingIngestionSuccessResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
    StreamingIngestionAuthError:
      type: object
      properties:
        message:
          type: string
      required:
        - message
    BulkDeleteEventRequest:
      type: object
      required:
        - file
        - storeId
      properties:
        file:
          type: string
          format: binary
        storeId:
          type: integer
    BulkDeleteEventResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            queryId:
              type: string
    LatestEventStoreJobResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            id:
              type: string
            eventStoreId:
              type: string
            queryId:
              type: string
            status:
              type: integer
              minimum: 5
              maximum: 8
            operationType:
              type: string
            inputRecordCount:
              type: integer
            uniqueRecordCount:
              type: integer
            modifiedRecordCount:
              type: integer
            createdAt:
              type: string
            updatedAt:
              type: string
    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
    ProxyGetPaymentMethodSnapshot:
      properties:
        AccountId:
          type: string
        AchAbaCode:
          type: string
        AchAccountName:
          type: string
        AchAccountNumberMask:
          type: string
        AchAccountType:
          enum:
            - BusinessChecking
            - Checking
            - Saving
          type: string
        AchBankName:
          type: string
        BankBranchCode:
          type: string
        BankCheckDigit:
          type: string
        BankCity:
          type: string
        BankCode:
          type: string
        BankIdentificationNumber:
          type: string
        BankName:
          type: string
        BankPostalCode:
          type: string
        BankStreetName:
          type: string
        BankStreetNumber:
          type: string
        BankTransferAccountName:
          type: string
        BankTransferAccountNumberMask:
          type: string
        BankTransferAccountType:
          type: string
        BankTransferType:
          enum:
            - AutomatischIncasso
            - LastschriftDE
            - LastschriftAT
            - DemandeDePrelevement
            - DirectDebitUK
            - Domicil
            - LastschriftCH
            - RID
            - OrdenDeDomiciliacion
            - Autogiro
            - Betalingsservice
          type: string
        BusinessIdentificationCode:
          type: string
        City:
          type: string
        CompanyName:
          type: string
        Country:
          type: string
        CreditCardAddress1:
          type: string
        CreditCardAddress2:
          type: string
        CreditCardCity:
          type: string
        CreditCardCountry:
          type: string
        CreditCardExpirationMonth:
          format: int32
          type: integer
        CreditCardExpirationYear:
          format: int32
          type: integer
        CreditCardHolderName:
          type: string
        CreditCardMaskNumber:
          type: string
        CreditCardPostalCode:
          type: string
        CreditCardState:
          type: string
        CreditCardType:
          enum:
            - AmericanExpress
            - Discover
            - MasterCard
            - Visa
          type: string
        DeviceSessionId:
          type: string
        Email:
          type: string
        ExistingMandate:
          enum:
            - 'Yes'
            - 'No'
          type: string
        FirstName:
          type: string
        IBAN:
          type: string
        IPAddress:
          type: string
        Id:
          type: string
        IdentityNumber:
          type: string
        IsCompany:
          type: boolean
        LastFailedSaleTransactionDate:
          format: date-time
          type: string
        LastName:
          type: string
        LastTransactionDateTime:
          format: date-time
          type: string
        LastTransactionStatus:
          type: string
        MandateCreationDate:
          format: date
          type: string
        MandateID:
          type: string
        MandateReceived:
          type: string
        MandateUpdateDate:
          format: date
          type: string
        MaxConsecutivePaymentFailures:
          type: integer
        Name:
          type: string
        NumConsecutiveFailures:
          format: int32
          type: integer
        PaymentMethodId:
          type: string
        PaymentMethodStatus:
          enum:
            - Active
            - Closed
          type: string
        PaymentRetryWindow:
          type: integer
        PaypalBaid:
          type: string
        PaypalEmail:
          type: string
        PaypalPreapprovalKey:
          type: string
        PaypalType:
          enum:
            - ExpressCheckout
            - AdaptivePayments
          type: string
        Phone:
          type: string
        PostalCode:
          type: string
        SecondTokenId:
          type: string
        State:
          type: string
        StreetName:
          type: string
        StreetNumber:
          type: string
        TokenId:
          type: string
        TotalNumberOfErrorPayments:
          format: int32
          type: integer
        TotalNumberOfProcessedPayments:
          format: int32
          type: integer
        Type:
          enum:
            - ACH
            - ApplePay
            - BankTransfer
            - Cash
            - Check
            - CreditCard
            - CreditCardReferenceTransaction
            - DebitCard
            - Other
            - PayPal
            - WireTransfer
          type: string
        UseDefaultRetryRule:
          type: boolean
      type: object
    ProxyGetPaymentMethodTransactionLog:
      properties:
        Gateway:
          type: string
        GatewayReasonCode:
          type: string
        GatewayReasonCodeDescription:
          type: string
        GatewayTransactionType:
          type: string
        Id:
          type: string
        PaymentMethodId:
          type: string
        PaymentMethodType:
          type: string
        RequestString:
          type: string
        ResponseString:
          type: string
        TransactionDate:
          format: date-time
          type: string
        TransactionId:
          type: string
      type: object
    GETPaymentMethodUpdaterInstancesResponse:
      properties:
        success:
          type: boolean
        updaters:
          properties:
            daysToUpdateBeforeBcd:
              type: integer
            id:
              type: string
            isActive:
              type: boolean
            isDefault:
              type: boolean
            isTest:
              type: string
            processAssociatedGwOnly:
              type: boolean
            processAutopayDefaultPmOnly:
              type: boolean
            processMastercard:
              type: boolean
            processVisa:
              type: boolean
            updaterGatewayType:
              type: string
            updaterName:
              type: string
          type: object
      type: object
    POSTPaymentMethodUpdaterBatchRequest:
      properties:
        billingCycleDay:
          type: integer
        updaterAccountId:
          type: string
      required:
        - updaterAccountId
        - billingCycleDay
      type: object
    POSTPaymentMethodUpdaterResponse:
      properties:
        success:
          type: boolean
      type: object
    POSTRSASignatureType:
      properties:
        IBAN:
          type: string
        accountId:
          type: string
        authorizationAmount:
          type: number
        bankBranchCode:
          type: string
        bankCheckDigit:
          type: string
        bankCity:
          type: string
        bankPostalCode:
          type: string
        bankStreetName:
          type: string
        bankStreetNumber:
          type: string
        businessIdentificationCode:
          type: string
        cityBlackList:
          type: string
        cityWhiteList:
          type: string
        currency:
          type: string
        deviceSessionId:
          type: string
        gatewayName:
          type: string
        id:
          type: string
        key:
          type: string
        locale:
          type: string
        maxConsecutivePaymentFailures:
          type: integer
        method:
          type: string
        pageId:
          type: string
        param_gwOptions_[*option*]:
          type: string
        param_supportedTypes:
          type: string
        passthrough[1,2,3,4,5]:
          type: string
        paymentGateway:
          type: string
        paymentRetryWindow:
          type: integer
        pmId:
          type: string
        signature:
          type: string
        signatureType:
          type: string
        style:
          type: string
        submitEnabled:
          type: boolean
        tenantId:
          type: string
        token:
          type: string
        uri:
          type: string
        useDefaultRetryRule:
          type: boolean
      required:
        - method
        - pageId
        - uri
      type: object
    POSTRSASignatureResponseType:
      properties:
        key:
          type: string
        signature:
          type: string
        success:
          type: boolean
        tenantId:
          type: string
        token:
          type: string
      type: object
    POSTDecryptionType:
      properties:
        method:
          type: string
        publicKey:
          type: string
        signature:
          type: string
      required:
        - method
        - publicKey
        - signature
      type: object
    POSTDecryptResponseType:
      properties:
        decryptedSignature:
          type: string
        publicKey:
          type: string
        signature:
          type: string
        success:
          type: boolean
      type: object
    GetHostedPagesType:
      properties:
        hostedpages:
          items:
            $ref: '#/components/schemas/GetHostedPageType'
          type: array
        success:
          type: boolean
      type: object
    GetHostedPageType:
      properties:
        pageId:
          type: string
        pageName:
          type: string
        pageType:
          type: string
        pageVersion:
          type: string
      title: hostedpages
      type: object
    POSTCreateOpenPaymentMethodTypeRequest:
      properties:
        entityId:
          type: string
        fields:
          items:
            $ref: '#/components/schemas/OpenPaymentMethodTypeRequestFields'
          type: array
        internalName:
          maxLength: 19
          type: string
        isSupportAsyncPayment:
          type: boolean
          default: false
        label:
          maxLength: 40
          type: string
        methodReferenceIdField:
          type: string
        subTypeField:
          type: string
        tenantId:
          type: string
        userReferenceIdField:
          type: string
      required:
        - internalName
        - tenantId
        - label
        - methodReferenceIdField
        - fields
    POSTCreateOpenPaymentMethodTypeResponse:
      properties:
        paymentMethodType:
          type: string
        publishDate:
          type: string
        revision:
          type: integer
        status:
          type: string
    OpenPaymentMethodTypeRequestFields:
      properties:
        checksum:
          type: boolean
        defaultValue:
          maxLength: 255
          type: string
        editable:
          type: boolean
        index:
          type: integer
        label:
          maxLength: 30
          type: string
        maxLength:
          type: integer
        minLength:
          type: integer
        name:
          maxLength: 30
          type: string
        representer:
          type: boolean
        required:
          type: boolean
        type:
          enum:
            - string
            - date
            - datetime
            - number
            - boolean
          type: string
        visible:
          type: boolean
      title: fields
    PUTPublishOpenPaymentMethodTypeResponse:
      properties:
        entityId:
          type: string
        fields:
          items:
            $ref: '#/components/schemas/OpenPaymentMethodTypeResponseFields'
          type: array
        internalName:
          type: string
        label:
          type: string
        methodReferenceIdField:
          type: string
        revision:
          type: integer
        status:
          type: string
        subTypeField:
          type: string
        tenantId:
          type: string
        userReferenceIdField:
          type: string
        version:
          type: string
    OpenPaymentMethodTypeResponseFields:
      properties:
        checksum:
          type: boolean
        defaultValue:
          type: string
        editable:
          type: boolean
        index:
          type: integer
        label:
          type: string
        maxLength:
          type: integer
        minLength:
          type: integer
        name:
          type: string
        representer:
          type: boolean
        required:
          type: boolean
        type:
          enum:
            - string
            - date
            - datetime
            - number
            - boolean
          type: string
        visible:
          type: boolean
      title: fields
    PUTUpdateOpenPaymentMethodTypeRequest:
      properties:
        entityId:
          type: string
        fields:
          items:
            $ref: '#/components/schemas/OpenPaymentMethodTypeRequestFields'
          type: array
        internalName:
          maxLength: 19
          type: string
        isSupportAsyncPayment:
          type: boolean
          default: false
        label:
          maxLength: 40
          type: string
        methodReferenceIdField:
          type: string
        subTypeField:
          type: string
        tenantId:
          type: string
        userReferenceIdField:
          type: string
      required:
        - internalName
        - tenantId
        - label
        - methodReferenceIdField
        - fields
    PUTUpdateOpenPaymentMethodTypeResponse:
      properties:
        paymentMethodType:
          type: string
        publishDate:
          type: string
        revision:
          type: integer
        status:
          type: string
    GETOpenPaymentMethodTypeRevisionResponse:
      properties:
        entityId:
          type: string
        fields:
          items:
            $ref: '#/components/schemas/OpenPaymentMethodTypeResponseFields'
          type: array
        internalName:
          type: string
        label:
          type: string
        methodReferenceIdField:
          type: string
        revision:
          type: integer
        status:
          type: string
        subTypeField:
          type: string
        tenantId:
          type: string
        userReferenceIdField:
          type: string
        version:
          type: string
    POSTDelayAuthorizeCapture:
      properties:
        accountId:
          type: string
        accountNumber:
          type: string
        amount:
          type: number
        gatewayOptions:
          properties:
            key:
              type: string
            value:
              type: string
          type: object
        gatewayOrderId:
          type: string
        mitTransactionSource:
          enum:
            - C_Unscheduled
            - M_Recurring
            - M_Unscheduled
            - M_MOTO
          type: string
        paymentGatewayId:
          type: string
        softDescriptor:
          type: string
        softDescriptorPhone:
          type: string
      required:
        - amount
        - gatewayOrderId
      type: object
    POSTAuthorizeResponse:
      properties:
        gatewayOrderId:
          type: string
        paymentGatewayResponse:
          properties:
            additionalInfo:
              type: object
            gatewayResponseCode:
              type: string
            gatewayResponseMessage:
              type: string
            gatewayType:
              type: string
            gatewayVersion:
              type: string
          type: object
        processId:
          type: string
        reasons:
          items:
            properties:
              code:
                type: string
              message:
                type: string
            type: object
          type: array
        requestId:
          type: string
        resultCode:
          type: string
        resultMessage:
          type: string
        success:
          type: boolean
        transactionId:
          type: string
      type: object
    POSTVoidAuthorize:
      properties:
        accountId:
          type: string
        accountNumber:
          type: string
        gatewayOptions:
          properties:
            key:
              type: string
            value:
              type: string
          type: object
        gatewayOrderId:
          type: string
        paymentGatewayId:
          type: string
          nullable: true
        transactionId:
          type: string
      required:
        - transactionId
        - gatewayOrderId
      type: object
    POSTVoidAuthorizeResponse:
      properties:
        gatewayOrderId:
          type: string
        resultCode:
          type: string
        resultMessage:
          type: string
        success:
          type: boolean
        transactionId:
          type: string
      type: object
    GETPaymentGatwaysResponse:
      properties:
        paymentgateways:
          items:
            $ref: '#/components/schemas/GETAPaymentGatwayResponse'
          type: array
        success:
          type: boolean
      type: object
    GETAPaymentGatwayResponse:
      properties:
        id:
          type: string
        isActive:
          type: boolean
        isDefault:
          type: boolean
        name:
          type: string
        type:
          type: string
      title: paymentgateways
      type: object
    PostTriggerPreDebitNotificationRequest:
      properties:
        invoiceKey:
          type: string
        paymentGatewayId:
          type: string
        paymentMethodId:
          type: string
      required:
        - invoiceKey
      type: object
    PostTriggerPreDebitNotificationResponse:
      properties:
        success:
          type: boolean
        invoiceId:
          type: string
        paymentMethodId:
          type: string
        gatewayId:
          type: string
        gatewayType:
          type: string
        gatewayVersion:
          type: string
        notificationReferenceId:
          type: string
        secondNotificationReferenceId:
          type: string
          nullable: true
        thirdNotificationReferenceId:
          type: string
          nullable: true
        extraParameters:
          type: string
          nullable: true
      type: object
    POSTReversePaymentRequest:
      properties:
        amount:
          type: number
        gatewayReconciliationReason:
          type: string
        gatewayReconciliationStatus:
          type: string
        gatewayResponse:
          type: string
        gatewayResponseCode:
          type: string
        payoutId:
          type: string
        referenceId:
          maxLength: 100
          type: string
        secondReferenceId:
          maxLength: 100
          type: string
        settledOn:
          format: date-time
          type: string
      required:
        - amount
      type: object
    POSTReversePaymentResponse:
      properties:
        accountId:
          type: string
        amount:
          format: double
          type: number
        cancelledOn:
          format: date-time
          type: string
        comment:
          type: string
          nullable: true
        createdById:
          type: string
        createdDate:
          format: date-time
          type: string
        creditMemoId:
          type: string
        financeInformation:
          properties:
            bankAccountAccountingCode:
              maxLength: 100
              minLength: 0
              type: string
            bankAccountAccountingCodeType:
              type: string
            transferredToAccounting:
              enum:
                - Processing
                - 'Yes'
                - 'No'
                - Error
                - Ignore
              type: string
            unappliedPaymentAccountingCode:
              maxLength: 100
              minLength: 0
              type: string
            unappliedPaymentAccountingCodeType:
              type: string
          type: object
        gatewayId:
          type: string
        gatewayReconciliationReason:
          type: string
        gatewayReconciliationStatus:
          type: string
        gatewayResponse:
          type: string
        gatewayResponseCode:
          type: string
        gatewayState:
          enum:
            - Submitted
            - NotSubmitted
            - Settled
            - 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
        organizationLabel:
          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:
          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
    POSTRejectPaymentRequest:
      properties:
        gatewayReconciliationReason:
          type: string
        gatewayReconciliationStatus:
          type: string
        gatewayResponse:
          type: string
        gatewayResponseCode:
          type: string
        referenceId:
          maxLength: 100
          type: string
        secondReferenceId:
          maxLength: 100
          type: string
        settledOn:
          format: date-time
          type: string
      type: object
    POSTRejectPaymentResponse:
      properties:
        accountId:
          type: string
        amount:
          format: double
          type: number
        cancelledOn:
          format: date-time
          type: string
        comment:
          type: string
          nullable: true
        createdById:
          type: string
        createdDate:
          format: date-time
          type: string
        creditMemoId:
          type: string
        financeInformation:
          properties:
            bankAccountAccountingCode:
              maxLength: 100
              minLength: 0
              type: string
            bankAccountAccountingCodeType:
              type: string
            transferredToAccounting:
              enum:
                - Processing
                - 'Yes'
                - 'No'
                - Error
                - Ignore
              type: string
            unappliedPaymentAccountingCode:
              maxLength: 100
              minLength: 0
              type: string
            unappliedPaymentAccountingCodeType:
              type: string
          type: object
        gatewayId:
          type: string
        gatewayReconciliationReason:
          type: string
        gatewayReconciliationStatus:
          type: string
        gatewayResponse:
          type: string
        gatewayResponseCode:
          type: string
        gatewayState:
          enum:
            - Submitted
            - NotSubmitted
            - Settled
            - 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
        organizationLabel:
          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:
          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
    POSTSettlePaymentRequest:
      properties:
        gatewayReconciliationReason:
          type: string
        gatewayReconciliationStatus:
          type: string
        payoutId:
          type: string
        settledOn:
          format: date-time
          type: string
      type: object
    POSTSettlePaymentResponse:
      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
        paymentGatewayNumber:
          type: string
          nullable: true
        financeInformation:
          properties:
            bankAccountAccountingCode:
              maxLength: 100
              minLength: 0
              type: string
              nullable: true
            bankAccountAccountingCodeType:
              type: string
              nullable: true
            transferredToAccounting:
              enum:
                - Processing
                - 'Yes'
                - 'No'
                - Error
                - Ignore
              type: string
            unappliedPaymentAccountingCode:
              maxLength: 100
              minLength: 0
              type: string
            unappliedPaymentAccountingCodeType:
              type: string
          type: object
        gatewayId:
          type: string
        gatewayOrderId:
          type: string
        gatewayReconciliationReason:
          type: string
        gatewayReconciliationStatus:
          type: string
          nullable: true
        gatewayResponse:
          type: string
        gatewayResponseCode:
          type: string
        gatewayState:
          enum:
            - Submitted
            - NotSubmitted
            - Settled
            - FailedToSettle
          type: string
        id:
          type: string
        markedForSubmissionOn:
          format: date-time
          type: string
        number:
          type: string
        organizationLabel:
          type: string
        paymentMethodId:
          type: string
        paymentMethodSnapshotId:
          type: string
        payoutId:
          type: string
          nullable: true
        referenceId:
          type: string
        refundAmount:
          format: double
          type: number
        secondPaymentReferenceId:
          type: string
          nullable: true
        settledOn:
          format: date-time
          type: string
        softDescriptor:
          type: string
        softDescriptorPhone:
          type: string
        status:
          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
    POSTReconcileRefundRequest:
      properties:
        action:
          enum:
            - settle
            - reject
          type: string
        actionDate:
          format: datetime
          type: string
        gatewayReconciliationReason:
          type: string
        gatewayReconciliationStatus:
          type: string
        payoutId:
          type: string
      type: object
    POSTReconcileRefundResponse:
      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:
              maxLength: 100
              minLength: 0
              type: string
            bankAccountAccountingCodeType:
              type: string
            transferredToAccounting:
              enum:
                - Processing
                - 'Yes'
                - 'No'
                - Error
                - Ignore
              type: string
            unappliedPaymentAccountingCode:
              maxLength: 100
              minLength: 0
              type: string
            unappliedPaymentAccountingCodeType:
              type: string
          type: object
        gatewayId:
          type: string
        gatewayReconciliationReason:
          type: string
        gatewayReconciliationStatus:
          type: string
        gatewayResponse:
          type: string
        gatewayResponseCode:
          type: string
        gatewayState:
          enum:
            - Settled
            - 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
        organizationLabel:
          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:
          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
    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
    ProxyGetPaymentTransactionLog:
      properties:
        AVSResponseCode:
          type: string
        BatchId:
          type: string
        CVVResponseCode:
          type: string
        Gateway:
          type: string
        GatewayReasonCode:
          type: string
        GatewayReasonCodeDescription:
          type: string
        GatewayState:
          enum:
            - MarkedForSubmission
            - Submitted
            - Settled
            - NotSubmitted
            - FailedToSettle
          type: string
        GatewayTransactionType:
          enum:
            - Authorization
            - Sale
            - Void
            - Inquiry
            - VoidAuth
          type: string
        Id:
          type: string
        PaymentId:
          type: string
        RequestString:
          type: string
        ResponseString:
          type: string
        TransactionDate:
          format: date-time
          type: string
        TransactionId:
          type: string
      type: object
    GETPaymentRunCollectionType:
      properties:
        nextPage:
          type: string
        paymentRuns:
          items:
            $ref: '#/components/schemas/GETPaymentRunType'
          type: array
        success:
          type: boolean
      type: object
    GETPaymentRunType:
      properties:
        accountId:
          type: string
        applyCreditBalance:
          type: boolean
        autoApplyCreditMemo:
          type: boolean
        autoApplyUnappliedPayment:
          type: boolean
        batch:
          type: string
        billCycleDay:
          type: string
        billingRunId:
          format: uuid
          type: string
        collectPayment:
          type: boolean
        completedOn:
          format: date-time
          type: string
          nullable: true
        consolidatedPayment:
          type: boolean
        createdById:
          type: string
        createdDate:
          format: date-time
          type: string
        currency:
          type: string
        executedOn:
          format: date-time
          type: string
          nullable: true
        id:
          type: string
        number:
          type: string
        organizationLabels:
          items:
            properties:
              organizationId:
                type: string
              organizationName:
                type: string
            type: object
          type: array
        paymentGatewayId:
          format: uuid
          type: string
          nullable: true
        processPaymentWithClosedPM:
          type: boolean
        runDate:
          format: date-time
          type: string
        status:
          enum:
            - Pending
            - Processing
            - Completed
            - Error
            - Canceled
          type: string
        success:
          type: boolean
        targetDate:
          format: date
          type: string
        updatedById:
          type: string
        updatedDate:
          format: date-time
          type: string
        useCustomPaymentMethods:
          type: boolean
      title: paymentRuns
      type: object
    POSTPaymentRunRequest:
      properties:
        accountId:
          format: uuid
          type: string
        applyCreditBalance:
          type: boolean
        autoApplyCreditMemo:
          type: boolean
        autoApplyUnappliedPayment:
          type: boolean
        batch:
          type: string
        billCycleDay:
          type: string
        billingRunId:
          format: uuid
          type: string
        collectPayment:
          type: boolean
        consolidatedPayment:
          type: boolean
        currency:
          type: string
        data:
          items:
            $ref: '#/components/schemas/POSTPaymentRunDataElementRequest'
          title: payment run data
          type: array
        organizationLabels:
          items:
            properties:
              organizationId:
                type: string
              organizationName:
                type: string
            type: object
          type: array
        paymentGatewayId:
          format: uuid
          type: string
        processPaymentWithClosedPM:
          type: boolean
        runDate:
          format: date-time
          type: string
        targetDate:
          format: date
          type: string
        useCustomPaymentMethods:
          type: boolean
      type: object
    POSTPaymentRunDataElementRequest:
      allOf:
        - properties:
            accountId:
              type: string
            accountNumber:
              type: string
            amount:
              type: number
            comment:
              type: string
            currency:
              type: string
            dataItems:
              properties:
                amount:
                  type: number
                documentItemId:
                  type: string
                taxItemId:
                  type: string
              title: dataItems
              type: object
            documentId:
              type: string
            documentNumber:
              type: string
            documentType:
              enum:
                - Invoice
                - DebitMemo
              type: string
            paymentGatewayId:
              type: string
            paymentMethodId:
              type: string
            standalone:
              default: false
              type: boolean
          type: object
        - $ref: '#/components/schemas/PaymentObjectCustomFields'
    PUTPaymentRunRequest:
      properties:
        accountId:
          format: uuid
          type: string
        applyCreditBalance:
          type: boolean
        autoApplyCreditMemo:
          type: boolean
        autoApplyUnappliedPayment:
          type: boolean
        batch:
          type: string
        billCycleDay:
          type: string
        billingRunId:
          format: uuid
          type: string
        collectPayment:
          type: boolean
        consolidatedPayment:
          type: boolean
        currency:
          type: string
        organizationLabels:
          items:
            properties:
              organizationId:
                type: string
              organizationName:
                type: string
            type: object
          type: array
        paymentGatewayId:
          format: uuid
          type: string
          nullable: true
        processPaymentWithClosedPM:
          type: boolean
        runDate:
          format: date-time
          type: string
        targetDate:
          format: date
          type: string
      type: object
    GETPaymentRunDataArrayResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/GETPaymentRunDataElementResponse'
          type: array
        success:
          type: boolean
      type: object
    GETPaymentRunDataElementResponse:
      allOf:
        - properties:
            accountId:
              type: string
            accountNumber:
              type: string
            amount:
              type: number
            amountCollected:
              type: number
            amountToCollect:
              type: number
            comment:
              type: string
              nullable: true
            currency:
              type: string
            documentId:
              type: string
            documentNumber:
              type: string
            documentType:
              enum:
                - Invoice
                - DebitMemo
              type: string
            errorCode:
              type: string
            errorMessage:
              type: string
            paymentGatewayId:
              type: string
              nullable: true
            paymentMethodId:
              type: string
            result:
              enum:
                - Processed
                - Error
              type: string
            standalone:
              type: boolean
            transactions:
              items:
                $ref: '#/components/schemas/GETPaymentRunDataTransactionElementResponse'
              type: array
          title: payment run data
          type: object
        - $ref: '#/components/schemas/PaymentObjectCustomFields'
    GETPaymentRunDataTransactionElementResponse:
      properties:
        amount:
          type: number
        appliedAmount:
          type: number
        errorCode:
          type: string
        errorMessage:
          type: string
        id:
          type: string
        status:
          enum:
            - Processed
            - Processing
            - Error
          type: string
        type:
          enum:
            - Payment
            - CreditMemo
            - UnappliedPayment
            - CreditBalanceAdjustment
          type: string
      title: payment run transaction
      type: object
    GETPaymentRunSummaryResponse:
      properties:
        numberOfCreditBalanceAdjustments:
          type: integer
        numberOfCreditMemos:
          type: integer
        numberOfDebitMemos:
          type: integer
        numberOfErrorInputData:
          type: integer
        numberOfErrors:
          type: integer
        numberOfInputData:
          type: integer
        numberOfInvoices:
          type: integer
        numberOfPayments:
          type: integer
        numberOfProcessedInputData:
          type: integer
        numberOfReceivables:
          type: integer
        numberOfUnappliedPayments:
          type: integer
        numberOfUnprocessedDebitMemos:
          type: integer
        numberOfUnprocessedInvoices:
          type: integer
        numberOfUnprocessedReceivables:
          type: integer
        success:
          type: boolean
        totalValues:
          items:
            $ref: '#/components/schemas/GETPaymentRunSummaryTotalValues'
          type: array
      type: object
    GETPaymentRunSummaryTotalValues:
      properties:
        totalValueOfCreditBalance:
          type: string
        totalValueOfCreditMemos:
          type: string
        totalValueOfDebitMemos:
          type: string
        totalValueOfErrors:
          type: string
        totalValueOfInvoices:
          type: string
        totalValueOfPayments:
          type: string
        totalValueOfReceivables:
          type: string
        totalValueOfUnappliedPayments:
          type: integer
        totalValueOfUnprocessedDebitMemos:
          type: string
        totalValueOfUnprocessedInvoices:
          type: string
        totalValueOfUnprocessedReceivables:
          type: string
      title: totalValues
      type: object
    POSTRetryPaymentScheduleItemRequest:
      properties:
        items:
          items:
            $ref: '#/components/schemas/POSTRetryPaymentScheduleItemInfo'
          title: Payment schedule items to be retried.
          type: array
      type: object
    POSTRetryPaymentScheduleItemResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/PaymentScheduleItemCommonResponse'
          type: array
        success:
          type: boolean
      type: object
    PaymentScheduleItemCommonResponse:
      allOf:
        - properties:
            accountId:
              type: string
            amount:
              format: decimal
              type: number
            balance:
              format: decimal
              type: number
            billingDocument:
              properties:
                id:
                  type: string
                number:
                  type: string
                type:
                  type: string
              type: object
            createdById:
              type: string
            createdDate:
              format: date
              type: string
            currency:
              type: string
            errorMessage:
              type: string
            id:
              type: string
            number:
              type: string
            paymentGatewayId:
              type: string
              nullable: true
            paymentMethodId:
              type: string
              nullable: true
            paymentOption:
              items:
                $ref: '#/components/schemas/PaymentSchedulePaymentOptionFields'
              type: array
            paymentScheduleId:
              type: string
            paymentScheduleNumber:
              type: string
            psiPayments:
              items:
                $ref: '#/components/schemas/LinkedPaymentID'
              type: array
            runHour:
              type: integer
            scheduledDate:
              format: date
              type: string
            standalone:
              type: boolean
            status:
              enum:
                - Pending
                - Processed
                - Error
                - Canceled
              type: string
            updatedById:
              type: string
            updatedDate:
              format: date
              type: string
          type: object
        - $ref: '#/components/schemas/PaymentScheduleItemCustomFields'
    LinkedPaymentID:
      properties:
        paymentId:
          type: string
      title: PaymentID
      type: object
    PaymentScheduleItemCustomFields:
      additionalProperties: {}
      title: paymentScheduleItemFieldsCustom
      type: object
    POSTRetryPaymentScheduleItemInfo:
      properties:
        id:
          type: string
        paymentGatewayId:
          type: string
        paymentMethodId:
          type: string
      type: object
    GETPaymentScheduleItemResponse:
      allOf:
        - properties:
            accountId:
              type: string
            amount:
              format: decimal
              type: number
            balance:
              format: decimal
              type: number
            billingDocument:
              properties:
                id:
                  type: string
                number:
                  type: string
                type:
                  type: string
              type: object
            cancellationReason:
              nullable: true
              type: string
            cancelledById:
              nullable: true
              type: string
            cancelledOn:
              nullable: true
              type: string
            createdById:
              type: string
            createdDate:
              format: date
              type: string
            currency:
              type: string
            errorMessage:
              type: string
            id:
              type: string
            number:
              type: string
            paymentGatewayId:
              type: string
              nullable: true
            paymentMethodId:
              type: string
            paymentOption:
              items:
                $ref: '#/components/schemas/PaymentSchedulePaymentOptionFields'
              type: array
            paymentScheduleId:
              type: string
            paymentScheduleNumber:
              type: string
            psiPayments:
              items:
                $ref: '#/components/schemas/LinkedPaymentID'
              type: array
            runHour:
              type: integer
            scheduledDate:
              format: date
              type: string
            standalone:
              type: boolean
            status:
              enum:
                - Pending
                - Processed
                - Error
                - Canceled
              type: string
            success:
              type: boolean
            updatedById:
              type: string
            updatedDate:
              format: date
              type: string
          type: object
        - $ref: '#/components/schemas/PaymentScheduleItemCustomFields'
    PUTPaymentScheduleItemRequest:
      allOf:
        - properties:
            amount:
              format: decimal
              type: number
            currency:
              type: string
            linkPayments:
              type: array
              items:
                type: string
            paymentGatewayId:
              type: string
              nullable: true
            paymentMethodId:
              type: string
            paymentOption:
              items:
                $ref: '#/components/schemas/PaymentSchedulePaymentOptionFields'
              type: array
            runHour:
              type: integer
            scheduledDate:
              format: date
              type: string
            unlinkPayments:
              type: array
              items:
                type: string
          type: object
        - $ref: '#/components/schemas/PaymentScheduleItemCustomFields'
    PUTPaymentScheduleItemResponse:
      allOf:
        - properties:
            accountId:
              type: string
            amount:
              format: decimal
              type: number
            balance:
              format: decimal
              type: number
            billingDocument:
              properties:
                id:
                  type: string
                number:
                  type: string
                type:
                  type: string
              type: object
            cancellationReason:
              type: string
            createdById:
              type: string
            createdDate:
              format: date
              type: string
            currency:
              type: string
            errorMessage:
              type: string
            id:
              type: string
            number:
              type: string
            paymentGatewayId:
              type: string
              nullable: true
            paymentMethodId:
              type: string
            paymentOption:
              items:
                $ref: '#/components/schemas/PaymentSchedulePaymentOptionFields'
              type: array
            paymentScheduleId:
              type: string
            paymentScheduleNumber:
              type: string
            psiPayments:
              items:
                $ref: '#/components/schemas/LinkedPaymentID'
              type: array
            runHour:
              type: integer
            scheduledDate:
              format: date
              type: string
            standalone:
              type: boolean
            status:
              enum:
                - Pending
                - Processed
                - Error
                - Canceled
              type: string
            success:
              type: boolean
            updatedById:
              type: string
            updatedDate:
              format: date
              type: string
          type: object
        - $ref: '#/components/schemas/PaymentScheduleItemCustomFields'
    PUTSkipPaymentScheduleItemResponse:
      allOf:
        - properties:
            amount:
              format: decimal
              type: number
            billingDocument:
              properties:
                id:
                  type: string
                number:
                  type: string
                type:
                  type: string
              type: object
            cancellationReason:
              type: string
            createdById:
              type: string
            createdDate:
              format: date
              type: string
            currency:
              type: string
            errorMessage:
              type: string
            id:
              type: string
            number:
              type: string
            paymentGatewayId:
              type: string
              nullable: true
            paymentMethodId:
              type: string
            paymentOption:
              items:
                $ref: '#/components/schemas/PaymentSchedulePaymentOptionFields'
              type: array
            paymentScheduleId:
              type: string
            paymentScheduleNumber:
              type: string
            psiPayments:
              items:
                $ref: '#/components/schemas/LinkedPaymentID'
              type: array
            runHour:
              type: integer
            scheduledDate:
              format: date
              type: string
            standalone:
              type: boolean
            status:
              enum:
                - Pending
                - Processed
                - Error
                - Canceled
              type: string
            success:
              type: boolean
            updatedById:
              type: string
            updatedDate:
              format: date
              type: string
          type: object
        - $ref: '#/components/schemas/PaymentScheduleItemCustomFields'
    GETPaymentSchedulesResponse:
      items:
        $ref: '#/components/schemas/PaymentScheduleCommonResponse'
      type: array
    PaymentScheduleCommonResponse:
      allOf:
        - properties:
            accountId:
              type: string
            accountNumber:
              type: string
            billingDocument:
              properties:
                id:
                  type: string
                number:
                  type: string
                type:
                  type: string
              type: object
            billingDocuments:
              items:
                allOf:
                  - properties:
                      id:
                        type: string
                      number:
                        type: string
                      type:
                        enum:
                          - Invoice
                          - DebitMemo
                        type: string
              type: array
            createdById:
              type: string
            createdDate:
              format: date
              type: string
            id:
              type: string
            isCustom:
              type: boolean
            items:
              items:
                $ref: '#/components/schemas/PaymentScheduleItemCommonResponse'
              type: array
            nextPaymentDate:
              format: date
              type: string
            occurrences:
              type: integer
            paymentOption:
              items:
                $ref: '#/components/schemas/PaymentSchedulePaymentOptionFields'
              type: array
            paymentScheduleNumber:
              type: string
            period:
              type: string
            prepayment:
              type: boolean
            recentPaymentDate:
              format: date
              type: string
            runHour:
              type: integer
            standalone:
              type: boolean
            startDate:
              format: date
              type: string
            status:
              enum:
                - Active
                - Canceled
                - Completed
              type: string
            totalAmount:
              type: number
            totalPaymentsErrored:
              type: integer
            totalPaymentsProcessed:
              type: integer
            updatedById:
              type: string
            updatedDate:
              format: date
              type: string
          type: object
        - $ref: '#/components/schemas/PaymentScheduleCustomFields'
    PaymentScheduleCustomFields:
      additionalProperties: {}
      title: paymentScheduleFieldsCustom
      type: object
    POSTPaymentScheduleRequest:
      allOf:
        - properties:
            accountId:
              type: string
            accountNumber:
              type: string
            amount:
              type: number
            billingDocument:
              properties:
                id:
                  type: string
                number:
                  type: string
                type:
                  enum:
                    - Invoice
                    - DebitMemo
                  default: Invoice
                  type: string
              required:
                - type
              type: object
            billingDocuments:
              items:
                type: object
                properties:
                  id:
                    type: string
                  number:
                    type: string
                  type:
                    enum:
                      - Invoice
                      - DebitMemo
                    type: string
                required:
                  - type
              type: array
            currency:
              type: string
            items:
              items:
                allOf:
                  - properties:
                      amount:
                        type: number
                      billingDocument:
                        properties:
                          id:
                            type: string
                          number:
                            type: string
                          type:
                            enum:
                              - Invoice
                              - DebitMemo
                            type: string
                        required:
                          - type
                        type: object
                      currency:
                        type: string
                      paymentGatewayId:
                        type: string
                      paymentMethodId:
                        type: string
                      paymentOption:
                        items:
                          $ref: '#/components/schemas/PaymentSchedulePaymentOptionFields'
                        type: array
                      runHour:
                        type: string
                      scheduledDate:
                        format: date
                        type: string
                    type: object
                  - $ref: '#/components/schemas/PaymentScheduleItemCustomFields'
              type: array
            occurrences:
              type: integer
            paymentGatewayId:
              type: string
            paymentMethodId:
              type: string
            paymentOption:
              items:
                $ref: '#/components/schemas/PaymentSchedulePaymentOptionFields'
              type: array
            paymentScheduleNumber:
              type: string
            period:
              enum:
                - Monthly
                - Weekly
                - BiWeekly
              type: string
            prepayment:
              type: boolean
            runHour:
              type: integer
            standalone:
              type: boolean
            startDate:
              format: date
              type: string
            totalAmount:
              type: number
          type: object
        - $ref: '#/components/schemas/PaymentScheduleCustomFields'
    POSTPaymentScheduleResponse:
      allOf:
        - properties:
            accountId:
              type: string
            accountNumber:
              type: string
            billingDocument:
              properties:
                id:
                  type: string
                number:
                  type: string
                type:
                  type: string
              type: object
            billingDocuments:
              items:
                type: object
                properties:
                  id:
                    type: string
                  number:
                    type: string
                  type:
                    enum:
                      - Invoice
                      - DebitMemo
                    type: string
              type: array
            createdById:
              type: string
            createdDate:
              format: date
              type: string
            id:
              type: string
            isCustom:
              type: boolean
            items:
              items:
                $ref: '#/components/schemas/PaymentScheduleItemCommonResponse'
              type: array
            nextPaymentDate:
              format: date
              type: string
            occurrences:
              type: integer
            paymentOption:
              items:
                $ref: '#/components/schemas/PaymentSchedulePaymentOptionFields'
              type: array
            paymentScheduleNumber:
              type: string
            period:
              type: string
              nullable: true
            prepayment:
              type: boolean
            recentPaymentDate:
              format: date
              type: string
              nullable: true
            runHour:
              type: integer
            standalone:
              type: boolean
            startDate:
              format: date
              type: string
            status:
              enum:
                - Active
                - Canceled
                - Completed
              type: string
            success:
              type: boolean
            totalAmount:
              type: number
            totalPaymentsErrored:
              type: integer
            totalPaymentsProcessed:
              type: integer
            updatedById:
              type: string
            updatedDate:
              format: date
              type: string
          type: object
        - $ref: '#/components/schemas/PaymentScheduleCustomFields'
    POSTPaymentSchedulesRequest:
      properties:
        paymentSchedules:
          items:
            $ref: '#/components/schemas/POSTPaymentScheduleRequest'
          type: array
      type: object
    POSTPaymentSchedulesResponse:
      properties:
        paymentSchedules:
          items:
            $ref: '#/components/schemas/POSTPaymentSchedulesEach'
          type: array
        success:
          type: boolean
      type: object
    POSTPaymentSchedulesEach:
      properties:
        id:
          type: string
        paymentScheduleNumber:
          type: string
      title: Payment Schedule ID and Number
      type: object
    GETPaymentScheduleStatisticResponse:
      properties:
        date:
          format: date
          type: string
        paymentRuns:
          items:
            $ref: '#/components/schemas/PaymentRunStatistic'
          title: PaymentRunStatistic
          type: array
        paymentScheduleItems:
          properties:
            error:
              type: integer
            pending:
              type: integer
            processed:
              type: integer
          type: object
        success:
          type: boolean
      type: object
    PaymentRunStatistic:
      properties:
        completedOn:
          format: date-time
          type: string
        executedOn:
          format: date-time
          type: string
          nullable: true
        number:
          type: string
        numberOfErrors:
          type: integer
        numberOfPayments:
          type: integer
        status:
          type: string
      type: object
    GETPaymentScheduleResponse:
      allOf:
        - properties:
            accountId:
              type: string
            accountNumber:
              type: string
            billingDocument:
              properties:
                id:
                  type: string
                number:
                  type: string
                type:
                  type: string
              type: object
            billingDocuments:
              items:
                type: object
                properties:
                  id:
                    type: string
                  number:
                    type: string
                  type:
                    enum:
                      - Invoice
                      - DebitMemo
                    type: string
              type: array
            createdById:
              type: string
            createdDate:
              format: date
              type: string
            cancellationReason:
              nullable: true
              type: string
            cancelledById:
              type: string
              nullable: true
            cancelledOn:
              type: string
              nullable: true
            cancelDate:
              format: date
              type: string
            id:
              type: string
            isCustom:
              type: boolean
            items:
              items:
                $ref: '#/components/schemas/PaymentScheduleItemCommonResponse'
              type: array
            nextPaymentDate:
              format: date
              type: string
            occurrences:
              type: integer
            paymentOption:
              items:
                $ref: '#/components/schemas/PaymentSchedulePaymentOptionFields'
              type: array
            paymentScheduleNumber:
              type: string
            period:
              type: string
            prepayment:
              type: boolean
            recentPaymentDate:
              format: date
              type: string
            runHour:
              type: integer
            standalone:
              type: boolean
            startDate:
              format: date
              type: string
            status:
              enum:
                - Active
                - Canceled
                - Completed
              type: string
            success:
              type: boolean
            totalAmount:
              type: number
            totalPaymentsErrored:
              type: integer
            totalPaymentsProcessed:
              type: integer
            updatedById:
              type: string
            updatedDate:
              format: date
              type: string
          type: object
        - $ref: '#/components/schemas/PaymentScheduleCustomFields'
    PUTPaymentScheduleRequest:
      allOf:
        - properties:
            amount:
              type: number
            currency:
              type: string
            occurrences:
              type: integer
            paymentGatewayId:
              type: string
            paymentMethodId:
              type: string
            paymentOption:
              items:
                $ref: '#/components/schemas/PaymentSchedulePaymentOptionFields'
              type: array
            period:
              enum:
                - Monthly
                - Weekly
                - BiWeekly
              type: string
            periodStartDate:
              format: date
              type: string
            runHour:
              format: date
              type: integer
          type: object
        - $ref: '#/components/schemas/PaymentScheduleCustomFields'
    PUTCancelPaymentScheduleRequest:
      properties:
        cancelDate:
          format: date
          type: string
      required:
        - cancelDate
      type: object
    POSTAddItemsToPaymentScheduleRequest:
      properties:
        items:
          items:
            $ref: '#/components/schemas/PaymentScheduleItemCommon'
          title: paymentScheduleItem
          type: array
      type: object
    PaymentScheduleItemCommon:
      allOf:
        - properties:
            amount:
              type: number
            currency:
              type: string
            paymentGatewayId:
              required:
                - type
              type: string
            paymentMethodId:
              type: string
            paymentOption:
              items:
                $ref: '#/components/schemas/PaymentSchedulePaymentOptionFields'
              type: array
            runHour:
              type: string
            scheduledDate:
              format: date
              type: string
          required:
            - scheduledDate
            - amount
          type: object
        - $ref: '#/components/schemas/PaymentScheduleItemCustomFields'
    PUTPreviewPaymentScheduleRequest:
      allOf:
        - properties:
            amount:
              type: number
            currency:
              type: string
            occurrences:
              type: integer
            paymentGatewayId:
              type: string
            paymentMethodId:
              type: string
            paymentOption:
              items:
                $ref: '#/components/schemas/PaymentSchedulePaymentOptionFields'
              type: array
            period:
              enum:
                - Monthly
                - Weekly
                - BiWeekly
              type: string
            periodStartDate:
              format: date
              type: string
            runHour:
              format: date
              type: integer
          type: object
        - $ref: '#/components/schemas/PaymentScheduleCustomFields'
    GETRefundCollectionType:
      properties:
        nextPage:
          format: URL
          type: string
        refunds:
          items:
            $ref: '#/components/schemas/GETRefundTypewithSuccess'
          type: array
        success:
          type: boolean
      type: object
    GETRefundTypewithSuccess:
      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
              nullable: true
            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
              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
            methodType:
              enum:
                - ACH
                - Cash
                - Check
                - CreditCard
                - PayPal
                - WireTransfer
                - DebitCard
                - CreditCardReferenceTransaction
                - BankTransfer
                - Other
              type: string
            number:
              type: string
            organizationLabel:
              type: string
            paymentId:
              type: string
            paymentMethodId:
              type: string
              nullable: true
            paymentMethodSnapshotId:
              type: string
              nullable: true
            payoutId:
              type: string
              nullable: true
            reasonCode:
              type: string
            referenceId:
              type: string
              nullable: true
            refundDate:
              format: date
              type: string
            refundTransactionTime:
              format: date-time
              type: string
              nullable: true
            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
              nullable: true
            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'
      title: refunds
    PUTRefundType:
      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
            reasonCode:
              type: string
            referenceId:
              maxLength: 100
              minLength: 0
              type: string
          type: object
        - $ref: '#/components/schemas/RefundObjectNSFields'
        - $ref: '#/components/schemas/RefundObjectCustomFields'
    GETRefundType:
      allOf:
        - properties:
            accountId:
              type: string
            amount:
              format: double
              type: number
            cancelledOn:
              format: date-time
              type: string
            comment:
              type: string
              nullable: true
            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
            organizationLabel:
              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:
              type: string
          type: object
        - $ref: '#/components/schemas/RefundObjectNSFields'
        - $ref: '#/components/schemas/RefundObjectCustomFields'
    GETRefundPartCollectionType:
      properties:
        parts:
          items:
            $ref: '#/components/schemas/RefundPartResponseTypewithSuccess'
          type: array
        success:
          type: boolean
      type: object
    RefundPartResponseTypewithSuccess:
      properties:
        amount:
          format: double
          type: number
        createdById:
          type: string
        createdDate:
          format: date-time
          type: string
        creditMemoId:
          type: string
        id:
          type: string
        organizationLabel:
          type: string
        paymentId:
          type: string
        updatedById:
          type: string
        updatedDate:
          format: date-time
          type: string
      title: parts
      type: object
    RefundPartResponseType:
      properties:
        amount:
          format: double
          type: number
        createdById:
          type: string
        createdDate:
          format: date-time
          type: string
        creditMemoId:
          type: string
        id:
          type: string
        organizationLabel:
          type: string
        paymentId:
          type: string
        success:
          type: boolean
        updatedById:
          type: string
        updatedDate:
          format: date-time
          type: string
      type: object
    GETRefundItemPartCollectionType:
      properties:
        itemParts:
          items:
            $ref: '#/components/schemas/GETRefundItemPartTypewithSuccess'
          type: array
        nextPage:
          format: URL
          type: string
        success:
          type: boolean
      type: object
    GETRefundItemPartTypewithSuccess:
      properties:
        amount:
          format: double
          type: number
        createdById:
          type: string
        createdDate:
          format: date-time
          type: string
        creditMemoItemId:
          type: string
        creditTaxItemId:
          type: string
        id:
          type: string
        organizationLabel:
          type: string
        updatedById:
          type: string
        updatedDate:
          format: date-time
          type: string
      title: itemParts
      type: object
    GETRefundItemPartType:
      properties:
        amount:
          format: double
          type: number
        createdById:
          type: string
        createdDate:
          format: date-time
          type: string
        creditMemoItemId:
          type: string
        creditTaxItemId:
          type: string
        id:
          type: string
        organizationLabel:
          type: string
        success:
          type: boolean
        updatedById:
          type: string
        updatedDate:
          format: date-time
          type: string
      type: object
    GETActiveInvoiceCycleResponse:
      type: object
      properties:
        cycles:
          type: array
          items:
            $ref: '#/components/schemas/GETInvoiceCycleElementResponse'
    GETInvoiceCycleElementResponse:
      type: object
      title: RetryCycle
      properties:
        account_id:
          type: string
        invoice_id:
          type: string
        payment_method_id:
          type: string
        currency:
          type: string
        status:
          type: string
        current_attempt_number:
          type: number
        next_attempt:
          type: string
          format: date-time
        customer_group:
          type: string
        attempts:
          type: array
          items:
            $ref: '#/components/schemas/GETCycleElementAttemptResponse'
    GETCycleElementAttemptResponse:
      type: object
      title: RetryAttempt
      properties:
        attempt_number:
          type: number
        zuora_payment_id:
          type: string
        time_of_execution:
          type: string
          format: date-time
        source:
          type: string
        cpr_generated:
          type: boolean
        success:
          type: boolean
        amount_collected:
          type: number
        action_info:
          type: object
          properties:
            action:
              type: string
        retry_info:
          type: object
          properties:
            next:
              type: string
              format: date-time
            criteria:
              type: string
        mapping_info:
          type: object
          properties:
            label:
              type: string
            level:
              type: string
            customer_group_id:
              type: number
        gateway_info:
          type: object
          properties:
            id:
              type: string
            code:
              type: string
            response:
              type: string
    GETActiveDebitMemoCycleResponse:
      type: object
      properties:
        cycles:
          type: array
          items:
            $ref: '#/components/schemas/GETDebitMemoCycleElementResponse'
    GETDebitMemoCycleElementResponse:
      type: object
      title: RetryCycle
      properties:
        account_id:
          type: string
        debit_memo_id:
          type: string
        payment_method_id:
          type: string
        currency:
          type: string
        status:
          type: string
        current_attempt_number:
          type: number
        next_attempt:
          type: string
          format: date-time
        customer_group:
          type: string
        attempts:
          type: array
          items:
            $ref: '#/components/schemas/GETCycleElementAttemptResponse'
    GETActiveAccountCycleResponse:
      type: object
      properties:
        cycles:
          type: array
          items:
            $ref: '#/components/schemas/GETAccountCycleElementResponse'
    GETAccountCycleElementResponse:
      type: object
      title: RetryCycle
      properties:
        account_id:
          type: string
        invoice_id:
          type: string
        debit_memo_id:
          type: string
        payment_method_id:
          type: string
        currency:
          type: string
        status:
          type: string
        current_attempt_number:
          type: number
        next_attempt:
          type: string
          format: date-time
        customer_group:
          type: string
        attempts:
          type: array
          items:
            $ref: '#/components/schemas/GETCycleElementAttemptResponse'
    GETInvoiceCycleHistoryResponse:
      type: object
      properties:
        cycles:
          type: array
          items:
            $ref: '#/components/schemas/GETInvoiceCycleElementResponse'
    GETDebitMemoCycleHistoryResponse:
      type: object
      properties:
        cycles:
          type: array
          items:
            $ref: '#/components/schemas/GETDebitMemoCycleElementResponse'
    GETAccountCycleHistoryResponse:
      type: object
      properties:
        cycles:
          type: array
          items:
            $ref: '#/components/schemas/GETAccountCycleElementResponse'
    GETBaselineMetricsResponse:
      type: object
      properties:
        retry_success_rate:
          type: number
        retry_success_rate_trend:
          type: string
        document_success_rate:
          type: number
        document_success_rate_trend:
          type: string
        average_days_outstanding:
          type: number
        average_days_outstanding_trend:
          type: string
        success:
          type: boolean
    GETAmountRecoveredResponse:
      type: object
      properties:
        currency:
          type: array
          items:
            type: object
        success:
          type: boolean
    GETDocumentSuccessRateByCustomerGroupResponse:
      type: object
      properties:
        customer_groups:
          type: array
          items:
            type: object
        success:
          type: boolean
    GETCustomerGroupMetricsResponse:
      type: object
      properties:
        customer_groups:
          type: array
          items:
            type: object
        success:
          type: boolean
    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
    GetApiVolumeSummaryResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/ApiVolumeSummaryRecord'
          type: array
      type: object
    SystemHealthErrorResponse:
      properties:
        error:
          type: string
        message:
          type: string
        path:
          type: string
        status:
          type: integer
        timestamp:
          format: date-time
          type: string
      type: object
    ApiVolumeSummaryRecord:
      allOf:
        - properties:
            api:
              type: string
            error:
              type: integer
            httpMethod:
              type: string
            success:
              type: integer
            total:
              type: integer
          type: object
      title: volumeSummaryRecord
    GetApiFailureRecordResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/ApiFailureRecord'
          type: array
        nextPage:
          type: string
          format: url
      type: object
    ApiFailureRecord:
      properties:
        tracing_identifier:
          type: string
          nullable: true
        latency:
          type: integer
          nullable: false
        ip:
          type: string
          nullable: false
        response_body:
          type: string
          nullable: false
        request_body:
          type: string
          nullable: false
        user_id:
          type: string
          nullable: false
        track_id:
          type: string
          nullable: true
        request_path:
          type: string
          nullable: false
        http_status:
          type: string
          nullable: false
        zuora_response_code:
          type: string
          nullable: false
        api:
          type: string
          nullable: false
        request_id:
          type: string
          nullable: false
        user_agent:
          type: string
          nullable: false
        timestamp:
          type: string
          format: date-time
          nullable: false
        status:
          type: string
          nullable: false
          enum:
            - Error
        http_method:
          type: string
          nullable: false
      type: object
      title: FailureRecords
    GetApiPerformanceDetailResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/ApiPerformanceDetail'
          type: array
        nextPage:
          type: string
          format: url
      type: object
    ApiPerformanceDetail:
      properties:
        tracing_identifier:
          type: string
          nullable: true
        latency:
          type: integer
          nullable: false
        ip:
          type: string
          nullable: true
        response_body:
          type: string
          nullable: true
        request_body:
          type: string
          nullable: true
        user_id:
          type: string
          nullable: false
        track_id:
          type: string
          nullable: true
        request_path:
          type: string
          nullable: false
        http_status:
          type: string
          nullable: false
        zuora_response_code:
          type: string
          nullable: false
        api:
          type: string
          nullable: false
        request_id:
          type: string
          nullable: false
        user_agent:
          type: string
          nullable: false
        timestamp:
          type: string
          format: date-time
          nullable: false
        status:
          type: string
          nullable: false
          enum:
            - Error
            - Success
        http_method:
          type: string
          nullable: false
      type: object
      title: DetailRecords
    GetBillingDocVolumeSummaryResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/BillingDocVolumeSummaryRecord'
          type: array
      type: object
    BillingDocVolumeSummaryRecord:
      allOf:
        - properties:
            totalFailedAccounts:
              type: integer
            totalGeneratedCreditMemos:
              type: integer
            totalGeneratedInvoices:
              type: integer
          type: object
      title: volumeSummaryRecord
    GetPaymentVolumeSummaryResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/PaymentVolumeSummaryRecord'
          type: array
      type: object
    PaymentVolumeSummaryRecord:
      allOf:
        - properties:
            error:
              type: integer
            paymentGatewayType:
              type: string
            paymentMethodType:
              type: string
            success:
              type: integer
            total:
              type: integer
          type: object
      title: volumeSummaryRecord
    GetPaymentRecordsResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/PaymentRecordsDetails'
          type: array
        nextPage:
          type: string
          format: url
      type: object
    PaymentRecordsDetails:
      properties:
        payment_method_type:
          type: string
          nullable: false
        amount:
          type: number
          nullable: false
        payment_status:
          type: string
          nullable: false
          enum:
            - Success
            - Error
        source_type:
          type: string
          nullable: false
        payment_gateway_response_code:
          type: string
          nullable: false
        payment_gateway_response_msg:
          type: string
          nullable: false
        request_duration:
          type: integer
          nullable: false
        payment_number:
          type: string
          nullable: false
        payment_id:
          type: string
          nullable: false
        zuora_response_code:
          type: string
          nullable: false
        currency:
          type: string
          nullable: false
        source_id:
          type: string
          nullable: false
        payment_gateway_type:
          type: string
          nullable: false
        payment_date:
          type: string
          format: date
          nullable: false
      type: object
      title: PaymentRecord
    GetTaxRecordsResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/TaxHealthDetailsRecords'
          type: array
        nextPage:
          type: string
          format: url
      type: object
    TaxHealthDetailsRecords:
      properties:
        error_message:
          type: string
          nullable: false
        document_number:
          type: string
          nullable: false
        vendor_name:
          type: string
          nullable: false
        event_source:
          type: string
          nullable: false
        error_category:
          type: string
          nullable: false
        account_id:
          type: string
          nullable: false
        event_type:
          type: string
          nullable: false
        total_duration:
          type: integer
          nullable: false
        zuora_request_id:
          type: string
          nullable: false
        account_name:
          type: string
          nullable: false
        vendor_duration:
          type: number
          nullable: false
        sub_error_category:
          type: string
          nullable: false
        status:
          type: string
          nullable: false
          enum:
            - success
            - error
        timestamp:
          type: string
          format: date-time
          nullable: false
      type: object
      title: TaxRecords
    DeleteWorkflowSuccess:
      properties:
        id:
          type: string
        success:
          type: boolean
      type: object
    DeleteWorkflowError:
      properties:
        Errors:
          items:
            type: string
          type: array
      type: object
    GetWorkflowsResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/WorkflowDefinitionAndVersions'
          type: array
        pagination:
          properties:
            next_page:
              type: string
            page:
              type: integer
            page_length:
              type: integer
          type: object
      type: object
    WorkflowDefinitionAndVersions:
      properties:
        active_version:
          properties:
            id:
              type: integer
            status:
              type: string
            type:
              enum:
                - Workflow::Setup
                - Workflow::Instance
              type: string
            version:
              type: string
          type: object
        calloutTrigger:
          type: boolean
        createdAt:
          format: datetime
          type: string
        id:
          type: integer
        interval:
          type: string
        latest_inactive_verisons:
          items:
            $ref: '#/components/schemas/Workflow'
          type: array
        name:
          type: string
        ondemandTrigger:
          type: boolean
        scheduledTrigger:
          type: boolean
        status:
          type: string
        timezone:
          type: string
        updatedAt:
          format: datetime
          type: string
      title: a workflow definition with version information
      type: object
    Workflow:
      properties:
        calloutTrigger:
          type: boolean
        createdAt:
          format: datetime
          type: string
        id:
          type: integer
        interval:
          type: string
        name:
          type: string
        ondemandTrigger:
          type: boolean
        scheduledTrigger:
          type: boolean
        timezone:
          type: string
        type:
          enum:
            - Workflow::Setup
            - Workflow::Instance
          type: string
        updatedAt:
          format: datetime
          type: string
        version:
          type: string
      title: workflow
      type: object
    POSTWorkflowDefinitionImportRequest:
      properties:
        linkages:
          items:
            $ref: '#/components/schemas/Linkage'
          type: array
        tasks:
          items:
            $ref: '#/components/schemas/Task'
          type: array
        workflow:
          $ref: '#/components/schemas/Workflow'
      type: object
    Linkage:
      properties:
        linkage_type:
          enum:
            - Start
            - Success
            - Failure
            - Iterate
            - 'True'
            - 'False'
            - Approve
            - Reject
          type: string
        source_task_id:
          type: integer
        source_workflow_id:
          type: integer
        target_task_id:
          type: integer
      type: object
    Task:
      properties:
        action_type:
          enum:
            - Approval
            - Attachment
            - Billing::BillRun
            - Billing::CurrencyConversion
            - Billing::CustomInvoice
            - Callout
            - Cancel
            - Create
            - CustomObject::Create
            - CustomObject::Delete
            - CustomObject::Query
            - CustomObject::Update
            - Data::BillingPreviewRun
            - Data::Link
            - Delay
            - Delete
            - Download::SFTP
            - Email
            - Export
            - File::CustomPDF::CustomDocument
            - If
            - InvoiceGenerate
            - Iterate
            - Logic::CSVTranslator
            - Logic::Case
            - Logic::CustomCode
            - Logic::JSONTransform
            - Logic::Lambda
            - Logic::ResponseFormatter
            - Logic::XMLTransform
            - NewProduct
            - Notifications::GoogleCloudPrint
            - Notifications::PhoneCall
            - Notifications::SMS
            - Payment::GatewayReconciliation
            - Payment::PaymentRun
            - Query
            - RemoveProduct
            - Reporting::ReportData
            - Reporting::RunReport
            - Resume
            - Suspend
            - UI::Page
            - UI::Stop
            - Update
            - Upload::FTP
            - Upload::SFTP
            - WriteOff
          type: string
        call_type:
          type: string
        concurrent_limit:
          type: integer
        data:
          type: object
        end_time:
          type: string
        error:
          type: string
        error_class:
          type: string
        error_details:
          type: string
        id:
          type: integer
        instance:
          type: boolean
        name:
          type: string
        object:
          type: string
        object_id:
          type: string
        original_task_id:
          type: integer
        original_workflow_id:
          type: integer
        parameters:
          type: object
        start_time:
          type: string
        status:
          enum:
            - Queued
            - Processing
            - Pending
            - Success
            - Stopped
            - Error
          type: string
        tags:
          items:
            type: string
          type: array
        task_id:
          type: integer
        workflow_id:
          type: integer
      type: object
    UsagesResponse:
      properties:
        metrics:
          items:
            $ref: '#/components/schemas/WorkflowUsage'
          type: array
      type: object
    WorkflowUsage:
      properties:
        date:
          type: string
        values:
          properties:
            taskCount:
              type: integer
          type: object
      type: object
    TasksResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/Task'
          type: array
        pagination:
          properties:
            next_page:
              type: string
            page:
              type: integer
            page_length:
              type: integer
          type: object
      type: object
    PutTasksRequest:
      properties:
        data:
          items:
            $ref: '#/components/schemas/UpdateTask'
          maximum: 50
          minimum: 1
          type: array
      type: object
    BadRequestResponse:
      properties:
        Errors:
          items:
            properties:
              code:
                type: string
              status:
                type: string
              title:
                type: string
            type: object
          type: array
      type: object
    UpdateTask:
      properties:
        action_type:
          type: string
        call_type:
          type: string
        concurrent_limit:
          maximum: 9999999
          minimum: 1
          type: integer
        id:
          type: integer
        name:
          type: string
        object:
          type: string
        object_id:
          type: string
        status:
          enum:
            - Queued
            - Processing
            - Pending
            - Success
            - Stopped
            - Error
          type: string
        tags:
          items:
            type: string
          type: array
        workflow_id:
          type: integer
      required:
        - id
      title: task
      type: object
    GetWorkflowResponse:
      properties:
        cpuTime:
          format: time
          type: string
        createdAt:
          format: datetime
          type: string
        finishedAt:
          format: datetime
          type: string
        id:
          type: integer
        messages:
          type: object
        name:
          type: string
        originalWorkflowId:
          type: string
        runTime:
          format: double
          type: number
        status:
          enum:
            - Queued
            - Processing
            - Stopping
            - Stopped
            - Finished
          type: string
        tasks:
          properties:
            error:
              type: integer
            pending:
              type: integer
            processing:
              type: integer
            queued:
              type: integer
            stopped:
              type: integer
            success:
              type: integer
            total:
              type: integer
          type: object
        type:
          type: string
        updatedAt:
          format: datetime
          type: string
      type: object
    WorkflowDefinition:
      properties:
        active_version:
          properties:
            id:
              type: integer
            status:
              type: string
            type:
              enum:
                - Workflow::Setup
                - Workflow::Instance
              type: string
            version:
              type: string
          type: object
        calloutTrigger:
          type: boolean
        createdAt:
          format: datetime
          type: string
        id:
          type: integer
        interval:
          type: string
        name:
          type: string
        ondemandTrigger:
          type: boolean
        scheduledTrigger:
          type: boolean
        status:
          type: string
        timezone:
          type: string
        updatedAt:
          format: datetime
          type: string
      title: a workflow definition with version information
      type: object
    ValidationErrors:
      properties:
        reasons:
          items:
            $ref: '#/components/schemas/ValidationReasons'
          title: validation reasons
          type: array
        success:
          type: boolean
      type: object
    ValidationReasons:
      properties:
        fieldName:
          type: string
        title:
          type: string
      type: object
    ExportWorkflowVersionResponse:
      properties:
        linkages:
          items:
            $ref: '#/components/schemas/Linkage'
          type: array
        tasks:
          items:
            $ref: '#/components/schemas/Task'
          type: array
        workflow:
          $ref: '#/components/schemas/Workflow'
      type: object
    WorkflowError:
      properties:
        code:
          enum:
            - invalid
          type: string
        status:
          type: integer
        title:
          type: string
      type: object
    WorkflowInstance:
      properties:
        createdAt:
          format: datetime
          type: string
        id:
          type: integer
        name:
          type: string
        originalWorkflowId:
          type: integer
        status:
          enum:
            - Queued
            - Processing
          type: string
        updatedAt:
          format: datetime
          type: string
      type: object
    GetVersionsResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/Workflow'
          type: array
      type: object
    DetailedWorkflow:
      properties:
        call_type:
          type: string
        calloutTrigger:
          type: boolean
        createdAt:
          format: datetime
          type: string
        finished_at:
          format: datetime
          type: string
        id:
          type: integer
        interval:
          type: string
        name:
          type: string
        ondemandTrigger:
          type: boolean
        original_workflow_id:
          type: integer
        priority:
          type: string
        scheduledTrigger:
          type: boolean
        started_at:
          format: datetime
          type: string
        status:
          type: integer
        sync_trigger:
          type: boolean
        timezone:
          type: string
        type:
          enum:
            - Workflow::Setup
            - Workflow::Instance
          type: string
        updatedAt:
          format: datetime
          type: string
        version:
          type: string
      title: detailed workflow
      type: object
    StopWorkflowRunSuccess:
      type: object
      properties:
        success:
          type: boolean
    StopWorkflowRunError:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              status:
                type: number
              title:
                type: string
    ExpandedAccount:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountNumber:
          type: string
        additionalEmailAddresses:
          type: string
        allowInvoiceEdit:
          type: boolean
          default: false
        autoPay:
          type: boolean
        balance:
          type: number
          format: double
        batch:
          type: string
        bcdSettingOption:
          type: string
          enum:
            - ManualSet
            - AutoSet
        billCycleDay:
          type: integer
          format: int64
        billToId:
          type: string
        communicationProfileId:
          type: string
        creditBalance:
          type: number
          format: double
        crmId:
          maxLength: 100
          type: string
        currency:
          type: string
        customerServiceRepName:
          maxLength: 50
          type: string
        defaultPaymentMethodId:
          type: string
        eInvoiceProfileId:
          type: string
        invoiceDeliveryPrefsEmail:
          type: boolean
        invoiceDeliveryPrefsPrint:
          type: boolean
        invoiceTemplateId:
          type: string
        lastInvoiceDate:
          type: string
          format: date
        lastMetricsUpdate:
          format: date-time
          type: string
        name:
          type: string
        notes:
          type: string
        organizationId:
          type: string
        parentId:
          type: string
        partnerAccount:
          type: boolean
        paymentMethodCascadingConsent:
          type: boolean
        purchaseOrderNumber:
          type: string
        salesRepName:
          type: string
        sequenceSetId:
          type: string
          nullable: true
        shipToId:
          type: string
        soldToId:
          type: string
        status:
          type: string
          enum:
            - Active
            - Draft
            - Canceled
        taxCompanyCode:
          type: string
          maxLength: 50
        taxExemptCertificateID:
          type: string
          maxLength: 32
        taxExemptCertificateType:
          type: string
          maxLength: 32
        taxExemptDescription:
          type: string
          maxLength: 500
        taxExemptEffectiveDate:
          type: string
          format: date
        taxExemptEntityUseCode:
          type: string
          maxLength: 64
        taxExemptExpirationDate:
          type: string
          format: date
        taxExemptIssuingJurisdiction:
          type: string
          maxLength: 32
        taxExemptStatus:
          type: string
          default: 'No'
          enum:
            - 'No'
            - 'Yes'
            - PendingVerification
        totalInvoiceBalance:
          type: number
          format: double
        unappliedBalance:
          type: number
        vATId:
          type: string
        mrr:
          type: number
        totalDebitMemoBalance:
          type: number
          format: double
        unappliedCreditMemoAmount:
          type: number
          format: double
        creditMemoTemplateId:
          type: string
        debitMemoTemplateId:
          type: string
        paymentGateway:
          type: string
        paymentTerm:
          type: string
        billTo:
          $ref: '#/components/schemas/ExpandedContact'
        shipTo:
          $ref: '#/components/schemas/ExpandedContact'
        soldTo:
          $ref: '#/components/schemas/ExpandedContact'
        defaultPaymentMethod:
          $ref: '#/components/schemas/NestedPaymentMethodOnExpand'
        subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/NestedSubscriptionOnExpand'
        payments:
          type: array
          items:
            $ref: '#/components/schemas/NestedPaymentOnExpand'
        refunds:
          type: array
          items:
            $ref: '#/components/schemas/NestedRefundOnExpand'
        creditMemos:
          type: array
          items:
            $ref: '#/components/schemas/NestedCreditMemoOnExpand'
        debitMemos:
          type: array
          items:
            $ref: '#/components/schemas/NestedDebitMemoOnExpand'
        invoices:
          type: array
          items:
            $ref: '#/components/schemas/NestedInvoiceOnExpand'
        usages:
          type: array
          items:
            $ref: '#/components/schemas/NestedUsageOnExpand'
        paymentMethods:
          type: array
          items:
            $ref: '#/components/schemas/NestedPaymentMethodOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryAccountResponse
    CommonOQErrorResponse:
      properties:
        reasons:
          items:
            properties:
              code:
                type: integer
              message:
                type: string
            type: object
          type: array
        requestId:
          format: uuid
          maxLength: 36
          minLength: 36
      type: object
    ExpandedContact:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountId:
          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
        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
        postalCode:
          maxLength: 20
          type: string
        taxRegion:
          maxLength: 32
          type: string
        workEmail:
          maxLength: 80
          type: string
        workPhone:
          maxLength: 40
          type: string
      additionalProperties:
        type: object
      type: object
      title: QueryContactResponse
    NestedPaymentMethodOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountId:
          type: string
        achAbaCode:
          type: string
        achAccountName:
          type: string
        achAccountNumberMask:
          type: string
        achAccountType:
          type: string
          enum:
            - BusinessChecking
            - Checking
            - Saving
        achAddress1:
          type: string
          maxLength: 255
        achAddress2:
          type: string
          maxLength: 255
        achBankName:
          type: string
          maxLength: 70
        achCity:
          type: string
          maxLength: 40
        achCountry:
          type: string
        achPostalCode:
          type: string
          maxLength: 20
        achState:
          type: string
        active:
          type: boolean
        isSystem:
          type: boolean
        bankBranchCode:
          type: string
        bankCheckDigit:
          type: string
        bankCity:
          type: string
        bankCode:
          type: string
        bankIdentificationNumber:
          type: string
        bankName:
          type: string
        bankPostalCode:
          type: string
        bankStreetName:
          type: string
        bankStreetNumber:
          type: string
        bankTransferAccountName:
          type: string
        bankTransferAccountNumberMask:
          type: string
        bankTransferAccountType:
          type: string
        bankTransferType:
          enum:
            - AutomatischIncasso
            - LastschriftDE
            - LastschriftAT
            - DemandeDePrelevement
            - DirectDebitUK
            - Domicil
            - LastschriftCH
            - RID
            - OrdenDeDomiciliacion
            - Autogiro
            - Betalingsservice
          type: string
        businessIdentificationCode:
          type: string
        city:
          type: string
        country:
          type: string
        creditCardAddress1:
          type: string
        creditCardAddress2:
          type: string
        creditCardCity:
          type: string
        creditCardCountry:
          type: string
        creditCardExpirationMonth:
          type: integer
          format: int32
          minimum: 1
          maximum: 12
        creditCardExpirationYear:
          type: integer
          format: int32
        creditCardHolderName:
          type: string
        creditCardMaskNumber:
          type: string
        creditCardPostalCode:
          type: string
        creditCardState:
          type: string
        creditCardType:
          type: string
        deviceSessionId:
          type: string
        existingMandate:
          enum:
            - 'Yes'
            - 'No'
          type: string
        email:
          type: string
        firstName:
          type: string
        iBAN:
          type: string
        iPAddress:
          type: string
        identityNumber:
          type: string
        companyName:
          type: string
        isCompany:
          type: boolean
        lastFailedSaleTransactionDate:
          type: string
          format: date
        lastName:
          type: string
        lastTransactionDateTime:
          type: string
          format: date-time
        lastTransactionStatus:
          type: string
        mandateCreationDate:
          format: date
          type: string
        mandateId:
          type: string
        mandateReason:
          type: string
        mandateReceived:
          type: string
          enum:
            - 'Yes'
            - 'No'
        mandateStatus:
          type: string
        mandateUpdateDate:
          type: string
          format: date
        maxConsecutivePaymentFailures:
          type: integer
          format: int32
        name:
          type: string
        numConsecutiveFailures:
          type: integer
          format: int32
        paymentMethodStatus:
          type: string
          enum:
            - Active
            - Closed
            - Scrubbed
        paymentRetryWindow:
          type: integer
          format: int32
        paypalBaid:
          type: string
        paypalEmail:
          type: string
        paypalPreapprovalKey:
          type: string
        paypalType:
          type: string
        phone:
          type: string
        postalCode:
          type: string
        secondTokenId:
          type: string
        state:
          type: string
        streetName:
          type: string
        streetNumber:
          type: string
        tokenId:
          type: string
        totalNumberOfErrorPayments:
          type: integer
          format: int32
        totalNumberOfProcessedPayments:
          type: integer
          format: int32
        type:
          type: string
        useDefaultRetryRule:
          type: boolean
        methodReferenceId:
          type: string
        userReferenceId:
          type: string
        subType:
          type: string
        methodSpecificData:
          type: string
        cardBrand:
          type: string
        cardClass:
          type: string
          enum:
            - ChargeCard
            - Credit
            - Debit
            - DeferredDebit
            - Prepaid
        cardIssuingBank:
          type: string
        cardIssuingCountry:
          type: string
        cardProductType:
          type: string
          enum:
            - Commercial_or_Corporate_Card
            - Consumer_Card
        account:
          type: object
      additionalProperties:
        type: object
      type: object
      title: QueryPaymentMethodResponse
    NestedSubscriptionOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountId:
          type: string
        autoRenew:
          type: boolean
          default: false
        cancelledDate:
          type: string
          format: date
        contractAcceptanceDate:
          type: string
          format: date
        contractEffectiveDate:
          type: string
          format: date
        creatorAccountId:
          type: string
        creatorInvoiceOwnerId:
          type: string
        currentTerm:
          type: integer
          format: int64
        currentTermPeriodType:
          type: string
          enum:
            - Month
            - Year
            - Day
            - Week
          default: Month
        initialTerm:
          type: integer
          format: int64
        initialTermPeriodType:
          type: string
          enum:
            - Month
            - Year
            - Day
            - Week
          default: Month
        invoiceOwnerId:
          type: string
        isInvoiceSeparate:
          type: boolean
          default: false
        isSingleVersioned:
          type: boolean
        name:
          type: string
        notes:
          type: string
          maxLength: 65535
        originalCreatedDate:
          type: string
        originalId:
          type: string
        previousSubscriptionId:
          type: string
        renewalSetting:
          type: string
          enum:
            - RENEW_WITH_SPECIFIC_TERM
            - RENEW_TO_EVERGREEN
          default: RENEW_WITH_SPECIFIC_TERM
        renewalTerm:
          type: integer
          format: int64
        renewalTermPeriodType:
          type: string
          enum:
            - Month
            - Year
            - Day
            - Week
          default: Month
        revision:
          type: string
        serviceActivationDate:
          type: string
          format: date
        status:
          type: string
          enum:
            - Draft
            - Pending Activation
            - Pending Acceptance
            - Active
            - Cancelled
            - Suspended
        isLatestVersion:
          type: boolean
        subscriptionEndDate:
          type: string
          format: date
        subscriptionStartDate:
          type: string
          format: date
        subscriptionVersionAmendmentId:
          type: string
        termEndDate:
          type: string
          format: date
        termStartDate:
          type: string
          format: date
        termType:
          type: string
          enum:
            - TERMED
            - EVERGREEN
        version:
          type: integer
          format: int64
        cMRR:
          type: number
        billToContactSnapshotId:
          type: string
        billToContactId:
          type: string
        invoiceTemplateId:
          type: string
        sequenceSetId:
          type: string
          nullable: true
        shipToContactId:
          type: string
        shipToContactSnapshotId:
          type: string
        soldToContactId:
          type: string
        soldToContactSnapshotId:
          type: string
        externallyManagedBy:
          type: string
          enum:
            - Amazon
            - Apple
            - Google
            - Roku
        lastBookingDate:
          format: date
          type: string
        invoiceScheduleId:
          type: string
        cancelReason:
          type: string
        prepayment:
          type: boolean
        currency:
          type: string
        orderId:
          type: string
        rampId:
          type: string
        paymentTerm:
          type: string
        quoteNumber__QT:
          type: string
          maxLength: 32
        quoteType__QT:
          maxLength: 32
          type: string
        quoteBusinessType__QT:
          type: string
          maxLength: 32
        opportunityName__QT:
          type: string
          maxLength: 100
        opportunityCloseDate__QT:
          type: string
          format: date
        cpqBundleJsonId__QT:
          maxLength: 32
          type: string
        account:
          type: object
        invoiceOwner:
          type: object
        billToContact:
          type: object
        invoiceItems:
          type: array
          items:
            type: object
        ratePlans:
          type: array
          items:
            type: object
      additionalProperties:
        type: object
      type: object
      title: QuerySubscriptionResponse
    NestedPaymentOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountId:
          type: string
        accountingCode:
          type: string
        amount:
          format: double
          type: number
        appliedAmount:
          format: double
          type: number
        authTransactionId:
          type: string
        appliedCreditBalanceAmount:
          type: number
        bankIdentificationNumber:
          type: string
        cancelledOn:
          type: string
          format: date-time
        comment:
          type: string
          nullable: true
        currency:
          type: string
        effectiveDate:
          type: string
          format: date
        gatewayOrderId:
          type: string
        gatewayReconciliationReason:
          type: string
        gatewayReconciliationStatus:
          type: string
        gatewayResponse:
          type: string
        gatewayResponseCode:
          type: string
        gatewayState:
          enum:
            - MarkedForSubmission
            - Submitted
            - Settled
            - NotSubmitted
            - FailedToSettle
          type: string
        gatewayTransactionState:
          type: string
        isStandalone:
          type: boolean
        markedForSubmissionOn:
          type: string
          format: date-time
        paymentMethodId:
          type: string
        paymentMethodSnapshotId:
          type: string
        paymentOptionId:
          type: string
        paymentNumber:
          type: string
        payoutId:
          type: string
        prepayment:
          type: boolean
        referencedPaymentID:
          type: string
        referenceId:
          type: string
        refundAmount:
          type: number
          format: double
        secondPaymentReferenceId:
          type: string
        settledOn:
          type: string
          format: date-time
        softDescriptor:
          type: string
        softDescriptorPhone:
          type: string
        source:
          type: string
          enum:
            - PaymentRun
            - Import
            - Manually
            - API
        sourceName:
          type: string
        status:
          enum:
            - Draft
            - Processing
            - Processed
            - Error
            - Canceled
            - Posted
          type: string
        submittedOn:
          format: date-time
          type: string
        type:
          enum:
            - External
            - Electronic
          type: string
        transferredToAccounting:
          enum:
            - Processing
            - 'Yes'
            - 'No'
            - Error
            - Ignore
          type: string
        transactionSource:
          type: string
          enum:
            - C_Unscheduled
            - M_Recurring
            - M_Unscheduled
            - M_MOTO
        unappliedAmount:
          type: number
        lastEmailDateTime:
          type: string
        gateway:
          type: string
        account:
          type: object
        paymentMethod:
          type: object
        paymentApplications:
          type: array
          items:
            type: object
      additionalProperties:
        type: object
      type: object
      title: QueryPaymentResponse
    NestedRefundOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountId:
          type: string
        amount:
          format: double
          type: number
        cancelledOn:
          format: date-time
          type: string
        comment:
          type: string
          nullable: true
        paymentMethodSnapshotId:
          type: string
        accountingCode:
          type: string
        currency:
          type: string
        gatewayReconciliationReason:
          type: string
        gatewayReconciliationStatus:
          type: string
        gatewayResponse:
          type: string
        gatewayResponseCode:
          type: string
        gatewayState:
          enum:
            - MarkedForSubmission
            - Submitted
            - Settled
            - NotSubmitted
            - FailedToSettle
          type: string
        markedForSubmissionOn:
          format: date-time
          type: string
        methodType:
          enum:
            - ACH
            - Cash
            - Check
            - CreditCard
            - PayPal
            - WireTransfer
            - DebitCard
            - CreditCardReferenceTransaction
            - BankTransfer
            - Other
          type: string
        paymentMethodId:
          type: string
        payoutId:
          type: string
        reasonCode:
          type: string
        refundNumber:
          type: string
        referenceID:
          type: string
        refundDate:
          format: date
          type: string
        refundTransactionTime:
          format: date-time
          type: string
        sourceType:
          type: string
          enum:
            - Payment
            - CreditBalance
            - CreditMemo
        secondRefundReferenceId:
          type: string
        settledOn:
          format: date-time
          type: string
        softDescriptor:
          type: string
        softDescriptorPhone:
          type: string
        status:
          enum:
            - Processed
            - Canceled
            - Error
            - Processing
          type: string
        submittedOn:
          type: string
          format: date-time
        transferredToAccounting:
          enum:
            - Processing
            - 'Yes'
            - 'No'
            - Error
            - Ignore
          type: string
        type:
          type: string
          enum:
            - External
            - Electronic
        associatedTransactionNumber:
          type: string
        gateway:
          type: string
        account:
          type: object
        paymentMethod:
          type: object
        refundApplications:
          type: array
          items:
            type: object
      additionalProperties:
        type: object
      type: object
      title: QueryRefundResponse
    NestedCreditMemoOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        appliedAmount:
          format: double
          type: number
        balance:
          type: number
        billToContactId:
          type: string
        billToContactSnapshotId:
          type: string
        cancelledById:
          type: string
          nullable: true
        cancelledOn:
          format: date-time
          type: string
          nullable: true
        comment:
          type: string
          nullable: true
        currency:
          type: string
          nullable: true
        discountAmount:
          type: number
        einvoiceErrorCode:
          type: string
        einvoiceErrorMessage:
          type: string
        einvoiceFileId:
          type: string
        einvoiceStatus:
          enum:
            - Processing
            - Generated
            - Success
            - Failed
            - ConditionalSuccess
            - ApprovedByAuthority
            - Rejected
          type: string
        excludeFromAutoApplyRules:
          type: boolean
        exchangeRateDate:
          type: string
          format: date
        autoApplyUponPosting:
          type: boolean
        memoDate:
          type: string
          format: date
        memoNumber:
          type: string
        postedById:
          type: string
        postedOn:
          format: date-time
          type: string
        reasonCode:
          type: string
        refundAmount:
          format: double
          type: number
        revenueImpacting:
          enum:
            - 'Yes'
            - 'No'
          default: 'Yes'
          type: string
        reversed:
          type: boolean
        sequenceSetId:
          type: string
          nullable: true
        source:
          type: string
          enum:
            - BillRun
            - API
            - ApiSubscribe
            - ApiAmend
            - AdhocFromPrpc
            - AdhocFromInvoice
        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
        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
        shipToContactSnapshotId:
          type: string
        soldToContactSnapshotId:
          type: string
        taxAutoCalculation:
          default: true
          type: boolean
        totalAmount:
          type: number
          format: double
        totalAmountWithoutTax:
          type: number
          format: double
        totalTaxExemptAmount:
          format: double
          type: number
        transferredToAccounting:
          enum:
            - Processing
            - 'Yes'
            - 'No'
            - Error
            - Ignore
          type: string
        invoiceId:
          type: string
        accountId:
          type: string
        account:
          type: object
        billToContact:
          type: object
        creditMemoItems:
          type: array
          items:
            type: object
        creditMemoApplications:
          type: array
          items:
            type: object
      additionalProperties:
        type: object
      type: object
      title: QueryCreditMemoResponse
    NestedDebitMemoOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        autoPay:
          type: boolean
        creditMemoId:
          type: string
          nullable: true
        balance:
          type: number
        billToContactId:
          type: string
        billToContactSnapshotId:
          type: string
        cancelledById:
          type: string
          nullable: true
        cancelledOn:
          format: date-time
          type: string
          nullable: true
        comments:
          type: string
        currency:
          type: string
          nullable: true
        discountAmount:
          type: number
        dueDate:
          type: string
          format: date
        einvoiceErrorCode:
          type: string
        einvoiceErrorMessage:
          type: string
        einvoiceFileId:
          type: string
        einvoiceStatus:
          enum:
            - Processing
            - Generated
            - Success
            - Failed
            - ConditionalSuccess
            - ApprovedByAuthority
            - Rejected
          type: string
        exchangeRateDate:
          type: string
          format: date
        memoDate:
          type: string
          format: date
        memoNumber:
          type: string
        postedById:
          type: string
        postedOn:
          format: date-time
          type: string
        reasonCode:
          type: string
        sequenceSetId:
          type: string
          nullable: true
        source:
          type: string
          enum:
            - BillRun
            - API
            - ApiSubscribe
            - ApiAmend
            - AdhocFromPrpc
            - AdhocFromInvoice
        sourceId:
          type: string
        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
        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
        shipToContactSnapshotId:
          type: string
        soldToContactSnapshotId:
          type: string
        taxAutoCalculation:
          default: true
          type: boolean
        totalAmount:
          type: number
          format: double
        totalAmountWithoutTax:
          type: number
          format: double
        totalTaxExemptAmount:
          format: double
          type: number
        transferredToAccounting:
          enum:
            - Processing
            - 'Yes'
            - 'No'
            - Error
            - Ignore
          type: string
        invoiceId:
          type: string
        accountId:
          type: string
        paymentTerm:
          type: string
        account:
          type: object
        billToContact:
          type: object
        debitMemoItems:
          type: array
          items:
            type: object
      additionalProperties:
        type: object
      type: object
      title: QueryDebitMemoResponse
    NestedInvoiceOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountId:
          type: string
        adjustmentAmount:
          format: double
          type: number
        amount:
          format: double
          type: number
        amountWithoutTax:
          format: double
          type: number
        autoPay:
          type: boolean
        balance:
          type: number
          format: double
        billToContactId:
          type: string
        billToContactSnapshotId:
          type: string
        comments:
          type: string
        creditBalanceAdjustmentAmount:
          format: double
          type: number
        creditMemoAmount:
          format: double
          type: number
        currency:
          nullable: true
          type: string
        dueDate:
          type: string
          format: date
        includesOneTime:
          type: boolean
        includesRecurring:
          type: boolean
        includesUsage:
          type: boolean
        invoiceDate:
          format: date
          type: string
        invoiceNumber:
          type: string
        lastEmailSentDate:
          type: string
        organizationId:
          type: string
        paymentAmount:
          format: double
          type: number
        postedBy:
          type: string
        postedDate:
          format: date-time
          type: string
        refundAmount:
          format: double
          type: number
        sequenceSetId:
          type: string
        communicationProfileId:
          type: string
          nullable: true
        shipToContactId:
          type: string
        shipToContactSnapshotId:
          type: string
        soldToContactId:
          type: string
        soldToContactSnapshotId:
          type: string
        source:
          enum:
            - BillRun
            - API
            - ApiSubscribe
            - ApiAmend
          type: string
        sourceId:
          type: string
        reversed:
          type: boolean
        sourceType:
          enum:
            - Subscription
            - Standalone
            - Order
            - Consolidation
          type: string
        status:
          enum:
            - Draft
            - Posted
          type: string
        targetDate:
          format: date
          type: string
        taxAmount:
          format: double
          type: number
        taxExemptAmount:
          format: double
          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
        transferredToAccounting:
          enum:
            - Processing
            - Error
            - Ignore
            - 'Yes'
            - 'No'
          type: string
        eInvoiceStatus:
          enum:
            - Processing
            - RetrieveTimeOut
            - Generated
            - Success
            - Failed
            - ConditionalSuccess
            - ApprovedByAuthority
            - Rejected
          type: string
        eInvoiceFileId:
          type: string
        eInvoiceErrorCode:
          type: string
        eInvoiceErrorMessage:
          type: string
        paymentLink:
          type: string
        paymentTerm:
          type: string
        account:
          type: object
        billToContact:
          type: object
        invoiceItems:
          type: array
          items:
            type: object
      additionalProperties:
        type: object
      type: object
      title: QueryInvoiceResponse
    NestedUsageOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountId:
          type: string
        accountNumber:
          type: string
        ratePlanChargeId:
          type: string
        endDateTime:
          type: string
          format: date-time
        productRatePlanChargeId:
          type: string
        quantity:
          type: number
        rbeStatus:
          type: string
          enum:
            - Importing
            - Pending
            - Processed
        sourceType:
          type: string
          enum:
            - API
            - Import
        startDateTime:
          format: date-time
          type: string
        subscriptionId:
          type: string
        submissionDateTime:
          type: string
          format: date-time
        uOM:
          type: string
        importId:
          type: string
        uniqueKey:
          type: string
        fileId:
          type: string
        fileName:
          type: string
        account:
          type: object
      additionalProperties:
        type: object
      type: object
      title: QueryUsageResponse
    ExpandedAmendment:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        autoRenew:
          type: boolean
        code:
          type: string
        contractEffectiveDate:
          type: string
          format: date
        currentTerm:
          type: integer
          format: int64
        currentTermPeriodType:
          type: string
          enum:
            - Month
            - Year
            - Day
            - Week
        customerAcceptanceDate:
          type: string
          format: date
        effectiveDate:
          type: string
          format: date
        effectivePolicy:
          type: string
          enum:
            - EffectiveImmediately
            - EffectiveEndOfBillingPeriod
            - SpecificDate
        name:
          type: string
        newRatePlanId:
          type: string
        removedRatePlanId:
          type: string
        renewalSetting:
          type: string
          enum:
            - RENEW_WITH_SPECIFIC_TERM
            - RENEW_TO_EVERGREEN
        renewalTerm:
          format: int64
          type: integer
        renewalTermPeriodType:
          type: string
          enum:
            - Month
            - Year
            - Day
            - Week
        resumeDate:
          format: date
          type: string
        serviceActivationDate:
          type: string
          format: date
        specificUpdateDate:
          type: string
          format: date
        status:
          type: string
          enum:
            - Draft
            - Pending Activation
            - Pending Acceptance
            - Completed
        subscriptionId:
          type: string
        suspendDate:
          type: string
          format: date
        termStartDate:
          type: string
          format: date
        termType:
          type: string
          enum:
            - TERMED
            - EVERGREEN
        type:
          type: string
          enum:
            - Cancellation
            - NewProduct
            - OwnerTransfer
            - RemoveProduct
            - Renewal
            - UpdateProduct
            - TermsAndConditions
            - ChangePlan
            - Composite
        subType:
          type: string
          enum:
            - Upgrade
            - Downgrade
            - Crossgrade
            - PlanChanged
        bookingDate:
          type: string
          format: date
      additionalProperties:
        type: object
      type: object
      title: QueryAmendmentResponse
    ExpandedBillingRun:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        billingRunNumber:
          type: string
        billingRunType:
          type: string
          enum:
            - Regular
            - CatchUp
          default: Regular
        endDate:
          type: string
          format: date-time
        errorMessage:
          type: string
        executedDate:
          type: string
          format: date-time
        invoiceDate:
          type: string
          format: date
        name:
          type: string
        numberOfAccounts:
          type: integer
          format: int64
        numberOfInvoices:
          type: integer
          format: int64
        numberOfCreditMemos:
          type: integer
          format: int64
        postedDate:
          type: string
          format: date-time
        startDate:
          type: string
          format: date-time
        status:
          enum:
            - Pending
            - Processing
            - Completed
            - Error
            - Canceled
            - Posted
            - PostInProgress
            - CancelInProgress
            - RemoveInProgress
            - Paused
          type: string
        targetDate:
          type: string
          format: date
        targetType:
          type: string
          enum:
            - SingleAccount
            - AllAccount
        totalTime:
          type: integer
          format: int64
        accountId:
          type: string
        batches:
          items:
            type: string
          type: array
        billCycleDay:
          type: string
          enum:
            - AllBillCycleDays
            - AsRunDay
        noEmailForZeroAmountInvoice:
          type: boolean
        autoEmail:
          type: boolean
        autoPost:
          type: boolean
        autoRenewal:
          type: boolean
        invoicesEmailed:
          type: boolean
        lastEmailSentTime:
          type: string
          format: date-time
        targetDateOffSet:
          type: integer
          format: int32
        invoiceDateOffSet:
          type: integer
          format: int32
        chargeTypeToExclude:
          enum:
            - OneTime
            - Recurring
            - Usage
          type: string
        scheduledExecutionTime:
          format: date-time
          type: string
        repeatType:
          enum:
            - None
            - Daily
            - Weekly
            - Monthly
          type: string
        repeatFrom:
          format: date
          type: string
        repeatTo:
          format: date
          type: string
        runTime:
          type: integer
          format: int32
          maximum: 23
          minimum: 0
        timeZone:
          type: string
        monthlyOnDay:
          type: string
        weeklyOnDay:
          enum:
            - Mon
            - Tue
            - Wed
            - Thu
            - Fri
            - Sat
            - Sun
          type: string
        includeSubscriptions:
          default: true
          type: boolean
        includeOrderLineItems:
          default: true
          type: boolean
      additionalProperties:
        type: object
      type: object
      title: QueryBillingRunResponse
    ExpandedCreditMemo:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        appliedAmount:
          format: double
          type: number
        balance:
          type: number
        billToContactId:
          type: string
        billToContactSnapshotId:
          type: string
        cancelledById:
          type: string
          nullable: true
        cancelledOn:
          format: date-time
          type: string
          nullable: true
        comment:
          type: string
          nullable: true
        currency:
          type: string
          nullable: true
        discountAmount:
          type: number
        einvoiceErrorCode:
          type: string
        einvoiceErrorMessage:
          type: string
        einvoiceFileId:
          type: string
        einvoiceStatus:
          enum:
            - Processing
            - RetrieveTimeOut
            - Generated
            - Success
            - Failed
            - ConditionalSuccess
            - ApprovedByAuthority
            - Rejected
          type: string
        excludeFromAutoApplyRules:
          type: boolean
        exchangeRateDate:
          type: string
          format: date
        autoApplyUponPosting:
          type: boolean
        memoDate:
          type: string
          format: date
        memoNumber:
          type: string
        postedById:
          type: string
        postedOn:
          format: date-time
          type: string
        reasonCode:
          type: string
        refundAmount:
          format: double
          type: number
        reversed:
          type: boolean
        revenueImpacting:
          enum:
            - 'Yes'
            - 'No'
          default: 'Yes'
          type: string
        sequenceSetId:
          type: string
          nullable: true
        source:
          type: string
          enum:
            - BillRun
            - API
            - ApiSubscribe
            - ApiAmend
            - AdhocFromPrpc
            - AdhocFromInvoice
        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
        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
        shipToContactSnapshotId:
          type: string
        soldToContactSnapshotId:
          type: string
        taxAutoCalculation:
          default: true
          type: boolean
        totalAmount:
          type: number
          format: double
        totalAmountWithoutTax:
          type: number
          format: double
        totalTaxExemptAmount:
          format: double
          type: number
        transferredToAccounting:
          enum:
            - Processing
            - 'Yes'
            - 'No'
            - Error
            - Ignore
          type: string
        invoiceId:
          type: string
        accountId:
          type: string
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        billToContact:
          $ref: '#/components/schemas/ExpandedContact'
        creditMemoItems:
          type: array
          items:
            $ref: '#/components/schemas/NestedCreditMemoItemOnExpand'
        creditMemoApplications:
          type: array
          items:
            $ref: '#/components/schemas/NestedCreditMemoApplicationOnExpand'
        billToContactSnapshot:
          $ref: '#/components/schemas/NestedContactSnapshotOnExpand'
        soldToContactSnapshot:
          $ref: '#/components/schemas/NestedContactSnapshotOnExpand'
        shipToContactSnapshot:
          $ref: '#/components/schemas/NestedContactSnapshotOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryCreditMemoResponse
    NestedAccountOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountNumber:
          type: string
        additionalEmailAddresses:
          type: string
        allowInvoiceEdit:
          type: boolean
          default: false
        autoPay:
          type: boolean
        balance:
          type: number
          format: double
        batch:
          type: string
        bcdSettingOption:
          type: string
          enum:
            - ManualSet
            - AutoSet
        billCycleDay:
          type: integer
          format: int64
        billToId:
          type: string
        communicationProfileId:
          type: string
        creditBalance:
          type: number
          format: double
        crmId:
          maxLength: 100
          type: string
        currency:
          type: string
        customerServiceRepName:
          maxLength: 50
          type: string
        defaultPaymentMethodId:
          type: string
        eInvoiceProfileId:
          type: string
        invoiceDeliveryPrefsEmail:
          type: boolean
        invoiceDeliveryPrefsPrint:
          type: boolean
        invoiceTemplateId:
          type: string
        lastInvoiceDate:
          type: string
          format: date
        lastMetricsUpdate:
          format: date-time
          type: string
        name:
          type: string
        notes:
          type: string
        organizationId:
          type: string
        parentId:
          type: string
        partnerAccount:
          type: boolean
        paymentMethodCascadingConsent:
          type: boolean
        purchaseOrderNumber:
          type: string
        salesRepName:
          type: string
        sequenceSetId:
          type: string
          nullable: true
        shipToId:
          type: string
        soldToId:
          type: string
        status:
          type: string
          enum:
            - Active
            - Draft
            - Canceled
        taxCompanyCode:
          type: string
          maxLength: 50
        taxExemptCertificateID:
          type: string
          maxLength: 32
        taxExemptCertificateType:
          type: string
          maxLength: 32
        taxExemptDescription:
          type: string
          maxLength: 500
        taxExemptEffectiveDate:
          type: string
          format: date
        taxExemptEntityUseCode:
          type: string
          maxLength: 64
        taxExemptExpirationDate:
          type: string
          format: date
        taxExemptIssuingJurisdiction:
          type: string
          maxLength: 32
        taxExemptStatus:
          type: string
          default: 'No'
          enum:
            - 'No'
            - 'Yes'
            - PendingVerification
        totalInvoiceBalance:
          type: number
          format: double
        unappliedBalance:
          type: number
        vATId:
          type: string
        mrr:
          type: number
        totalDebitMemoBalance:
          type: number
          format: double
        unappliedCreditMemoAmount:
          type: number
          format: double
        creditMemoTemplateId:
          type: string
        debitMemoTemplateId:
          type: string
        paymentGateway:
          type: string
        paymentTerm:
          type: string
        billTo:
          type: object
        shipTo:
          type: object
        soldTo:
          type: object
        defaultPaymentMethod:
          type: object
        subscriptions:
          type: array
          items:
            type: object
        payments:
          type: array
          items:
            type: object
        refunds:
          type: array
          items:
            type: object
        creditMemos:
          type: array
          items:
            type: object
        debitMemos:
          type: array
          items:
            type: object
        invoices:
          type: array
          items:
            type: object
        usages:
          type: array
          items:
            type: object
        paymentMethods:
          type: array
          items:
            type: object
      additionalProperties:
        type: object
      type: object
      title: QueryAccountResponse
    NestedCreditMemoItemOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        amount:
          type: number
        amountWithoutTax:
          format: double
          type: number
        appliedToItemId:
          type: string
        appliedToOthersAmount:
          type: number
        beAppliedByOthersAmount:
          type: number
        chargeDate:
          type: string
          format: date-time
        excludeItemBillingFromRevenueAccounting:
          type: boolean
        fulfillmentId:
          type: string
        invoiceScheduleId:
          type: string
        invoiceScheduleItemId:
          type: string
        itemShipToContactId:
          type: string
        itemSoldToContactId:
          type: string
        itemSoldToContactSnapshotId:
          type: string
        itemType:
          type: string
        orderLineItemId:
          type: string
        processingType:
          type: string
          enum:
            - '0'
            - '1'
        quantity:
          format: double
          type: number
        purchaseOrderNumber:
          type: string
        creditFromItemSource:
          enum:
            - InvoiceItem
            - CreditMemoItem
          type: string
        creditFromItemId:
          type: string
        reflectDiscountInNetAmount:
          type: boolean
          default: false
        serviceEndDate:
          format: date
          type: string
        serviceStartDate:
          format: date
          type: string
        sku:
          type: string
        sourceItemType:
          enum:
            - SubscriptionComponent
            - InvoiceDetail
            - ProductRatePlanCharge
            - OrderLineItem
          type: string
        subscriptionId:
          type: string
        taxMode:
          enum:
            - TaxExclusive
            - TaxInclusive
          type: string
        chargeName:
          type: string
        chargeNumber:
          type: string
        commitmentChargeSegmentNumber:
          type: string
        commitmentChargeNumber:
          type: string
        taxAmount:
          format: double
          type: number
        taxCodeName:
          type: string
        taxExemptAmount:
          type: number
        unappliedAmount:
          format: double
          type: number
        unitOfMeasure:
          type: string
        unitPrice:
          format: double
          type: number
        subscriptionNumber:
          type: string
        invoiceItemId:
          type: string
        productRatePlanChargeId:
          type: string
        ratePlanChargeId:
          type: string
        revenueRecognitionRuleName:
          type: string
        revenueImpacting:
          enum:
            - 'Yes'
            - 'No'
          default: 'Yes'
          type: string
        creditMemoId:
          type: string
        numberOfDeliveries:
          type: number
        recognizedRevenueAccountingCodeId:
          type: string
        accountReceivableAccountingCodeId:
          type: string
        onAccountAccountingCodeId:
          type: string
        deferredRevenueAccountingCodeId:
          type: string
        journalEntryId:
          type: string
        shipToContactSnapshotId:
          type: string
        soldToContactSnapshotId:
          type: string
        billToContactSnapshotId:
          type: string
        subscription:
          type: object
        ratePlanCharge:
          type: object
      additionalProperties:
        type: object
      type: object
      title: QueryCreditMemoItemResponse
    NestedCreditMemoApplicationOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        amount:
          type: number
          format: double
        effectiveDate:
          type: string
          format: date
        creditMemoId:
          type: string
        accountId:
          type: string
        applicationGroupId:
          type: string
        debitMemoId:
          type: string
        invoiceId:
          type: string
        creditMemo:
          type: object
      type: object
      title: QueryCreditMemoApplicationResponse
      additionalProperties: false
    NestedContactSnapshotOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountId:
          type: string
        contactId:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        nickName:
          type: string
        address1:
          type: string
        address2:
          type: string
        city:
          type: string
        state:
          type: string
        postalCode:
          type: string
        county:
          type: string
        country:
          type: string
        taxRegion:
          type: string
        homePhone:
          type: string
        otherPhone:
          type: string
        otherPhoneType:
          type: string
        fax:
          type: string
        personalEmail:
          type: string
        workEmail:
          type: string
        deleted:
          type: boolean
      additionalProperties:
        type: object
      type: object
      title: QueryContactSnapshotResponse
    ExpandedCreditMemoApplication:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        amount:
          type: number
          format: double
        effectiveDate:
          type: string
          format: date
        creditMemoId:
          type: string
        accountId:
          type: string
        applicationGroupId:
          type: string
        debitMemoId:
          type: string
        invoiceId:
          type: string
        creditMemo:
          $ref: '#/components/schemas/NestedCreditMemoOnExpand'
      type: object
      title: QueryCreditMemoApplicationResponse
      additionalProperties: false
    ExpandedCreditMemoItem:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        amount:
          type: number
        amountWithoutTax:
          format: double
          type: number
        appliedToItemId:
          type: string
        appliedToOthersAmount:
          type: number
        beAppliedByOthersAmount:
          type: number
        chargeDate:
          type: string
          format: date-time
        excludeItemBillingFromRevenueAccounting:
          type: boolean
        fulfillmentId:
          type: string
        invoiceScheduleId:
          type: string
        invoiceScheduleItemId:
          type: string
        itemShipToContactId:
          type: string
        itemSoldToContactId:
          type: string
        itemSoldToContactSnapshotId:
          type: string
        itemType:
          type: string
        orderLineItemId:
          type: string
        processingType:
          type: string
          enum:
            - '0'
            - '1'
        revenueImpacting:
          enum:
            - 'Yes'
            - 'No'
          default: 'Yes'
          type: string
        quantity:
          format: double
          type: number
        purchaseOrderNumber:
          type: string
        creditFromItemSource:
          enum:
            - InvoiceItem
            - CreditMemoItem
          type: string
        creditFromItemId:
          type: string
        reflectDiscountInNetAmount:
          type: boolean
          default: false
        serviceEndDate:
          format: date
          type: string
        serviceStartDate:
          format: date
          type: string
        sku:
          type: string
        sourceItemType:
          enum:
            - SubscriptionComponent
            - InvoiceDetail
            - ProductRatePlanCharge
            - OrderLineItem
          type: string
        subscriptionId:
          type: string
        taxMode:
          enum:
            - TaxExclusive
            - TaxInclusive
          type: string
        chargeName:
          type: string
        chargeNumber:
          type: string
        commitmentChargeSegmentNumber:
          type: string
        commitmentChargeNumber:
          type: string
        taxAmount:
          format: double
          type: number
        taxCodeName:
          type: string
        taxExemptAmount:
          type: number
        unappliedAmount:
          format: double
          type: number
        unitOfMeasure:
          type: string
        unitPrice:
          format: double
          type: number
        subscriptionNumber:
          type: string
        invoiceItemId:
          type: string
        productRatePlanChargeId:
          type: string
        ratePlanChargeId:
          type: string
        revenueRecognitionRuleName:
          type: string
        creditMemoId:
          type: string
        numberOfDeliveries:
          type: number
        recognizedRevenueAccountingCodeId:
          type: string
        accountReceivableAccountingCodeId:
          type: string
        onAccountAccountingCodeId:
          type: string
        deferredRevenueAccountingCodeId:
          type: string
        journalEntryId:
          type: string
        shipToContactSnapshotId:
          type: string
        soldToContactSnapshotId:
          type: string
        billToContactSnapshotId:
          type: string
        subscription:
          $ref: '#/components/schemas/NestedSubscriptionOnExpand'
        ratePlanCharge:
          $ref: '#/components/schemas/NestedRatePlanChargeOnExpand'
        subscriptionOwner:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        creditTaxationItems:
          $ref: '#/components/schemas/NestedCreditTaxationItemOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryCreditMemoItemResponse
    NestedRatePlanChargeOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        ratePlanId:
          type: string
        productRatePlanChargeId:
          type: string
        accountingCode:
          type: string
        applyDiscountTo:
          type: string
        billCycleDay:
          type: integer
          format: int64
        billCycleType:
          type: string
        billingPeriod:
          type: string
        billingPeriodAlignment:
          type: string
        billingTiming:
          type: string
          enum:
            - In Advance
            - In Arrears
        chargedThroughDate:
          type: string
          format: date
          maxLength: 29
        chargeModel:
          type: string
        chargeNumber:
          type: string
        chargeType:
          type: string
        discountLevel:
          type: string
          enum:
            - rateplan
            - subscription
            - account
        dMRC:
          type: number
        drawdownRate:
          type: number
        dTCV:
          type: number
        effectiveEndDate:
          type: string
          format: date
        effectiveStartDate:
          type: string
          format: date
        endDateCondition:
          enum:
            - SubscriptionEnd
            - FixedPeriod
            - SpecificEndDate
            - OneTime
          type: string
        excludeItemBillingFromRevenueAccounting:
          default: false
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          default: false
          type: boolean
        invoiceScheduleId:
          type: string
        isLastSegment:
          type: boolean
        isPrepaid:
          type: boolean
        isRollover:
          type: boolean
        rolloverPeriods:
          type: integer
          format: int64
        rolloverPeriodLength:
          type: integer
          format: int32
          nullable: true
        rolloverApply:
          type: string
          enum:
            - ApplyFirst
            - ApplyLast
        isProcessed:
          type: boolean
        listPriceBase:
          type: string
          enum:
            - Per Billing Period
            - Per Month
            - Per Week
            - Per Year
            - Per Specific Months
        specificListPriceBase:
          type: integer
          format: int32
          maximum: 200
          minimum: 1
          nullable: true
        priceUpsellQuantityStacked:
          type: boolean
        commitmentType:
          enum:
            - UNIT
            - CURRENCY
          type: string
        isCommitted:
          type: boolean
        mRR:
          type: number
        name:
          type: string
          maxLength: 100
        numberOfPeriods:
          type: integer
          format: int64
        originalId:
          type: string
          maxLength: 32
        overageCalculationOption:
          type: string
          maxLength: 20
        overageUnusedUnitsCreditOption:
          type: string
          maxLength: 20
        prepaidOperationType:
          enum:
            - topup
            - drawdown
            - null
          type: string
          nullable: true
        prepaidQuantity:
          type: number
          nullable: true
        prepaidTotalQuantity:
          type: number
          nullable: true
        priceChangeOption:
          type: string
        priceIncreasePercentage:
          type: number
          format: double
        processedThroughDate:
          type: string
          format: date
          maxLength: 29
        prorationOption:
          type: string
        quantity:
          type: number
        numberOfDeliveries:
          type: number
        ratingGroup:
          type: string
          enum:
            - ByBillingPeriod
            - ByUsageStartDate
            - ByUsageRecord
            - ByUsageUpload
            - ByGroupId
        revenueRecognitionRuleName:
          type: string
        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
        revRecCode:
          type: string
          maxLength: 70
        revRecTriggerCondition:
          type: string
          maxLength: 22
        segment:
          type: integer
          format: int32
        specificBillingPeriod:
          type: integer
          format: int64
        specificEndDate:
          type: string
          format: date
        tCV:
          format: double
          type: number
        triggerDate:
          format: date
          type: string
        triggerEvent:
          type: string
          maxLength: 18
        uOM:
          type: string
          maxLength: 25
        upToPeriods:
          type: integer
          format: int64
        upToPeriodsType:
          type: string
          enum:
            - Billing Periods
            - Days
            - Weeks
            - Months
            - Years
          default: Billing Periods
        version:
          type: integer
          format: int64
        weeklyBillCycleDay:
          type: string
          enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
        subscriptionId:
          type: string
        subscriptionOwnerId:
          type: string
        invoiceOwnerId:
          type: string
        originalOrderDate:
          type: string
          format: date
        amendedByOrderOn:
          type: string
          format: date
        validityPeriodType:
          type: string
          enum:
            - SUBSCRIPTION_TERM
            - ANNUAL
            - SEMI_ANNUAL
            - QUARTER
            - MONTH
        creditOption:
          type: string
          enum:
            - TimeBased
            - ConsumptionBased
            - FullCreditBack
        applyToBillingPeriodPartially:
          type: boolean
        productChargeDefinitionId:
          type: string
        accountReceivableAccountingCodeId:
          type: string
        deferredRevenueAccountingCodeId:
          type: string
        recognizedRevenueAccountingCodeId:
          type: string
        prepaidUOM:
          type: string
        drawdownUom:
          type: string
        ratePlan:
          type: object
        productRatePlanCharge:
          type: object
        salesPrice:
          type: number
        taxable:
          type: boolean
        reverted:
          type: boolean
        reflectDiscountInNetAmount:
          type: boolean
      additionalProperties:
        type: object
      type: object
      title: QueryRatePlanChargeResponse
    NestedCreditTaxationItemOnExpand:
      properties:
        appliedAmount:
          format: double
          type: number
        axemptAmount:
          format: double
          type: number
        jurisdiction:
          type: string
        locationCode:
          type: string
        name:
          type: string
        refundAmount:
          format: double
          type: number
        taxAmount:
          format: double
          type: number
        taxCode:
          type: string
        taxCodeDescription:
          type: string
        taxDate:
          type: string
          format: date
        taxMode:
          enum:
            - TaxExclusive
            - TaxInclusive
          type: string
        taxRate:
          format: decimal
          type: string
        taxRateDescription:
          type: string
        taxRateType:
          enum:
            - Percentage
            - FlatFee
          type: string
        unappliedAmount:
          format: double
          type: number
        creditMemoItemId:
          type: string
        taxableItemSnapshotId:
          type: string
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountReceivableAccountingCodeId:
          type: string
      type: object
      title: QueryCreditTaxationItemResponse
    ExpandedDailyConsumptionSummary:
      properties:
        id:
          type: string
        originChargeId:
          type: string
        chargeSegmentNumber:
          type: integer
          format: int32
        fundId:
          type: string
        dailyConsumptionAmount:
          type: number
        dailyTotalQuantity:
          type: number
        transactionDate:
          type: string
          format: date
        ratingResultId:
          type: string
        dailyGroupSummaryId:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        drawdownOriginChargeId:
          type: string
        drawdownChargeSegmentNumber:
          type: integer
          format: int32
        drawdownRecognizedRevenueGlAccountNumber:
          type: string
        drawdownAdjustmentRevenueGlAccountNumber:
          type: string
        usageChargeName:
          type: string
        usageChargeNumber:
          type: string
      type: object
      title: QueryDailyConsumptionSummaryResponse
    ExpandedDebitMemo:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        autoPay:
          type: boolean
        creditMemoId:
          type: string
          nullable: true
        balance:
          type: number
        billToContactId:
          type: string
        billToContactSnapshotId:
          type: string
        cancelledById:
          type: string
          nullable: true
        cancelledOn:
          format: date-time
          type: string
          nullable: true
        comments:
          type: string
        currency:
          type: string
          nullable: true
        discountAmount:
          type: number
        dueDate:
          type: string
          format: date
        einvoiceErrorCode:
          type: string
        einvoiceErrorMessage:
          type: string
        einvoiceFileId:
          type: string
        einvoiceStatus:
          enum:
            - Processing
            - RetrieveTimeOut
            - Generated
            - Success
            - Failed
            - ConditionalSuccess
            - ApprovedByAuthority
            - Rejected
          type: string
        exchangeRateDate:
          type: string
          format: date
        memoDate:
          type: string
          format: date
        memoNumber:
          type: string
        postedById:
          type: string
        postedOn:
          format: date-time
          type: string
        reasonCode:
          type: string
        sequenceSetId:
          type: string
          nullable: true
        source:
          type: string
          enum:
            - BillRun
            - API
            - ApiSubscribe
            - ApiAmend
            - AdhocFromPrpc
            - AdhocFromInvoice
        sourceId:
          type: string
        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
        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
        shipToContactSnapshotId:
          type: string
        soldToContactSnapshotId:
          type: string
        taxAutoCalculation:
          default: true
          type: boolean
        totalAmount:
          type: number
          format: double
        totalAmountWithoutTax:
          type: number
          format: double
        totalTaxExemptAmount:
          format: double
          type: number
        transferredToAccounting:
          enum:
            - Processing
            - 'Yes'
            - 'No'
            - Error
            - Ignore
          type: string
        invoiceId:
          type: string
        accountId:
          type: string
        paymentTerm:
          type: string
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        billToContact:
          $ref: '#/components/schemas/ExpandedContact'
        debitMemoItems:
          type: array
          items:
            $ref: '#/components/schemas/NestedDebitMemoItemOnExpand'
        billToContactSnapshot:
          $ref: '#/components/schemas/NestedContactSnapshotOnExpand'
        soldToContactSnapshot:
          $ref: '#/components/schemas/NestedContactSnapshotOnExpand'
        shipToContactSnapshot:
          $ref: '#/components/schemas/NestedContactSnapshotOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryDebitMemoResponse
    NestedDebitMemoItemOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        amount:
          format: double
          type: number
        amountWithoutTax:
          format: double
          type: number
        appliedToItemId:
          type: string
        appliedToOthersAmount:
          type: number
        beAppliedByOthersAmount:
          type: number
        chargeDate:
          type: string
          format: date-time
        creditMemoItemId:
          type: string
        excludeItemBillingFromRevenueAccounting:
          type: boolean
        itemShipToContactId: {}
        itemSoldToContactId:
          type: string
        itemSoldToContactSnapshotId:
          type: string
        processingType:
          type: string
          enum:
            - '0'
            - '1'
        quantity:
          format: double
          type: number
        reflectDiscountInNetAmount:
          type: boolean
          default: false
        serviceEndDate:
          format: date
          type: string
        serviceStartDate:
          format: date
          type: string
        sku:
          type: string
        sourceItemType:
          enum:
            - CreditMemoItem
            - SubscriptionComponent
            - InvoiceDetail
            - ProductRatePlanCharge
          type: string
        chargeName:
          type: string
        chargeNumber:
          type: string
        taxAmount:
          type: number
          format: double
        taxCodeName:
          type: string
        taxExemptAmount:
          type: number
          format: double
        taxMode:
          enum:
            - TaxExclusive
            - TaxInclusive
          type: string
        unitOfMeasure:
          type: string
        unitPrice:
          format: double
          type: number
        subscriptionId:
          type: string
        subscriptionNumber:
          type: string
        invoiceItemId:
          type: string
        productRatePlanChargeId:
          type: string
        ratePlanChargeId:
          type: string
        debitMemoId:
          type: string
        balance:
          type: number
          format: double
        recognizedRevenueAccountingCodeId:
          type: string
        accountReceivableAccountingCodeId:
          type: string
        deferredRevenueAccountingCodeId:
          type: string
        journalEntryId:
          type: string
        soldToContactSnapshotId:
          type: string
        billToContactSnapshotId:
          type: string
        subscription:
          type: object
        ratePlanCharge:
          type: object
      additionalProperties:
        type: object
      type: object
      title: QueryDebitMemoItemResponse
    ExpandedDebitMemoItem:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        amount:
          format: double
          type: number
        amountWithoutTax:
          format: double
          type: number
        appliedToItemId:
          type: string
        appliedToOthersAmount:
          type: number
        beAppliedByOthersAmount:
          type: number
        chargeDate:
          type: string
          format: date-time
        creditMemoItemId:
          type: string
        excludeItemBillingFromRevenueAccounting:
          type: boolean
        itemShipToContactId:
          type: string
        itemSoldToContactId:
          type: string
        itemSoldToContactSnapshotId:
          type: string
        processingType:
          type: string
          enum:
            - '0'
            - '1'
        quantity:
          format: double
          type: number
        reflectDiscountInNetAmount:
          type: boolean
          default: false
        serviceEndDate:
          format: date
          type: string
        serviceStartDate:
          format: date
          type: string
        sku:
          type: string
        sourceItemType:
          enum:
            - CreditMemoItem
            - SubscriptionComponent
            - InvoiceDetail
            - ProductRatePlanCharge
          type: string
        chargeName:
          type: string
        chargeNumber:
          type: string
        taxAmount:
          type: number
          format: double
        taxCodeName:
          type: string
        taxExemptAmount:
          type: number
          format: double
        taxMode:
          enum:
            - TaxExclusive
            - TaxInclusive
          type: string
        unitOfMeasure:
          type: string
        unitPrice:
          format: double
          type: number
        subscriptionId:
          type: string
        subscriptionNumber:
          type: string
        invoiceItemId:
          type: string
        productRatePlanChargeId:
          type: string
        ratePlanChargeId:
          type: string
        debitMemoId:
          type: string
        balance:
          type: number
          format: double
        recognizedRevenueAccountingCodeId:
          type: string
        accountReceivableAccountingCodeId:
          type: string
        deferredRevenueAccountingCodeId:
          type: string
        journalEntryId:
          type: string
        shipToContactSnapshotId:
          type: string
        soldToContactSnapshotId:
          type: string
        billToContactSnapshotId:
          type: string
        subscription:
          $ref: '#/components/schemas/NestedSubscriptionOnExpand'
        ratePlanCharge:
          $ref: '#/components/schemas/NestedRatePlanChargeOnExpand'
        subscriptionOwner:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        debitTaxationItems:
          $ref: '#/components/schemas/NestedDebitTaxationItemOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryDebitMemoItemResponse
    NestedDebitTaxationItemOnExpand:
      properties:
        balance:
          format: double
          type: number
        creditAmount:
          format: double
          type: number
        exemptAmount:
          format: double
          type: number
        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:
          type: string
          format: date
        taxMode:
          enum:
            - TaxExclusive
            - TaxInclusive
          type: string
        taxRate:
          format: decimal
          type: string
        taxRateDescription:
          type: string
        taxRateType:
          enum:
            - Percentage
            - FlatFee
          type: string
        debitMemoItemId:
          type: string
        taxableItemSnapshotId:
          type: string
        taxationItemId:
          type: string
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountReceivableAccountingCodeId:
          type: string
      type: object
      title: QueryDebitTaxationItemResponse
    ExpandedDeliveryAdjustment:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        adjustmentNumber:
          type: string
        creditMemoNumber:
          type: string
        debitMemoNumber:
          type: string
        creditMemoId:
          type: string
        segmentId:
          type: string
        chargeId:
          type: string
        chargeNumber:
          type: string
        subscriptionId:
          type: string
        subscriptionNumber:
          type: string
        originalSubId:
          type: string
        status:
          type: string
          enum:
            - Billed
            - Cancelled
        numberOfDeliveries:
          type: number
        amountPerUnit:
          type: number
        amount:
          type: number
        date:
          type: string
          format: date
        deliveryDay:
          type: string
        reason:
          type: string
        type:
          type: string
          enum:
            - DeliveryCredit
        accountId:
          type: string
        invoiceOwnerAccountId:
          type: string
        accountingCode:
          type: string
        deferredAccountingCode:
          type: string
        recognizedRevenueAccountingCode:
          type: string
        revenueRecognitionRuleName:
          type: string
        billingDate:
          format: date
          type: string
      additionalProperties:
        type: object
      type: object
      title: QueryDeliveryAdjustmentResponse
    ExpandedFulfillment:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        orderLineItemId:
          type: string
        fulfillmentNumber:
          type: string
        fulfillmentType:
          enum:
            - Delivery
            - Return
          type: string
        fulfillmentDate:
          format: date
          type: string
        quantity:
          type: number
        state:
          enum:
            - Executing
            - Booked
            - SentToBilling
            - Complete
            - Cancelled
          type: string
        trackingNumber:
          type: string
        billTargetDate:
          format: date
          type: string
        carrier:
          type: string
        fulfillmentLocation:
          type: string
        fulfillmentSystem:
          type: string
        externalId:
          type: string
        excludeItemBookingFromRevenueAccounting:
          type: boolean
        excludeItemBillingFromRevenueAccounting:
          type: boolean
      additionalProperties:
        type: object
      type: object
      title: QueryFulfillmentResponse
    ExpandedInvoice:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountId:
          type: string
        adjustmentAmount:
          format: double
          type: number
        amount:
          format: double
          type: number
        amountWithoutTax:
          format: double
          type: number
        autoPay:
          type: boolean
        balance:
          type: number
          format: double
        billToContactId:
          type: string
        billToContactSnapshotId:
          type: string
        comments:
          type: string
        creditBalanceAdjustmentAmount:
          format: double
          type: number
        creditMemoAmount:
          format: double
          type: number
        currency:
          nullable: true
          type: string
        dueDate:
          type: string
          format: date
        includesOneTime:
          type: boolean
        includesRecurring:
          type: boolean
        includesUsage:
          type: boolean
        invoiceDate:
          format: date
          type: string
        invoiceNumber:
          type: string
        lastEmailSentDate:
          type: string
        organizationId:
          type: string
        paymentAmount:
          format: double
          type: number
        postedBy:
          type: string
        postedDate:
          format: date-time
          type: string
        refundAmount:
          format: double
          type: number
        sequenceSetId:
          type: string
          nullable: true
        communicationProfileId:
          type: string
          nullable: true
        shipToContactId:
          type: string
        shipToContactSnapshotId:
          type: string
        soldToContactId:
          type: string
        soldToContactSnapshotId:
          type: string
        source:
          enum:
            - BillRun
            - API
            - ApiSubscribe
            - ApiAmend
          type: string
        sourceId:
          type: string
        reversed:
          type: boolean
        sourceType:
          enum:
            - Subscription
            - Standalone
            - Order
            - Consolidation
          type: string
        status:
          enum:
            - Draft
            - Posted
          type: string
        targetDate:
          format: date
          type: string
        taxAmount:
          format: double
          type: number
        taxExemptAmount:
          format: double
          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
        transferredToAccounting:
          enum:
            - Processing
            - Error
            - Ignore
            - 'Yes'
            - 'No'
          type: string
        eInvoiceStatus:
          enum:
            - Processing
            - RetrieveTimeOut
            - Generated
            - Success
            - Failed
            - ConditionalSuccess
            - ApprovedByAuthority
            - Rejected
          type: string
        eInvoiceFileId:
          type: string
        eInvoiceErrorCode:
          type: string
        eInvoiceErrorMessage:
          type: string
        paymentLink:
          type: string
        paymentTerm:
          type: string
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        billToContact:
          $ref: '#/components/schemas/ExpandedContact'
        invoiceItems:
          type: array
          items:
            $ref: '#/components/schemas/NestedInvoiceItemOnExpand'
        billToContactSnapshot:
          $ref: '#/components/schemas/NestedContactSnapshotOnExpand'
        soldToContactSnapshot:
          $ref: '#/components/schemas/NestedContactSnapshotOnExpand'
        shipToContactSnapshot:
          $ref: '#/components/schemas/NestedContactSnapshotOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryInvoiceResponse
    NestedInvoiceItemOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        invoiceId:
          type: string
        invoiceScheduleId:
          type: string
        invoiceScheduleItemId:
          type: string
        ratePlanChargeId:
          type: string
        accountingCode:
          type: string
        appliedToInvoiceItemId:
          type: string
        chargeAmount:
          format: double
          type: number
        chargeDate:
          format: date-time
          type: string
        chargeName:
          type: string
        chargeNumber:
          type: string
        commitmentChargeNumber:
          type: string
        commitmentChargeSegmentNumber:
          type: string
        discountAmount:
          type: number
        excludeItemBillingFromRevenueAccounting:
          type: boolean
        fulfillmentId:
          type: string
        itemShipToContactId:
          type: string
        itemSoldToContactId:
          type: string
        itemSoldToContactSnapshotId:
          type: string
        processingType:
          type: string
          enum:
            - '0'
            - '1'
            - '2'
            - '3'
        quantity:
          type: number
        reflectDiscountInNetAmount:
          type: boolean
          default: false
        revRecStartDate:
          type: string
          format: date
        serviceEndDate:
          format: date
          type: string
        serviceStartDate:
          format: date
          type: string
        sKU:
          type: string
        sourceItemType:
          enum:
            - SubscriptionComponent
            - Rounding
            - ProductRatePlanCharge
            - None
            - OrderLineItem
          type: string
        subscriptionId:
          type: string
        subscriptionNumber:
          type: string
        taxAmount:
          format: double
          type: number
        taxCode:
          type: string
        taxExemptAmount:
          type: number
        taxMode:
          enum:
            - TaxExclusive
            - TaxInclusive
          type: string
        unitPrice:
          format: double
          type: number
        uOM:
          type: string
        balance:
          type: number
        numberOfDeliveries:
          type: number
        accountReceivableAccountingCodeId:
          type: string
        recognizedRevenueAccountingCodeId:
          type: string
        deferredRevenueAccountingCodeId:
          type: string
        contractAssetAccountingCodeId:
          type: string
        contractLiabilityAccountingCodeId:
          type: string
        contractRecognizedRevenueAccountingCodeId:
          type: string
        unbilledReceivablesAccountingCodeId:
          type: string
        adjustmentRevenueAccountingCodeId:
          type: string
        adjustmentLiabilityAccountingCodeId:
          type: string
        journalEntryId:
          type: string
        accountId:
          type: string
        billToContactSnapshotId:
          type: string
        shipToContactSnapshotId:
          type: string
        soldToContactSnapshotId:
          type: string
        parentAccountId:
          type: string
        billToContactId:
          type: string
        shipToContactId:
          type: string
        soldToContactId:
          type: string
        defaultPaymentMethodId:
          type: string
        ratePlanId:
          type: string
        amendmentId:
          type: string
        productRatePlanChargeId:
          type: string
        productRatePlanId:
          type: string
        productId:
          type: string
        bookingReference:
          type: string
        itemType:
          type: string
        purchaseOrderNumber:
          type: string
        revRecCode:
          type: string
        revRecTriggerCondition:
          enum:
            - ContractEffectiveDate
            - ServiceActivationDate
            - CustomerAcceptanceDate
          type: string
        revenueRecognitionRuleName:
          type: string
        subscriptionOwnerId:
          type: string
        orderLineItemId:
          type: string
        invoice:
          type: object
        subscription:
          type: object
        ratePlanCharge:
          type: object
        orderLineItem:
          type: object
      additionalProperties:
        type: object
      type: object
      title: QueryInvoiceItemResponse
    ExpandedInvoiceItem:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        invoiceId:
          type: string
        invoiceScheduleId:
          type: string
        invoiceScheduleItemId:
          type: string
        ratePlanChargeId:
          type: string
        accountingCode:
          type: string
        appliedToInvoiceItemId:
          type: string
        chargeAmount:
          format: double
          type: number
        chargeDate:
          format: date-time
          type: string
        chargeName:
          type: string
        chargeNumber:
          type: string
        commitmentChargeNumber:
          type: string
        commitmentChargeSegmentNumber:
          type: string
        discountAmount:
          type: number
        excludeItemBillingFromRevenueAccounting:
          type: boolean
        fulfillmentId:
          type: string
        itemShipToContactId:
          type: string
        itemSoldToContactId:
          type: string
        itemSoldToContactSnapshotId:
          type: string
        processingType:
          type: string
          enum:
            - '0'
            - '1'
            - '2'
            - '3'
        quantity:
          type: number
        reflectDiscountInNetAmount:
          type: boolean
          default: false
        revRecStartDate:
          type: string
          format: date
        serviceEndDate:
          format: date
          type: string
        serviceStartDate:
          format: date
          type: string
        sKU:
          type: string
        sourceItemType:
          enum:
            - SubscriptionComponent
            - Rounding
            - ProductRatePlanCharge
            - None
            - OrderLineItem
          type: string
        subscriptionId:
          type: string
        subscriptionNumber:
          type: string
        taxAmount:
          format: double
          type: number
        taxCode:
          type: string
        taxExemptAmount:
          type: number
        taxMode:
          enum:
            - TaxExclusive
            - TaxInclusive
          type: string
        unitPrice:
          format: double
          type: number
        uOM:
          type: string
        balance:
          type: number
        numberOfDeliveries:
          type: number
        accountReceivableAccountingCodeId:
          type: string
        recognizedRevenueAccountingCodeId:
          type: string
        deferredRevenueAccountingCodeId:
          type: string
        contractAssetAccountingCodeId:
          type: string
        contractLiabilityAccountingCodeId:
          type: string
        contractRecognizedRevenueAccountingCodeId:
          type: string
        unbilledReceivablesAccountingCodeId:
          type: string
        adjustmentRevenueAccountingCodeId:
          type: string
        adjustmentLiabilityAccountingCodeId:
          type: string
        journalEntryId:
          type: string
        accountId:
          type: string
        billToContactSnapshotId:
          type: string
        shipToContactSnapshotId:
          type: string
        soldToContactSnapshotId:
          type: string
        parentAccountId:
          type: string
        billToContactId:
          type: string
        shipToContactId:
          type: string
        soldToContactId:
          type: string
        defaultPaymentMethodId:
          type: string
        ratePlanId:
          type: string
        amendmentId:
          type: string
        productRatePlanChargeId:
          type: string
        productRatePlanId:
          type: string
        productId:
          type: string
        bookingReference:
          type: string
        itemType:
          type: string
        purchaseOrderNumber:
          type: string
        revRecCode:
          type: string
        revRecTriggerCondition:
          enum:
            - ContractEffectiveDate
            - ServiceActivationDate
            - CustomerAcceptanceDate
          type: string
        revenueRecognitionRuleName:
          type: string
        orderLineItemId:
          type: string
        subscriptionOwnerId:
          type: string
        invoice:
          $ref: '#/components/schemas/NestedInvoiceOnExpand'
        subscription:
          $ref: '#/components/schemas/NestedSubscriptionOnExpand'
        taxationItems:
          type: array
          items:
            $ref: '#/components/schemas/ExpandedTaxationItem'
        ratePlanCharge:
          $ref: '#/components/schemas/NestedRatePlanChargeOnExpand'
        orderLineItem:
          $ref: '#/components/schemas/NestedOrderLineItemOnExpand'
        subscriptionOwner:
          $ref: '#/components/schemas/NestedAccountOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryInvoiceItemResponse
    ExpandedTaxationItem:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        creditAmount:
          type: number
          format: double
        accountingCode:
          type: string
        exemptAmount:
          type: number
          format: double
        invoiceItemId:
          type: string
        jurisdiction:
          type: string
        locationCode:
          type: string
        name:
          type: string
        paymentAmount:
          type: number
          format: double
        taxAmount:
          type: number
          format: double
        taxAmountUnrounded:
          type: number
        countryCode:
          type: string
        taxCodeDescription:
          type: string
        customerCode:
          type: string
        exemptCertificate:
          type: string
        sellerRegistration:
          type: string
        taxDescription:
          type: string
        taxRuleId:
          type: string
        taxCode:
          type: string
        taxMode:
          type: string
          enum:
            - TaxExclusive
            - TaxInclusive
        taxDate:
          type: string
          format: date
        taxRate:
          type: number
          format: double
        taxRateDescription:
          type: string
        taxRateType:
          type: string
          enum:
            - Percentage
            - FlatFee
        balance:
          type: number
        journalEntryId:
          type: string
        salesTaxPayableAccountingCodeId:
          type: string
        accountReceivableAccountingCodeId:
          type: string
        taxableItemSnapshotId:
          type: string
        periodEndDate:
          type: string
          format: date
        periodStartDate:
          type: string
          format: date
        taxableAmount:
          type: number
          format: double
      additionalProperties:
        type: object
      type: object
      title: QueryTaxationItemResponse
    NestedOrderLineItemOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountingCode:
          type: string
          nullable: true
        billTargetDate:
          format: date
          type: string
        amountPerUnit:
          type: number
        amount:
          type: number
        amountWithoutTax:
          type: number
        itemName:
          type: string
        itemNumber:
          type: string
        itemState:
          enum:
            - Executing
            - Booked
            - SentToBilling
            - Complete
            - Cancelled
          type: string
        itemType:
          enum:
            - Product
            - Fee
            - Services
          type: string
        listPricePerUnit:
          type: number
        listPrice:
          type: number
        orderId:
          type: string
        productCode:
          type: string
        purchaseOrderNumber:
          type: string
        quantity:
          type: number
        revenueRecognitionRule:
          type: string
        productRatePlanChargeId:
          type: string
        billToId:
          type: string
        billToSnapshotId:
          type: string
        shipTo:
          type: string
        shipToSnapshotId:
          type: string
        soldTo:
          type: string
        soldToSnapshotId:
          type: string
        soldToOrderContactId:
          type: string
        ownerAccountId:
          type: string
        invoiceOwnerAccountId:
          type: string
        taxCode:
          type: string
        taxMode:
          enum:
            - TaxInclusive
            - TaxExclusive
          type: string
        transactionDate:
          type: string
          format: date
        uOM:
          type: string
        relatedSubscriptionNumber:
          type: string
        transactionEndDate:
          format: date
          type: string
        transactionStartDate:
          format: date
          type: string
        excludeItemBillingFromRevenueAccounting:
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          type: boolean
        originalOrderDate:
          type: string
          format: date
        amendedByOrderOn:
          type: string
          format: date
        itemCategory:
          default: Sales
          enum:
            - Sales
            - Return
          type: string
        originalOrderId:
          type: string
        originalOrderLineItemId:
          type: string
        originalOrderLineItemNumber:
          type: string
        originalOrderNumber:
          type: string
        quantityAvailableForReturn:
          type: number
        quantityFulfilled:
          type: number
        quantityPendingFulfillment:
          type: number
        requiresFulfillment:
          type: boolean
        billingRule:
          enum:
            - TriggerWithoutFulfillment
            - TriggerAsFulfillmentOccurs
          type: string
        inlineDiscountPerUnit:
          type: number
        inlineDiscountType:
          enum:
            - Percentage
            - FixedAmount
            - None
          type: string
        discount:
          type: number
        recognizedRevenueAccountingCodeId:
          type: string
        deferredRevenueAccountingCodeId:
          type: string
        contractAssetAccountingCode:
          type: string
        contractLiabilityAccountingCode:
          type: string
        contractRecognizedRevenueAccountingCodeId:
          type: string
        unbilledReceivablesAccountingCodeId:
          type: string
        adjustmentRevenueAccountingCodeId:
          type: string
        adjustmentLiabilityAccountingCodeId:
          type: string
        invoiceItems:
          type: array
          items:
            type: object
      additionalProperties:
        type: object
      type: object
      title: QueryOrderLineItemResponse
    ExpandedInvoiceSchedule:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        totalAmount:
          type: number
        actualAmount:
          type: number
        billedAmount:
          type: number
        unbilledAmount:
          type: number
        nextRunDate:
          type: string
          format: date
        number:
          type: string
        notes:
          type: string
          maxLength: 255
        accountId:
          type: string
        status:
          type: string
          enum:
            - Pending
            - PartiallyProcessed
            - Paused
            - FullyProcessed
        additionalSubscriptionsToBill:
          type: string
        currency:
          type: string
        invoiceScheduleItems:
          type: array
          items:
            $ref: '#/components/schemas/NestedInvoiceScheduleItemOnExpand'
        invoiceScheduleBookings:
          type: array
          items:
            $ref: '#/components/schemas/NestedInvoiceScheduleBookingOnExpand'
        ratePlanCharges:
          type: array
          items:
            $ref: '#/components/schemas/NestedRatePlanChargeOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryInvoiceScheduleResponse
    NestedInvoiceScheduleItemOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        amount:
          type: string
          format: number
        percentage:
          type: number
        actualAmount:
          type: string
          format: number
        runDate:
          type: string
          format: date
        invoiceScheduleId:
          type: string
        invoiceId:
          type: string
        creditMemoId:
          type: string
        status:
          type: string
          enum:
            - Pending
            - Executing
            - Processed
        name:
          type: string
          maxLength: 100
        sequenceNumber:
          type: string
        targetDateForAdditionalSubscriptions:
          type: string
          format: date
      additionalProperties:
        type: object
      type: object
      title: QueryInvoiceScheduleItemResponse
    NestedInvoiceScheduleBookingOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        invoiceScheduleId:
          type: string
        orderId:
          type: string
        orderNumber:
          type: string
        subscriptionId:
          type: string
        subscriptionNumber:
          type: string
        chargeNumbers:
          type: string
      type: object
      title: QueryInvoiceScheduleBookingResponse
    ExpandedOrderAction:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        contractEffectiveDate:
          type: string
          format: date
        customerAcceptanceDate:
          type: string
          format: date
        type:
          enum:
            - CreateSubscription
            - TermsAndConditions
            - AddProduct
            - UpdateProduct
            - RemoveProduct
            - RenewSubscription
            - CancelSubscription
            - OwnerTransfer
            - Suspend
            - Resume
            - ChangePlan
          type: string
        sequence:
          type: integer
          format: int32
        subscriptionVersionAmendmentId:
          type: string
        orderId:
          type: string
        subscriptionId:
          type: string
        subscriptionNumber:
          type: string
        serviceActivationDate:
          type: string
          format: date
        autoRenew:
          type: boolean
          default: false
        renewSetting:
          type: string
          enum:
            - RENEW_WITH_SPECIFIC_TERM
            - RENEW_TO_EVERGREEN
          default: RENEW_WITH_SPECIFIC_TERM
        renewalTerm:
          type: integer
          format: int64
          default: 0
        renewalTermPeriodType:
          type: string
          enum:
            - Month
            - Year
            - Day
            - Week
          default: Month
        termStartDate:
          type: string
          format: date
        termType:
          type: string
          enum:
            - TERMED
            - EVERGREEN
        currentTerm:
          type: integer
          format: int64
        currentTermPeriodType:
          type: string
          enum:
            - Month
            - Year
            - Day
            - Week
          default: Month
        suspendDate:
          type: string
          format: date
        resumeDate:
          type: string
          format: date
        cancellationEffectiveDate:
          type: string
          format: date
        cancellationPolicy:
          type: string
          enum:
            - EndOfCurrentTerm
            - EndOfLastInvoicePeriod
            - SpecificDate
        paymentTerm:
          type: string
        billToContactId:
          type: string
        invoiceTemplateId:
          type: string
        sequenceSetId:
          type: string
          nullable: true
        shipToContactId:
          type: string
        soldToContactId:
          type: string
        clearingExistingPaymentTerm:
          default: false
          type: boolean
        clearingExistingBillToContact:
          default: false
          type: boolean
        clearingExistingInvoiceTemplate:
          default: false
          type: boolean
        clearingExistingSequenceSet:
          default: false
          type: boolean
        clearingExistingShipToContact:
          default: false
          type: boolean
        clearingExistingSoldToContact:
          default: false
          type: boolean
        communicationProfileId:
          type: string
          nullable: true
        clearingExistingCommunicationProfile:
          default: false
          type: boolean
        subType:
          enum:
            - Upgrade
            - Downgrade
            - Crossgrade
            - PlanChanged
          type: string
        effectivePolicy:
          enum:
            - EffectiveImmediately
            - EffectiveEndOfBillingPeriod
            - SpecificDate
          type: string
        subscription:
          $ref: '#/components/schemas/NestedSubscriptionOnExpand'
        order:
          $ref: '#/components/schemas/NestedOrderOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryOrderActionResponse
    NestedOrderOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        orderDate:
          type: string
          format: date
        orderNumber:
          type: string
        accountId:
          type: string
        status:
          type: string
          enum:
            - Draft
            - Pending
            - Completed
            - Cancelled
            - Scheduled
            - Executing
            - Failed
        state:
          type: string
        createdByMigration:
          type: boolean
        category:
          type: string
        invoiceScheduleId:
          type: string
        scheduledDate:
          type: string
          format: date
        scheduledDatePolicy:
          enum:
            - SpecificDate
          type: string
        errorCode:
          type: string
        errorMessage:
          type: string
        response:
          type: string
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        orderLineItems:
          type: array
          items:
            $ref: '#/components/schemas/NestedOrderLineItemOnExpand'
        orderActions:
          type: array
          items:
            $ref: '#/components/schemas/NestedOrderActionOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryOrdersResponse
    NestedOrderActionOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        contractEffectiveDate:
          type: string
          format: date
        customerAcceptanceDate:
          type: string
          format: date
        type:
          enum:
            - CreateSubscription
            - TermsAndConditions
            - AddProduct
            - UpdateProduct
            - RemoveProduct
            - RenewSubscription
            - CancelSubscription
            - OwnerTransfer
            - Suspend
            - Resume
            - ChangePlan
          type: string
        sequence:
          type: integer
          format: int32
        subscriptionVersionAmendmentId:
          type: string
        orderId:
          type: string
        subscriptionId:
          type: string
        subscriptionNumber:
          type: string
        serviceActivationDate:
          type: string
          format: date
        autoRenew:
          type: boolean
          default: false
        renewSetting:
          type: string
          enum:
            - RENEW_WITH_SPECIFIC_TERM
            - RENEW_TO_EVERGREEN
          default: RENEW_WITH_SPECIFIC_TERM
        renewalTerm:
          type: integer
          format: int64
          default: 0
        renewalTermPeriodType:
          type: string
          enum:
            - Month
            - Year
            - Day
            - Week
          default: Month
        termStartDate:
          type: string
          format: date
        termType:
          type: string
          enum:
            - TERMED
            - EVERGREEN
        currentTerm:
          type: integer
          format: int64
        currentTermPeriodType:
          type: string
          enum:
            - Month
            - Year
            - Day
            - Week
          default: Month
        suspendDate:
          type: string
          format: date
        resumeDate:
          type: string
          format: date
        cancellationEffectiveDate:
          type: string
          format: date
        cancellationPolicy:
          type: string
          enum:
            - EndOfCurrentTerm
            - EndOfLastInvoicePeriod
            - SpecificDate
        paymentTerm:
          type: string
        billToContactId:
          type: string
        invoiceTemplateId:
          type: string
        sequenceSetId:
          type: string
        shipToContactId:
          type: string
        soldToContactId:
          type: string
        clearingExistingPaymentTerm:
          default: false
          type: boolean
        clearingExistingBillToContact:
          default: false
          type: boolean
        clearingExistingInvoiceTemplate:
          default: false
          type: boolean
        clearingExistingSequenceSet:
          default: false
          type: boolean
        clearingExistingShipToContact:
          default: false
          type: boolean
        clearingExistingSoldToContact:
          default: false
          type: boolean
        communicationProfileId:
          type: string
          nullable: true
        clearingExistingCommunicationProfile:
          default: false
          type: boolean
        subType:
          enum:
            - Upgrade
            - Downgrade
            - Crossgrade
            - PlanChanged
          type: string
        effectivePolicy:
          enum:
            - EffectiveImmediately
            - EffectiveEndOfBillingPeriod
            - SpecificDate
          type: string
        subscription:
          type: object
      additionalProperties:
        type: object
      type: object
      title: QueryOrderActionResponse
    ExpandedOrderLineItem:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountingCode:
          type: string
          nullable: true
        billTargetDate:
          format: date
          type: string
        amountPerUnit:
          type: number
        amount:
          type: number
        amountWithoutTax:
          type: number
        itemName:
          type: string
        itemNumber:
          type: string
        itemState:
          enum:
            - Executing
            - Booked
            - SentToBilling
            - Complete
            - Cancelled
          type: string
        itemType:
          enum:
            - Product
            - Fee
            - Services
          type: string
        listPricePerUnit:
          type: number
        listPrice:
          type: number
        orderId:
          type: string
        productCode:
          type: string
        purchaseOrderNumber:
          type: string
        quantity:
          type: number
        revenueRecognitionRule:
          type: string
        productRatePlanChargeId:
          type: string
        billToId:
          type: string
        billToSnapshotId:
          type: string
        shipTo:
          type: string
        shipToSnapshotId:
          type: string
        soldTo:
          type: string
        soldToSnapshotId:
          type: string
        soldToOrderContactId:
          type: string
        ownerAccountId:
          type: string
        invoiceOwnerAccountId:
          type: string
        taxCode:
          type: string
        taxMode:
          enum:
            - TaxInclusive
            - TaxExclusive
          type: string
        transactionDate:
          type: string
          format: date
        uOM:
          type: string
        relatedSubscriptionNumber:
          type: string
        transactionEndDate:
          format: date
          type: string
        transactionStartDate:
          format: date
          type: string
        excludeItemBillingFromRevenueAccounting:
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          type: boolean
        originalOrderDate:
          type: string
          format: date
        amendedByOrderOn:
          type: string
          format: date
        itemCategory:
          default: Sales
          enum:
            - Sales
            - Return
          type: string
        originalOrderId:
          type: string
        originalOrderLineItemId:
          type: string
        originalOrderLineItemNumber:
          type: string
        originalOrderNumber:
          type: string
        quantityAvailableForReturn:
          type: number
        quantityFulfilled:
          type: number
        quantityPendingFulfillment:
          type: number
        requiresFulfillment:
          type: boolean
        billingRule:
          enum:
            - TriggerWithoutFulfillment
            - TriggerAsFulfillmentOccurs
          type: string
        inlineDiscountPerUnit:
          type: number
        inlineDiscountType:
          enum:
            - Percentage
            - FixedAmount
            - None
          type: string
        discount:
          type: number
        recognizedRevenueAccountingCodeId:
          type: string
        deferredRevenueAccountingCodeId:
          type: string
        contractAssetAccountingCode:
          type: string
        contractLiabilityAccountingCode:
          type: string
        contractRecognizedRevenueAccountingCodeId:
          type: string
        unbilledReceivablesAccountingCodeId:
          type: string
        adjustmentRevenueAccountingCodeId:
          type: string
        adjustmentLiabilityAccountingCodeId:
          type: string
        invoiceItems:
          type: array
          items:
            $ref: '#/components/schemas/NestedInvoiceItemOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryOrderLineItemResponse
    ExpandedOrders:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        orderDate:
          type: string
          format: date
        orderNumber:
          type: string
        accountId:
          type: string
        status:
          type: string
          enum:
            - Draft
            - Pending
            - Completed
            - Cancelled
            - Scheduled
            - Executing
            - Failed
        state:
          type: string
        createdByMigration:
          type: boolean
        category:
          type: string
        invoiceScheduleId:
          type: string
        scheduledDate:
          type: string
          format: date
        scheduledDatePolicy:
          enum:
            - SpecificDate
          type: string
        errorCode:
          type: string
        errorMessage:
          type: string
        response:
          type: string
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        orderLineItems:
          type: array
          items:
            $ref: '#/components/schemas/NestedOrderLineItemOnExpand'
        orderActions:
          type: array
          items:
            $ref: '#/components/schemas/NestedOrderActionOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryOrdersResponse
    ExpandedPayment:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountId:
          type: string
        accountingCode:
          type: string
        amount:
          format: double
          type: number
        appliedAmount:
          format: double
          type: number
        authTransactionId:
          type: string
        appliedCreditBalanceAmount:
          type: number
        bankIdentificationNumber:
          type: string
        cancelledOn:
          type: string
          format: date-time
        comment:
          type: string
          nullable: true
        currency:
          type: string
        effectiveDate:
          type: string
          format: date
        gatewayOrderId:
          type: string
        gatewayReconciliationReason:
          type: string
        gatewayReconciliationStatus:
          type: string
        gatewayResponse:
          type: string
        gatewayResponseCode:
          type: string
        gatewayState:
          enum:
            - MarkedForSubmission
            - Submitted
            - Settled
            - NotSubmitted
            - FailedToSettle
          type: string
        gatewayTransactionState:
          type: string
        isStandalone:
          type: boolean
        markedForSubmissionOn:
          type: string
          format: date-time
        paymentMethodId:
          type: string
        paymentMethodSnapshotId:
          type: string
        paymentOptionId:
          type: string
        paymentNumber:
          type: string
        payoutId:
          type: string
        prepayment:
          type: boolean
        referencedPaymentID:
          type: string
        referenceId:
          type: string
        refundAmount:
          type: number
          format: double
        secondPaymentReferenceId:
          type: string
        settledOn:
          type: string
          format: date-time
        softDescriptor:
          type: string
        softDescriptorPhone:
          type: string
        source:
          type: string
          enum:
            - PaymentRun
            - Import
            - Manually
            - API
        sourceName:
          type: string
        status:
          enum:
            - Draft
            - Processing
            - Processed
            - Error
            - Canceled
            - Posted
          type: string
        submittedOn:
          format: date-time
          type: string
        type:
          enum:
            - External
            - Electronic
          type: string
        transferredToAccounting:
          enum:
            - Processing
            - 'Yes'
            - 'No'
            - Error
            - Ignore
          type: string
        transactionSource:
          type: string
          enum:
            - C_Unscheduled
            - M_Recurring
            - M_Unscheduled
            - M_MOTO
        unappliedAmount:
          type: number
        lastEmailDateTime:
          type: string
        gateway:
          type: string
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        paymentMethod:
          $ref: '#/components/schemas/NestedPaymentMethodOnExpand'
        paymentApplications:
          type: array
          items:
            $ref: '#/components/schemas/ExpandedPaymentApplication'
      additionalProperties:
        type: object
      type: object
      title: QueryPaymentResponse
    ExpandedPaymentApplication:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        applyAmount:
          type: number
          format: double
        effectiveDate:
          type: string
          format: date
        paymentApplicationStatus:
          type: string
          enum:
            - Processing
            - Processed
            - Cancelled
        accountId:
          type: string
        paymentId:
          type: string
        invoiceId:
          type: string
        applicationGroupId:
          type: string
        debitMemoId:
          type: string
        billingDocumentOwnerId:
          type: string
        accountReceivableAccountingCodeId:
          type: string
        unappliedPaymentAccountingCodeId:
          type: string
        cashAccountingCodeId:
          type: string
        journalEntryId:
          type: string
        payment:
          $ref: '#/components/schemas/NestedPaymentOnExpand'
      type: object
      title: QueryPaymentApplicationResponse
      additionalProperties: false
    ExpandedPaymentMethod:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountId:
          type: string
        achAbaCode:
          type: string
        achAccountName:
          type: string
        achAccountNumberMask:
          type: string
        achAccountType:
          type: string
          enum:
            - BusinessChecking
            - Checking
            - Saving
        achAddress1:
          type: string
          maxLength: 255
        achAddress2:
          type: string
          maxLength: 255
        achBankName:
          type: string
          maxLength: 70
        achCity:
          type: string
          maxLength: 40
        achCountry:
          type: string
        achPostalCode:
          type: string
          maxLength: 20
        achState:
          type: string
        active:
          type: boolean
        isSystem:
          type: boolean
        accountVerificationService:
          type: string
        accountVerificationStatus:
          enum:
            - Active
            - Expired
            - Expiring
            - Inactive
          type: string
        bankBranchCode:
          type: string
        bankCheckDigit:
          type: string
        bankCity:
          type: string
        bankCode:
          type: string
        bankIdentificationNumber:
          type: string
        bankName:
          type: string
        bankPostalCode:
          type: string
        bankStreetName:
          type: string
        bankStreetNumber:
          type: string
        bankTransferAccountName:
          type: string
        bankTransferAccountNumberMask:
          type: string
        bankTransferAccountType:
          type: string
        bankTransferType:
          enum:
            - AutomatischIncasso
            - LastschriftDE
            - LastschriftAT
            - DemandeDePrelevement
            - DirectDebitUK
            - Domicil
            - LastschriftCH
            - RID
            - OrdenDeDomiciliacion
            - Autogiro
            - Betalingsservice
          type: string
        businessIdentificationCode:
          type: string
        city:
          type: string
        country:
          type: string
        creditCardAddress1:
          type: string
        creditCardAddress2:
          type: string
        creditCardCity:
          type: string
        creditCardCountry:
          type: string
        creditCardExpirationMonth:
          type: integer
          format: int32
          minimum: 1
          maximum: 12
        creditCardExpirationYear:
          type: integer
          format: int32
        creditCardHolderName:
          type: string
        creditCardMaskNumber:
          type: string
        creditCardPostalCode:
          type: string
        creditCardState:
          type: string
        creditCardType:
          type: string
        deviceSessionId:
          type: string
        existingMandate:
          enum:
            - 'Yes'
            - 'No'
          type: string
        email:
          type: string
        firstName:
          type: string
        iBAN:
          type: string
        iPAddress:
          type: string
        identityNumber:
          type: string
        companyName:
          type: string
        isCompany:
          type: boolean
        lastFailedSaleTransactionDate:
          type: string
          format: date
        lastName:
          type: string
        lastTransactionDateTime:
          type: string
          format: date-time
        lastTransactionStatus:
          type: string
        mandateCreationDate:
          format: date
          type: string
        mandateId:
          type: string
        mandateReason:
          type: string
        mandateReceived:
          type: string
          enum:
            - 'Yes'
            - 'No'
        mandateStatus:
          type: string
        mandateUpdateDate:
          type: string
          format: date
        maxConsecutivePaymentFailures:
          type: integer
          format: int32
        name:
          type: string
        numConsecutiveFailures:
          type: integer
          format: int32
        paymentMethodStatus:
          type: string
          enum:
            - Active
            - Closed
            - Scrubbed
        paymentRetryWindow:
          type: integer
          format: int32
        paypalBaid:
          type: string
        paypalEmail:
          type: string
        paypalPreapprovalKey:
          type: string
        paypalType:
          type: string
        phone:
          type: string
        postalCode:
          type: string
        secondTokenId:
          type: string
        state:
          type: string
        streetName:
          type: string
        streetNumber:
          type: string
        tokenId:
          type: string
        totalNumberOfErrorPayments:
          type: integer
          format: int32
        totalNumberOfProcessedPayments:
          type: integer
          format: int32
        type:
          type: string
        useDefaultRetryRule:
          type: boolean
        methodReferenceId:
          type: string
        userReferenceId:
          type: string
        subType:
          type: string
        methodSpecificData:
          type: string
        cardBrand:
          type: string
        cardClass:
          type: string
          enum:
            - ChargeCard
            - Credit
            - Debit
            - DeferredDebit
            - Prepaid
        cardIssuingBank:
          type: string
        cardIssuingCountry:
          type: string
        cardProductType:
          type: string
          enum:
            - Commercial_or_Corporate_Card
            - Consumer_Card
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryPaymentMethodResponse
    ExpandedPaymentMethodSnapshot:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountId:
          type: string
        achAbaCode:
          type: string
        achAccountName:
          type: string
        achAccountNumberMask:
          type: string
        achAccountType:
          type: string
          enum:
            - BusinessChecking
            - Checking
            - Saving
        achAddress1:
          type: string
          maxLength: 255
        achAddress2:
          type: string
          maxLength: 255
        achBankName:
          type: string
          maxLength: 70
        achCity:
          type: string
          maxLength: 40
        achCountry:
          type: string
        achPostalCode:
          type: string
          maxLength: 20
        achState:
          type: string
        active:
          type: boolean
        isSystem:
          type: boolean
        bankBranchCode:
          type: string
        bankCheckDigit:
          type: string
        bankCity:
          type: string
        bankCode:
          type: string
        bankIdentificationNumber:
          type: string
        bankName:
          type: string
        bankPostalCode:
          type: string
        bankStreetName:
          type: string
        bankStreetNumber:
          type: string
        bankTransferAccountName:
          type: string
        bankTransferAccountNumberMask:
          type: string
        bankTransferAccountType:
          type: string
        bankTransferType:
          enum:
            - AutomatischIncasso
            - LastschriftDE
            - LastschriftAT
            - DemandeDePrelevement
            - DirectDebitUK
            - Domicil
            - LastschriftCH
            - RID
            - OrdenDeDomiciliacion
            - Autogiro
            - Betalingsservice
          type: string
        businessIdentificationCode:
          type: string
        city:
          type: string
        country:
          type: string
        creditCardAddress1:
          type: string
        creditCardAddress2:
          type: string
        creditCardCity:
          type: string
        creditCardCountry:
          type: string
        creditCardExpirationMonth:
          type: integer
          format: int32
          minimum: 1
          maximum: 12
        creditCardExpirationYear:
          type: integer
          format: int32
        creditCardHolderName:
          type: string
        creditCardMaskNumber:
          type: string
        creditCardPostalCode:
          type: string
        creditCardState:
          type: string
        creditCardType:
          type: string
        deviceSessionId:
          type: string
        existingMandate:
          enum:
            - 'Yes'
            - 'No'
          type: string
        email:
          type: string
        firstName:
          type: string
        iBAN:
          type: string
        iPAddress:
          type: string
        identityNumber:
          type: string
        companyName:
          type: string
        isCompany:
          type: boolean
        lastFailedSaleTransactionDate:
          type: string
          format: date
        lastName:
          type: string
        lastTransactionDateTime:
          type: string
          format: date-time
        lastTransactionStatus:
          type: string
        mandateCreationDate:
          format: date
          type: string
        mandateId:
          type: string
        mandateReason:
          type: string
        mandateReceived:
          type: string
          enum:
            - 'Yes'
            - 'No'
        mandateStatus:
          type: string
        mandateUpdateDate:
          type: string
          format: date
        maxConsecutivePaymentFailures:
          type: integer
          format: int32
        paymentMethodId:
          type: string
        name:
          type: string
        numConsecutiveFailures:
          type: integer
          format: int32
        paymentMethodStatus:
          type: string
          enum:
            - Active
            - Closed
            - Scrubbed
        paymentRetryWindow:
          type: integer
          format: int32
        paypalBaid:
          type: string
        paypalEmail:
          type: string
        paypalPreapprovalKey:
          type: string
        paypalType:
          type: string
        phone:
          type: string
        postalCode:
          type: string
        secondTokenId:
          type: string
        state:
          type: string
        streetName:
          type: string
        streetNumber:
          type: string
        tokenId:
          type: string
        totalNumberOfErrorPayments:
          type: integer
          format: int32
        totalNumberOfProcessedPayments:
          type: integer
          format: int32
        type:
          type: string
        useDefaultRetryRule:
          type: boolean
        methodReferenceId:
          type: string
        userReferenceId:
          type: string
        subType:
          type: string
        methodSpecificData:
          type: string
      additionalProperties:
        type: object
      type: object
      title: QueryPaymentMethodSnapshotResponse
    ExpandedPaymentRun:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        endDate:
          type: string
        executedDate:
          type: string
          format: date-time
        numberOfCreditBalanceAdjustments:
          type: integer
          format: int32
        numberOfErrors:
          format: int32
          type: integer
        numberOfInvoices:
          type: integer
          format: int32
        numberOfPayments:
          type: integer
          format: int32
        numberOfUnprocessed:
          type: integer
          format: int32
        paymentRunNumber:
          type: string
        status:
          enum:
            - Pending
            - Processing
            - Completed
            - Error
            - Canceled
          type: string
        targetDate:
          type: string
          format: date
        applyCreditBalance:
          type: boolean
        consolidatedPayment:
          type: boolean
        processPaymentWithClosedPM:
          type: boolean
        collectPayment:
          type: boolean
        autoApplyCreditMemo:
          type: boolean
        autoApplyUnappliedPayment:
          type: boolean
        numberOfCreditMemos:
          type: integer
          format: int32
        numberOfDebitMemos:
          type: integer
          format: int32
        numberOfDebitMemosUnprocessed:
          type: integer
          format: int32
        numberofUnappliedPayments:
          type: integer
          format: int32
        totalExecutionTime:
          type: integer
          format: int64
        errorMessage:
          type: string
        runDate:
          type: string
          format: date
        nextRunOn:
          type: string
          format: date
        repeatType:
          type: string
          enum:
            - None
            - Daily
            - Weekly
            - Monthly
        repeatFrom:
          type: string
        repeatTo:
          type: string
        runTime:
          type: integer
          format: int32
          minimum: 0
          maximum: 23
        timeZone:
          type: string
        monthlyOnDay:
          type: string
        weeklyOnDay:
          type: string
          enum:
            - Mon
            - Tue
            - Wed
            - Thu
            - Fri
            - Sat
            - Sun
        accountId:
          type: string
        batch:
          type: string
        billingCycleDay:
          type: string
        currency:
          type: string
        paymentGatewayId:
          type: string
          format: uuid
          nullable: true
        billingRunId:
          type: string
      additionalProperties:
        type: object
      type: object
      title: QueryPaymentRunResponse
    ExpandedPaymentSchedule:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        number:
          type: string
        accountId:
          type: string
        invoiceId:
          type: string
        debitmemoId:
          type: string
        paymentOptionId:
          type: string
        startDate:
          type: string
          format: date
        runHour:
          type: integer
          format: int32
          minimum: 0
          maximum: 23
        period:
          type: string
          nullable: true
          enum:
            - Monthly
            - Weekly
            - BiWeekly
            - null
        prepayment:
          type: boolean
        occurrences:
          type: integer
          format: int32
        status:
          type: string
          enum:
            - Active
            - Canceled
            - Completed
        nextPaymentDate:
          type: string
          format: date
        recentPaymentDate:
          type: string
          format: date
        totalPaymentsProcessed:
          type: integer
          format: int32
        totalPaymentsErrored:
          type: integer
          format: int32
        totalAmount:
          type: number
      additionalProperties:
        type: object
      type: object
      title: QueryPaymentScheduleResponse
    ExpandedPaymentScheduleItem:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        number:
          type: string
        accountId:
          type: string
        invoiceId:
          type: string
        debitmemoId:
          type: string
        paymentOptionId:
          type: string
        prepayment:
          type: boolean
        scheduledDate:
          type: string
          format: date
        runHour:
          type: integer
          format: int32
          minimum: 0
          maximum: 23
        paymentMethodId:
          type: string
        paymentGatewayId:
          type: string
          nullable: true
        amount:
          type: number
        balance:
          type: number
        currency:
          type: string
        status:
          enum:
            - Pending
            - Processed
            - Error
            - Canceled
          type: string
        errorMessage:
          type: string
        paymentId:
          type: string
        cancellationReason:
          type: string
        paymentScheduleId:
          type: string
      additionalProperties:
        type: object
      type: object
      title: QueryPaymentScheduleItemResponse
    ExpandedPrepaidBalance:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        name:
          type: string
        totalFund:
          type: number
        balance:
          type: number
        endDate:
          format: date
          type: string
        startDate:
          format: date
          type: string
        accountId:
          type: string
        origSubscriptionId:
          type: string
        uOM:
          type: string
        prepaidBalanceState:
          type: string
          enum:
            - ACTIVE
            - EXPIRED
        prepaidType:
          type: integer
          format: int32
          nullable: true
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        origSubscription:
          $ref: '#/components/schemas/NestedSubscriptionOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryPrepaidBalanceResponse
    ExpandedPrepaidBalanceFund:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountId:
          type: string
        balance:
          type: number
        chargeSegmentNumber:
          type: integer
          format: int32
        endDate:
          type: string
          format: date
        fundedBalance:
          type: number
        fundSourceType:
          type: string
          enum:
            - CHARGE
            - ORDER_LINE_ITEM
            - CREDIT_MEMO_ITEM
            - DEBIT_MEMO_ITEM
        fundingPrice:
          type: number
        totalBilled:
          type: number
        totalBalance:
          type: number
        originalTotalBalance:
          type: number
        originalFundingPrice:
          type: number
        originalFundEndDate:
          type: string
          format: date
        rolloverValidityPeriodStartDate:
          type: string
          format: date
        rolloverValidityPeriodEndDate:
          type: string
          format: date
        prepaidBalanceId:
          type: string
        priority:
          type: integer
          format: int32
          enum:
            - 10
            - 50
            - 100
        sourceId:
          type: string
        startDate:
          type: string
          format: date
        vpSummaryId:
          type: string
        rolloverCount:
          type: integer
          format: int32
        originFundId:
          type: string
        rolloverApplyOption:
          type: string
        done:
          type: integer
          format: int32
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        prepaidBalance:
          $ref: '#/components/schemas/NestedPrepaidBalanceOnExpand'
        source:
          $ref: '#/components/schemas/NestedRatePlanChargeOnExpand'
        vpSummary:
          $ref: '#/components/schemas/NestedValidityPeriodSummaryOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryPrepaidBalanceFundResponse
    NestedPrepaidBalanceOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        name:
          type: string
        totalFund:
          type: number
        balance:
          type: number
        endDate:
          format: date
          type: string
        startDate:
          format: date
          type: string
        accountId:
          type: string
        origSubscriptionId:
          type: string
        uOM:
          type: string
        prepaidBalanceState:
          type: string
          enum:
            - ACTIVE
            - EXPIRED
        prepaidType:
          type: integer
          format: int32
          nullable: true
        account:
          type: object
        origSubscription:
          type: object
      additionalProperties:
        type: object
      type: object
      title: QueryPrepaidBalanceResponse
    NestedValidityPeriodSummaryOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        prepaidBalanceId:
          type: string
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        totalBalance:
          type: number
        remainingBalance:
          type: number
        totalBilledAmount:
          type: number
        billedBalanceAmount:
          type: number
        subscriptionNumber:
          type: string
        uom:
          type: string
        accountNumber:
          type: string
        accountId:
          type: string
        overageRatedQuantity:
          type: number
          format: double
        overageRatedAmount:
          type: number
          format: double
        account:
          type: object
        prepaidBalance:
          type: object
        billingTiming:
          type: string
          enum:
            - In Advance
            - In Arrears
      additionalProperties:
        type: object
      type: object
      title: QueryValidityPeriodSummaryResponse
    ExpandedPrepaidBalanceTransaction:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountId:
          type: string
        prepaidBalanceId:
          type: string
        fundId:
          type: string
        amount:
          type: number
        balance:
          type: number
        sourceId:
          type: string
        transactionDate:
          type: string
          format: date
        transactionSourceType:
          type: string
          enum:
            - CHARGE
            - ORDER_LINE_ITEM
            - USAGE
        prepaidBalanceTransactionType:
          type: string
          enum:
            - PREPAYMENT
            - DRAWDOWN
            - PREPAYMENT_ADJUSTMENT
            - DRAWDOWN_ADJUSTMENT
            - DRAWDOWN_REVERSAL
            - PREPAYMENT_CREDIT_BACK
            - PREPAYMENT_CREDIT_BACK_REVERSAL
        usageUom:
          type: string
        drawdownRate:
          type: number
          nullable: true
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        prepaidBalance:
          $ref: '#/components/schemas/NestedPrepaidBalanceOnExpand'
        fund:
          $ref: '#/components/schemas/NestedPrepaidBalanceFundOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryPrepaidBalanceTransactionResponse
    NestedPrepaidBalanceFundOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountId:
          type: string
        balance:
          type: number
        chargeSegmentNumber:
          type: integer
          format: int32
        endDate:
          type: string
          format: date
        fundedBalance:
          type: number
        fundSourceType:
          type: string
          enum:
            - CHARGE
            - ORDER_LINE_ITEM
            - CREDIT_MEMO_ITEM
            - DEBIT_MEMO_ITEM
        fundingPrice:
          type: number
        totalBilled:
          type: number
        totalBalance:
          type: number
        originalTotalBalance:
          type: number
        originalFundingPrice:
          type: number
        originalFundEndDate:
          type: string
          format: date
        rolloverValidityPeriodStartDate:
          type: string
          format: date
        rolloverValidityPeriodEndDate:
          type: string
          format: date
        prepaidBalanceId:
          type: string
        priority:
          type: integer
          format: int32
          enum:
            - 10
            - 50
            - 100
        sourceId:
          type: string
        startDate:
          type: string
          format: date
        vpSummaryId:
          type: string
        rolloverCount:
          type: integer
          format: int32
        originFundId:
          type: string
        rolloverApplyOption:
          type: string
        done:
          type: integer
          format: int32
        account:
          type: object
        prepaidBalance:
          type: object
        source:
          type: object
        vpSummary:
          type: object
      additionalProperties:
        type: object
      type: object
      title: QueryPrepaidBalanceFundResponse
    ExpandedProcessedUsage:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        usageId:
          type: string
        amount:
          type: number
        billingPeriodEndDate:
          type: string
        billingPeriodStartDate:
          type: string
        invoiceItemId:
          type: string
        creditMemoItemId:
          type: string
        ratePlanChargeId:
          type: string
        usage:
          $ref: '#/components/schemas/NestedUsageOnExpand'
        invoiceItem:
          $ref: '#/components/schemas/NestedInvoiceItemOnExpand'
        creditMemoItem:
          $ref: '#/components/schemas/NestedCreditMemoItemOnExpand'
      type: object
      title: QueryProcessedUsageResponse
      additionalProperties: false
    ExpandedProduct:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        allowFeatureChanges:
          type: boolean
          default: false
        name:
          type: string
        effectiveEndDate:
          type: string
          format: date
        effectiveStartDate:
          type: string
          format: date
        sKU:
          type: string
        productNumber:
          type: string
        category:
          type: string
          enum:
            - Base Products
            - Add On Services
            - Miscellaneous Products
        productRatePlans:
          type: array
          items:
            $ref: '#/components/schemas/NestedProductRatePlanOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryProductResponse
    NestedProductRatePlanOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        productId:
          type: string
        name:
          type: string
        effectiveStartDate:
          type: string
          format: date
        effectiveEndDate:
          type: string
          format: date
        grade:
          type: integer
          format: int32
        productRatePlanNumber:
          type: string
        product:
          type: object
        productRatePlanCharges:
          type: array
          items:
            type: object
      additionalProperties:
        type: object
      type: object
      title: QueryProductRatePlanResponse
    ExpandedProductRatePlan:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        productId:
          type: string
        name:
          type: string
        effectiveStartDate:
          type: string
          format: date
        effectiveEndDate:
          type: string
          format: date
        grade:
          type: integer
          format: int32
        productRatePlanNumber:
          type: string
        product:
          $ref: '#/components/schemas/NestedProductOnExpand'
        productRatePlanCharges:
          type: array
          items:
            $ref: '#/components/schemas/NestedPrpcOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryProductRatePlanResponse
    NestedProductOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        allowFeatureChanges:
          type: boolean
          default: false
        name:
          type: string
        effectiveEndDate:
          type: string
          format: date
        effectiveStartDate:
          type: string
          format: date
        sKU:
          type: string
        productNumber:
          type: string
        category:
          type: string
          enum:
            - Base Products
            - Add On Services
            - Miscellaneous Products
        productRatePlans:
          type: array
          items:
            type: object
      additionalProperties:
        type: object
      type: object
      title: QueryProductResponse
    NestedPrpcOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountingCode:
          type: string
          maxLength: 100
        applyDiscountTo:
          type: string
          enum:
            - ONETIME
            - RECURRING
            - USAGE
            - ONETIMERECURRING
            - ONETIMEUSAGE
            - RECURRINGUSAGE
            - ONETIMERECURRINGUSAGE
            - null
          nullable: true
        chargeFunction:
          enum:
            - Standard
            - Prepayment
            - CommitmentTrueUp
            - Drawdown
            - CreditCommitment
            - DrawdownAndCreditCommitment
          type: string
        isAllocationEligible:
          type: boolean
          default: false
        isUnbilled:
          type: boolean
          default: false
        applyToBillingPeriodPartially:
          type: boolean
          default: false
        billCycleDay:
          type: integer
          format: int64
          minimum: 1
          maximum: 31
        billCycleType:
          enum:
            - DefaultFromCustomer
            - SpecificDayofMonth
            - SubscriptionStartDay
            - ChargeTriggerDay
            - SpecificDayofWeek
            - TermStartDay
            - TermEndDay
          type: string
        billingPeriod:
          enum:
            - Month
            - Quarter
            - Annual
            - Semi-Annual
            - Specific Months
            - Subscription Term
            - Week
            - Specific Weeks
            - Specific Days
          type: string
        billingPeriodAlignment:
          type: string
          enum:
            - AlignToCharge
            - AlignToSubscriptionStart
            - AlignToTermStart
            - AlignToTermEnd
        billingTiming:
          type: string
          enum:
            - IN_ADVANCE
            - IN_ARREARS
        chargeModel:
          enum:
            - Discount-Fixed Amount
            - Discount-Percentage
            - Flat Fee Pricing
            - Per Unit Pricing
            - Overage Pricing
            - Tiered Pricing
            - Tiered with Overage Pricing
            - Volume Pricing
            - Delivery Pricing
            - MultiAttributePricing
            - PreratedPerUnit
            - PreratedPricing`
            - HighWatermarkVolumePricing
            - HighWatermarkTieredPricing
          type: string
        chargeType:
          enum:
            - OneTime
            - Recurring
            - Usage
          type: string
        creditOption:
          type: string
          enum:
            - TimeBased
            - ConsumptionBased
            - FullCreditBack
        defaultQuantity:
          type: number
          nullable: true
        deferredRevenueAccount:
          type: string
          maxLength: 100
        discountClassId:
          type: string
          nullable: true
        discountLevel:
          enum:
            - rateplan
            - subscription
            - account
            - null
          type: string
          nullable: true
        drawdownRate:
          type: number
          nullable: true
        endDateCondition:
          enum:
            - SubscriptionEnd
            - OneTime
            - FixedPeriod
            - SpecificEndDate
          type: string
        excludeItemBillingFromRevenueAccounting:
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          type: boolean
        includedUnits:
          type: number
        isPrepaid:
          type: boolean
          default: false
        isRollover:
          type: boolean
        isStackedDiscount:
          type: boolean
        legacyRevenueReporting:
          type: boolean
        listPriceBase:
          enum:
            - Per Billing Period
            - Per Month
            - Per Week
            - Per Year
            - Per Specific Months
          type: string
        specificListPriceBase:
          type: integer
          format: int32
          nullable: true
        maxQuantity:
          type: number
        minQuantity:
          type: number
        name:
          type: string
        numberOfPeriod:
          type: integer
          format: int64
          nullable: true
        overageCalculationOption:
          type: string
          enum:
            - EndOfSmoothingPeriod
            - PerBillingPeriod
            - null
          nullable: true
        overageUnusedUnitsCreditOption:
          type: string
          enum:
            - NoCredit
            - CreditBySpecificRate
          nullable: true
        prepaidOperationType:
          enum:
            - topup
            - drawdown
            - null
          type: string
          nullable: true
        prepaidQuantity:
          type: number
          nullable: true
        prepaidTotalQuantity:
          type: number
          nullable: true
        priceChangeOption:
          enum:
            - NoChange
            - SpecificPercentageValue
            - UseLatestProductCatalogPricing
          type: string
          default: NoChange
          nullable: true
        priceIncreasePercentage:
          type: number
          minimum: -100
          maximum: 100
          nullable: true
        productRatePlanChargeNumber:
          type: string
        prorationOption:
          type: string
        ratingGroup:
          type: string
          nullable: true
        revRecTriggerCondition:
          enum:
            - ContractEffectiveDate
            - ServiceActivationDate
            - CustomerAcceptanceDate
            - null
          maxLength: 22
          type: string
          nullable: true
        revenueRecognitionRuleName:
          type: string
        rolloverApply:
          enum:
            - ApplyFirst
            - ApplyLast
          type: string
        rolloverPeriodLength:
          default: null
          type: integer
          format: int32
        rolloverPeriods:
          type: integer
          format: int64
        recognizedRevenueAccount:
          maxLength: 100
          type: string
        smoothingModel:
          type: string
          nullable: true
        specificBillingPeriod:
          type: integer
          format: int64
          nullable: true
        taxable:
          type: boolean
        taxCode:
          type: string
        taxMode:
          enum:
            - TaxExclusive
            - TaxInclusive
            - null
          type: string
          nullable: true
        triggerEvent:
          type: string
          enum:
            - ContractEffective
            - ServiceActivation
            - CustomerAcceptance
            - SpecificDate
        upToPeriods:
          type: integer
          format: int64
          nullable: true
        upToPeriodsType:
          enum:
            - Billing Periods
            - Days
            - Weeks
            - Months
            - Years
            - null
          type: string
          nullable: true
        usageRecordRatingOption:
          type: string
          nullable: true
        useDiscountSpecificAccountingCode:
          type: boolean
          nullable: true
        useTenantDefaultForPriceChange:
          type: boolean
        validityPeriodType:
          type: string
          enum:
            - SubscriptionTerm
            - Annual
            - SemiAnnual
            - Quarter
            - Month
        weeklyBillCycleDay:
          enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
          type: string
        priceUpsellQuantityStacked:
          type: boolean
        deliveryScheduleId:
          type: string
        commitmentType:
          type: string
          enum:
            - UNIT
            - CURRENCY
        isCommitted:
          type: boolean
        productRatePlanId:
          type: string
        accountReceivableAccountingCodeId:
          type: string
        recognizedRevenueAccountingCodeId:
          type: string
        deferredRevenueAccountingCodeId:
          type: string
          nullable: true
        adjustmentLiabilityAccountingCodeId:
          type: string
        adjustmentRevenueAccountingCodeId:
          type: string
        contractAssetAccountingCodeId:
          type: string
        contractLiabilityAccountingCodeId:
          type: string
        contractRecognizedRevenueAccountingCodeId:
          type: string
        unbilledReceivablesAccountingCodeId:
          type: string
          nullable: true
        revRecCode:
          maxLength: 70
          type: string
          nullable: true
        uOM:
          type: string
          nullable: true
        drawdownUom:
          type: string
        prepaidUom:
          type: string
          nullable: true
        productRatePlan:
          type: object
        productRatePlanChargeTiers:
          type: array
          items:
            type: object
      additionalProperties:
        type: object
      type: object
      title: QueryProductRatePlanChargeResponse
    ExpandedProductRatePlanCharge:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountingCode:
          type: string
          maxLength: 100
        applyDiscountTo:
          type: string
          enum:
            - ONETIME
            - RECURRING
            - USAGE
            - ONETIMERECURRING
            - ONETIMEUSAGE
            - RECURRINGUSAGE
            - ONETIMERECURRINGUSAGE
            - null
          nullable: true
        chargeFunction:
          enum:
            - Standard
            - Prepayment
            - CommitmentTrueUp
            - Drawdown
            - CreditCommitment
            - DrawdownAndCreditCommitment
          type: string
        isAllocationEligible:
          type: boolean
          default: false
        isUnbilled:
          type: boolean
          default: false
        applyToBillingPeriodPartially:
          type: boolean
          default: false
        billCycleDay:
          type: integer
          format: int64
          minimum: 1
          maximum: 31
        billCycleType:
          enum:
            - DefaultFromCustomer
            - SpecificDayofMonth
            - SubscriptionStartDay
            - ChargeTriggerDay
            - SpecificDayofWeek
            - TermStartDay
            - TermEndDay
          type: string
        billingPeriod:
          enum:
            - Month
            - Quarter
            - Annual
            - Semi-Annual
            - Specific Months
            - Subscription Term
            - Week
            - Specific Weeks
            - Specific Days
          type: string
        billingPeriodAlignment:
          type: string
          enum:
            - AlignToCharge
            - AlignToSubscriptionStart
            - AlignToTermStart
            - AlignToTermEnd
        billingTiming:
          type: string
          enum:
            - IN_ADVANCE
            - IN_ARREARS
        chargeModel:
          enum:
            - Discount-Fixed Amount
            - Discount-Percentage
            - Flat Fee Pricing
            - Per Unit Pricing
            - Overage Pricing
            - Tiered Pricing
            - Tiered with Overage Pricing
            - Volume Pricing
            - Delivery Pricing
            - MultiAttributePricing
            - PreratedPerUnit
            - PreratedPricing`
            - HighWatermarkVolumePricing
            - HighWatermarkTieredPricing
          type: string
        chargeType:
          enum:
            - OneTime
            - Recurring
            - Usage
          type: string
        creditOption:
          type: string
          enum:
            - TimeBased
            - ConsumptionBased
            - FullCreditBack
        defaultQuantity:
          type: number
          nullable: true
        deferredRevenueAccount:
          type: string
          maxLength: 100
        discountClassId:
          type: string
          nullable: true
        discountLevel:
          enum:
            - rateplan
            - subscription
            - account
            - null
          type: string
          nullable: true
        drawdownRate:
          type: number
          nullable: true
        endDateCondition:
          enum:
            - SubscriptionEnd
            - OneTime
            - FixedPeriod
            - SpecificEndDate
          type: string
        excludeItemBillingFromRevenueAccounting:
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          type: boolean
        includedUnits:
          type: number
        isPrepaid:
          type: boolean
          default: false
        isRollover:
          type: boolean
        isStackedDiscount:
          type: boolean
        legacyRevenueReporting:
          type: boolean
        listPriceBase:
          enum:
            - Per Billing Period
            - Per Month
            - Per Week
            - Per Year
            - Per Specific Months
          type: string
        specificListPriceBase:
          type: integer
          format: int32
          nullable: true
        maxQuantity:
          type: number
        minQuantity:
          type: number
        name:
          type: string
        numberOfPeriod:
          type: integer
          format: int64
          nullable: true
        overageCalculationOption:
          type: string
          enum:
            - EndOfSmoothingPeriod
            - PerBillingPeriod
            - null
          nullable: true
        overageUnusedUnitsCreditOption:
          type: string
          enum:
            - NoCredit
            - CreditBySpecificRate
          nullable: true
        prepaidOperationType:
          enum:
            - topup
            - drawdown
            - null
          type: string
          nullable: true
        prepaidQuantity:
          type: number
          nullable: true
        prepaidTotalQuantity:
          type: number
          nullable: true
        priceChangeOption:
          enum:
            - NoChange
            - SpecificPercentageValue
            - UseLatestProductCatalogPricing
          type: string
          default: NoChange
          nullable: true
        priceIncreasePercentage:
          type: number
          minimum: -100
          maximum: 100
          nullable: true
        productRatePlanChargeNumber:
          type: string
        prorationOption:
          type: string
        ratingGroup:
          type: string
          nullable: true
        revRecTriggerCondition:
          enum:
            - ContractEffectiveDate
            - ServiceActivationDate
            - CustomerAcceptanceDate
            - null
          maxLength: 22
          type: string
          nullable: true
        revenueRecognitionRuleName:
          type: string
        rolloverApply:
          enum:
            - ApplyFirst
            - ApplyLast
          type: string
        rolloverPeriodLength:
          default: null
          type: integer
          format: int32
        rolloverPeriods:
          type: integer
          format: int64
        recognizedRevenueAccount:
          maxLength: 100
          type: string
        smoothingModel:
          type: string
          nullable: true
        specificBillingPeriod:
          type: integer
          format: int64
          nullable: true
        taxable:
          type: boolean
        taxCode:
          type: string
        taxMode:
          enum:
            - TaxExclusive
            - TaxInclusive
            - null
          type: string
          nullable: true
        triggerEvent:
          type: string
          enum:
            - ContractEffective
            - ServiceActivation
            - CustomerAcceptance
            - SpecificDate
        upToPeriods:
          type: integer
          format: int64
          nullable: true
        upToPeriodsType:
          enum:
            - Billing Periods
            - Days
            - Weeks
            - Months
            - Years
            - null
          type: string
          nullable: true
        usageRecordRatingOption:
          type: string
          nullable: true
        useDiscountSpecificAccountingCode:
          type: boolean
          nullable: true
        useTenantDefaultForPriceChange:
          type: boolean
        validityPeriodType:
          type: string
          enum:
            - SubscriptionTerm
            - Annual
            - SemiAnnual
            - Quarter
            - Month
        weeklyBillCycleDay:
          enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
          type: string
        priceUpsellQuantityStacked:
          type: boolean
        deliveryScheduleId:
          type: string
        commitmentType:
          type: string
          enum:
            - UNIT
            - CURRENCY
        isCommitted:
          type: boolean
        productRatePlanId:
          type: string
        accountReceivableAccountingCodeId:
          type: string
        recognizedRevenueAccountingCodeId:
          type: string
        deferredRevenueAccountingCodeId:
          type: string
          nullable: true
        adjustmentLiabilityAccountingCodeId:
          type: string
        adjustmentRevenueAccountingCodeId:
          type: string
        contractAssetAccountingCodeId:
          type: string
        contractLiabilityAccountingCodeId:
          type: string
        contractRecognizedRevenueAccountingCodeId:
          type: string
        unbilledReceivablesAccountingCodeId:
          type: string
          nullable: true
        revRecCode:
          maxLength: 70
          type: string
          nullable: true
        uOM:
          type: string
          nullable: true
        drawdownUom:
          type: string
        prepaidUom:
          type: string
          nullable: true
        productRatePlan:
          $ref: '#/components/schemas/NestedProductRatePlanOnExpand'
        productRatePlanChargeTiers:
          type: array
          items:
            $ref: '#/components/schemas/NestedPrpcTierOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryProductRatePlanChargeResponse
    NestedPrpcTierOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        active:
          type: boolean
        currency:
          type: string
        discountAmount:
          type: number
          format: double
        discountPercentage:
          type: number
          format: double
        endingUnit:
          type: number
        includedUnits:
          type: number
        overagePrice:
          format: double
          type: number
        price:
          type: number
          format: double
        priceFormat:
          type: string
          enum:
            - Flat Fee
            - Per Unit
        startingUnit:
          type: number
        tier:
          type: integer
          format: int32
        isDefault:
          type: boolean
        productRatePlanChargeId:
          type: string
        productChargeDefinitionId:
          type: string
        productRatePlanCharge:
          type: object
      additionalProperties:
        type: object
      type: object
      title: QueryProductRatePlanChargeTierResponse
    ExpandedProductRatePlanChargeTier:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        active:
          type: boolean
        currency:
          type: string
        discountAmount:
          type: number
          format: double
        discountPercentage:
          type: number
          format: double
        endingUnit:
          type: number
        includedUnits:
          type: number
        overagePrice:
          format: double
          type: number
        price:
          type: number
          format: double
        priceFormat:
          type: string
          enum:
            - Flat Fee
            - Per Unit
        startingUnit:
          type: number
        tier:
          type: integer
          format: int32
        isDefault:
          type: boolean
        productRatePlanChargeId:
          type: string
        productChargeDefinitionId:
          type: string
        productRatePlanCharge:
          $ref: '#/components/schemas/NestedPrpcOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryProductRatePlanChargeTierResponse
    ExpandedRamp:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        name:
          type: string
        number:
          type: string
        subscriptionNumbers:
          type: string
        chargeNumbers:
          type: string
        orderId:
          type: string
        grossTcb:
          type: number
        grossTcv:
          type: number
        netTcb:
          type: number
        netTcv:
          type: number
        discountTcb:
          type: number
        discountTcv:
          type: number
        metricsProcessingStatus:
          type: string
          enum:
            - Completed
            - NotStarted
      additionalProperties:
        type: object
      type: object
      title: QueryRampResponse
    ExpandedRatePlan:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        productId:
          type: string
        amendmentId:
          type: string
        amendmentType:
          type: string
        name:
          type: string
        productRatePlanId:
          type: string
        subscriptionId:
          type: string
        subscriptionOwnerId:
          type: string
        invoiceOwnerId:
          type: string
        reverted:
          type: boolean
        externallyManagedPlanId:
          type: string
        originalRatePlanId:
          type: string
        subscriptionOfferId:
          type: string
        subscriptionRatePlanNumber:
          type: string
        subscription:
          $ref: '#/components/schemas/NestedSubscriptionOnExpand'
        productRatePlan:
          $ref: '#/components/schemas/NestedProductRatePlanOnExpand'
        ratePlanCharges:
          type: array
          items:
            $ref: '#/components/schemas/NestedRatePlanChargeOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryRatePlanResponse
    ExpandedRatePlanCharge:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        ratePlanId:
          type: string
        productRatePlanChargeId:
          type: string
        accountingCode:
          type: string
        applyDiscountTo:
          type: string
        billCycleDay:
          type: integer
          format: int64
        billCycleType:
          type: string
        billingPeriod:
          type: string
        billingPeriodAlignment:
          type: string
        billingTiming:
          type: string
          enum:
            - In Advance
            - In Arrears
        chargedThroughDate:
          type: string
          format: date
          maxLength: 29
        chargeModel:
          type: string
        chargeNumber:
          type: string
        chargeType:
          type: string
        discountLevel:
          type: string
          enum:
            - rateplan
            - subscription
            - account
        dMRC:
          type: number
        drawdownRate:
          type: number
        dTCV:
          type: number
        effectiveEndDate:
          type: string
          format: date
        effectiveStartDate:
          type: string
          format: date
        endDateCondition:
          enum:
            - SubscriptionEnd
            - FixedPeriod
            - SpecificEndDate
            - OneTime
          type: string
        estimatedStartDate:
          type: string
          format: date
        estimatedEndDate:
          type: string
          format: date
        excludeItemBillingFromRevenueAccounting:
          default: false
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          default: false
          type: boolean
        invoiceScheduleId:
          type: string
        isLastSegment:
          type: boolean
        isPrepaid:
          type: boolean
        isRollover:
          type: boolean
        rolloverPeriods:
          type: integer
          format: int64
        rolloverPeriodLength:
          type: integer
          format: int32
          nullable: true
        rolloverApply:
          type: string
          enum:
            - ApplyFirst
            - ApplyLast
        isProcessed:
          type: boolean
        listPriceBase:
          type: string
          enum:
            - Per Billing Period
            - Per Month
            - Per Week
            - Per Year
            - Per Specific Months
        specificListPriceBase:
          type: integer
          format: int32
          maximum: 200
          minimum: 1
          nullable: true
        priceUpsellQuantityStacked:
          type: boolean
        commitmentType:
          enum:
            - UNIT
            - CURRENCY
          type: string
        isCommitted:
          type: boolean
        mRR:
          type: number
        name:
          type: string
        numberOfPeriods:
          type: integer
          format: int64
        originalId:
          type: string
        overageCalculationOption:
          type: string
        overageUnusedUnitsCreditOption:
          type: string
        prepaidOperationType:
          enum:
            - topup
            - drawdown
            - null
          type: string
          nullable: true
        prepaidQuantity:
          type: number
          nullable: true
        prepaidTotalQuantity:
          type: number
          nullable: true
        priceChangeOption:
          type: string
        priceIncreasePercentage:
          type: number
          format: double
        processedThroughDate:
          type: string
          format: date
        prorationOption:
          type: string
        quantity:
          type: number
        numberOfDeliveries:
          type: number
        ratingGroup:
          type: string
          enum:
            - ByBillingPeriod
            - ByUsageStartDate
            - ByUsageRecord
            - ByUsageUpload
            - ByGroupId
        revenueRecognitionRuleName:
          type: string
        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
        revRecCode:
          type: string
        revRecTriggerCondition:
          type: string
        segment:
          type: integer
          format: int32
        specificBillingPeriod:
          type: integer
          format: int64
        specificEndDate:
          type: string
          format: date
        tCV:
          format: double
          type: number
        triggerDate:
          format: date
          type: string
        triggerEvent:
          type: string
        uOM:
          type: string
        upToPeriods:
          type: integer
          format: int64
        upToPeriodsType:
          type: string
          enum:
            - Billing Periods
            - Days
            - Weeks
            - Months
            - Years
          default: Billing Periods
        version:
          type: integer
          format: int64
        weeklyBillCycleDay:
          type: string
          enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
        subscriptionId:
          type: string
        subscriptionOwnerId:
          type: string
        invoiceOwnerId:
          type: string
        originalOrderDate:
          type: string
          format: date
        amendedByOrderOn:
          type: string
          format: date
        validityPeriodType:
          type: string
          enum:
            - SUBSCRIPTION_TERM
            - ANNUAL
            - SEMI_ANNUAL
            - QUARTER
            - MONTH
        creditOption:
          type: string
          enum:
            - TimeBased
            - ConsumptionBased
            - FullCreditBack
        applyToBillingPeriodPartially:
          type: boolean
        productChargeDefinitionId:
          type: string
        accountReceivableAccountingCodeId:
          type: string
        deferredRevenueAccountingCodeId:
          type: string
        recognizedRevenueAccountingCodeId:
          type: string
        prepaidUOM:
          type: string
        drawdownUom:
          type: string
        salesPrice:
          type: number
        taxable:
          type: boolean
        reverted:
          type: boolean
        reflectDiscountInNetAmount:
          type: boolean
        ratePlan:
          $ref: '#/components/schemas/NestedRatePlanOnExpand'
        productRatePlanCharge:
          $ref: '#/components/schemas/NestedPrpcOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryRatePlanChargeResponse
    NestedRatePlanOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        productId:
          type: string
        amendmentId:
          type: string
        amendmentType:
          type: string
        name:
          type: string
        productRatePlanId:
          type: string
        subscriptionId:
          type: string
        subscriptionOwnerId:
          type: string
        invoiceOwnerId:
          type: string
        externallyManagedPlanId:
          type: string
        originalRatePlanId:
          type: string
        subscriptionOfferId:
          type: string
        subscriptionRatePlanNumber:
          type: string
        subscription:
          type: object
        productRatePlan:
          type: object
        reverted:
          type: boolean
        ratePlanCharges:
          type: array
          items:
            type: object
      additionalProperties:
        type: object
      type: object
      title: QueryRatePlanResponse
    ExpandedRatePlanChargeTier:
      properties:
        currency:
          type: string
        discountAmount:
          type: number
        discountPercentage:
          type: number
        endingUnit:
          type: number
        includedUnits:
          type: number
        overagePrice:
          type: number
        price:
          type: number
        priceFormat:
          type: string
          enum:
            - Per Unit
            - Flat Fee
        startingUnit:
          type: number
        tier:
          type: integer
          format: int64
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        ratePlanChargeId:
          type: string
        ratePlanCharge:
          $ref: '#/components/schemas/NestedRatePlanChargeOnExpand'
      type: object
      title: QueryRatePlanChargeTierResponse
      additionalProperties: true
    ExpandedRatingResult:
      properties:
        id:
          type: string
        createdByID:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedByID:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountId:
          type: string
        subscriptionId:
          type: string
        ratePlanChargeId:
          type: string
        quantity:
          type: number
        amount:
          type: number
        serviceStartDate:
          type: string
          format: date
        serviceEndDate:
          type: string
          format: date
        status:
          type: string
        isPartial:
          type: boolean
        chargeSegmentNumber:
          type: integer
          format: int32
        invoiceItemId:
          type: string
        actualPeriodStartDate:
          type: string
          format: date
        actualPeriodEndDate:
          type: string
          format: date
        billingCycleDay:
          type: integer
          format: int32
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        ratePlanCharge:
          $ref: '#/components/schemas/NestedRatePlanChargeOnExpand'
        subscription:
          $ref: '#/components/schemas/NestedSubscriptionOnExpand'
        invoiceItem:
          $ref: '#/components/schemas/NestedInvoiceItemOnExpand'
      type: object
      title: QueryRatingResultResponse
      additionalProperties: false
    ExpandedRefund:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountId:
          type: string
        amount:
          format: double
          type: number
        cancelledOn:
          format: date-time
          type: string
        comment:
          type: string
          nullable: true
        paymentMethodSnapshotId:
          type: string
        accountingCode:
          type: string
        currency:
          type: string
        gatewayReconciliationReason:
          type: string
        gatewayReconciliationStatus:
          type: string
        gatewayResponse:
          type: string
        gatewayResponseCode:
          type: string
        gatewayState:
          enum:
            - MarkedForSubmission
            - Submitted
            - Settled
            - NotSubmitted
            - FailedToSettle
          type: string
        markedForSubmissionOn:
          format: date-time
          type: string
        methodType:
          enum:
            - ACH
            - Cash
            - Check
            - CreditCard
            - PayPal
            - WireTransfer
            - DebitCard
            - CreditCardReferenceTransaction
            - BankTransfer
            - Other
          type: string
        paymentMethodId:
          type: string
        payoutId:
          type: string
        reasonCode:
          type: string
        refundNumber:
          type: string
        referenceID:
          type: string
        refundDate:
          format: date
          type: string
        refundTransactionTime:
          format: date-time
          type: string
        sourceType:
          type: string
          enum:
            - Payment
            - CreditBalance
            - CreditMemo
        secondRefundReferenceId:
          type: string
        settledOn:
          format: date-time
          type: string
        softDescriptor:
          type: string
        softDescriptorPhone:
          type: string
        status:
          enum:
            - Processed
            - Canceled
            - Error
            - Processing
          type: string
        submittedOn:
          type: string
          format: date-time
        transferredToAccounting:
          enum:
            - Processing
            - 'Yes'
            - 'No'
            - Error
            - Ignore
          type: string
        type:
          type: string
          enum:
            - External
            - Electronic
        associatedTransactionNumber:
          type: string
        gateway:
          type: string
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        paymentMethod:
          $ref: '#/components/schemas/NestedPaymentMethodOnExpand'
        refundApplications:
          type: array
          items:
            $ref: '#/components/schemas/NestedRefundApplicationOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryRefundResponse
    NestedRefundApplicationOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountId:
          type: string
        applicationGroupId:
          type: string
        applyAmount:
          type: number
          format: double
        creditMemoId:
          type: string
        effectiveDate:
          type: string
          format: date
        invoiceId:
          type: string
        paymentId:
          type: string
        refundId:
          type: string
        accountReceivableAccountingCodeId:
          type: string
        onAccountAccountingCodeId:
          type: string
        unappliedPaymentAccountingCodeId:
          type: string
        cashAccountingCodeId:
          type: string
        journalEntryId:
          type: string
        refund:
          type: object
        payment:
          type: object
        refundApplicationItems:
          type: array
          items:
            type: object
      type: object
      title: QueryRefundApplicationResponse
      additionalProperties: false
    ExpandedRefundApplication:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountId:
          type: string
        applicationGroupId:
          type: string
        applyAmount:
          type: number
          format: double
        creditMemoId:
          type: string
        effectiveDate:
          type: string
          format: date
        invoiceId:
          type: string
        paymentId:
          type: string
        refundId:
          type: string
        accountReceivableAccountingCodeId:
          type: string
        onAccountAccountingCodeId:
          type: string
        unappliedPaymentAccountingCodeId:
          type: string
        cashAccountingCodeId:
          type: string
        journalEntryId:
          type: string
        refund:
          $ref: '#/components/schemas/NestedRefundOnExpand'
        payment:
          $ref: '#/components/schemas/NestedPaymentOnExpand'
        refundApplicationItems:
          type: array
          items:
            $ref: '#/components/schemas/NestedRefundApplicationItemOnExpand'
      type: object
      title: QueryRefundApplicationResponse
      additionalProperties: false
    NestedRefundApplicationItemOnExpand:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        amount:
          type: number
        effectiveDate:
          type: string
          format: date
        applicationGroupId:
          type: string
        refundApplicationId:
          type: string
        accountReceivableAccountingCodeId:
          type: string
        onAccountAccountingCodeId:
          type: string
        unappliedPaymentAccountingCodeId:
          type: string
        cashAccountingCodeId:
          type: string
        journalEntryId:
          type: string
        creditTaxationItemId:
          type: string
        creditMemoItemId:
          type: string
        refundApplication:
          type: object
      type: object
      title: QueryRefundApplicationItemResponse
      additionalProperties: false
    ExpandedRefundApplicationItem:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        amount:
          type: number
        effectiveDate:
          type: string
          format: date
        applicationGroupId:
          type: string
        refundApplicationId:
          type: string
        accountReceivableAccountingCodeId:
          type: string
        onAccountAccountingCodeId:
          type: string
        unappliedPaymentAccountingCodeId:
          type: string
        cashAccountingCodeId:
          type: string
        journalEntryId:
          type: string
        creditTaxationItemId:
          type: string
        creditMemoItemId:
          type: string
        refundApplication:
          $ref: '#/components/schemas/NestedRefundApplicationOnExpand'
      type: object
      title: QueryRefundApplicationItemResponse
      additionalProperties: false
    ExpandedSummaryStatementRun:
      properties:
        accountId:
          type: string
        autoEmailEnabled:
          type: string
        batchName:
          type: string
        billCycleDay:
          nullable: true
          type: string
        createdDate:
          format: dateTime
          type: string
        updatedDate:
          format: dateTime
          type: string
        createdById:
          type: string
        updatedById:
          type: string
        dateRangeType:
          enum:
            - Custom
            - PreviousOneCalendarMonth
            - PreviousThreeCalendarMonth
          type: string
        deleted:
          type: string
        endDate:
          format: date
          type: string
        id:
          type: string
        numberOfAccounts:
          type: string
        runType:
          enum:
            - AdHoc
            - Scheduled
          type: string
        startDate:
          format: date
          type: string
        statementRunNumber:
          type: string
        status:
          enum:
            - Pending
            - Processing
            - GenerationCompleted
            - Completed
            - Error
            - Terminated
          type: string
        targetAccountCategory:
          enum:
            - SingleAccount
            - AllAccounts
            - AccountsWithOpenInvoices
            - AccountsWithOpenBalances
            - AccountsWithoutInvoices
            - AccountsWithoutInvoicesAndOpenBalances
          type: string
        errorCategory:
          type: string
        errorMessage:
          type: string
        success:
          type: boolean
        statementDate:
          format: date
          type: string
        statementNumber:
          type: string
        statementRunId:
          type: string
        emailStatus:
          type: string
      type: object
    ExpandedSummaryStatement:
      properties:
        accountId:
          type: string
        autoEmailEnabled:
          type: boolean
        batchName:
          type: string
          nullable: true
        billCycleDay:
          nullable: true
          type: string
        dateRangeType:
          enum:
            - Custom
            - PreviousThreeCalendarMonth
            - PreviousOneCalendarMonth
          type: string
        runType:
          enum:
            - AdHoc
          type: string
        createdById:
          type: string
        createdDate:
          format: dateTime
          type: string
        deleted:
          type: string
        endDate:
          format: date
          type: string
        fileId:
          type: string
        id:
          type: string
        startDate:
          format: date
          type: string
        emailStatus:
          type: string
        statementDate:
          format: date
          type: string
        statementNumber:
          type: string
        statementRunNumber:
          type: string
        statementRunId:
          type: string
        status:
          enum:
            - Pending
            - Processing
            - Completed
            - Error
            - Terminated
          type: string
        targetAccountCategory:
          type: string
          enum:
            - SingleAccount
            - AllAccounts
            - AccountsWithOpenInvoices
            - AccountsWithOpenBalances
            - AccountsWithoutInvoices
            - AccountsWithoutInvoicesAndOpenBalances
        updatedById:
          type: string
        updatedDate:
          format: dateTime
          type: string
        errorCategory:
          type: string
        errorMessage:
          type: string
        success:
          type: boolean
      type: object
    ExpandedSubscription:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountId:
          type: string
        autoRenew:
          type: boolean
          default: false
        cancelledDate:
          type: string
          format: date
        contractAcceptanceDate:
          type: string
          format: date
        contractEffectiveDate:
          type: string
          format: date
        creatorAccountId:
          type: string
        creatorInvoiceOwnerId:
          type: string
        currentTerm:
          type: integer
          format: int64
        currentTermPeriodType:
          type: string
          enum:
            - Month
            - Year
            - Day
            - Week
          default: Month
        initialTerm:
          type: integer
          format: int64
        initialTermPeriodType:
          type: string
          enum:
            - Month
            - Year
            - Day
            - Week
          default: Month
        invoiceOwnerId:
          type: string
        isInvoiceSeparate:
          type: boolean
          default: false
        isSingleVersioned:
          type: boolean
        name:
          type: string
        notes:
          type: string
          maxLength: 65535
        originalCreatedDate:
          type: string
        originalId:
          type: string
        previousSubscriptionId:
          type: string
        renewalSetting:
          type: string
          enum:
            - RENEW_WITH_SPECIFIC_TERM
            - RENEW_TO_EVERGREEN
          default: RENEW_WITH_SPECIFIC_TERM
        renewalTerm:
          type: integer
          format: int64
        renewalTermPeriodType:
          type: string
          enum:
            - Month
            - Year
            - Day
            - Week
          default: Month
        revision:
          type: string
        serviceActivationDate:
          type: string
          format: date
        status:
          type: string
          enum:
            - Draft
            - Pending Activation
            - Pending Acceptance
            - Active
            - Cancelled
            - Suspended
        isLatestVersion:
          type: boolean
        subscriptionEndDate:
          type: string
          format: date
        subscriptionStartDate:
          type: string
          format: date
        subscriptionVersionAmendmentId:
          type: string
        termEndDate:
          type: string
          format: date
        termStartDate:
          type: string
          format: date
        termType:
          type: string
          enum:
            - TERMED
            - EVERGREEN
        version:
          type: integer
          format: int64
        cMRR:
          type: number
        billToContactSnapshotId:
          type: string
        billToContactId:
          type: string
        invoiceTemplateId:
          type: string
        sequenceSetId:
          type: string
          nullable: true
        shipToContactId:
          type: string
        shipToContactSnapshotId:
          type: string
        soldToContactId:
          type: string
        soldToContactSnapshotId:
          type: string
        externallyManagedBy:
          type: string
          enum:
            - Amazon
            - Apple
            - Google
            - Roku
        lastBookingDate:
          format: date
          type: string
        invoiceScheduleId:
          type: string
        cancelReason:
          type: string
        prepayment:
          type: boolean
        currency:
          type: string
        orderId:
          type: string
        rampId:
          type: string
        paymentTerm:
          type: string
        quoteNumber__QT:
          type: string
          maxLength: 32
        quoteType__QT:
          maxLength: 32
          type: string
        quoteBusinessType__QT:
          type: string
          maxLength: 32
        opportunityName__QT:
          type: string
          maxLength: 100
        opportunityCloseDate__QT:
          type: string
          format: date
        cpqBundleJsonId__QT:
          maxLength: 32
          type: string
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        invoiceOwner:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        billToContact:
          $ref: '#/components/schemas/ExpandedContact'
        invoiceItems:
          type: array
          items:
            $ref: '#/components/schemas/NestedInvoiceItemOnExpand'
        ratePlans:
          type: array
          items:
            $ref: '#/components/schemas/NestedRatePlanOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QuerySubscriptionResponse
    ExpandedUsage:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountId:
          type: string
        accountNumber:
          type: string
        ratePlanChargeId:
          type: string
        endDateTime:
          type: string
          format: date-time
        productRatePlanChargeId:
          type: string
        quantity:
          type: number
        rbeStatus:
          type: string
          enum:
            - Importing
            - Pending
            - Processed
        sourceType:
          type: string
          enum:
            - API
            - Import
        startDateTime:
          format: date-time
          type: string
        subscriptionId:
          type: string
        submissionDateTime:
          type: string
          format: date-time
        uOM:
          type: string
        importId:
          type: string
        uniqueKey:
          type: string
        fileId:
          type: string
        fileName:
          type: string
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryUsageResponse
    ExpandedValidityPeriodSummary:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        prepaidBalanceId:
          type: string
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        totalBalance:
          type: number
        remainingBalance:
          type: number
        totalBilledAmount:
          type: number
        billedBalanceAmount:
          type: number
        subscriptionNumber:
          type: string
        uom:
          type: string
        accountNumber:
          type: string
        accountId:
          type: string
        billingTiming:
          type: string
          enum:
            - In Advance
            - In Arrears
        overageRatedQuantity:
          type: number
          format: double
        overageRatedAmount:
          type: number
          format: double
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        prepaidBalance:
          $ref: '#/components/schemas/NestedPrepaidBalanceOnExpand'
      additionalProperties:
        type: object
      type: object
      title: QueryValidityPeriodSummaryResponse
    ExpandedContactSnapshot:
      properties:
        id:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        updatedById:
          type: string
        updatedDate:
          type: string
          format: date-time
        accountId:
          type: string
        contactId:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        nickName:
          type: string
        address1:
          type: string
        address2:
          type: string
        city:
          type: string
        state:
          type: string
        postalCode:
          type: string
        county:
          type: string
        country:
          type: string
        taxRegion:
          type: string
        homePhone:
          type: string
        otherPhone:
          type: string
        otherPhoneType:
          type: string
        fax:
          type: string
        personalEmail:
          type: string
        workEmail:
          type: string
        deleted:
          type: boolean
      additionalProperties:
        type: object
      type: object
      title: QueryContactSnapshotResponse
    QueryRatingDetailsResponse:
      type: object
      title: QueryRatingDetailsResponse
      properties:
        nextPage:
          type: string
          nullable: true
        data:
          type: array
          items:
            $ref: '#/components/schemas/RatingDetails'
      additionalProperties: false
    RatingDetails:
      type: object
      title: RatingDetailResponse
      properties:
        id:
          type: string
        invoiceItemId:
          type: string
        creditMemoItemId:
          type: string
          nullable: true
        chargeType:
          type: string
        chargeModel:
          type: string
        formula:
          type: string
        calculation:
          type: string
        calculatedAmount:
          type: number
          format: double
        currency:
          type: string
        unitOfMeasure:
          type: string
        quantity:
          type: number
          format: double
          nullable: true
        billedQuantity:
          type: number
          format: double
          nullable: true
        billedAmount:
          type: number
          format: double
          nullable: true
        isProration:
          type: boolean
        isCredit:
          type: boolean
        listPriceBase:
          type: string
        billingCycleDay:
          type: integer
        billingCycleType:
          type: string
        billingPeriod:
          type: string
        specificBillingPeriod:
          type: string
        validityPeriodType:
          type: string
        billingPeriodAlignment:
          type: string
        alignmentStartDate:
          type: string
          format: date
        amountWithoutTax:
          type: number
          format: double
        isInclusiveTaxNoRounding:
          type: boolean
        isProrationPartialPeriod:
          type: boolean
        isProrateMonthlyCharges:
          type: boolean
        isProrateWeeklyCharges:
          type: boolean
        prorationUnitRule:
          type: string
        daysInMonthRule:
          type: string
        recurringCreditProrationOptionRule:
          type: string
        isCreditWithOriginalCE:
          type: boolean
        isProrateDiscountCredit:
          type: boolean
        stackedDiscountClassApplyRule:
          type: string
        recurringPeriodStart:
          type: string
          format: date
        recurringPeriodEnd:
          type: string
          format: date
        chargeStartDate:
          type: string
          format: date
        chargeEndDate:
          type: string
          format: date
        subStartDate:
          type: string
          format: date
        subEndDate:
          type: string
          format: date
        termStartDate:
          type: string
          format: date
        termEndDate:
          type: string
          format: date
        creditOption:
          type: string
        fundingPrice:
          type: number
          format: double
        totalBalance:
          type: number
          format: double
        remainingBalance:
          type: number
          format: double
        originalBillingPeriodStart:
          type: string
          format: date
        originalBillingPeriodEnd:
          type: string
          format: date
        originalAmount:
          type: number
          format: double
        basePrice:
          type: number
          format: double
        discountClass:
          type: string
        discountClassOrder:
          type: integer
        discountLevel:
          type: string
        discountApplySequence:
          type: integer
        discountSchedulePeriodStart:
          type: string
          format: date
        discountSchedulePeriodEnd:
          type: string
          format: date
        regularChargeAmount:
          type: number
          format: double
        regularChargeAmountLeft:
          type: number
          format: double
        originalRegularChargeAmount:
          type: number
          format: double
        discountBalanceFormula:
          type: string
      additionalProperties: false
    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
    SubmitDataLabelingJobRequest:
      properties:
        ids:
          items:
            type: string
          type: array
        objectType:
          type: string
        orgIds:
          format: byte
          items:
            format: uuid
            maxLength: 36
            minLength: 36
            type: string
          type: array
        orgs:
          items:
            type: string
          type: array
        query:
          type: string
        queryType:
          enum:
            - ByZoql
            - ById
          type: string
      required:
        - objectType
        - queryType
      type: object
    SubmitDataLabelingJobResponse:
      properties:
        jobId:
          format: uuid
          maxLength: 32
          minLength: 32
          type: string
        jobStatus:
          enum:
            - Accepted
            - Dispatched
            - Completed
          type: string
        success:
          type: boolean
      type: object
    GetDataLabelingJobResponse:
      properties:
        jobId:
          format: uuid
          maxLength: 32
          minLength: 32
          type: string
        jobStatus:
          enum:
            - Accepted
            - Dispatched
            - Completed
          type: string
        objectType:
          type: string
        progress:
          properties:
            failed:
              type: integer
            labeled:
              type: integer
            timeout:
              type: integer
          type: object
        success:
          type: boolean
        totalObject:
          type: integer
      type: object
    RegenerateBookingRequest:
      properties:
        itemNumber:
          type: string
        orderLineItemId:
          type: string
        orderNumber:
          type: string
        subscriptionId:
          type: string
        subscriptionName:
          type: string
        subscriptionVersion:
          type: integer
        ratePlanChargeId:
          type: string
        chargeNumber:
          type: string
        type:
          enum:
            - Subscription
            - OrderLineItem
            - DynamicUsageCharge
          type: string
      type: object
    RegenerateTransactionObjectResponse:
      properties:
        idList:
          items:
            type: string
          type: array
        reasons:
          items:
            $ref: '#/components/schemas/ResponseReasons'
          type: array
        success:
          type: boolean
      type: object
    ResponseReasons:
      properties:
        code:
          type: string
        message:
          type: string
      type: object
    RegenerateBillingRequest:
      properties:
        id:
          type: string
        number:
          type: string
        type:
          enum:
            - Invoice
            - CreditMemo
            - DebitMemo
            - InvoiceItemAdjustment
          type: string
      type: object
    RegenerateRevRecEventsResponse:
      properties:
        reasons:
          items:
            $ref: '#/components/schemas/ResponseReasons'
          type: array
        success:
          type: boolean
      type: object
    DailyConsumptionRevRecRequest:
      properties:
        chargeSegmentNumber:
          type: string
        fundId:
          type: string
        originalChargeId:
          type: string
      required:
        - originalChargeId
      type: object
    GETAutoBackfillJobResponse:
      type: object
      properties:
        id:
          type: string
        createdOn:
          type: integer
          format: int64
        createdOnReadable:
          type: string
          format: datetime
        updatedOn:
          type: integer
          format: int64
        updatedOnReadable:
          type: string
          format: datetime
        updatedByUsername:
          type: string
        status:
          type: string
          enum:
            - ACCEPTED
            - PROCESSING
            - COMPLETED
            - FAILED
            - STOPPED
        type:
          type: string
          enum:
            - BookingDate
            - RatePlanCharge
            - OrderLineItem
        batchSentCount:
          type: integer
          format: int32
        batchFinishedCount:
          type: integer
          format: int32
        errorCount:
          type: integer
          format: int32
        progress:
          type: string
    DataBackfillJob:
      type: object
      properties:
        id:
          type: string
        importType:
          $ref: '#/components/schemas/DataBackfillJobType'
        uploadedFileId:
          type: string
        uploadedFileName:
          type: string
        uploadedFileUrl:
          type: string
        uploadedFileSize:
          type: string
        inputFileSize:
          type: integer
          format: int64
        outputSize:
          type: string
        outputType:
          type: string
        outputFileSize:
          type: integer
          format: int64
        resultFileId:
          type: string
        resultFileName:
          type: string
        resultFileUrl:
          type: string
        uploadedBy:
          type: string
        uploadedOn:
          type: string
          format: date-time
        completedOn:
          type: string
          format: date-time
        startedProcessingOn:
          type: string
          format: date-time
        totalCount:
          type: integer
          format: int32
        failedCount:
          type: integer
          format: int32
        status:
          $ref: '#/components/schemas/DataBackfillJobStatus'
        failureMessage:
          type: string
        processedCount:
          type: integer
          format: int64
        successCount:
          type: integer
          format: int64
        remainingTime:
          type: integer
          format: int64
        remainingTimeText:
          type: string
        completedPercentage:
          type: integer
          format: int32
    DataBackfillJobType:
      type: string
      enum:
        - ProductRatePlanCharge
        - RatePlanCharge
        - InvoiceDetail
        - MemoDetail
        - InvoiceItemAdjustment
    DataBackfillJobStatus:
      type: string
      enum:
        - Pending
        - Processing
        - Completed
        - Canceled
        - Failed
        - Stopping
        - Stopped
    ProxyActioncreateRequest:
      properties:
        objects:
          items:
            $ref: '#/components/schemas/zObject'
          type: array
        type:
          type: string
      required:
        - objects
        - type
      type: object
    SaveResult:
      properties:
        Errors:
          items:
            $ref: '#/components/schemas/ActionsErrorResponse'
          type: array
        Id:
          type: string
        Success:
          type: boolean
      type: object
    ActionsErrorResponse:
      properties:
        Code:
          type: string
        Message:
          type: string
      type: object
    zObject:
      additionalProperties: {}
      type: object
    ProxyActiondeleteRequest:
      properties:
        ids:
          items:
            type: string
          type: array
        type:
          type: string
      required:
        - type
        - ids
      type: object
    DeleteResult:
      properties:
        errors:
          items:
            $ref: '#/components/schemas/ActionsErrorResponse'
          type: array
        id:
          type: string
        success:
          type: boolean
      type: object
    ProxyActionqueryRequest:
      properties:
        conf:
          properties:
            batchSize:
              type: integer
          type: object
        queryString:
          type: string
      required:
        - queryString
      type: object
    ProxyActionqueryResponse:
      properties:
        done:
          type: boolean
        queryLocator:
          type: string
        records:
          items:
            $ref: '#/components/schemas/zObject'
          type: array
        size:
          format: int32
          type: integer
      type: object
    ProxyActionqueryMoreRequest:
      properties:
        conf:
          properties:
            batchSize:
              type: integer
          type: object
        queryLocator:
          type: string
      required:
        - queryLocator
      type: object
    ProxyActionqueryMoreResponse:
      properties:
        done:
          type: boolean
        queryLocator:
          type: string
        records:
          items:
            $ref: '#/components/schemas/zObject'
          type: array
        size:
          format: int32
          type: integer
      type: object
    ProxyActionupdateRequest:
      properties:
        objects:
          items:
            $ref: '#/components/schemas/zObject_update'
          type: array
        type:
          type: string
      required:
        - objects
        - type
      type: object
    zObject_update:
      allOf:
        - properties:
            Id:
              type: string
            fieldsToNull:
              items:
                type: string
              type: array
          required:
            - Id
          type: object
        - $ref: '#/components/schemas/zObject'
      title: zObject
    SettingsBatchRequest:
      properties:
        requests:
          items:
            $ref: '#/components/schemas/SettingValueRequest'
          type: array
      type: object
    SettingsBatchResponse:
      properties:
        responses:
          items:
            $ref: '#/components/schemas/SettingValueResponseWrapper'
          type: array
      title: batchResponse
      type: object
    SettingValueResponseWrapper:
      properties:
        id:
          type: string
        method:
          enum:
            - GET
            - HEAD
            - POST
            - PUT
            - PATCH
            - DELETE
            - OPTIONS
            - TRACE
          type: string
        response:
          $ref: '#/components/schemas/SettingValueResponse'
        url:
          type: string
      title: settingsValueResponseWrapper
      type: object
    SettingValueResponse:
      properties:
        body:
          $ref: '#/components/schemas/BodyInSettingValueReponse'
        errorMessages:
          items:
            type: string
          type: array
        status:
          type: string
      title: settingsValueResponse
      type: object
    BodyInSettingValueReponse:
      additionalProperties: true
      title: settingsResponseBody
      type: object
    SettingValueRequest:
      properties:
        body:
          $ref: '#/components/schemas/BodyInSettingValueRequest'
        children:
          items:
            $ref: '#/components/schemas/ChildrenSettingValueRequest'
          type: array
        id:
          type: string
        method:
          enum:
            - GET
            - HEAD
            - POST
            - PUT
            - PATCH
            - DELETE
            - OPTIONS
            - TRACE
          type: string
        url:
          type: string
      title: settingsRequest
      type: object
    BodyInSettingValueRequest:
      additionalProperties: true
      title: settingsRequestBody
      type: object
    ChildrenSettingValueRequest:
      properties:
        body:
          $ref: '#/components/schemas/BodyInSettingValueRequest'
        id:
          type: string
        method:
          enum:
            - GET
            - HEAD
            - POST
            - PUT
            - PATCH
            - DELETE
            - OPTIONS
            - TRACE
          type: string
        url:
          type: string
      title: childSettingsRequest
      type: object
    ListAllSettingsResponse:
      properties:
        settings:
          items:
            $ref: '#/components/schemas/SettingItemWithOperationsInformation'
          type: array
      title: allSettings
      type: object
    SettingItemWithOperationsInformation:
      properties:
        context:
          enum:
            - Tenant
            - Entity
            - User
            - None
          type: string
        httpOperations:
          items:
            $ref: '#/components/schemas/SettingItemHttpOperation'
          type: array
        key:
          type: string
        pathPattern:
          type: string
      title: settingItem
      type: object
    SettingItemHttpOperation:
      properties:
        method:
          enum:
            - GET
            - HEAD
            - POST
            - PUT
            - PATCH
            - DELETE
            - OPTIONS
            - TRACE
          type: string
        parameters:
          items:
            $ref: '#/components/schemas/SettingItemHttpRequestParameter'
          type: array
        requestType:
          type: object
        responseType:
          type: object
        url:
          type: string
      title: httpOperation
      type: object
    SettingItemHttpRequestParameter:
      properties:
        name:
          type: string
      title: httpRequestParameter
      type: object
    RestoreFile:
      properties:
        success:
          type: boolean
        fileId:
          type: string
        status:
          enum:
            - ACTIVE
            - ARCHIVING
            - ARCHIVED
            - RESTORE_ACCEPTED
            - RESTORE_IN_PROGRESS
            - RESTORED
          type: string
      type: object
    RetrieveFileStatus:
      properties:
        success:
          type: boolean
        accessible:
          type: boolean
        status:
          enum:
            - ACTIVE
            - ARCHIVING
            - ARCHIVED
            - RESTORE_ACCEPTED
            - RESTORE_IN_PROGRESS
            - RESTORED
          type: string
      type: object
    ProxyPostImport:
      properties:
        Id:
          type: string
        Success:
          type: boolean
      type: object
    ProxyGetImport:
      properties:
        CreatedById:
          type: string
        CreatedDate:
          format: date-time
          type: string
        Id:
          type: string
        ImportType:
          type: string
        ImportedCount:
          format: int32
          type: integer
        Md5:
          type: string
        Name:
          type: string
        OriginalResourceUrl:
          type: string
        ResultResourceUrl:
          type: string
        Status:
          type: string
        StatusReason:
          type: string
        TotalCount:
          format: int32
          type: integer
        UpdatedById:
          type: string
        UpdatedDate:
          format: date-time
          type: string
      type: object
    GETCustomExchangeRatesType:
      properties:
        inverse:
          type: boolean
        rateSetName:
          type: string
        rates:
          additionalProperties:
            type: object
            title: rate
            properties:
              providerExchangeRateDate:
                format: date
                type: string
            additionalProperties:
              type: number
              format: double
          type: object
          title: rates
        success:
          type: boolean
      type: object
    POSTAttachmentResponseType:
      properties:
        fileId:
          type: string
        id:
          type: string
        success:
          type: boolean
      type: object
    GETAttachmentResponseType:
      properties:
        createdBy:
          type: string
        createdOn:
          format: date-time
          type: string
        fileContentType:
          type: string
        fileId:
          type: string
        fileName:
          type: string
        id:
          type: string
        organizationLabel:
          type: string
        success:
          type: boolean
        updatedBy:
          type: string
        updatedOn:
          format: date-time
          type: string
      type: object
    PUTAttachmentType:
      properties:
        fileName:
          type: string
      type: object
    GETAttachmentsResponseType:
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/GETAttachmentResponseWithoutSuccessType'
          type: array
        nextPage:
          format: URL
          type: string
        success:
          type: boolean
      type: object
    GETAttachmentResponseWithoutSuccessType:
      properties:
        createdBy:
          type: string
        createdOn:
          format: date-time
          type: string
        fileContentType:
          type: string
        fileId:
          type: string
        fileName:
          type: string
        id:
          type: string
        organizationLabel:
          type: string
        updatedBy:
          type: string
        updatedOn:
          format: date-time
          type: string
      title: attachments
      type: object
  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