Skip to main content
GET
/
statements
/
{user_id}
/
{period_id}
Get a rep's statement for a period
curl --request GET \
  --url https://api.openquota.ai/v1/statements/{user_id}/{period_id} \
  --header 'Authorization: Bearer <token>'
{
  "user_id": "<string>",
  "period_id": "<string>",
  "period": {
    "id": "<string>",
    "cadence": "<string>",
    "start_date": "<string>",
    "end_date": "<string>",
    "status": "<string>"
  },
  "total_amount_cents": 123,
  "line_count": 123,
  "lines": [
    {
      "id": "<string>",
      "user_id": "<string>",
      "period_id": "<string>",
      "deal_id": "<string>",
      "plan_version_id": "<string>",
      "rule_chip_id": "<string>",
      "rule_version": "<string>",
      "amount_cents": 123,
      "status": "open",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Provide your API key as Authorization: Bearer <key>. Generate keys in the OpenQuota admin under Settings → API Keys.

Path Parameters

​
user_id
string
required
​
period_id
string
required

Response

The rep's statement for the period.

Aggregate view of a rep's commissions for a single period — the rep's canonical document at period close.

​
user_id
string
required
​
period_id
string
required
​
period
object
required

Period the statement covers. status is open while live, locked post-close.

​
total_amount_cents
integer
required

Sum of amount_cents across every Line in the statement.

​
line_count
integer
required

Number of Lines (commissions) in the statement.

​
lines
object[]
required

Every Commission (Line) for (user_id, period_id) in the caller's org, created-first order.