CHchrt
/billing_new
/billing_new/invoice_line_items

List

Changed on

Lists owner-scoped invoice line items with attached invoices expanded. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (InvoiceLineItemListRes)

get/billing_new/invoice_line_items/list/v1

Request

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

Query parameters

sort_by'created_at_timestamp' | 'last_edited_at_timestamp' | 'description' | 'quantity' | 'unit_price' | 'invoice_type' | 'currency_code' | 'line_item_type'

Field to sort by.

sort_order'asc' | 'desc'

Sort order for query results

Sort order.

pageinteger
page_sizeinteger
filter_invoice_typesInvoiceTypeEnum1[] nullable

Filter by one or more invoice types.

filter_currency_codesBillingCurrencyCodeEnum1[] nullable

Filter by one or more currency codes.

filter_line_item_typesInvoiceLineItemTypeEnum1[] nullable

Filter by one or more line item types.

filter_unitsInvoiceLineItemUnitEnum1[] nullable

Filter by one or more units.

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_shipper_account_idstring nullable

Filter by an associated shipper account.

filter_invoice_idstring nullable

Filter by an attached invoice.

filter_is_invoicedboolean nullable

Filter by whether a line item is attached to an invoice.

filter_order_idstring nullable

Filter by an attributed order.

filter_task_group_idstring nullable

Filter by an attributed task group.

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

  • 9a30893d8db1Revision changes
    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • warning

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

    • info

      api tag /billing_new/invoice_line_items added

    • info

      added the enum value tax to the property anyOf[subschema #1]/items/ of the query request parameter filter_line_item_types

    • 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