Knowledge Center

Knowledge Center > API > REST API > REST API Reference > Journal Runs > Delete Journal Run

Delete Journal Run

This reference describes how to delete a journal run using the REST API.

You can only delete journal runs that have already been canceled. See Cancel Journal Run for more information.

You must have the "Delete Cancelled Journal Run" Z-Finance user permission enabled to delete journal runs.

Request

  • Production: DELETE https://api.zuora.com/rest/v1/journal-runs/{jr-number}
  • API Sandbox: DELETE https://apisandbox-api.zuora.com/rest/v1/journal-runs/{jr-number}

Request Header

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

Request Path Fields

jr-number

required

Journal run number. Must be a valid journal run number in the format JR-00000001

The journal run must already be cancelled.

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

DELETE https://api.zuora.com/rest/v1/journal-runs/JR-00000075

Response

{
    "success": true
}
Last modified
22:45, 10 Mar 2016

Tags

This page has no custom tags.

Classifications

(not set)