Zuora

opencollection: 1.0.0
info:
  name: API Reference
  version: '2023-12-15'
items:
- info:
    name: Accounting Codes
    type: folder
  items:
  - info:
      name: List all accounting codes
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/accounting-codes'
      headers:
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      params:
      - name: page
        value: ''
        type: query
        description: 'The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You
          must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the
          21st to 40th records are returned in the response.

          '
      - name: pageSize
        value: ''
        type: query
        description: 'The number of records returned per page in the response.

          '
    docs: This reference describes how to query all accounting codes in your chart of accounts through the REST API.
  - info:
      name: Create an accounting code
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/accounting-codes'
      headers:
      - name: Idempotency-Key
        value: ''
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
    docs: "This reference describes how to create a new accounting code through the REST API. \nThe accounting code will be\
      \ active as soon as it has been created.\n\n### Prerequisites\n  If you have Zuora Finance enabled on your tenant, you\
      \ must have the  Configure Accounting Codes permission. \n"
  - info:
      name: Activate an accounting code
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/v1/accounting-codes/:ac-id/activate'
      headers:
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      params:
      - name: ac-id
        value: ''
        type: path
        description: ID of the accounting code you want to activate.
    docs: "This reference describes how to activate an accounting code through the REST API.\n\nPrerequisites\n-------------\n\
      If you have Zuora Finance enabled on your tenant, you must have the Manage Accounting Code permission. \n"
  - info:
      name: Deactivate an accounting code
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/v1/accounting-codes/:ac-id/deactivate'
      headers:
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      params:
      - name: ac-id
        value: ''
        type: path
        description: ID of the accounting code you want to deactivate.
    docs: "This reference describes how to deactivate an accounting code through the REST API.\n\n### Prerequisites\nIf you\
      \ have Zuora Finance enabled on your tenant, you must have the Manage Accounting Code permission.\n### Limitations\n\
      You can only deactivate accounting codes that are not associated with any transactions. \nYou cannot disable accounting\
      \ codes of type AccountsReceivable.\n"
  - info:
      name: Retrieve an accounting code
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/accounting-codes/:ac-id'
      headers:
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      params:
      - name: ac-id
        value: ''
        type: path
        description: ID of the accounting code you want to query.
    docs: This reference describes how to query an accounting code through the REST API.
  - info:
      name: Update an accounting code
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/v1/accounting-codes/:ac-id'
      headers:
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      params:
      - name: ac-id
        value: ''
        type: path
        description: ID of the accounting code you want to update.
    docs: "This reference describes how to update an existing accounting code through the REST API.\n### Prerequisites\n \
      \ If you have Zuora Finance enabled on your tenant, you must have the  Manage Accounting Code permission. \n### Limitations\n\
      You can only update accounting codes that are not already associated with any transactions.\n"
  - info:
      name: Delete an accounting code
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/v1/accounting-codes/:ac-id'
      headers:
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      params:
      - name: ac-id
        value: ''
        type: path
        description: ID of the accounting code you want to delete.
    docs: 'This reference describes how to delete an accounting code through the REST API.

      ### Prerequisites

      If you have Zuora Finance enabled on your tenant, then you must have the Delete Unused Accounting Code permission.

      ### Limitations

      You can only delete accounting codes that have never been associated with any transactions. An accounting code must
      be deactivated before you can delete it.

      '
