Skip to content
Revenue API
/
/
Reject journal entries

Reject journal entries

Request

Purpose

Rejects one or more journal entries that are Approval Pending. Rejected entries can be edited and resubmitted. Provide a comment explaining the rejection; it is stored in the audit trail.

When to use

  • An approver sends one or more entries back to the preparer for correction. Always include a comment explaining why.

Notes

  • Check success on the response and on every item in results. HTTP 200 is also returned when every entry failed; HTTP 207 means a mix of successes and failures.
  • Each results item currently reports the entry inside message; id may be omitted.
Security
OneIdOAuth
Headers
Idempotency-Keystring

Optional client-generated unique key (for example a UUID). Accepted for forward compatibility; not currently enforced - the service does not de-duplicate retries, so do not rely on it to prevent duplicate entries.

Example:6f1c2c3e-0b7a-4d1e-9a51-1f1e2a3b4c5d
Bodyapplication/jsonrequired
jeIdsArray of integers or null, (int64)

IDs of the journal entries to act on. Required for approve, reject, recall, reverse and bulk-delete. Reverse accepts exactly one ID. Ignored by submit (the ID comes from the path).

Example:
[
  10045,
  10046
]
commentstring or null

Comment recorded in the audit trail with the action.

Example:"Approved for September close"
bookIdinteger or null, (int32)

Identifier of the accounting book (for example the primary book or a secondary/parallel book) the entry belongs to. Optional.

Example:1
reversalPeriodinteger or null, (int32)

Period ID in which the reversal is posted. Required for reverse; ignored by other actions.

Example:202610
{
  "jeIds": [
    10046
  ],
  "comment": "Account code is wrong; please correct line 2"
}

Responses

All entries rejected

Headers
traceIdstring

Identifier of the request. Quote it when you contact Zuora Support.

Bodyapplication/json
successboolean

true only when the action succeeded for every entry.

Example:true
statusstring or null

Journal entry status after the action as reported by the service (for example Approved after approve, Rejected after reject, Approval Pending after submit); for reverse, the reversal status. May be omitted (for example bulk delete).

Example:"Approved"
resultsArray of objects or null(BulkActionItem)

Per-entry outcomes.

Response
{
  "success": true,
  "status": "Rejected",
  "results": [
    { … },
    { … }
  ]
}