v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB

Reports

Get ARR report

get/v3/reports/arr

Query parameters

pagenumber

Page Number

limitnumber

Max items per page. Defaults to 50. Values above 500 will be rejected.

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 ARR by filter

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Example response

{
  "payload": {
    "data": [
      {
        "customer": {
          "id": "482ff1f3-7270-4a62-8f78-9006f6eb2354",
          "name": "John Doe",
          "externalIds": [
            {
              "id": "123",
              "type": "QUICKBOOKS",
              "sourceType": "QUICKBOOKS"
            }
          ]
        },
        "timeframe": "2026-01",
        "currency": "USD",
        "total": 120000
      }
    ]
  }
}