- info:
    name: Accounting Periods
    type: folder
  items:
  - info:
      name: Close an accounting period
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/v1/accounting-periods/:ap-id/close'
      headers:
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      params:
      - name: ap-id
        value: ''
        type: path
        description: ID of the accounting period you want to close.
    docs: 'Close an accounting period by accounting period ID.


      Prerequisites

      -------------

      You must have Zuora Finance enabled on your tenant. You must have the Manage Close Process and Run Trial Balance user
      permissions.


      Limitations

      -----------

      * The accounting period cannot already be closed.

      * The accounting period cannot be in the process of running a trial balance.

      * All earlier accounting periods must be closed.

      * There must be no required action items for the accounting period. See Reconcile Trans'
  - info:
      name: Set an accounting period to pending close
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/v1/accounting-periods/:ap-id/pending-close'
      headers:
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      params:
      - name: ap-id
        value: ''
        type: path
        description: ID of the accounting period you want to set to pending close.
    docs: "Sets an accounting period to pending close.\n\n\nPrerequisites\n-------------\n\n* You must have Zuora Finance\
      \ enabled on your tenant.\n* You must have the Manage Close Process and Run Trial Balance user permissions.\n\n    \
      \        \nLimitations \n -----------\n \n * The accounting period cannot be closed or pending close.\n \n * The accounting\
      \ period cannot be in the process of running a trial balance.\n \n * All earlier accounting periods must be closed.\n\
      \ \n \nNotes\n-----\nWhen you set an accounting period to pen"
  - info:
      name: List all accounting periods
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/accounting-periods'
      headers:
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      params:
      - name: page
        value: ''
        type: query
        description: 'The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You
          must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the
          21st to 40th records are returned in the response.

          '
      - name: pageSize
        value: ''
        type: query
        description: 'The number of records returned per page in the response.

          '
    docs: Retrieves all accounting periods on your tenant.
  - info:
      name: Create an accounting period
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/accounting-periods'
      headers:
      - name: Idempotency-Key
        value: ''
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
    docs: 'Creates an accounting period.

      Prerequisites

      -------------

      * You must have Zuora Finance enabled on your tenant.

      * You must have the Create Accounting Period user permission.


      Limitations

      -----------

      * When creating the first accounting period on your tenant, the start date must be equal to or earlier than the date
      of the earliest transaction on the tenant.

      * Start and end dates of accounting periods must be contiguous. For example, if one accounting period ends on January
      31, the next period mus'
  - info:
      name: Retrieve an accounting period
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/accounting-periods/:ap-id'
      headers:
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      params:
      - name: ap-id
        value: ''
        type: path
        description: ID of the accounting period you want to get.
    docs: 'Retrieves an accounting period.

      Prerequisites

      -------------


      You must have Zuora Finance enabled on your tenant.

      '
  - info:
      name: Update an accounting period
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/v1/accounting-periods/:ap-id'
      headers:
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      params:
      - name: ap-id
        value: ''
        type: path
        description: ID of the accounting period you want to update.
    docs: '

      Updates an accounting period.


      Prerequisites

      -------------


      * You must have Zuora Finance enabled on your tenant.


      * You must have the Create Accounting Period user permission. See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles).


      Limitations

      -----------


      * You can update the start date of only the earliest accounting period on your tenant. You cannot update the start date
      of later periods.


      * If you update the e'
  - info:
      name: Delete an accounting period
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/v1/accounting-periods/:ap-id'
      headers:
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      params:
      - name: ap-id
        value: ''
        type: path
        description: ID of the accounting period you want to delete.
    docs: "Deletes an accounting period.\n\nPrerequisites\n-------------\n\n * You must have Zuora Finance enabled on your\
      \ tenant.\n\n * You must have the Delete Accounting Period user permission. See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles).\n\
      \n\nLimitations\n-----------\n\nThe accounting period to be deleted:\n\n* Must be the most recent accounting period\n\
      \n* Must be an open accounting period\n\n* Must have no revenue distributed int"
  - info:
      name: Reopen an accounting period
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/v1/accounting-periods/:ap-id/reopen'
      headers:
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      params:
      - name: ap-id
        value: ''
        type: path
        description: ID of the accounting period that you want to re-open.
    docs: 'Re-opens an accounting period.

      Prerequisites

      -------------

      * You must have Zuora Finance enabled on your tenant.

      * You must have the Manage Close Process and Run Trial Balance user permissions.


      Limitations

      -----------

      * The accounting period must be closed or pending close.

      * You can only re-open an accounting period that is immediately previous to an open period.'
  - info:
      name: Run trial balance
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/v1/accounting-periods/:ap-id/run-trial-balance'
      headers:
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      params:
      - name: ap-id
        value: ''
        type: path
        description: ID of the accounting period for which you want to run a trial balance.
    docs: "Runs the trial balance for an accounting period. \n\nPrerequisites\n-------------\n\n* You must have Zuora Finance\
      \ enabled on your tenant.\n\n* You must have the Manage Close Process and Run Trial Balance user permissions. See [Finance\
      \ Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles).\n\
      \n          \nLimitations \n-----------\n \n * The accounting period must be open.\n \n * The accounting period cannot\
      \ already be in the process of running"
