List

GET

/billing_new/chrt_ground_provider_rates/list/v1

GET

/billing_new/chrt_ground_provider_rates/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.chrtGroundProviderRates.listV1({
8         filter_cargo_types: [
9             "spare_parts",
10         ],
11         filter_counterparty_driver_id: "filter_counterparty_driver_id",
12         filter_counterparty_off_chrt_org_data_id: "filter_counterparty_off_chrt_org_data_id",
13         filter_counterparty_org_id: "filter_counterparty_org_id",
14         filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
15         filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
16         filter_currency_codes: [
17             "USD",
18         ],
19         filter_invoice_types: [
20             "accounts_receivable",
21         ],
22         filter_service_line: [
23             "on_demand",
24         ],
25         filter_shipper_account_id: "filter_shipper_account_id",
26         filter_updated_at_timestamp_gte: "2024-01-15T09:30:00Z",
27         filter_updated_at_timestamp_lte: "2024-01-15T09:30:00Z",
28         filter_vehicle_types: [
29             "sedan",
30         ],
31         page: 1,
32         page_size: 1,
33         search: "search",
34         sort_by: "name",
35         sort_order: "asc",
36     });
37 }
38 main();

1 {
2   "items": [
3     {
4       "_id": "rate_9876543210",
5       "created_at_timestamp": "2024-01-15T09:30:00Z",
6       "currency_code": "USD",
7       "invoice_type": "accounts_receivable",
8       "owned_by_org_id": "org_123456",
9       "schema_version": 1,
10       "updated_at_timestamp": "2024-04-10T14:45:00Z",
11       "additional_mileage": {
12         "ends_at_total_distance_miles": 150,
13         "rate_per_mile": 0.75,
14         "starts_at_total_distance_miles": 50,
15         "sage_item_id": "sage_amd_001"
16       },
17       "after_hours": {
18         "rate_per_instance": 25,
19         "sage_item_id": "sage_ah_002"
20       },
21       "archived": true,
22       "attempt": {
23         "rate_per_instance": 15,
24         "sage_item_id": "sage_attempt_003"
25       },
26       "base_mileage": {
27         "included_distance_miles": 30,
28         "rate_per_instance": 100,
29         "sage_item_id": "sage_bm_004"
30       },
31       "cargo_types": [
32         "spare_parts"
33       ],
34       "comments": "Standard rate for spare parts delivery within the region.",
35       "counterparty_driver_ids": [
36         "driver_12345"
37       ],
38       "counterparty_off_chrt_org_data_id": "offchrt_org_7890",
39       "counterparty_org_id": "org_456789",
40       "dangerous_goods": {
41         "rate_per_instance": 50,
42         "sage_item_id": "sage_dg_005"
43       },
44       "extra_stop": {
45         "rate_per_instance": 20,
46         "sage_item_id": "sage_es_006"
47       },
48       "flat_fee": {
49         "rate_per_instance": 150,
50         "sage_item_id": "sage_ff_007"
51       },
52       "fuel_surcharge": {
53         "rate_per_mile": 0.1,
54         "sage_item_id": "sage_fs_008"
55       },
56       "holiday": {
57         "rate_per_instance": 40,
58         "sage_item_id": "sage_hol_009"
59       },
60       "long_distance_surcharge": {
61         "rate_per_mile": 0.5,
62         "starts_at_total_distance_miles": 200,
63         "sage_item_id": "sage_lds_010"
64       },
65       "name": "Spare Parts Regional Rate",
66       "pick_and_hold": {
67         "rate_per_instance": 30,
68         "sage_item_id": "sage_pah_011"
69       },
70       "service_line": "on_demand",
71       "shipper_account_id": "shipper_7890",
72       "tax_1": {
73         "name": "State Tax",
74         "percentage": 7.5,
75         "note": "Applicable state sales tax",
76         "sage_item_id": "sage_tax1_012"
77       },
78       "tax_2": {
79         "name": "County Tax",
80         "percentage": 2,
81         "note": "County level tax",
82         "sage_item_id": "sage_tax2_013"
83       },
84       "tax_3": {
85         "name": "Environmental Fee",
86         "percentage": 0.5,
87         "note": "Environmental surcharge fee",
88         "sage_item_id": "sage_tax3_014"
89       },
90       "vehicle_types": [
91         "cargo_van"
92       ],
93       "wait_time": {
94         "included_minutes": 15,
95         "rate_per_minute": 2,
96         "sage_item_id": "sage_wt_015"
97       },
98       "weekend": {
99         "rate_per_instance": 35,
100         "sage_item_id": "sage_we_016"
101       }
102     }
103   ],
104   "total_count": 1
105 }

Lists owner-scoped ground-provider rates with counterparty, cargo, vehicle, currency, search, sort, and pagination controls. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (ChrtGroundProviderRatesListRes)

Authentication

AuthorizationBearer

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

Query parameters

searchstringOptional

Search rate names and comments.

sort_byenumOptional

Field to sort by.

Allowed values:

sort_orderenumOptional

Sort order.

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

filter_service_lineenumOptional

Filter by one or more service lines.

Allowed values:

filter_invoice_typesenumOptional

Filter by one or more invoice types.

Allowed values:

filter_currency_codesenumOptional

Filter by one or more currency codes.

filter_counterparty_org_idstringOptional

Filter by an associated on-CHRT organization.

filter_counterparty_off_chrt_org_data_idstringOptional

Filter by associated off-CHRT organization data.

filter_shipper_account_idstringOptional

Filter by an associated shipper account.

filter_counterparty_driver_idstringOptional

Filter by an associated driver.

filter_cargo_typesenumOptional

Filter by one or more cargo types.

filter_vehicle_typesenumOptional

Filter by one or more vehicle types.

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_updated_at_timestamp_gtedatetimeOptional

Filter by updated_at_timestamp greater than or equal.

filter_updated_at_timestamp_ltedatetimeOptional

Filter by updated_at_timestamp less than or equal.

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Chrt Ground Provider Rates List V1request Unprocessable Entity Error