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_789xyz123",
  "owned_by_org_type": "courier",
  "payment_vector_type": "shipper_pay_forwarder",
  "_id": "rate_sheet_456abc789",
  "archived": true,
  "name": "Express Delivery Rate Sheet",
  "comments": "Updated rates for express courier services effective Q3 2024.",
  "cargo_types": [
    "spare_parts"
  ],
  "vehicle_types": [
    "sedan"
  ],
  "base_mileage_distance_miles": 5,
  "base_mileage_rate_usd_per_instance": 15.75,
  "additional_mileage_rate_usd_per_mile": 2.5,
  "long_distance_surcharge_miles_before_surcharge": 100,
  "long_distance_surcharge_rate_usd_per_mile": 1.75,
  "fuel_surcharge_rate_usd_per_mile": 0.3,
  "wait_time_before_charge_minutes": 10,
  "wait_time_rate_usd_per_minute": 0.75,
  "extra_stop_rate_usd": 20,
  "dangerous_goods_rate_usd_per_instance": 50,
  "after_hours_rate_usd_per_instance": 25,
  "weekend_rate_usd_per_instance": 30,
  "holiday_rate_usd_per_instance": 40
}

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

name__set_to_NonebooleanOptionalDefaults to false

comments__set_to_NonebooleanOptionalDefaults to false

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

archivedbooleanDefaults to false

namestring

commentsstring

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

dangerous_goods_rate_usd_per_instancedouble

after_hours_rate_usd_per_instancedouble

weekend_rate_usd_per_instancedouble

holiday_rate_usd_per_instancedouble

Errors

422

Rate Sheets Update V1request Unprocessable Entity Error