Sign in
Organization Group

Retrieve organization billing stats group

Download billing stats report for an organization group.

Limitations:

  • filter.queues can only be used when filter.organizations contains a single organization
  • filter.queues cannot be used for group_by=organization
post/api/v1/organization_groups/{organizationGroupID}/billing_stats

Path parameters

organizationGroupIDinteger required

A unique integer value identifying organization group.

Request body

group_bystring[]

List of attributes by which the results are to be grouped. Only a single value is supported. Note that 'organization' is only available for organization groups.

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",
    "organizations": [
      "https://example.rossum.app/api/v1/organization_groups/42/organizations/406"
    ]
  },
  "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",
      "organization_group": "https://example.rossum.app/api/v1/organization_groups/17",
      "queue": "https://example.rossum.app/api/v1/queues/8199",
      "values": {
        "billable_documents": 32,
        "billable_pages": 27,
        "purchased_pages": 555,
        "is_current": true
      }
    }
  ],
  "totals": {
    "billable_documents": 32,
    "billable_pages": 27,
    "purchased_pages": 555
  },
  "updated_at": "2022-09-01"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.