---
title: "Run trial balance"
method: PUT
path: "/v1/accounting-periods/{ap-id}/run-trial-balance"
tags: ["Accounting Periods"]
---

# Run trial balance

`PUT /v1/accounting-periods/{ap-id}/run-trial-balance`

## Request

- Base URL: `https://rest.test.zuora.com`
- URL: `https://rest.test.zuora.com/v1/accounting-periods/{ap-id}/run-trial-balance`
- Auth: HTTP bearer

Runs the trial balance for an accounting period. 

Prerequisites
-------------

* You must have Zuora Finance enabled on your tenant.

* You must have the Manage Close Process and Run Trial Balance user permissions. See [Finance Roles](https://docs.zuora.com?resourceId=platform-finance-roles).

          
Limitations 
-----------
 
 * The accounting period must be open.
 
 * The accounting period cannot already be in the process of running a trial balance.

 
Notes
-----
The trial balance is run asynchronously. A response of `{ "success": true }` means only that the trial balance has started processing, but does not mean that the trial balance has successfully completed. You can use the [Get Accounting Period](https://developer.zuora.com/api-references/api/operation/GET_AccountingPeriod) REST API call to view details about the outcome of the trial balance.

## 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

- CommonResponse
  - `processId` string: The ID of the process that handles the operation.
  - `reasons` object[]: The container of the error code and message. This field is available only if the `success` field is `false`.
    - `code` string: The error code of response.
    - `message` string: The detail information of the error response
  - `requestId` string, uuid: Unique identifier of the request.
  - `success` boolean: Indicates whether the call succeeded.

## 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.dev/zuora/apis/api-reference/revisions/2deecb0dd041?raw)