List expanded

POST

/billing/statements/expanded/list/v1

POST

/billing/statements/expanded/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.statements.expandedListV1({
8         sort_by: "amount",
9         sort_order: "asc",
10         page: 1,
11         page_size: 1,
12         filter_settlement_type: "stripe_connect",
13         filter_order_id: "filter_order_id",
14         filter_order_short_id: "filter_order_short_id",
15         filter_order_off_chrt_reference_id: "filter_order_off_chrt_reference_id",
16         filter_payment_origin_org_id: "filter_payment_origin_org_id",
17         filter_payment_origin_off_chrt_shipper_org_id: "filter_payment_origin_off_chrt_shipper_org_id",
18         filter_payment_destination_org_id: "filter_payment_destination_org_id",
19         filter_owned_by_org_id: "filter_owned_by_org_id",
20         filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
21         filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
22         filter_opened_at_timestamp_gte: "2024-01-15T09:30:00Z",
23         filter_opened_at_timestamp_lte: "2024-01-15T09:30:00Z",
24         filter_paid_at_timestamp_gte: "2024-01-15T09:30:00Z",
25         filter_paid_at_timestamp_lte: "2024-01-15T09:30:00Z",
26         filter_uncollectible_at_timestamp_gte: "2024-01-15T09:30:00Z",
27         filter_uncollectible_at_timestamp_lte: "2024-01-15T09:30:00Z",
28     });
29 }
30 main();

1 {
2   "items": [
3     {
4       "statement": {
5         "schema_version": 1,
6         "_id": "stmt_8f3b2c9d4a7e",
7         "settlement_type": "stripe_connect",
8         "owned_by_org_id": "org_9a7b6c5d4e3f",
9         "payment_vector_type": "shipper_pay_forwarder",
10         "line_item_group_ids": [
11           "lig_123abc456def"
12         ],
13         "order_ids": [
14           "order_789xyz123abc"
15         ],
16         "order_short_ids": [
17           "ORD12345"
18         ],
19         "order_off_chrt_reference_ids": [
20           "ref_2024_04_20"
21         ],
22         "amount": 125000,
23         "units": "usd_cents",
24         "staged_by_user_id": "user_42f7a9c8d1e2",
25         "payment_origin_org_id": "org_1a2b3c4d5e6f",
26         "payment_origin_off_chrt_shipper_org_id": "offchrt_shipper_001",
27         "payment_destination_org_id": "org_7f8e9d0c1b2a",
28         "payment_destination_driver_id": "driver_5d4c3b2a1f0e",
29         "status": "open",
30         "stripe_invoice_id": "in_1GqIC8Lz0qyl6XeW",
31         "stripe_invoice_url": "https://dashboard.stripe.com/invoices/in_1GqIC8Lz0qyl6XeW",
32         "stripe_invoice_created_by_user_id": "user_42f7a9c8d1e2",
33         "stripe_invoice_status": "open",
34         "staged_at_timestamp": "2024-04-15T08:00:00Z",
35         "opened_at_timestamp": "2024-04-16T09:00:00Z",
36         "marked_open_by_user_id": "user_42f7a9c8d1e2"
37       },
38       "line_item_groups": [
39         {
40           "schema_version": 1,
41           "_id": "lig_123abc456def",
42           "line_items": [
43             {
44               "item": "base_rate",
45               "quantity": 1.1,
46               "rate": 1500,
47               "amount": 1650,
48               "schema_version": 1,
49               "units": "usd",
50               "comments": "Base rate for ground courier service",
51               "created_at_timestamp": "2024-04-14T07:45:00Z",
52               "uuid_str": "uuid-1234-5678-9012"
53             }
54           ],
55           "owned_by_org_id": "org_9a7b6c5d4e3f",
56           "payment_vector_type": "shipper_pay_forwarder",
57           "settlement_type": "stripe_connect",
58           "is_ad_hoc": false,
59           "task_group_id": "tg_789xyz123abc",
60           "order_id": "order_789xyz123abc",
61           "order_short_id": "ORD12345",
62           "order_off_chrt_reference_id": "ref_2024_04_20",
63           "rate_sheet_id": "rs_456def789abc",
64           "line_item_group_s3_object_metadata_ids": [
65             "s3meta_001"
66           ],
67           "statement_id": "stmt_8f3b2c9d4a7e",
68           "payment_origin_org_id": "org_1a2b3c4d5e6f",
69           "payment_origin_off_chrt_shipper_org_id": "offchrt_shipper_001",
70           "payment_destination_org_id": "org_7f8e9d0c1b2a",
71           "payment_destination_driver_id": "driver_5d4c3b2a1f0e",
72           "status": "finalized",
73           "messages": [
74             {
75               "message": "Reviewed and approved by billing team.",
76               "user_id": "user_42f7a9c8d1e2",
77               "org_id": "org_9a7b6c5d4e3f",
78               "timestamp": "2024-04-15T10:00:00Z"
79             }
80           ]
81         }
82       ],
83       "task_groups": [
84         {
85           "schema_version": 1,
86           "_id": "tg_789xyz123abc",
87           "order_id": "order_789xyz123abc",
88           "order_short_id": "ORD12345",
89           "created_by_org_id": "org_9a7b6c5d4e3f",
90           "created_by_user_id": "user_42f7a9c8d1e2",
91           "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
92           "task_group_type": "chrt_ground_courier",
93           "order_off_chrt_reference_id": "ref_2024_04_20",
94           "task_ids": [
95             "task_001",
96             "task_002"
97           ],
98           "courier_org_id": "org_3c4d5e6f7a8b",
99           "forwarder_org_id": "org_1a2b3c4d5e6f",
100           "shipper_org_id": "org_7f8e9d0c1b2a",
101           "off_chrt_shipper_org_id": "offchrt_shipper_001",
102           "driver_id": "driver_5d4c3b2a1f0e",
103           "service_type": "on_demand",
104           "task_group_s3_object_metadata_ids": [
105             "s3meta_task_001"
106           ],
107           "status": "in_progress",
108           "staged_at_timestamp": "2024-04-14T08:00:00Z",
109           "in_progress_at_timestamp": "2024-04-15T09:00:00Z",
110           "order_cancelled": false,
111           "tasks_mileage": 12.5,
112           "fa_flight_ids": [],
113           "messages": [
114             {
115               "message": "Task group started and assigned to courier.",
116               "user_id": "user_42f7a9c8d1e2",
117               "org_id": "org_9a7b6c5d4e3f",
118               "timestamp": "2024-04-14T08:15:00Z"
119             }
120           ],
121           "shipper_pay_forwarder_rate_sheet_id": "rs_456def789abc",
122           "shipper_pay_forwarder_line_item_group_id": "lig_123abc456def"
123         }
124       ]
125     }
126   ],
127   "total_count": 1
128 }

