Knowledge Center

Knowledge Center > API > REST API > REST API Reference > Accounting Periods > Re-Open Accounting Period

Re-Open Accounting Period

This reference describes how to re-open an accounting period through the REST API.

Prerequisites

  • You must have Z-Finance enabled on your tenant.
  • You must have the Reopen Accounting Period user permission. See Z-Finance Roles.

Limitations

  • The accounting period must be closed or pending close.
  • You can only re-open an accounting period that is immediately previous to an open period. See re-open an accounting period for an example.

Request

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

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 path of the request URL.

ap-id

required

ID of the accounting period that you want to re-open.

Response

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/reopen

Example Response

{
    "success": true
}

 

Last modified
22:03, 25 May 2016

Tags

Classifications

(not set)