{ "opencollection": "1.0.0", "info": { "name": "API Reference Accounting Codes Sequence Sets API", "version": "2023-12-15" }, "items": [ { "info": { "name": "Sequence Sets", "type": "folder" }, "items": [ { "info": { "name": "List sequence sets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/sequence-sets", "headers": [ { "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": "" } ], "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "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.\n" }, { "name": "name", "value": "", "type": "query", "description": "The name of a specific sequence set.\n" } ] }, "docs": "Retrieves information about all sequence sets configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos.\n\nYou can use query parameters to restrict the data returned in the response.\n\n**Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuor" }, { "info": { "name": "Create sequence sets", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/sequence-sets", "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": "" } ] }, "docs": "Creates sequence sets, allowing distinct numbering sequences for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos.\n\nYou can create a maximum of 100 sequence sets in one single request. A sequence set comprises a set of custom prefixes and starting numbers that are used for billing documents to generate, and payments and refunds to create.\n\nSee [Prefix and Numbering Configuration for Billing Documents](https://knowledgecenter.zuora.com/CB" }, { "info": { "name": "Retrieve a sequence set", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/sequence-sets/:id", "headers": [ { "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": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the sequence set to retrieve information about.\n" } ] }, "docs": "Retrieves information about a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos\n\n**Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Paym" }, { "info": { "name": "Update a sequence set", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/sequence-sets/:id", "headers": [ { "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": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the sequence set to update.\n" } ] }, "docs": "Updates a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos.\n\n**Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and De" }, { "info": { "name": "Delete a sequence set", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/sequence-sets/:id", "headers": [ { "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": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the sequence set to delete.\n" } ] }, "docs": "Deletes a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos.\n\n**Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and De" } ] } ], "bundled": true }