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 Journal Runs API

Use journal runs to automatically create summary journal entities that are suitable for importing into your general ledger system.For more information about journal runs, see Journal Runs.

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

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

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

4 operations 3 paths 6 schemas 1 DELETE1 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 4

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

Journal Runs 4

Use journal runs to automatically create summary journal entities that are suitable for importing into your general ledger system. For more information about journal runs, see Jou…

POST
/v1/journal-runs
Create a journal run
POST_JournalRun 8 params → 200
GET
/v1/journal-runs/{jr-number}
Retrieve a journal run
GET_JournalRun 7 params → 200
DELETE
/v1/journal-runs/{jr-number}
Delete a journal run
DELETE_JournalRun 7 params → 200
PUT
/v1/journal-runs/{jr-number}/cancel
Cancel a journal run
PUT_JournalRun 7 params → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are GETJournalRunType (12 properties), POSTJournalRunType (6 properties), CommonResponseType (3 properties), POSTJournalRunResponseType (2 properties). Each schema is shown below with its type and property counts.

GETJournalRunType
object
12 properties
GETJournalRunTransactionType
object
1 property
CommonResponseType
object
3 properties
POSTJournalRunType
object
6 properties 2 required
POSTJournalRunTransactionType
object
1 property 1 required
POSTJournalRunResponseType
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-journal-runs-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