- info:
    name: Accounts
    type: folder
  items:
  - info:
      name: Create an account
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/accounts'
      headers:
      - name: Idempotency-Key
        value: ''
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      - name: zuora-version
        value: ''
    docs: 'Creates a customer account with a payment method, a bill-to contact, and an optional sold-to contact. Request and
      response field descriptions and sample code are provided. Use this operation to optionally create a subscription, invoice
      for that subscription, and collect payment through the default payment method. The transaction is atomic; if any part
      fails for any reason, the entire transaction is rolled back.


      This operation is CORS Enabled, so you can use client-side Javascript to invoke the '
  - info:
      name: Retrieve an account
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/accounts/:account-key'
      headers:
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      params:
      - name: account-key
        value: ''
        type: path
        description: Account number or account ID.
    docs: 'Retrieves basic information about a customer account.


      This operation is a quick retrieval that doesn''t include the account''s subscriptions, invoices, payments, or usage
      details. Use Get account summary to get more detailed information about an account.

      '
  - info:
      name: Update an account
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/v1/accounts/:account-key'
      headers:
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      params:
      - name: account-key
        value: ''
        type: path
        description: Account number or account ID.
    docs: 'Updates a customer account by specifying the account-key.


      ### Notes

      1. Only the fields to be changed should be specified.  Any field that is not included in the request body will not be
      changed.

      2. If an empty field is submitted with this operation, the corresponding field in the account is emptied.

      3. Email addresses: If no email addresses are specified, no change is made to the email addresses or to the email delivery
      preference. If either the **personalEmail** or **workEmail** of **billToCon'
  - info:
      name: Delete an account
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/v1/accounts/:account-key'
      headers:
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      params:
      - name: account-key
        value: ''
        type: path
        description: Account number or account ID.
    docs: "Deletes a specific account asynchronously. \n\n**Notes and Limitations:** \n- For account deletion, the system\
      \ will start a backend job to remove all transactions under the accounts and change the status of the accounts to 'Cancelled'.\
      \ This backend job is asynchronous and will take some time, depending on the job size.  \n- An account cannot be deleted\
      \ when the account is either the invoice owner or the subscription owner of a subscription and the subscription's invoice\
      \ owner and subscription owner "
  - info:
      name: Retrieve an account summary
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/accounts/:account-key/summary'
      headers:
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      params:
      - name: account-key
        value: ''
        type: path
        description: Account number or account ID.
      - name: excludeUsage
        value: ''
        type: query
        description: Indicate whether to exclude usage information in the response. The default value is `false`.
    docs: "Retrieves detailed information about the specified customer account.\n\nThe response includes the account information\
      \ and a summary of the account’s subscriptions, invoices, payments, and usages.\n\n### Notes\nReturns only the six most\
      \ recent subscriptions based on the subscription updatedDate. Within those subscriptions, there may be many rate plans\
      \ and many rate plan charges. These items are subject to the maximum limit on the array size. \n"
  - info:
      name: List payment methods of an account
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/accounts/:account-key/payment-methods'
      headers:
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      params:
      - name: account-key
        value: ''
        type: path
        description: Account number or account ID.
      - name: isDefaultOnly
        value: ''
        type: query
        description: Indicates whether to only retrieve the default payment method of the account. The default value is `false`.
          If this parameter is set to `true`, only the default payment method is retrieved.
      - name: isActiveOnly
        value: ''
        type: query
        description: Indicates whether to only retrieve the active payment methods of the account. The default value is `false`.
          If this parameter is set to `true`, only the active payment methods are retrieved.
    docs: 'Retrieves the payment methods of the specified customer account.


      **Note:** This operation also supports retrieving custom payment methods created through the [Open Payment Method](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods)
      service.

      '
  - info:
      name: Retrieve the default payment method of an account
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/accounts/:account-key/payment-methods/default'
      headers:
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      params:
      - name: account-key
        value: ''
        type: path
        description: Account number or account ID.
    docs: 'Retrieves the default payment method of the specified customer account.


      **Note:** This operation also supports retrieving the custom payment method created through the [Open Payment Method](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods)
      service.

      '
