Sign in
Organization

Retrieve organization billing (deprecated)

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

<Callout type="info"> This endpoint is deprecated in favor of billing stats for organization and may return inaccurate results. </Callout> <Callout type="info"> Please note that data are accurate starting on June 1st 2021. </Callout>
post/api/v1/organizations/{organizationID}/billing

Request body

group_bystring[]

List of attributes by which the series is to be grouped.

Example request

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

Response

OK

Example response

{
  "series": [
    {
      "begin_date": "2019-02-01",
      "end_date": "2019-02-01",
      "queue": "https://example.rossum.app/api/v1/queues/8198",
      "values": {
        "header_fields_per_page": 2,
        "header_fields_per_document": 5,
        "header_fields_and_line_items_per_page": 9,
        "header_fields_and_line_items_per_document": 20
      }
    }
  ],
  "totals": {
    "header_fields_per_page": 8,
    "header_fields_per_document": 16,
    "header_fields_and_line_items_per_page": 20,
    "header_fields_and_line_items_per_document": 43
  }
}

Changes

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