---
title: "Retrieve an accounting period"
method: GET
path: "/v1/accounting-periods/{ap-id}"
tags: ["Accounting Periods"]
---

# Retrieve an accounting period

`GET /v1/accounting-periods/{ap-id}`

Retrieves an accounting period.

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

## Path parameters

- `ap-id` string, required

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Version` string

## Response `200`

OK

- GETAccountingPeriodType — Container for custom fields of an Accounting Period object.
  - `createdBy` string — ID of the user who created the accounting period.
  - `createdOn` string — Date and time when the accounting period was created.
  - `endDate` string, date — The end date of the accounting period.
  - `fileIds` object — File IDs of the reports available for the accounting period. You can retrieve the reports by specifying the file ID in a [Get Files](https://developer.zuora.com/api-references/api/operation/GET_Files) REST API call.
    - `accountsReceivableAccountAgingDetailExportFileId` string — File ID of the Accounts Receivable Aging Account Detail report.
    - `accountsReceivableInvoiceAgingDetailExportFileId` string — File ID of the Accounts Receivable Aging Invoice Detail report.
    - `accountsReceivableDebitMemoAgingDetailExportFileId` string — File ID of the Accounts Receivable Aging Debit Memo Detail report.
    - `arRollForwardDetailExportFileId` string — File ID of the Accounts Receivable Detail report.
    - `fxRealizedGainAndLossDetailExportFileId` string — File ID of the Realized Gain and Loss Detail report. Returned only if you have Foreign Currency Conversion enabled.
    - `fxUnrealizedGainAndLossDetailExportFileId` string — File ID of the Unrealized Gain and Loss Detail report. Returned only if you have Foreign Currency Conversion enabled
    - `revenueDetailCsvFileId` string — File ID of the Revenue Detail report in CSV format.
    - `revenueDetailExcelFileId` string — File ID of the Revenue Detail report in XLSX format.
    - `unprocessedChargesFileId` string, nullable — File ID of a report containing all unprocessed charges for the accounting period.
  - `fiscalYear` integer — Fiscal year of the accounting period.
  - `fiscalQuarter` integer — Fiscal quarter of the accounting period.
  - `id` string — ID of the accounting period.
  - `name` string — Name of the accounting period.
  - `notes` string — Any optional notes about the accounting period.
  - `organizationLabels` object[] — The organization(s) that the object belongs to. Note: This field is available only when the Multi-Org feature is enabled.
    - `organizationId` string — The organization ID.
    - `organizationName` string — The organization name.
  - `runTrialBalanceEnd` string — Date and time that the trial balance was completed. If the trial balance status is `Pending`, `Processing`, or `Error`, this field is `null`.
  - `runTrialBalanceErrorMessage` string, nullable — If trial balance status is Error, an error message is returned in this field.
  - `runTrialBalanceStart` string — Date and time that the trial balance was run. If the trial balance status is Pending, this field is null.
  - `runTrialBalanceStatus` string — Status of the trial balance for the accounting period. Possible values: * `Pending` * `Processing` * `Completed` * `Error`
  - `startDate` string, date — The start date of the accounting period.
  - `status` string — Status of the accounting period. Possible values: * `Open` * `PendingClose` * `Closed`
  - `success` boolean — Returns `true` if the request was processed successfully.
  - `updatedBy` string — ID of the user who last updated the accounting period.
  - `updatedOn` string — Date and time when the accounting period was last updated.

## Other responses

- `500` — Internal Server Error
- `4XX` — Request Errors

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)