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>"

200Retrieved

{
  "payload": {
    "data": [
      {
        "customer": {
          "id": "123",
          "name": "John Doe",
          "externalIds": [
            {
              "id": "123",
              "type": "salesforce",
              "sourceType": "salesforce"
            }
          ]
        },
        "timeframe": "2026-01",
        "categories": [
          {
            "name": "Platform",
            "revenue": 5861.5
          },
          {
            "name": "Service",
            "revenue": 208.33
          }
        ],
        "currency": "USD",
        "total": 6069.83,
        "deferredTotal": 57211.49,
        "unbilledTotal": 0
      }
    ],
    "limit": 1.1,
    "totalItems": 1.1,
    "currentPage": 1.1
  },
  "success": true,
  "message": "string",
  "error": {
    "code": 1.1,
    "message": "string",
    "errorCode": "string",
    "details": {}
  }
}

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 endMonth (string): eq, lte customerId (uuid): eq currency (string): eq

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

errorobjectOptional

json element with any error messages or warnings