Update | Chrt

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.billing.rateSheets.updateV1("rate_sheet_id", {});
}
main();

{
  "schema_version": 1,
  "service_type": "on_demand",
  "owned_by_org_id": "org_9f8e7d6c5b4a3",
  "owned_by_org_type": "courier",
  "payment_vector_type": "shipper_pay_forwarder",
  "_id": "rate_sheet_1234567890abcdef",
  "archived": false,
  "name": "Standard Delivery Rate Sheet",
  "comments": "Updated rates for Q2 2024 reflecting fuel cost adjustments.",
  "cargo_types": [
    "spare_parts",
    "medical_supplies",
    "pharmaceuticals"
  ],
  "vehicle_types": [
    "sedan",
    "cargo_van",
    "box_truck"
  ],
  "base_mileage_distance_miles": 5,
  "base_mileage_rate_usd_per_instance": 25,
  "additional_mileage_rate_usd_per_mile": 2.5,
  "long_distance_surcharge_miles_before_surcharge": 100,
  "long_distance_surcharge_rate_usd_per_mile": 1.5,
  "fuel_surcharge_rate_usd_per_mile": 0.75,
  "wait_time_before_charge_minutes": 10,
  "wait_time_rate_usd_per_minute": 1,
  "extra_stop_rate_usd": 15,
  "dangerous_goods_rate_usd_per_instance": 50,
  "after_hours_rate_usd_per_instance": 30,
  "weekend_rate_usd_per_instance": 40,
  "holiday_rate_usd_per_instance": 60
}

Updates a rate sheet. Only name, comments, cargo_types, and vehicle_types can be changed. Use the archive endpoint for archiving. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | (RateSheetClientUpdate1) -> (RateSheet1)

Authentication

AuthorizationBearer

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

Path parameters

rate_sheet_idstringRequired

Request

This endpoint expects an object.

namestringOptional

commentsstringOptional

cargo_typeslist of enumsOptional

vehicle_typeslist of enumsOptional

Response

Successful Response

schema_versioninteger

service_typeenum

Allowed values:

owned_by_org_idstring

Must be a string starting with org_

owned_by_org_typeenum

Allowed values:

payment_vector_typeenum

Allowed values:

_idstring

archivedboolean or nullDefaults to false

namestring or null

commentsstring or null

cargo_typeslist of enums or null

vehicle_typeslist of enums or null

base_mileage_distance_milesdouble or null

base_mileage_rate_usd_per_instancedouble or null

additional_mileage_rate_usd_per_miledouble or null

applies only to the additional/incremental miles

long_distance_surcharge_miles_before_surchargedouble or null

long_distance_surcharge_rate_usd_per_miledouble or null

applies only to the additional/incremental miles

fuel_surcharge_rate_usd_per_miledouble or null

wait_time_before_charge_minutesdouble or null

wait_time_rate_usd_per_minutedouble or null

extra_stop_rate_usddouble or null

dangerous_goods_rate_usd_per_instancedouble or null

after_hours_rate_usd_per_instancedouble or null

weekend_rate_usd_per_instancedouble or null

holiday_rate_usd_per_instancedouble or null

Authentication

Path parameters

Request

Response

Errors