Lists statements with expanded LIGs and task groups, using filtering, sorting, and pagination. | authz_personas=[statement_org_operators, statement_driver] | () -> (StatementsExpandedListRes)

Authentication

AuthorizationBearer

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

Query parameters

sort_byenumOptional

Field to sort by

Allowed values:

sort_orderenumOptional

Sort order (ascending or descending)

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

filter_statusenumOptional

Filter by statement status(es)

Allowed values:

filter_settlement_typeenumOptional

Filter by settlement type

Allowed values:

filter_order_idstringOptionalDeprecated

[DEPRECATED — use filter_order_short_id] Filter by order ID (returns statements whose order_ids list contains this value)

filter_order_short_idstringOptional

Filter by order short ID (returns statements whose order_short_ids list contains this value)

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

Filter by order off-chrt reference ID (returns statements whose order_off_chrt_reference_ids list contains this value)

filter_payment_origin_org_idstringOptional

Filter by payment origin org ID

filter_payment_origin_off_chrt_shipper_org_idstringOptional

Filter by payment origin off-chrt shipper org ID

filter_payment_destination_org_idstringOptional

Filter by payment destination org ID

filter_owned_by_org_idstringOptional

Filter by owned by org ID

filter_staged_at_timestamp_gtedatetimeOptional

Filter by staged_at_timestamp >= value

filter_staged_at_timestamp_ltedatetimeOptional

Filter by staged_at_timestamp <= value

filter_opened_at_timestamp_gtedatetimeOptional

Filter by opened_at_timestamp >= value

filter_opened_at_timestamp_ltedatetimeOptional

Filter by opened_at_timestamp <= value

filter_paid_at_timestamp_gtedatetimeOptional

Filter by paid_at_timestamp >= value

filter_paid_at_timestamp_ltedatetimeOptional

Filter by paid_at_timestamp <= value

filter_uncollectible_at_timestamp_gtedatetimeOptional

Filter by uncollectible_at_timestamp >= value

filter_uncollectible_at_timestamp_ltedatetimeOptional

Filter by uncollectible_at_timestamp <= value

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Statements Expanded List V1request Unprocessable Entity Error