Get by ID

GET

/billing_new/chrt_ground_provider_rates/get/v1/:rate_id

GET

/billing_new/chrt_ground_provider_rates/get/v1/:rate_id

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.getV1("rate_id");
8 }
9 main();

1 {
2   "_id": "rate_9876543210",
3   "created_at_timestamp": "2024-01-15T09:30:00Z",
4   "currency_code": "USD",
5   "invoice_type": "accounts_receivable",
6   "owned_by_org_id": "org_provider123",
7   "schema_version": 1,
8   "updated_at_timestamp": "2024-04-10T15:45:00Z",
9   "additional_mileage": {
10     "ends_at_total_distance_miles": 150,
11     "rate_per_mile": 0.75,
12     "starts_at_total_distance_miles": 100,
13     "sage_item_id": "sage_amd_2024"
14   },
15   "after_hours": {
16     "rate_per_instance": 50,
17     "sage_item_id": "sage_ah_2024"
18   },
19   "archived": false,
20   "attempt": {
21     "rate_per_instance": 20,
22     "sage_item_id": "sage_attempt_2024"
23   },
24   "base_mileage": {
25     "included_distance_miles": 50,
26     "rate_per_instance": 100,
27     "sage_item_id": "sage_bm_2024"
28   },
29   "cargo_types": [
30     "medical_supplies",
31     "pharmaceuticals"
32   ],
33   "comments": "Standard ground provider rate for medical shipments within the northeast region.",
34   "counterparty_driver_ids": [
35     "driver_12345",
36     "driver_67890"
37   ],
38   "counterparty_off_chrt_org_data_id": "offchrt_54321",
39   "counterparty_org_id": "org_abc123xyz",
40   "dangerous_goods": {
41     "rate_per_instance": 75,
42     "sage_item_id": "sage_dg_2024"
43   },
44   "extra_stop": {
45     "rate_per_instance": 30,
46     "sage_item_id": "sage_es_2024"
47   },
48   "flat_fee": {
49     "rate_per_instance": 150,
50     "sage_item_id": "sage_ff_2024"
51   },
52   "from_payables": {
53     "combine": false,
54     "margin": 0.15,
55     "markup": 0.1,
56     "sage_item_id": "sage_fp_2024"
57   },
58   "fuel_surcharge": {
59     "rate_per_mile": 0.12,
60     "sage_item_id": "sage_fs_2024"
61   },
62   "holiday": {
63     "rate_per_instance": 100,
64     "sage_item_id": "sage_hol_2024"
65   },
66   "long_distance_surcharge": {
67     "rate_per_mile": 0.5,
68     "starts_at_total_distance_miles": 200,
69     "sage_item_id": "sage_lds_2024"
70   },
71   "name": "Northeast Medical Ground Provider Rate",
72   "pick_and_hold": {
73     "rate_per_instance": 40,
74     "sage_item_id": "sage_pah_2024"
75   },
76   "service_line": "on_demand",
77   "shipper_account_id": "shipper_78910",
78   "tax_1": {
79     "name": "State Tax",
80     "percentage": 7.25,
81     "note": "Applicable state sales tax",
82     "sage_item_id": "sage_tax1_2024"
83   },
84   "tax_2": {
85     "name": "County Tax",
86     "percentage": 1.5,
87     "note": "County level tax",
88     "sage_item_id": "sage_tax2_2024"
89   },
90   "tax_3": {
91     "name": "City Tax",
92     "percentage": 0.75,
93     "note": "City municipal tax",
94     "sage_item_id": "sage_tax3_2024"
95   },
96   "vehicle_types": [
97     "cargo_van",
98     "box_truck"
99   ],
100   "wait_time": {
101     "included_minutes": 15,
102     "rate_per_minute": 2,
103     "sage_item_id": "sage_wt_2024"
104   },
105   "weekend": {
106     "rate_per_instance": 60,
107     "sage_item_id": "sage_wknd_2024"
108   }
109 }

Retrieves owner-scoped ground-provider rates. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (ChrtGroundProviderRates1)

Authentication

AuthorizationBearer

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

Path parameters

rate_idstringRequired

Response

Successful Response

_idstring

created_at_timestampdatetime

currency_codeenum

invoice_typeenum

owned_by_org_idstring

Must be a string starting with org_

schema_versioninteger

updated_at_timestampdatetime

additional_mileageobjectOptional

after_hoursobjectOptional

archivedbooleanOptionalDefaults to false

attemptobjectOptional

base_mileageobjectOptional

cargo_typeslist of enumsOptional

commentsstringOptional<=524288 characters

counterparty_driver_idslist of stringsOptional

counterparty_off_chrt_org_data_idstringOptional

counterparty_org_idstringOptional

Must be a string starting with org_

dangerous_goodsobjectOptional

extra_stopobjectOptional

flat_feeobjectOptional

from_payablesobjectOptional

fuel_surchargeobjectOptional

holidayobjectOptional

long_distance_surchargeobjectOptional

namestringOptional

pick_and_holdobjectOptional

service_lineenumOptional

shipper_account_idstringOptional

tax_1objectOptional

tax_2objectOptional

tax_3objectOptional

vehicle_typeslist of enumsOptional

wait_timeobjectOptional

weekendobjectOptional

Errors

422

Chrt Ground Provider Rates Get V1request Unprocessable Entity Error