Retrieve a revenue audit report

Retrieve a revenue audit report which contains detailed journal entries. A revenue audit report is a combination of a granular revenue waterfall and a journal report, which describes revenue per account. Use filter limit and offset parameters to restrict the output.

SecuritySecretApiKey or JWT
Request
query Parameters
filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

Responses
200

Revenue audit report successfully retrieved.

Response Headers
Pagination-Total
integer

Total items count.

Example: 332
Pagination-Limit
integer

Items per page limit.

Example: 100
Pagination-Offset
integer

Pagination offset.

Example: 2
Response Schema: application/json
Array
customerId
string <= 50 characters

ID of the customer which generated the revenue.

invoiceId
string <= 50 characters

ID of the invoice that contains the item which generated the revenue.

invoiceItemId
string <= 50 characters

ID of the invoice item which generated the revenue.

productId
string or null <= 50 characters

ID of the product related to the invoice item.

planId
string or null <= 50 characters

ID of the plan related to the invoice item.

accountingCode
string

The product accounting code.

status
string

The entry's recognition status.

Enum: Description
scheduled

The amount will be recognized at the end of month.

recognized

The amount is recognized and final.

estimatedAmount
number <double>

Estimated amount which will be recognized unless it is changed before recognition time.

recognizedAmount
number <double>

The recognized amount.

scheduledTime
string <date-time>

Date and time at which the entry was created.

recognizedTime
string or null <date-time>

Date and time at which the entry was recognized.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/revenue-audit
Request samples
Response samples
application/json
[
  • {
    }
]