Knowledge Center

Knowledge Center > API > REST API > REST API Reference > Accounting Periods > Run Trial Balance

Run Trial Balance

This reference describes how to run a trial balance for an accounting period through the REST API.

Prerequisites

  • You must have Z-Finance enabled on your tenant.
  • You must have the Run Trial Balance user permission. See Z-Finance Roles.

Limitations

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

Request

  • Production: PUT https://api.zuora.com/rest/v1/accounting-periods/{ap-id}/run-trial-balance
  • API Sandbox: PUT https://apisandbox-api.zuora.com/rest/v1/accounting-periods/{ap-id}/run-trial-balance

Request Header Fields

Specify the following field in the request header.

Accept

optional

Optionally specify application/json. Only JSON is returned.

Request Path Fields

Specify the following field in the URL path of the request.

ap-id

required

ID of the accounting period for which you want to run a trial balance.

Response

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 REST API call to view details about the outcome of the trial balance.

Response Body Fields

The following fields are returned in the body of the response.

success

Returns true if the request is successful. Otherwise, returns false.

processId

The internal process ID used to assist Zuora support. Returned only if success is false.

reasons

Information describing the reason for the result. Returned only if success is false.

code

An eight-digit numeric error code.

message

A description of the error.

Example

Example Request

PUT https://apisandbox-api.zuora.com/rest/v1/accounting-periods/7b7181ae547aac1e01547efb61f20162/run-trial-balance

Example Response

{
    "success": true
}

 

Last modified

Tags

This page has no custom tags.

Classifications

(not set)