List

GET

/billing/line_item_groups/list/v1

GET

/billing/line_item_groups/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.billing.lineItemGroups.listV1({
8         sort_order: "asc",
9         page: 1,
10         page_size: 1,
11         filter_task_group_id: "filter_task_group_id",
12         filter_order_id: "filter_order_id",
13         filter_order_short_id: "filter_order_short_id",
14         filter_order_off_chrt_reference_id: "filter_order_off_chrt_reference_id",
15         filter_owned_by_org_id: "filter_owned_by_org_id",
16         filter_payment_origin_org_id: "filter_payment_origin_org_id",
17         filter_payment_destination_org_id: "filter_payment_destination_org_id",
18         filter_payment_destination_driver_id: "filter_payment_destination_driver_id",
19         filter_rate_sheet_id: "filter_rate_sheet_id",
20         filter_statement_id: "filter_statement_id",
21         filter_attached_to_statement: true,
22     });
23 }
24 main();

1 {
2   "items": [
3     {
4       "schema_version": 1,
5       "_id": "_id",
6       "owned_by_org_id": "owned_by_org_id",
7       "task_group_id": "task_group_id",
8       "order_id": "order_id",
9       "order_short_id": "order_short_id",
10       "order_off_chrt_reference_id": "order_off_chrt_reference_id",
11       "rate_sheet_id": "rate_sheet_id",
12       "agreement_line_item_ids": [
13         "agreement_line_item_ids"
14       ],
15       "agreement_amount": 1.1,
16       "amendment_line_item_ids": [
17         "amendment_line_item_ids"
18       ],
19       "amendment_amount": 1.1,
20       "pending_line_item_ids": [
21         "pending_line_item_ids"
22       ],
23       "pending_amount": 1.1,
24       "denied_line_item_ids": [
25         "denied_line_item_ids"
26       ],
27       "denied_amount": 1.1,
28       "line_item_group_s3_object_metadata_ids": [
29         "line_item_group_s3_object_metadata_ids"
30       ],
31       "statement_id": "statement_id",
32       "settlement_type": "stripe_connect",
33       "payment_origin_org_id": "payment_origin_org_id",
34       "payment_origin_off_chrt_shipper_org_id": "payment_origin_off_chrt_shipper_org_id",
35       "payment_destination_org_id": "payment_destination_org_id",
36       "payment_destination_off_chrt_provider_org_id": "payment_destination_off_chrt_provider_org_id",
37       "payment_destination_driver_id": "payment_destination_driver_id",
38       "status": "staged",
39       "finalized_at_timestamp": "2024-01-15T09:30:00Z",
40       "finalized_by_user_id": "finalized_by_user_id",
41       "messages": [
42         {
43           "message": "message",
44           "user_id": "user_id",
45           "org_id": "org_id",
46           "timestamp": "2024-01-15T09:30:00Z"
47         }
48       ]
49     }
50   ],
51   "total_count": 1
52 }

Lists LineItemGroups the caller owns, is a payment counterparty on, or is the destination driver for. | authz_personas=[lig_org_operators, lig_driver] | () -> (LineItemGroupListRes)

Authentication

AuthorizationBearer

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

Query parameters

sort_orderenumOptional

Sort order on _id (proxy for creation order; LIGs have no user-facing timestamps to sort by).

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

filter_statusenumOptional

Filter by LineItemGroup status(es). Multi-select.

Allowed values:

filter_task_group_idstringOptional

Filter by parent task group id.

filter_order_idstringOptional

Filter by parent order id.

filter_order_short_idstringOptional

Filter by order short id.

filter_order_off_chrt_reference_idstringOptionalformat: "^[A-Za-z0-9._~\-]{1,64}$"1-64 characters

Filter by order off-chrt reference id.

filter_owned_by_org_idstringOptional

Filter by owner org id.

filter_payment_origin_org_idstringOptional

Filter by payment origin org id.

filter_payment_destination_org_idstringOptional

Filter by payment destination org id.

filter_payment_destination_driver_idstringOptional

Filter by payment destination driver id.

filter_rate_sheet_idstringOptional

Filter by source rate sheet id (None for ad-hoc/pro-forma LIGs).

filter_statement_idstringOptional

Filter to LineItemGroups bundled into this statement.

filter_attached_to_statementbooleanOptional

Filter by whether the LineItemGroup is bundled into a statement (statement_id is not None if true, is None if false). Used by the statement-bundling worklist to find unbundled LIGs.

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Line Item Groups List V1request Unprocessable Entity Error