---
title: "Expanded"
method: GET
path: "/billing_new/billing_periods/expanded/v1/{billing_period_id}"
tags: ["/billing_new", "/billing_new/billing_periods"]
---

# Expanded

`GET /billing_new/billing_periods/expanded/v1/{billing_period_id}`

## Request

- Base URL: `http://localhost:8000`
- URL: `http://localhost:8000/billing_new/billing_periods/expanded/v1/{billing_period_id}`
- Auth: HTTP bearer

Gets an owner-scoped billing period with its generated line item and invoice when present. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (BillingPeriodExpanded1)

## Path parameters

- `billing_period_id` string, required

## Response `200`

Successful Response

- BillingPeriodExpanded1
  - `billing_period` BillingPeriod1, required
    - `schema_version` 1, required
    - `invoice_type` 'accounts_receivable' | 'accounts_payable', required
    - `currency_code` 'USD' | 'CAD' | 'EUR' | 'GBP' | 'MXN' | 'AUD' | 'JPY' | 'CNY' | 'CHF' | 'INR', required
    - `name` string, nullable
    - `description` string, required
    - `amount` number, required
    - `counterparty_org_id` string, nullable: Must be a string starting with `org_`
    - `counterparty_off_chrt_org_data_id` string, nullable
    - `counterparty_driver_id` string, nullable
    - `shipper_account_id` string, nullable
    - `period_start_at_timestamp` string, date-time, required
    - `period_end_at_timestamp` string, date-time, required
    - `cycle` 'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly', required
    - `task_group_ids` string[]
    - `owned_by_org_id` string, required: Must be a string starting with `org_`
    - `status` 'open' | 'closed'
    - `created_by_user_id` string, required: Must be a string starting with `user_`
    - `created_at_timestamp` string, date-time, required
    - `last_edited_by_user_id` string, required: Must be a string starting with `user_`
    - `last_edited_at_timestamp` string, date-time, required
    - `closed_by_user_id` string, nullable: Must be a string starting with `user_`
    - `closed_at_timestamp` string, date-time, nullable
    - `_id` string, required
  - `invoice_line_item` InvoiceLineItem1
    - `schema_version` 1, required
    - `invoice_type` 'accounts_receivable' | 'accounts_payable', required
    - `description` string, required
    - `quantity` number, required
    - `unit` 'each' | 'shipment' | 'hour' | 'day' | 'mile' | 'kilometer' | 'pound' | 'kilogram'
    - `unit_price` number, required
    - `currency_code` 'USD' | 'CAD' | 'EUR' | 'GBP' | 'MXN' | 'AUD' | 'JPY' | 'CNY' | 'CHF' | 'INR', required
    - `line_item_type` 'base_rate' | 'additional_mileage' | 'long_distance_mileage' | 'fuel' | 'extra_stop' | 'wait_time' | 'attempt' | 'pick_and_hold' | 'parking' | 'tolls' | 'additional_fee' | 'dispute' | 'equipment' | 'dangerous_goods' | 'special_vehicle' | 'after_hours' | 'weekend' | 'holiday' | 'air_waybill' | 'insurance' | 'off_network_carrier' | 'obc_day_rate' | 'flight_ticket' | 'tracking_device_label' | 'tracking_device_tag' | 'tracking_device_other' | 'tax' | 'other', required
    - `tax_percentage` number, nullable
    - `counterparty_org_id` string, nullable: Must be a string starting with `org_`
    - `counterparty_off_chrt_org_data_id` string, nullable
    - `counterparty_driver_id` string, nullable
    - `shipper_account_id` string, nullable
    - `awb_number` string, nullable: IATA Air Waybill number: 3-digit airline prefix + 8-digit serial, e.g. '020-12345678'.
    - `export_ref__sage__item_id` string, nullable
    - `order_id` string, nullable
    - `task_group_id` string, nullable
    - `billing_period_id` string, nullable
    - `invoice_id` string, nullable
    - `rate_sheet_id` string, nullable
    - `currency_conversion` InvoiceLineItemCurrencyConversion1
      - `source_unit_price` number, required
      - `source_currency_code` 'USD' | 'CAD' | 'EUR' | 'GBP' | 'MXN' | 'AUD' | 'JPY' | 'CNY' | 'CHF' | 'INR', required
      - `conversion_rate` number, required: Units of the target currency per one unit of source_currency_code. unit_price = source_unit_price * conversion_rate.
      - `description` string, nullable
    - `status` 'draft' | 'approved' | 'finalized'
    - `owned_by_org_id` string, required: Must be a string starting with `org_`
    - `created_by_user_id` string, required: Must be a string starting with `user_`
    - `created_at_timestamp` string, date-time, required
    - `last_edited_by_user_id` string, required: Must be a string starting with `user_`
    - `last_edited_at_timestamp` string, date-time, required
    - `_id` string, required
    - `total_amount` number, required
  - `invoice` Invoice1
    - `schema_version` 1, required
    - `invoice_type` 'accounts_receivable' | 'accounts_payable', required
    - `counterparty_org_id` string, nullable: Must be a string starting with `org_`
    - `counterparty_off_chrt_org_data_id` string, nullable
    - `counterparty_driver_id` string, nullable
    - `currency_code` 'USD' | 'CAD' | 'EUR' | 'GBP' | 'MXN' | 'AUD' | 'JPY' | 'CNY' | 'CHF' | 'INR', required
    - `name` string, nullable
    - `description` string, nullable
    - `export_ref__sage__department_id` string, nullable
    - `export_ref__sage__customer_id` string, nullable
    - `owned_by_org_id` string, required: Must be a string starting with `org_`
    - `period_start_at_timestamp` string, date-time, required
    - `period_end_at_timestamp` string, date-time, required
    - `counterparty_account_ids` string[]
    - `invoice_line_item_ids` string[]
    - `total_amount` number, nullable
    - `status` 'draft' | 'approved' | 'void'
    - `approved_by_user_id` string, nullable: Must be a string starting with `user_`
    - `approved_at_timestamp` string, date-time, nullable
    - `voided_by_user_id` string, nullable: Must be a string starting with `user_`
    - `voided_at_timestamp` string, date-time, nullable
    - `void_reason` string, nullable
    - `merge_linked_account_id` string, nullable
    - `merge_invoice_id` string, nullable
    - `merge_remote_id` string, nullable
    - `merge_invoice_number` string, nullable
    - `merge_invoice_url` string, nullable
    - `merge_status` 'draft' | 'submitted' | 'open' | 'partially_paid' | 'paid' | 'void'
    - `merge_remote_was_deleted` boolean
    - `merge_exported_by_user_id` string, nullable: Must be a string starting with `user_`
    - `merge_exported_at_timestamp` string, date-time, nullable
    - `stripe_invoice_id` string, nullable
    - `stripe_invoice_number` string, nullable
    - `stripe_invoice_url` string, nullable
    - `stripe_status` 'draft' | 'open' | 'paid' | 'uncollectible' | 'void'
    - `stripe_was_deleted` boolean
    - `stripe_exported_by_user_id` string, nullable: Must be a string starting with `user_`
    - `stripe_exported_at_timestamp` string, date-time, nullable
    - `file_exported_by_user_id` string, nullable: Must be a string starting with `user_`
    - `file_exported_at_timestamp` string, date-time, nullable
    - `created_by_user_id` string, required: Must be a string starting with `user_`
    - `created_at_timestamp` string, date-time, required
    - `last_edited_by_user_id` string, required: Must be a string starting with `user_`
    - `last_edited_at_timestamp` string, date-time, required
    - `_id` string, required

## Other responses

- `422`: Validation Error

## Changes

- **2026-09-21** `9a30893d8db1`: 1 warning, 9 info
  - added the new `tax` enum value to the `invoice_line_item/anyOf[subschema #1: InvoiceLineItem1]/line_item_type` response property for the response status `200`
  - api tag `/billing_new/billing_periods` added
  - removed the `XXX` enum value from the `billing_period/currency_code` response property for the response status `200`
  - removed the `XXX` enum value from the `invoice/anyOf[subschema #1: Invoice1]/currency_code` response property for the response status `200`
  - …6 more

[Operation history](https://skmtc.dev/chrt/apis/chrt-fastapi/changes/billing_new/billing_periods/expanded/v1/:billing_period_id/get.md)

---

[API](https://skmtc.dev/chrt/apis/chrt-fastapi.md) - [All operations](https://skmtc.dev/chrt/apis/chrt-fastapi/llms.txt) - [OpenAPI document](https://skmtc.dev/chrt/apis/chrt-fastapi/revisions/6f428e2e2b98?raw)