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 Summary Journal Entries API

A summary journal entry is a summary of Zuora transaction amounts organized by accounting code and general ledger segments. A segment adds more reporting granularity through business dimensions, such as country or product. For more information, see Summary Journal Entries Introduction

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

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

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

6 operations 5 paths 14 schemas 1 DELETE2 GET1 POST2 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 6

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

Summary Journal Entries 6

A summary journal entry is a summary of Zuora transaction amounts organized by accounting code and general ledger segments. A segment adds more reporting granularity through busin…

POST
/v1/journal-entries
Create a summary journal entry
POST_SummaryJournalEntry 8 params → 200
GET
/v1/journal-entries/journal-runs/{jr-number}
List all summary journal entries in a journal run
GET_AllSummaryJournalEntries 9 params → 200
GET
/v1/journal-entries/{je-number}
Retrieve a summary journal entry
GET_SummaryJournalEntry 7 params → 200
DELETE
/v1/journal-entries/{je-number}
Delete a summary journal entry
DELETE_SummaryJournalEntry 7 params → 200
PUT
/v1/journal-entries/{je-number}/cancel
Cancel a summary journal entry
PUT_SummaryJournalEntry 7 params → 200
PUT
/v1/journal-entries/{je-number}/basic-information
Update a summary journal entry
PUT_BasicSummaryJournalEntry 8 params → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are GETJournalEntriesInJournalRunType (3 properties), CommonResponseType (3 properties), POSTJournalEntrySegmentType (2 properties), GETJournalEntrySegmentType (2 properties). Each schema is shown below with its type and property counts.

CommonResponseType
object
3 properties
GETJournalEntriesInJournalRunType
object
3 properties
JournalEntryItemObjectCustomFields
object
Container for custom fields of a Journal Entry Item object.
PUTJournalEntryItemType
GETJournalEntrySegmentType
object
2 properties
GETJournalEntryItemType
GETJournalEntryDetailTypeWithoutSuccess
POSTJournalEntryResponseType
object
2 properties
PUT_BasicSummaryJournalEntryType
GETJournalEntryDetailType
POSTJournalEntrySegmentType
object
2 properties 2 required
POSTJournalEntryType
POSTJournalEntryItemType
JournalEntryObjectCustomFields
object
Container for custom fields of a Journal Entry object.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-summary-journal-entries-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