Retrieve the waterfall status

Request

Purpose

Returns the status of waterfall (schedule) generation for a journal entry. Poll this after create, update or approval until it is SUCCESS or ERROR.

When to use

Poll after create, update or approval until waterfall generation finishes (SUCCESS or ERROR), before reading schedules or waterfall entries.

Notes

For an ID that does not exist, the call returns HTTP 200 with an empty waterfallStatus.

Security

OneIdOAuth

Path

jeIdinteger, (int64)required

ID of the journal entry.

Example:10045

cURL

curl -i -X GET \
  https://one.zuora.com/revenue/services/v1/journal-entries/10045/waterfall-status \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Waterfall status

Headers

traceIdstring

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

Bodyapplication/json

idinteger or null, (int64)

Unique system-generated identifier of the journal entry (JE header ID).

Example:10045

waterfallStatusstring or null

Status of revenue waterfall (schedule) generation for the entry. One of NEW, IN PROGRESS, SUCCESS, ERROR. For approved entries this reflects the final waterfall; otherwise the preview waterfall.

Enum:"NEW""IN PROGRESS""SUCCESS""ERROR"

Example:"SUCCESS"

Response

{
  "id": 10045,
  "waterfallStatus": "SUCCESS"
}