CHchrt
/billing_new
/billing_new/invoices

List

Changed on

Lists owner-scoped invoices with related orders, counterparties, and accounts expanded. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (InvoiceListRes)

get/billing_new/invoices/list/v1

Request

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

Query parameters

searchstring nullable

Search invoice names and descriptions.

sort_by'created_at_timestamp' | 'last_edited_at_timestamp' | 'total_amount' | 'status' | 'invoice_type'

Field to sort by.

sort_order'asc' | 'desc'

Sort order for query results

Sort order.

pageinteger
page_sizeinteger
filter_invoice_idsstring[] nullable

Filter by selected invoice ids

filter_statusesInvoiceStatusEnum1[] nullable

Filter by one or more invoice 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 off-CHRT counterparty organization data.

filter_counterparty_driver_idstring nullable

Filter by a driver counterparty.

filter_counterparty_account_idstring nullable

Filter by an associated counterparty account.

filter_created_at_timestamp_gtestring date-time nullable

Filter by created_at_timestamp greater than or equal.

filter_created_at_timestamp_ltestring date-time nullable

Filter by created_at_timestamp less than or equal.

filter_last_edited_at_timestamp_gtestring date-time nullable

Filter by last_edited_at_timestamp greater than or equal.

filter_last_edited_at_timestamp_ltestring date-time nullable

Filter by last_edited_at_timestamp less than or equal.

Response

Successful Response

total_countinteger required

Changes

  • 5e62049a1c19Revision changes
    • info

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

  • b5a0a0e20ff8Revision changes
    • info

      added the new optional query request parameter filter_invoice_ids