Retrieve a revenue audit report

Retrieves 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

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

Responses
200

Revenue audit report retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

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

Customer resource ID.

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

Product accounting code.

currency
string (CurrencyCode) = 3 characters

Currency code in ISO 4217 format.

status
string

Entry recognition status.

Enum: Description
scheduled

The amount is recognized at the end of the month.

recognized

The amount is recognized and final.

estimatedAmount
number <double>

Estimated amount of recognized revenue unless it changes before recognition time.

recognizedAmount
number <double>

Recognized amount.

scheduledTime
string <date-time>

Date and time when the entry is created.

issuedTime
string <date-time>

Date and time when the related invoice is issued.

recognizedTime
string or null <date-time>

Date and time when the entry is recognized.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/experimental/reports/revenue-audit
Request samples
$service = new Rebilly\Sdk\ReportsService($client);

$report = $service->reports()->getRevenueAudit(limit: 5);
Response samples
application/json
[
  • {
    }
]