List by org

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

{
  "rate_sheets": [
    {
      "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": "rs_1234567890abcdef",
      "archived": false,
      "name": "Standard Courier Rate Sheet",
      "comments": "Applicable for all on-demand shipments within city limits.",
      "cargo_types": [
        "spare_parts",
        "electronics",
        "medical_supplies"
      ],
      "vehicle_types": [
        "sedan",
        "cargo_van"
      ],
      "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": 50,
      "long_distance_surcharge_rate_usd_per_mile": 3,
      "fuel_surcharge_rate_usd_per_mile": 0.5,
      "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
    }
  ],
  "total_count": 1
}

Lists rate sheets for the caller’s organization with filtering, sorting, and pagination. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (RateSheetListResponse)

Authentication

AuthorizationBearer

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

Query parameters

sort_byenum or nullOptional

Sortable fields for rate sheet list.

Allowed values:

sort_orderenumOptionalDefaults to descending

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

filter_archivedboolean or nullOptional

filter_payment_vector_typeenum or nullOptional

Allowed values:

filter_service_typeenum or nullOptional

Filter by service type (exact match)

Allowed values:

filter_cargo_typeenum or nullOptional

Filter by cargo type (checks if value is in cargo_types array)

filter_vehicle_typeenum or nullOptional

Filter by vehicle type (checks if value is in vehicle_types array)

Response

Successful Response

rate_sheetslist of objects

total_countinteger

Authentication

Query parameters

Response

Errors