Sign in
Organization

Retrieve organization billing stats

In order to obtain an overview of the billed items, you can get basic billing statistics.

The billing unit (pages or documents) is defined in the contract.

post/api/v1/organizations/{organizationID}/billing_stats

Request body

group_bystring[]

List of attributes by which the results are to be grouped. Only a single value is supported.

order_bystring[]

List of attributes by which the results are to be ordered.

Example request

{
  "filters": {
    "queues": [
      "https://example.rossum.app/api/v1/queues/8199"
    ],
    "begin_date": "2021-08-01",
    "end_date": "2021-08-31"
  },
  "group_by": [
    "queue"
  ],
  "order_by": [
    "billable_pages"
  ]
}

Response

OK

updated_atstring date

Date when the billing stats were last updated.

Example response

{
  "results": [
    {
      "begin_date": "2021-01-01",
      "end_date": "2022-12-31",
      "organization": "https://example.rossum.app/api/v1/organizations/406",
      "queue": "https://example.rossum.app/api/v1/queues/8198",
      "values": {
        "billable_documents": 13,
        "billable_pages": 7
      }
    }
  ],
  "totals": {
    "billable_documents": 21288,
    "billable_pages": 30204,
    "non_billable_documents": 81,
    "non_billable_pages": 5649
  },
  "updated_at": "2022-09-01"
}

Changes

No recorded changes to this endpoint across all 2 revisions of this API.