Revenue

Retrieving Revenue Report Information

If you are distributing under any Revelator distribution deals, your Revelator revenue reports are automatically added to your account. You can download these reports for use in external systems.

If you are using non-Revelator distribution deals and do not rely on Revelator for reporting or analytics:

  • Do not configure your account to import third-party revenue reports.
  • Do not enter credentials for external reporting fields in your integration settings.

GET /finance/salereport/all

Retrieves a list of financial reports. This endpoint can return two distinct report types - User Statements and Sale Reports - each with its own data source, granularity, and filters. Use filtering parameters to locate a specific statementTypeId.

Understanding Report Types

It is crucial to understand the two types of reports returned by this endpoint, as their availability and behavior differ based on your account type (Parent or Child).

1. User Statements
  • What they are: System-generated statements created during a Royalty Run.
  • Granularity: Contain consolidated revenue from all applicable sources for a specific period.
  • Availability:
    • For Child Accounts: These are the only reports available.
    • For Parent Accounts: To retrieve User Statements generated for your children, you must include the query parameter received=false.
2. Sale Reports
  • What they are: Raw financial reports imported directly into our system from DSPs or imported using our template for unsupported DSPs import.
  • Granularity: Are granulated on a per-store basis.
  • Availability:
    • For Parent Accounts: These are the primary reports you will see by default (when received is not false).
    • For Child Accounts: Sale Reports are not accessible.

Query Params

ParameterTypeDescriptionApplicable Report Type
pageNumber
optional		integerThe page number of the results to retrieve.All
pageSize
optional		integerThe number of items to return per page.All
fromDate
optional		stringFilters for reports with a date (reporting month) on or after this date (YYYY-MM-DD).All
toDate
optional		stringFilters for reports with a date (reporting month) on or before this date (YYYY-MM-DD).All
releaseId
optional		integerFilters for reports associated with a specific releaseId.User Statements
trackId
optional		integerFilters for reports associated with a specific trackId.User Statements
storeId
optional		integerFilters for reports from a specific DSP storeId.Sale Reports
payeeId
optional		integerFilters User Statements reports to include only those associated with the specified payeeId.User Statements
processed
optional		booleanFilters for reports based on their processing status (true or false).Sale Reports
approved
optional		booleanFilters for reports based on their approval status (true or false).User Statements
received
optional		booleanFor Parent Accounts only. Set to false to retrieve User Statements generated for your children. If omitted or true, retrieves Sale Reports.User Statements
searchText
optional		stringA case-insensitive search term used to filter reports by matching the payee name or payor name.All

Examples

Example: Retrieving Sale Reports (Parent Account)

This example shows a parent account retrieving Sale Reports (the default behavior). Note the statementTypeId is -1 and payorName is a DSP like “Spotify”.

Request
curl -X GET 'https://api.revelator.com/finance/salereport/all' \
     -H 'Authorization: Bearer YOUR_AUTH_TOKEN'

Response

{
    "total": 116322.6200000000,
    "totalItemsCount": 3,
    "pageNumber": 1,
    "pageSize": 10,
    "items": [
        {
            "statementId": "-1|123456",
            "statementTypeId": -1,
            "payorDistributorId": 348,
            "payorDistributorStoreId": 301,
            "payorName": "Spotify",
            "payorImageId": null,
            "payeeName": "Your Parent Account",
            "payeeImageId": null,
            "isReady": true,
            "isReprocessing": false,
            "currencyCode": "USD",
            "targetCurrencyCode": "USD",
            "countryId": null,
            "exchangeRate": 1.0000000000,
            "isExchangeRateConfirmed": true,
            "fileName": null,
            "filePath": null,
            "userStatementDownloadToken": null,
            "createdBy": null,
            "lastUpdateBy": null,
            "creationDate": "0001-01-01T00:00:00",
            "lastUpdateDate": null,
            "approvalDate": "2025-09-09T13:19:27.61",
            "date": "2025-08-01T00:00:00",
            "totalQuantity": 0,
            "totalQuantityDownload": 0,
            "totalQuantityStreaming": 0,
            "totalGross": 0.0,
            "totalNet": 104891.33,
            "errorsAssetsCount": 0.0,
            "errorsGross": null,
            "matchedAssetsCount": 0,
            "totalNetDownload": 0.0,
            "totalNetStreaming": 0.0,
            "totalTax": 0.0000000000,
            "totalAdjustment": 1597.3300386065,
            "adjustmentPercentage": 1.5000000000,
            "totalRevenuShare": 0.0,
            "totalMechanicals": 0.0,
            "hasErrors": false,
            "payeeId": 123456,
            "isRoyaltyTokenPayee": false,
            "statementDisplayTypeId": -1,
            "statementType": "Revenue Report",
            "isNew": false,
            "suffix": null,
            "contractName": null,
            "status": 2,
            "isSplited": false,
            "approvedBy": "Parent Account User",
            "sentToPayeeAtDate": null,
            "userStatementsQueueName": null,
            "payorId": null,
            "canUnlock": true,
            "isPayed": true,
            "statementApprovalQueueApprove": null,
            "statementApprovalQueueStatus": null,
            "statementApprovalQueueErrorMessage": null,
            "statementEmailQueueStatus": null,
            "eligibleForApproval": true,
            "payeeIsPayable": false,
            "sentForPayment": false,
            "isSaleLineGenerationCompleted": null,
            "isCrypto": false,
            "isSmartWalletPayee": false
        }
    ],
    "additionalCounters": {
        "totalApprovedCount": 2.0,
        "totalUnApprovedCount": 0.0,
        "totalErrorCount": 1.0,
        "totalNeedFxCount": 0.0,
        "totalCount": 3.0
    }
}
Example: Retrieving User Statements

