CHchrt
/billing_new
/billing_new/billing_periods

List

Changed on

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

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/billing_new/billing_periods/list/v1
  • Auth
    HTTP bearer

Query parameters

sort_by'created_at_timestamp' | 'last_edited_at_timestamp' | 'period_start_at_timestamp' | 'period_end_at_timestamp' | 'amount' | 'name'

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

  • 9a30893d8db1Revision changes
    • breaking

      removed the enum value XXX from the property anyOf[subschema #1]/items/ of the query request parameter filter_currency_codes

    • warning

      added the new tax enum value to the //// response property for the response status

    • info

      api tag /billing_new/billing_periods added

    • info

      removed the XXX enum value from the /// response property for the response status

    • info

      removed the XXX enum value from the //// response property for the response status

    • info

      removed the XXX enum value from the //// response property for the response status

    • info

      removed the XXX enum value from the ////// response property for the response status

    • info

      removed the tax_1 enum value from the //// response property for the response status

    • info

      removed the tax_2 enum value from the //// response property for the response status

    • info

      removed the tax_3 enum value from the //// response property for the response status

    • info

      added the required property //// to the response with the status