List billing orders

POST

/billing_new/orders/expanded/list/for_coordinator_operators/v1

POST

/billing_new/orders/expanded/list/for_coordinator_operators/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.orders.listExpandedForCoordinatorOperatorsV1({
8         filter_awb_number: "filter_awb_number",
9         filter_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
10         filter_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
11         filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
12         filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
13         filter_coordinator_label: "filter_coordinator_label",
14         filter_coordinator_shipper_account_ids: [
15             "filter_coordinator_shipper_account_ids",
16         ],
17         filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
18         filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
19         filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
20         filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
21         filter_executor_org_id: "filter_executor_org_id",
22         filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
23         filter_in_progress_at_timestamp_lte: "2024-01-15T09:30:00Z",
24         filter_off_chrt_shipper_org_data_id: "filter_off_chrt_shipper_org_data_id",
25         filter_shipper_org_id: "filter_shipper_org_id",
26         filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
27         filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
28         filter_status: [
29             "draft",
30         ],
31         page: 1,
32         page_size: 1,
33         search: "search",
34         sort_by: "draft_started_at_timestamp",
35         sort_order: "asc",
36     });
37 }
38 main();

1 {
2   "items": [
3     {
4       "includes_air_waybill_invoice_line_item": true,
5       "invoice_count": 3,
6       "invoice_line_item_count": 15,
7       "order_id": "ord_20240615_12345",
8       "order_short_id": "NW-12345",
9       "order_status": "in_progress",
10       "accounts": [
11         {
12           "account_id": "acc_987654321"
13         }
14       ],
15       "awb_numbers": [
16         "123-45678901"
17       ],
18       "coordinator_label": "Northwest Logistics Team",
19       "executors": [
20         {
21           "task_group_id": "tg_20240615_001"
22         }
23       ],
24       "invoice_statuses": [
25         "approved"
26       ],
27       "totals_by_currency": [
28         {
29           "accounts_payable_total_amount": 12500.75,
30           "accounts_receivable_total_amount": 13000,
31           "currency_code": "USD"
32         }
33       ]
34     }
35   ],
36   "total_count": 1
37 }

Lists coordinator orders with billing summaries and optional party-name expansion. | authz: allowed_org_types=[provider], min_org_role=operator | (OrderBillingExpandedListReq) -> (OrderBillingExpandedListRes)

Authentication

AuthorizationBearer

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

Query parameters

sort_byenumOptional

Order lifecycle timestamp used for sorting.

sort_orderenumOptional

Sort order (asc or desc).

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

searchstringOptional

Full-text search query for order short ID, off-CHRT reference ID, and AWB.

filter_statusenumOptional

Filter by one or more order statuses.

filter_awb_numberstringOptionalformat: "^\d{3}-\d{8}$"

Filter by an exact order AWB number.

filter_shipper_org_idstringOptional

Filter by an on-CHRT shipper organization.

filter_off_chrt_shipper_org_data_idstringOptional

Filter by an off-CHRT shipper.

filter_coordinator_shipper_account_idsstringOptional

Filter by one or more coordinator shipper accounts.

filter_executor_org_idstringOptional

Filter by an on-CHRT executor organization.

filter_coordinator_labelstringOptional

Filter by an exact coordinator label.

filter_draft_started_at_timestamp_gtedatetimeOptional

filter_draft_started_at_timestamp_ltedatetimeOptional

filter_staged_at_timestamp_gtedatetimeOptional

filter_staged_at_timestamp_ltedatetimeOptional

filter_in_progress_at_timestamp_gtedatetimeOptional

filter_in_progress_at_timestamp_ltedatetimeOptional

filter_completed_at_timestamp_gtedatetimeOptional

filter_completed_at_timestamp_ltedatetimeOptional

filter_cancelled_at_timestamp_gtedatetimeOptional

filter_cancelled_at_timestamp_ltedatetimeOptional

filter_exception_at_timestamp_gtedatetimeOptional

filter_exception_at_timestamp_ltedatetimeOptional

Request

This endpoint expects an object.

expand_account_namesbooleanOptionalDefaults to false

expand_executor_namesbooleanOptionalDefaults to false

expand_shipper_namebooleanOptionalDefaults to false

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Orders List Expanded for Coordinator Operators V1request Unprocessable Entity Error