This example shows a child account retrieving its User Statements, or a parent account using received=false. Note the statementTypeId is 1 and payorName is the parent account.

Request
curl -X GET 'https://api.revelator.com/finance/salereport/all?received=false' \
     -H 'Authorization: Bearer YOUR_AUTH_TOKEN'

Response

{
    "total": 14136.4567257717,
    "totalItemsCount": 2,
    "pageNumber": 1,
    "pageSize": 10,
    "items": [
        {
            "statementId": "1|123456",
            "statementTypeId": 1,
            "payorDistributorId": null,
            "payorDistributorStoreId": null,
            "payorName": "Your Parent Account",
            "payorImageId": null,
            "payeeName": "Your Payee",
            "payeeImageId": null,
            "isReady": true,
            "isReprocessing": false,
            "currencyCode": "USD",
            "targetCurrencyCode": "USD",
            "countryId": null,
            "exchangeRate": 1.0000000000,
            "isExchangeRateConfirmed": true,
            "fileName": null,
            "filePath": "file path",
            "userStatementDownloadToken": "access token",
            "createdBy": null,
            "lastUpdateBy": null,
            "creationDate": "0001-01-01T00:00:00",
            "lastUpdateDate": null,
            "approvalDate": "2025-09-11T12:57:01.047",
            "date": "2025-09-01T00:00:00",
            "totalQuantity": 0,
            "totalQuantityDownload": 0,
            "totalQuantityStreaming": 0,
            "totalGross": 0.0,
            "totalNet": 13571.34,
            "errorsAssetsCount": 0.0,
            "errorsGross": 0.000000,
            "matchedAssetsCount": 0,
            "totalNetDownload": 0.0,
            "totalNetStreaming": 0.0,
            "totalTax": 0.0000000000,
            "totalAdjustment": 0.0000000000,
            "adjustmentPercentage": null,
            "totalRevenuShare": 0.0,
            "totalMechanicals": 0.0,
            "hasErrors": false,
            "payeeId": 480176,
            "isRoyaltyTokenPayee": false,
            "statementDisplayTypeId": 1,
            "statementType": "Managed Distr. Sales",
            "isNew": false,
            "suffix": null,
            "contractName": "Client name",
            "status": 2,
            "isSplited": false,
            "approvedBy": "Parent Account User",
            "sentToPayeeAtDate": null,
            "userStatementsQueueName": null,
            "payorId": null,
            "canUnlock": true,
            "isPayed": true,
            "statementApprovalQueueApprove": null,
            "statementApprovalQueueStatus": null,
            "statementApprovalQueueErrorMessage": null,
            "statementEmailQueueStatus": null,
            "eligibleForApproval": false,
            "payeeIsPayable": false,
            "sentForPayment": false,
            "isSaleLineGenerationCompleted": null,
            "isCrypto": false,
            "isSmartWalletPayee": false
        },
    ],
    "additionalCounters": {
        "totalApprovedCount": 2.0,
        "totalUnApprovedCount": 0.0,
        "totalErrorCount": 0.0,
        "totalNeedFxCount": 0.0,
        "totalCount": 2.0
    }
}

GET /finance/salereport/{statementId}

Retrieves a single specified statement and its details.

The format of statementId in the query is: statementId={statementTypeId}%7C{statementId} , %7C is URL-encoded for ”|” (bar/pipe).

Failure to use this format will result in an error response. Use the Retrieving Revenue Report Information endpoint with filtering parameters, to find the specific statementTypeId of the statement you need.

