Check allowed actions

Request

Purpose

Tells you which actions (submit, approve, reject, recall, delete, update, reverse) the caller may perform on the selected journal entries right now, considering their status, the approval rule, soft freeze and the caller's role. Call it before showing action buttons or before running an automated workflow step.

When to use

Decide which actions to offer a user (show or hide Submit, Approve, Delete ... buttons) in your own UI.
Check up front, in an automated workflow, whether a step will be allowed before calling it.

Security

OneIdOAuth

Bodyapplication/jsonrequired

jeIdsArray of integers, (int64)required

Journal entry IDs to evaluate. Privileges are returned for the combined selection.

Example:

[
  10045
]

bookIdinteger or null, (int32)

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

Example:1

{
  "jeIds": [
    10045
  ],
  "bookId": 1
}

Responses

Allowed actions

Headers

traceIdstring

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

Bodyapplication/json

submitAllowedboolean or null

Caller can submit the entries for approval.

Example:true

approveAllowedboolean or null

Caller can approve the entries.

Example:false

rejectAllowedboolean or null

Caller can reject the entries.

Example:false

recallAllowedboolean or null

Caller can recall the entries from approval.

Example:false

deleteAllowedboolean or null

Caller can delete the entries.

Example:true

updateAllowedboolean or null

Caller can edit the entries.

Example:true

revertAllowedboolean or null

Caller can reverse the entries.

Example:false

Response

{
  "submitAllowed": true,
  "approveAllowed": false,
  "rejectAllowed": false,
  "recallAllowed": false,
  "deleteAllowed": true,
  "updateAllowed": true,
  "revertAllowed": false
}