- info:
    name: Actions
    type: folder
  items:
  - info:
      name: Create
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/action/create'
      headers:
      - name: Idempotency-Key
        value: ''
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: X-Zuora-WSDL-Version
        value: ''
      params:
      - name: rejectUnknownFields
        value: ''
        type: query
        description: "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields`\
          \ set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400\
          \ response is:\n\n```json\n{\n    \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores\
          \ unknown fields in the request body.\n"
    docs: "Use the create call to create one or more objects of a specific type. You can specify different types in different\
      \ create calls, but each create call must apply to only one type of object.\n\n### Limitations \n\nThis call has the\
      \ following limitations:\n\n* A maximum of 50 objects are supported in a single call.\n* The Orders feature is not supported.\n\
      * The Invoice Settlement feature is not supported. This feature includes Unapplied Payments, Credit and Debit Memo,\
      \ and Invoice Item Settlement.\n* The de"
  - info:
      name: Delete
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/action/delete'
      headers:
      - name: Idempotency-Key
        value: ''
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: X-Zuora-WSDL-Version
        value: ''
      params:
      - name: rejectUnknownFields
        value: ''
        type: query
        description: "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields`\
          \ set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400\
          \ response is:\n\n```json\n{\n    \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores\
          \ unknown fields in the request body.\n"
    docs: 'Deletes one or more objects of the same type. You can specify different types in different delete calls, but each
      delete call must apply only to one type of object.


      The following information applies to this call:


      * You will need to first determine the IDs for the objects you wish to delete.

      * You cannot pass in any null IDs.

      * All objects in a specific delete call must be of the same type.



      ### Objects per Call

      50 objects are supported in a single call.

      '
  - info:
      name: Query
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/action/query'
      headers:
      - name: Idempotency-Key
        value: ''
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: X-Zuora-WSDL-Version
        value: ''
      params:
      - name: rejectUnknownFields
        value: ''
        type: query
        description: "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields`\
          \ set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400\
          \ response is:\n\n```json\n{\n    \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores\
          \ unknown fields in the request body.\n"
    docs: 'The query call sends a query expression by specifying the object to query, the fields to retrieve from that object,
      and any filters to determine whether a given object should be queried.



      You can use [Zuora Object Query Language](https://knowledgecenter.zuora.com/DC_Developers/K_Zuora_Object_Query_Language)
      (ZOQL) to construct those queries, passing them through the `queryString`.



      Once the call is made, the API executes the query against the specified object and returns a query response objec'
  - info:
      name: QueryMore
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/action/queryMore'
      headers:
      - name: Idempotency-Key
        value: ''
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: X-Zuora-WSDL-Version
        value: ''
      params:
      - name: rejectUnknownFields
        value: ''
        type: query
        description: "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields`\
          \ set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400\
          \ response is:\n\n```json\n{\n    \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores\
          \ unknown fields in the request body.\n"
    docs: "Use queryMore to request additional results from a previous query call. If your initial query call returns more\
      \ than 2000 results, you can use queryMore to query for the additional results.\n\n\nAny `queryLocator` results greater\
      \ than 2,000, will only be stored by Zuora for 5 days before it is deleted.\n\n\n This call sends a request for additional\
      \ results from an initial query call. If the initial query call returns more than 2000 results, you can use the `queryLocator`\
      \ returned from query to request"
  - info:
      name: Update
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/action/update'
      headers:
      - name: Idempotency-Key
        value: ''
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
        value: ''
      - name: Zuora-Track-Id
        value: ''
      - name: X-Zuora-WSDL-Version
        value: ''
      params:
      - name: rejectUnknownFields
        value: ''
        type: query
        description: "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields`\
          \ set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400\
          \ response is:\n\n```json\n{\n    \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores\
          \ unknown fields in the request body.\n"
    docs: "\nUpdates the information in one or more objects of the same type. You can specify different types of objects in\
      \ different update calls, but each specific update call must apply to only one type of object.\n\n\n### Limitations\
      \ \n\nThis call has the following limitations:\n\n* A maximum of 50 objects are supported in a single call.\n* The Invoice\
      \ Settlement feature is not supported. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice\
      \ Item Settlement.\n* The default WSDL version for"
- info:
    name: Aggregate Queries
    type: folder
  items:
  - info:
      name: Submit an aggregate query job
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/batch-query/'
      headers:
      - name: Idempotency-Key
        value: ''
      - name: Accept-Encoding
        value: ''
      - name: Content-Encoding
        value: ''
      - name: Authorization
        value: ''
      - name: Zuora-Entity-Ids
        value: ''
      - name: Zuora-Org-Ids
      

# --- truncated at 32 KB (522 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zuora/refs/heads/main/apis.yml