---
title: "Get billing transaction totals"
method: GET
path: "/v1/organizations/{organization_id}/billing_transaction_totals"
tags: ["Organization"]
---

# Get billing transaction totals

`GET /v1/organizations/{organization_id}/billing_transaction_totals`

## Request

- Base URL: `https://api.telerivet.com`
- URL: `https://api.telerivet.com/v1/organizations/{organization_id}/billing_transaction_totals`
- Auth: one of:
  - HTTP basic
  - OAuth 2 (authorization code, authorization URL `https://telerivet.com/oauth/authorize`, token URL `https://api.telerivet.com/oauth/token`)

Retrieves aggregate totals of the organization's billing transactions over a date range, optionally grouped by transaction properties and/or rolled up into calendar periods.

 This is useful for answering questions such as how much was spent on each type of usage in a given month, without needing to retrieve each individual transaction via queryBillingTransactions.

 Amounts are in the organization's billing currency, with charges negative and payments/credits positive. Totals are always separated by currency; entries in different currencies are never summed together.

 Note that usage-based charges are posted to the transaction history approximately once per day, so totals for a range including the current day may not include the most recent usage.

## Path parameters

- `organization_id` string, required

## Query parameters

- `start_date` string, required
- `end_date` string, required
- `rollup` 'day' | 'week' | 'month' | 'year'
- `group_by` string
- `entry_type` string
- `usage_category` string
- `usage_country` string
- `usage_network` string
- `project_id` string: ID of Project
- `phone_id` string: ID of Phone

## Response `200`

Successful response

- object
  - `timezone_id` string: The organization's time zone ID, used to determine period boundaries
  - `totals` object[]: Total transaction amounts for each combination of period, grouped property values, and currency, ordered by period then grouped property values.
    - `period_start` string: Start date of the calendar period covered by this item, in YYYY-MM-DD format in the organization's time zone. Only present when the `rollup` parameter is provided.
    - `entry_type` string: The transaction type of this item (or another grouped property, matching the `group_by` parameter). Only properties named in `group_by` are present.
    - `currency` string: Currency code of `amount`
    - `amount` number: Sum of transaction amounts in `currency`. Negative for net charges/debits, positive for net payments/credits.
    - `item_count` integer: Sum of the number of billable items (e.g. messages) covered by these transactions
    - `count` integer: Number of transactions included in this item
  - `truncated` boolean: True if the number of result items exceeded the maximum (500) and the results were truncated

## Other responses

- `400`: Invalid request parameters
- `401`: Invalid or missing API key or Bearer token
- `404`: Resource not found

---

[API](https://skmtc.dev/telerivet/apis/telerivet-api.md) · [All operations](https://skmtc.dev/telerivet/apis/telerivet-api/llms.txt) · [OpenAPI document](https://skmtc.dev/telerivet/apis/telerivet-api/revisions/4e14b1c8d917?raw)