Example
Request
curl -X GET -H 'Accept: text/plain'\
'https://api.revelator.com/finance/salereport/1%7C123456'
Response
{
    "statementId": "-1|123456",
    "statementTypeId": -1,
    "payorDistributorId": 479,
    "payorDistributorStoreId": 413,
    "payorName": "Example Payor",
    "payorImageId": null,
    "payeeName": "Example Payee",
    "payeeImageId": null,
    "isReady": true,
    "isReprocessing": false,
    "currencyCode": "USD",
    "targetCurrencyCode": "USD",
    "countryId": null,
    "exchangeRate": 1.0000000000,
    "isExchangeRateConfirmed": true,
    "fileName": "monthly-sales-report.txt",
    "filePath": null,
    "userStatementDownloadToken": null,
    "createdBy": "[email protected]",
    "lastUpdateBy": "[email protected]",
    "creationDate": "2024-07-10T13:37:28.6",
    "lastUpdateDate": "2024-07-11T11:56:11.663",
    "approvalDate": "2024-07-11T11:56:11.663",
    "date": "2024-01-01T00:00:00",
    "totalQuantity": 20,
    "totalQuantityDownload": 0,
    "totalQuantityStreaming": 0,
    "totalGross": 14.0000000000,
    "totalNet": 14.000000,
    "errorsAssetsCount": 0.0,
    "errorsGross": null,
    "totalNetDownload": 0.0,
    "totalNetStreaming": 0.0,
    "totalTax": 0.0000000000,
    "totalAdjustment": 0.0000000000,
    "adjustmentPercentage": null,
    "totalRevenuShare": 0.0000000000,
    "totalMechanicals": 0.0000000000,
    "hasErrors": false,
    "payeeId": 123456,
    "isRoyaltyTokenPayee": false,
    "statementDisplayTypeId": -1,
    "statementType": "Revenue Report",
    "isNew": false,
    "suffix": null,
    "contractName": null,
    "status": 2,
    "isSplited": false,
    "approvedBy": "John Doe",
    "sentToPayeeAtDate": null,
    "userStatementsQueueName": null,
    "payorId": null,
    "canUnlock": true,
    "isPayed": true,
    "statementApprovalQueueApprove": true,
    "statementApprovalQueueStatus": 4,
    "statementEmailQueueStatus": null,
    "smartContractsTotalNet": 0.000000,
    "totalNetMissingSmartContracts": 14.000000,
    "isCrypto": null,
    "isSmartWalletPayee": false
}

Downloading Revenue Reports

The method for downloading reports depends on the report type you wish to retrieve:

  • User Statements - system-generated royalty statements.
  • Sale Reports - raw reports imported from DSPs or through the import template.

Use the Retrieving Revenue Report Information endpoint with filtering parameters, to find the specific statementTypeId of the statement you need.

  • User Statements will have a statementTypeId of 1.
  • Sale Reports will have a statementTypeId of -1.

Downloading User Statements

User Statements can be downloaded in two formats:

  • Summary - an HTML overview file.
  • Details - a CSV file with detailed transaction-level data.

Each endpoint downloads a single statement at a time.

GET /finance/salereport/download/summary

Downloads the Summary revenue report (HTML file) for a specified User Statement.

Query Params

ParameterTypeDescription
statementId
required		stringThe full statement ID of the User Statement (e.g., 1%7C12345).

GET /finance/salereport/download/details

Downloads the Details revenue report (CSV file) for a specified User Statement.

Query Params

ParameterTypeDescription
statementId
required		stringThe full statement ID of the User Statement (e.g., 1%7C12345).
Example: Downloading User Statements
Download Summary (HTML)
curl -X GET 'https://api.revelator.com/finance/salereport/download/summary?statementId=1%7C12345' \
     -H 'Authorization: Bearer YOUR_AUTH_TOKEN'
Download Details (CSV)
curl -X GET 'https://api.revelator.com/finance/salereport/download/details?statementId=1%7C12345' \
     -H 'Authorization: Bearer YOUR_AUTH_TOKEN'

Downloading Sale Reports

Sale Reports (statementTypeId = -1) can be downloaded in bulk using a POST request. This returns a ZIP archive containing one or more Sale Reports.

POST /finance/salereport/post-download

Downloads one or more Sale Reports as a compressed ZIP archive.

The request body should be a JSON array of statementId strings. Each statementId must be for a Sale Report (statementTypeId of -1).

Request Body

ParameterTypeDescription
bodyarray of stringsAn array of statementId strings to download.
Example: Downloading Sale Reports
 
curl -X POST 'https://api.revelator.com/finance/salereport/post-download' \
     -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer YOUR_AUTH_TOKEN' \
     -d '[ "-1|59108", "-1|12356" ]'
Previous
Rights
Next
Integrations