Submit a journal entry for approval

Revenue API

Submit a journal entry for approval

Request

Purpose

Submits a validated journal entry into the approval workflow. The approval rule that matches the entry determines the approvers; if no approval rule matches, the submit is refused. Only the comment property of the body is used.

When to use

An entry is complete and Validated, and should now go to its approvers.
Call GET /journal-entries/{jeId}/validation-status first; submitting an entry with line errors fails.

Security

OneIdOAuth

Path

jeIdinteger, (int64)required

ID of the journal entry.

Example:10045

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/json

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:

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

{
  "comment": "Ready for September close review"
}

Responses

Entry submitted

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": "Approval Pending",
  "results": [
    { … }
  ]
}