List

GET

/billing_new/invoice_line_items/list/v1

GET

/billing_new/invoice_line_items/list/v1

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.billingNew.invoiceLineItems.listV1({});
}
main();

{
  "items": [
    {
      "invoice_line_item": {
        "_id": "string",
        "created_at_timestamp": "2024-01-15T09:30:00Z",
        "created_by_user_id": "string",
        "currency_code": "USD",
        "description": "string",
        "invoice_type": "accounts_receivable",
        "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
        "last_edited_by_user_id": "string",
        "line_item_type": "base_rate",
        "owned_by_org_id": "string",
        "quantity": 1.1,
        "schema_version": 1,
        "total_amount": 1.1,
        "unit_price": 1.1,
        "awb_number": "string",
        "billing_period_id": "string",
        "counterparty_driver_id": "string",
        "counterparty_off_chrt_org_data_id": "string",
        "counterparty_org_id": "string",
        "currency_conversion": {
          "conversion_rate": 1.1,
          "source_currency_code": "USD",
          "source_unit_price": 1.1,
          "description": "string"
        },
        "export_ref__sage__item_id": "string",
        "invoice_id": "string",
        "order_id": "string",
        "rate_sheet_id": "string",
        "shipper_account_id": "string",
        "status": "draft",
        "task_group_id": "string",
        "tax_percentage": 1.1,
        "unit": "each"
      },
      "invoice": {
        "_id": "string",
        "created_at_timestamp": "2024-01-15T09:30:00Z",
        "created_by_user_id": "string",
        "currency_code": "USD",
        "invoice_type": "accounts_receivable",
        "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
        "last_edited_by_user_id": "string",
        "owned_by_org_id": "string",
        "period_end_at_timestamp": "2024-01-15T09:30:00Z",
        "period_start_at_timestamp": "2024-01-15T09:30:00Z",
        "schema_version": 1,
        "approved_at_timestamp": "2024-01-15T09:30:00Z",
        "approved_by_user_id": "string",
        "counterparty_account_ids": [
          "string"
        ],
        "counterparty_driver_id": "string",
        "counterparty_off_chrt_org_data_id": "string",
        "counterparty_org_id": "string",
        "description": "string",
        "export_ref__sage__customer_id": "string",
        "export_ref__sage__department_id": "string",
        "file_exported_at_timestamp": "2024-01-15T09:30:00Z",
        "file_exported_by_user_id": "string",
        "invoice_line_item_ids": [
          "string"
        ],
        "merge_exported_at_timestamp": "2024-01-15T09:30:00Z",
        "merge_exported_by_user_id": "string",
        "merge_invoice_id": "string",
        "merge_invoice_number": "string",
        "merge_invoice_url": "string",
        "merge_linked_account_id": "string",
        "merge_remote_id": "string",
        "merge_remote_was_deleted": false,
        "merge_status": "draft",
        "name": "string",
        "status": "draft",
        "stripe_exported_at_timestamp": "2024-01-15T09:30:00Z",
        "stripe_exported_by_user_id": "string",
        "stripe_invoice_id": "string",
        "stripe_invoice_number": "string",
        "stripe_invoice_url": "string",
        "stripe_status": "draft",
        "stripe_was_deleted": false,
        "total_amount": 1.1,
        "void_reason": "string",
        "voided_at_timestamp": "2024-01-15T09:30:00Z",
        "voided_by_user_id": "string"
      }
    }
  ],
  "total_count": 1
}

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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

sort_byenumOptional

Field to sort by.

sort_orderenumOptional

Sort order.

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

filter_invoice_typeslist of enums or nullOptional

Filter by one or more invoice types.

Allowed values:

filter_currency_codeslist of enums or nullOptional

Filter by one or more currency codes.

filter_line_item_typeslist of enums or nullOptional

Filter by one or more line item types.

filter_unitslist of enums or nullOptional

Filter by one or more units.

filter_counterparty_org_idstring or nullOptional

Filter by an on-CHRT counterparty organization.

filter_counterparty_off_chrt_org_data_idstring or nullOptional

Filter by off-CHRT counterparty organization data.

filter_counterparty_driver_idstring or nullOptional

Filter by a driver counterparty.

filter_shipper_account_idstring or nullOptional

Filter by an associated shipper account.

filter_invoice_idstring or nullOptional

Filter by an attached invoice.

filter_is_invoicedboolean or nullOptional

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

filter_order_idstring or nullOptional

Filter by an attributed order.

filter_task_group_idstring or nullOptional

Filter by an attributed task group.

filter_created_at_timestamp_gtestring or nullOptionalformat: "date-time"

Filter by created_at_timestamp greater than or equal.

filter_created_at_timestamp_ltestring or nullOptionalformat: "date-time"

Filter by created_at_timestamp less than or equal.

filter_last_edited_at_timestamp_gtestring or nullOptionalformat: "date-time"

Filter by last_edited_at_timestamp greater than or equal.

filter_last_edited_at_timestamp_ltestring or nullOptionalformat: "date-time"

Filter by last_edited_at_timestamp less than or equal.

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Unprocessable Entity Error