receivablesAnalytics

Requires an authenticated session.

Receivables analytics over a date range. Org-wide figures: needs the analytics:organization:read permission, so users limited to their own records are refused.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query ReceivablesAnalytics($range: AnalyticsRangeInput!) {
  receivablesAnalytics(range: $range) {
    avgDaysToCollect
    dsoDays
    aging {
      bucket
      count
      value
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ReceivablesAnalytics($range: AnalyticsRangeInput!) {\n  receivablesAnalytics(range: $range) {\n    avgDaysToCollect\n    dsoDays\n    aging {\n      bucket\n      count\n      value\n    }\n  }\n}",
  "variables": {
    "range": {
      "from": "2025-01-15T00:00:00Z",
      "to": "2025-01-15T00:00:00Z"
    }
  }
}
EOF

Variables:

{
  "range": {
    "from": "2025-01-15T00:00:00Z",
    "to": "2025-01-15T00:00:00Z"
  }
}

Response:

{
  "data": {
    "receivablesAnalytics": {
      "avgDaysToCollect": 0,
      "dsoDays": 0,
      "aging": [
        {
          "bucket": "string",
          "count": 0,
          "value": 0
        }
      ]
    }
  }
}

receivablesAnalytics(
  range: AnalyticsRangeInput!
): ReceivablesAnalytics!

Arguments

receivablesAnalytics.range ● AnalyticsRangeInput! non-null input

The date range and, optionally, the visibility scope.

Type

ReceivablesAnalytics object

What customers owe the organization.