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 Billing Documents API

Billing documents include invoices, credit memos, and debit memos. **Note**: Credit memos and debit memos are only available if you have the Invoice Settlement feature enabled.

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

Tagged areas include Billing Documents. The published artifact set on APIs.io includes an OpenAPI specification.

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

4 operations 4 paths 9 schemas 2 GET2 POST

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 4

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

Billing Documents 4

Billing documents include invoices, credit memos, and debit memos. Note: Credit memos and debit memos are only available if you have the Invoice Settlement feature enabled.

POST
/v1/accounts/{key}/billing-documents/generate
Generate billing documents by account ID
POST_GenerateBillingDocuments 9 params → 200
GET
/v1/billing-documents
List billing documents for an account
GET_BillingDocuments 13 params → 200
POST
/v1/accounts/billing-documents/files/deletion-jobs
Create a job to hard delete billing document files
POST_BillingDocumentFilesDeletionJob 8 params → 200
GET
/v1/accounts/billing-documents/files/deletion-jobs/{jobId}
Retrieve a job of hard deleting billing document files
GET_BillingDocumentFilesDeletionJob 7 params → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are GETBillingDocumentsResponseType (8 properties), PostGenerateBillingDocumentType (7 properties), POSTBillingDocumentFilesDeletionJobResponse (3 properties), BillingDocumentQueryResponseElementType (3 properties). Each schema is shown below with its type and property counts.

CreditMemoResponseType
object
1 property
BillingDocumentQueryResponseElementType
object
3 properties
POSTBillingDocumentFilesDeletionJobResponse
object
3 properties
GenerateBillingDocumentResponseType
object
3 properties
GETBillingDocumentFilesDeletionJobResponse
object
3 properties
GETBillingDocumentsResponseType
object
8 properties
InvoiceResponseType
object
1 property
POSTBillingDocumentFilesDeletionJobRequest
object
2 properties
PostGenerateBillingDocumentType
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-billing-documents-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 Preview Run API
Zuora Catalog API