Knowledge Center

Knowledge Center > API > REST API > REST API Reference > Chart of Accounts > Deactivate Accounting Code

Deactivate Accounting Code

This reference describes how to deactivate an accounting code through the REST API.

Prerequisites

If you have Z-Finance enabled on your tenant, you must have the Z-Finance Manage Accounting Code permission. See Z-Finance Roles.

Limitations

You can only deactivate accounting codes that are not associated with any transactions. 

You cannot disable accounting codes of type AccountsReceivable.

Request

  • Production: PUT https://api.zuora.com/rest/v1/accounting-codes/{ac-id}/deactivate
  • API Sandbox: PUT https://apisandbox-api.zuora.com/rest/v1/accounting-codes/{ac-id}/deactivate

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.

ac-id

required

ID of the accounting code you want to deactivate.

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.

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-codes/8a8081ae547aac1e01547efb61f20140/deactivate

Example Response

{
    "success": true
}

 

Last modified
18:56, 10 May 2016

Tags

Classifications

(not set)