Sign in
Accounting Periods

Retrieve an accounting period

Retrieves an accounting period.

Prerequisites: You must have Zuora Finance enabled on your tenant.

get/v1/accounting-periods/{ap-id}

Path parameters

ap-idstring required

ID of the accounting period you want to get.

Headers

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Response

OK

createdBystring

ID of the user who created the accounting period.

createdOnstring

Date and time when the accounting period was created.

endDatestring date

The end date of the accounting period.

fiscalYearinteger

Fiscal year of the accounting period.

fiscalQuarterinteger

Fiscal quarter of the accounting period.

idstring

ID of the accounting period.

namestring

Name of the accounting period.

notesstring

Any optional notes about the accounting period.

runTrialBalanceEndstring

Date and time that the trial balance was completed. If the trial balance status is Pending, Processing, or Error, this field is null.

runTrialBalanceErrorMessagestring nullable

If trial balance status is Error, an error message is returned in this field.

runTrialBalanceStartstring

Date and time that the trial balance was run. If the trial balance status is Pending, this field is null.

runTrialBalanceStatusstring

Status of the trial balance for the accounting period. Possible values:

  • Pending
  • Processing
  • Completed
  • Error
startDatestring date

The start date of the accounting period.

statusstring

Status of the accounting period. Possible values:

  • Open
  • PendingClose
  • Closed
successboolean

Returns true if the request was processed successfully.

updatedBystring

ID of the user who last updated the accounting period.

updatedOnstring

Date and time when the accounting period was last updated.

Changes

No recorded changes to this endpoint across all 4 revisions of this API.