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 Operations API

Use operations to generate invoices and credit memos, collect payments for posted invoices, and generate previews of future invoice items for customer accounts.

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

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

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

3 operations 3 paths 9 schemas 1 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 3

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

Operations 3

Use operations to generate invoices and credit memos, collect payments for posted invoices, and generate previews of future invoice items for customer accounts.

POST
/v1/operations/invoice-collect
Invoice and collect
POST_TransactionInvoicePayment 9 params → 200
POST
/v1/operations/billing-preview
Generate a billing preview
POST_BillingPreview 8 params → 200
GET
/v1/operations/jobs/{jobId}
Retrieve an operation job
GET_OperationJob 7 params → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are POSTBillingPreviewInvoiceItem (20 properties), POSTBillingPreviewCreditMemoItem (19 properties), POSTInvoiceCollectType (8 properties), PostBillingPreviewParam (7 properties). Each schema is shown below with its type and property counts.

POSTBillingPreviewCreditMemoItem
object
19 properties
BillingPreviewResult
object
4 properties
POSTInvoiceCollectInvoicesType
object
3 properties
POSTBillingPreviewInvoiceItem
object
20 properties
POSTInvoiceCollectCreditMemosType
object
3 properties
GetOperationJobResponseType
object
7 properties
PostBillingPreviewParam
object
7 properties 1 required
POSTInvoiceCollectType
object
8 properties 1 required
POSTInvoiceCollectResponseType
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-operations-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