Get ChrtGroundProvider rate sheet by ID

GET

/billing/chrt_ground_provider_rate_sheets/by_id/v1/:id

GET

/billing/chrt_ground_provider_rate_sheets/by_id/v1/: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.billing.chrtGroundProviderRateSheets.getByIdV1("id");
8 }
9 main();

1 {
2   "schema_version": 1,
3   "_id": "rate_sheet_9f8e7d6c5b4a3",
4   "owned_by_org_id": "org_1234567890abcdef",
5   "archived": true,
6   "name": "Standard Ground Provider Rate Sheet",
7   "comments": "This rate sheet applies to all standard ground shipments handled by our organization.",
8   "cargo_types": [
9     "spare_parts",
10     "medical_supplies",
11     "electronics"
12   ],
13   "vehicle_types": [
14     "sedan",
15     "cargo_van",
16     "box_truck"
17   ],
18   "base_mileage_distance_miles": 10,
19   "base_mileage_rate_usd_per_instance": 50,
20   "additional_mileage_rate_usd_per_mile": 2.5,
21   "long_distance_surcharge_miles_before_surcharge": 100,
22   "long_distance_surcharge_rate_usd_per_mile": 3,
23   "fuel_surcharge_rate_usd_per_mile": 0.5,
24   "wait_time_before_charge_minutes": 15,
25   "wait_time_rate_usd_per_minute": 1,
26   "extra_stop_rate_usd": 20,
27   "attempt_rate_usd_per_instance": 30,
28   "pick_and_hold_rate_usd_per_instance": 40,
29   "dangerous_goods_rate_usd_per_instance": 75,
30   "after_hours_rate_usd_per_instance": 60,
31   "weekend_rate_usd_per_instance": 80,
32   "holiday_rate_usd_per_instance": 100
33 }

Retrieves a specific ChrtGroundProvider rate sheet owned by the caller’s organization. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (ChrtGroundProviderRateSheet1)

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

Successful Response

schema_versioninteger

_idstring

owned_by_org_idstring

Must be a string starting with org_

archivedbooleanDefaults to false

namestring

commentsstring<=524288 characters

cargo_typeslist of enums

vehicle_typeslist of enums

base_mileage_distance_milesdouble

base_mileage_rate_usd_per_instancedouble

additional_mileage_rate_usd_per_miledouble

applies only to the additional/incremental miles

long_distance_surcharge_miles_before_surchargedouble

long_distance_surcharge_rate_usd_per_miledouble

applies only to the additional/incremental miles

fuel_surcharge_rate_usd_per_miledouble

wait_time_before_charge_minutesdouble

wait_time_rate_usd_per_minutedouble

extra_stop_rate_usddouble

attempt_rate_usd_per_instancedouble

pick_and_hold_rate_usd_per_instancedouble

dangerous_goods_rate_usd_per_instancedouble

after_hours_rate_usd_per_instancedouble

weekend_rate_usd_per_instancedouble

holiday_rate_usd_per_instancedouble

Errors

422

Chrt Ground Provider Rate Sheets Get by ID V1request Unprocessable Entity Error