/billing_new

List

Lists owner-scoped billing periods with generated line items and invoices. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (BillingPeriodListRes)

get/billing_new/billing_periods/list/v1

Query parameters

Field to sort by.

sort_order'asc' | 'desc'

Sort order for query results

Sort order.

pageinteger

page_sizeinteger

filter_statusesBillingPeriodStatusEnum1[] nullable

Filter by one or more billing-period statuses.

filter_invoice_typesInvoiceTypeEnum1[] nullable

Filter by one or more invoice types.

filter_currency_codesBillingCurrencyCodeEnum1[] nullable

Filter by one or more currency codes.

filter_counterparty_org_idstring nullable

Must be a string starting with org_

Filter by an on-CHRT counterparty organization.

filter_counterparty_off_chrt_org_data_idstring nullable

Filter by an off-CHRT counterparty organization.

filter_counterparty_driver_idstring nullable

Filter by a driver counterparty.

filter_shipper_account_idstring nullable

Filter by an associated shipper account.

filter_task_group_idstring nullable

Filter by an attributed TaskGroup.

filter_period_start_at_timestamp_gtestring date-time nullable

Filter by period start greater than or equal.

filter_period_start_at_timestamp_ltestring date-time nullable

Filter by period start less than or equal.

filter_period_end_at_timestamp_gtestring date-time nullable

Filter by period end greater than or equal.

filter_period_end_at_timestamp_ltestring date-time nullable

Filter by period end less than or equal.

Response

Successful Response

total_countinteger required

Changes

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