Skip to content
Revenue API
/
/
List revenue waterfall en...

List revenue waterfall entries

Request

Purpose

Returns a page of the revenue waterfall for a journal entry: for each line, the amount recognized in each period. Use it to review the revenue impact before approving.

When to use

  • Preview the revenue impact of an entry by period before approving it.
  • Explain to stakeholders how an adjustment changes future revenue.
Security
OneIdOAuth
Path
jeIdinteger, (int64)required

ID of the journal entry.

Example:10045
Query
filterArray of strings

Filter clause in the form field.OPERATOR:value. Repeat the parameter to combine clauses with AND. Operators: EQ (equals), NE (not equals), LT, GT, LE, GE (comparisons for numbers and dates), SW (starts with) and IN (any of a list: field.IN:[v1,v2]). Values are not quoted. Allowed fields for waterfall entries: jeSetNo, soNumber, soLineId, accountCode, jeAmount, startDate, endDate, accountType. Unknown fields return 400 INVALID_VALUE.

Example:filter=accountType.EQ:Revenue
sortArray of strings

Sort clause field.ASC or field.DESC. Only the first sort clause is applied. Uses the same field names as filter.

Example:sort=jeSetNo.ASC
fieldsArray of strings

Accepted for consistency with other list endpoints; not applied by this endpoint.

expandArray of strings

Reserved for future use; currently ignored.

pageSizeinteger, (int32)

Number of records per page. Defaults to 20. Values above 40 are reduced to 40.

Default:20
Example:pageSize=20
cursorstring

Page to return. Use the 1-based page number (1, 2, ...). Defaults to the first page. A non-numeric or non-positive value returns 400 INVALID_VALUE.

Example:cursor=2
cURL
curl -i -X GET \
  'https://one.zuora.com/revenue/services/v1/journal-entries/10045/waterfall-entries?filter=accountType.EQ%3ARevenue&sort=jeSetNo.ASC&fields=string&expand=string&pageSize=20&cursor=2' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Page of waterfall entries

Headers
traceIdstring

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

Bodyapplication/json
pageNumberinteger or null, (int32)

1-based number of the page returned.

Example:1
pageSizeinteger or null, (int32)

Maximum number of records per page (capped at 40).

Example:20
totalRecordsinteger or null, (int64)

Total number of records that match the query across all pages.

Example:1
resultArray of objects or null(WaterfallEntry)

Records on this page.

Response
{
  "pageNumber": 1,
  "pageSize": 20,
  "totalRecords": 1,
  "result": [
    { … }
  ]
}