Knowledge Center

Knowledge Center > API > REST API > REST API Reference > Accounting Periods > Delete Accounting Period

Delete Accounting Period

This reference describes how to delete an accounting period through the REST API.

Prerequisites

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

Limitations

The accounting period to be deleted:

  • Must be the most recent accounting period
  • Must be an open accounting period
  • Must have no revenue distributed into it
  • Must not have any active journal entries
  • Must not be the open-ended accounting period
  • Must not be in the process of running a trial balance

Request

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

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 you want to delete.

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

DELETE https://apisandbox-api.zuora.com/rest/v1/accounting-periods/7b7181ae547aac1e01547efb61f20162

Example Response

{
    "success": true
}
Last modified
22:03, 25 May 2016

Tags

This page has no custom tags.

Classifications

(not set)