List

GET

/billing_new/invoice_line_items/list/v1

GET

/billing_new/invoice_line_items/list/v1

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.billingNew.invoiceLineItems.listV1({
8         sort_by: "created_at_timestamp",
9         sort_order: "asc",
10         page: 1,
11         page_size: 1,
12         filter_counterparty_org_id: "filter_counterparty_org_id",
13         filter_counterparty_off_chrt_org_data_id: "filter_counterparty_off_chrt_org_data_id",
14         filter_shipper_account_id: "filter_shipper_account_id",
15         filter_invoice_id: "filter_invoice_id",
16         filter_is_invoiced: true,
17         filter_order_id: "filter_order_id",
18         filter_task_group_id: "filter_task_group_id",
19         filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
20         filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
21         filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
22         filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
23     });
24 }
25 main();

1 {
2   "items": [
3     {
4       "_id": "_id",
5       "created_at_timestamp": "2024-01-15T09:30:00Z",
6       "created_by_user_id": "created_by_user_id",
7       "currency_code": "USD",
8       "description": "description",
9       "invoice_type": "accounts_receivable",
10       "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
11       "last_edited_by_user_id": "last_edited_by_user_id",
12       "line_item_type": "base_rate",
13       "owned_by_org_id": "owned_by_org_id",
14       "quantity": 1.1,
15       "schema_version": 1,
16       "unit_price": 1.1,
17       "counterparty_off_chrt_org_data_id": "counterparty_off_chrt_org_data_id",
18       "counterparty_org_id": "counterparty_org_id",
19       "export_ref__sage__item_id": "export_ref__sage__item_id",
20       "invoice_id": "invoice_id",
21       "order_id": "order_id",
22       "rate_sheet_id": "rate_sheet_id",
23       "shipper_account_id": "shipper_account_id",
24       "status": "draft",
25       "task_group_id": "task_group_id",
26       "tax_percentage": 1.1,
27       "unit": "each"
28     }
29   ],
30   "total_count": 1
31 }

Lists owner-scoped invoice line items with filtering, sorting, and pagination. | 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_typesenumOptional

Filter by one or more invoice types.

Allowed values:

filter_currency_codesenumOptional

Filter by one or more currency codes.

filter_line_item_typesenumOptional

Filter by one or more line item types.

filter_unitsenumOptional

Filter by one or more units.

filter_counterparty_org_idstringOptional

Filter by an on-CHRT counterparty organization.

filter_counterparty_off_chrt_org_data_idstringOptional

Filter by off-CHRT counterparty organization data.

filter_shipper_account_idstringOptional

Filter by an associated shipper account.

filter_invoice_idstringOptional

Filter by an attached invoice.

filter_is_invoicedbooleanOptional

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

filter_order_idstringOptional

Filter by an attributed order.

filter_task_group_idstringOptional

Filter by an attributed task group.

filter_created_at_timestamp_gtedatetimeOptional

Filter by created_at_timestamp greater than or equal.

filter_created_at_timestamp_ltedatetimeOptional

Filter by created_at_timestamp less than or equal.

filter_last_edited_at_timestamp_gtedatetimeOptional

Filter by last_edited_at_timestamp greater than or equal.

filter_last_edited_at_timestamp_ltedatetimeOptional

Filter by last_edited_at_timestamp less than or equal.

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Invoice Line Items List V1request Unprocessable Entity Error