v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB

Revenue

List revenue

get/v3.1/revenue

Query parameters

pagenumber

Page Number

limitnumber

Number of items to return

filterstring

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

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Example response

{
  "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
      }
    ]
  }
}