Knowledge Center

Knowledge Center > API > REST API > REST API Reference > Summary Journal Entries > Cancel Summary Journal Entry

Cancel Summary Journal Entry

This reference describes how to cancel a summary journal entry using the REST API.

You must have the "Cancel Journal Entry" Z-Finance user permission enabled to cancel summary journal entries.

A summary journal entry cannot be canceled if its Transferred to Accounting status is "Yes" or "Processing".

Request

  • Production: PUT https://api.zuora.com/rest/v1/journal-entries/{je-number}/cancel
  • API Sandbox: PUT https://apisandbox-api.zuora.com/rest/v1/journal-entries/{je-number}/cancel

Request Header

The Accept request header is optional. Only JSON is returned.

Request Path Fields

je-number

required

Journal entry number in the format JE-00000001.

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

Request

PUT https://api.zuora.com/rest/v1/journal-entries/JE-00000001/cancel

Response

{
    "success": true
}
Last modified
00:56, 4 Mar 2016

Tags

This page has no custom tags.

Classifications

(not set)