List revenue

GET

https://integrators.prod.api.tabsplatform.com/v3.1/revenue

GET

/v3.1/revenue

$ curl https://integrators.prod.api.tabsplatform.com/v3.1/revenue \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "payload": {
3     "data": [
4       {
5         "customer": {
6           "id": "a3f47b9e-8c2d-4f1a-9b7e-2d5f3c6a7e8b",
7           "name": "Acme Corporation",
8           "externalIds": [
9             {
10               "id": "SF-987654321",
11               "type": "salesforce",
12               "sourceType": "salesforce"
13             }
14           ]
15         },
16         "timeframe": "2024-05",
17         "categories": [
18           {
19             "name": "Platform",
20             "revenue": 12500.75
21           },
22           {
23             "name": "Service",
24             "revenue": 3200.4
25           }
26         ],
27         "currency": "USD",
28         "total": 15701.15,
29         "deferredTotal": 4500,
30         "unbilledTotal": 1200.5
31       }
32     ],
33     "limit": 50,
34     "totalItems": 125,
35     "currentPage": 1
36   },
37   "success": true,
38   "message": "Revenue data retrieved successfully",
39   "error": {
40     "code": 0,
41     "message": "",
42     "details": {}
43   }
44 }

Authentication

Authorizationstring

API Key authentication via header

Query parameters

pagedoubleOptionalDefaults to 1

Page number (default: 1)

limitdoubleOptionalDefaults to 50

Flat rows per page (default: 50, maximum: 250)

filterstringOptional

Format: field:rule:value — comma-separated for multiple filters.

Fields: startMonth (string): eq, gte, lte endMonth (string): eq, gte, lte customerId (uuid): eq, gte, lte currency (string): eq, gte, lte

Example: filter=startMonth:eq:value

Format: startMonth/endMonth must be YYYY-MM (e.g. 2026-01); currency must be a valid ISO 4217 code (e.g. USD, EUR).

Format: field:rule:value — comma-separated for multiple filters. Fields: startMonth (string): eq, gte, lte endMonth (string): eq, gte, lte customerId (uuid): eq, gte, lte currency (string): eq, gte, lte Example: filter=startMonth:eq:value Format: `startMonth`/`endMonth` must be `YYYY-MM` (e.g. `2026-01`); `currency` must be a valid ISO 4217 code (e.g. `USD`, `EUR`).

Response

Get all Revenues by filter

payloadobject

Response payload, will be empty when success is false

successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobject

json element with any error messages or warnings