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 Accounting Periods API

A key step in configuring Finance is to create accounting periods in Zuora to match your company's financial calendar. This allows Zuora to produce reports and data exports organized by accounting periods, and to perform the work of closing the accounting periods for the revenue sub-ledger.

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

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

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

9 operations 6 paths 8 schemas 1 DELETE2 GET1 POST5 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 9

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

Accounting Periods 9

A key step in configuring Finance is to create accounting periods in Zuora to match your company's financial calendar. This allows Zuora to produce reports and data exports organi…

PUT
/v1/accounting-periods/{ap-id}/close
Close an accounting period
PUT_CloseAccountingPeriod 7 params → 200
PUT
/v1/accounting-periods/{ap-id}/pending-close
Set an accounting period to pending close
PUT_PendingCloseAccountingPeriod 7 params → 200
POST
/v1/accounting-periods
Create an accounting period
POST_AccountingPeriod 8 params → 200
GET
/v1/accounting-periods
List all accounting periods
GET_AllAccountingPeriods 8 params → 200
GET
/v1/accounting-periods/{ap-id}
Retrieve an accounting period
GET_AccountingPeriod 7 params → 200
PUT
/v1/accounting-periods/{ap-id}
Update an accounting period
PUT_UpdateAccountingPeriod 8 params → 200
DELETE
/v1/accounting-periods/{ap-id}
Delete an accounting period
DELETE_AccountingPeriod 7 params → 200
PUT
/v1/accounting-periods/{ap-id}/reopen
Reopen an accounting period
PUT_ReopenAccountingPeriod 7 params → 200
PUT
/v1/accounting-periods/{ap-id}/run-trial-balance
Run trial balance
PUT_RunTrialBalance 7 params → 200

Schemas 8

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

GETAccountingPeriodWithoutSuccessType
GETAccountingPeriodsType
object
3 properties
GETAccountingPeriodType
POSTAccountingPeriodType
AccountingPeriodObjectCustomFields
object
Container for custom fields of an Accounting Period object.
CommonResponseType
object
3 properties
PUTAccountingPeriodType
POSTAccountingPeriodResponseType
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-accounting-periods-api-openapi.yml Raw ↑

Other APIs Zuora publishes across the network.

Zuora V1 API
Zuora Accounting Codes 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
Zuora Catalog API