Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuora Sequence Sets API

You can create billing document sequence sets through the REST API or the Zuora UI, allowing distinct numbering sequences for billing documents, payments, and refunds. To create a billing document sequence set through the Zuora UI, see Create Billing Document Sequence Sets for more information.

Zuora Sequence Sets API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sequence Sets. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 2 paths, and defines 13 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

5 operations 2 paths 13 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023-12-15
Resource Areas
1

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Sequence Sets 5

You can create billing document sequence sets through the REST API or the Zuora UI, allowing distinct numbering sequences for billing documents, payments, and refunds. To create a…

POST
/v1/sequence-sets
Create sequence sets
POST_SequenceSets 8 params → 200
GET
/v1/sequence-sets
List sequence sets
GET_SequenceSets 9 params → 200
PUT
/v1/sequence-sets/{id}
Update a sequence set
PUT_SequenceSet 8 params → 200
GET
/v1/sequence-sets/{id}
Retrieve a sequence set
GET_SequenceSet 7 params → 200
DELETE
/v1/sequence-sets/{id}
Delete a sequence set
DELETE_SequenceSet 7 params → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are GETSequenceSetResponse (7 properties), PUTSequenceSetRequest (6 properties), POSTSequenceSetRequest (6 properties), CommonResponseType (3 properties). Each schema is shown below with its type and property counts.

CommonResponseType
object
3 properties
CreditMemoEntityPrefix
object
Container for the prefix and starting document number of credit memos. Note: This field is only available if you have the Invoice Settlement feature enabled. T…
2 properties
PaymentEntityPrefix
object
Container for the prefix and starting number of payments.
2 properties
POSTSequenceSetsRequest
object
1 property
RefundEntityPrefix
object
Container for the prefix and starting number of refunds.
2 properties
PUTSequenceSetResponse
object
1 property
PUTSequenceSetRequest
object
6 properties
DebitMemoEntityPrefix
object
Container for the prefix and starting document number of debit memos. Note: This field is only available if you have the Invoice Settlement feature enabled. Th…
2 properties
GETSequenceSetsResponse
object
2 properties
POSTSequenceSetsResponse
object
2 properties
GETSequenceSetResponse
object
7 properties
InvoiceEntityPrefix
object
Container for the prefix and starting document number of invoices.
2 properties
POSTSequenceSetRequest
object
6 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-sequence-sets-api-openapi.yml Raw ↑

Other APIs Zuora publishes across the network.

Zuora V1 API
Zuora Accounting Codes API
Zuora Accounting Periods API
Zuora Accounts API
Zuora Actions API
Zuora Aggregate Queries API
Zuora API Health API
Zuora Attachments API
Zuora Bill Run API
Zuora Bill Run Health API
Zuora Billing Documents API
Zuora Billing Preview Run API