Create | Chrt

Creates a rate sheet. Couriers and forwarders only. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | (RateSheetClientCreate1) -> (PydanticObjectId)

Authentication

AuthorizationBearer

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

Query parameters

payment_vector_typeenumRequired

Allowed values:

Request

This endpoint expects an object.

schema_versionintegerRequired

service_typeenumRequired

Allowed values:

archivedbooleanOptionalDefaults to false

namestring or nullOptional

commentsstring or nullOptional

cargo_typeslist of enumsOptional

vehicle_typeslist of enumsOptional

base_mileage_distance_milesdouble or nullOptional

base_mileage_rate_usd_per_instancedouble or nullOptional

additional_mileage_rate_usd_per_miledouble or nullOptional

applies only to the additional/incremental miles

long_distance_surcharge_miles_before_surchargedouble or nullOptional

long_distance_surcharge_rate_usd_per_miledouble or nullOptional

applies only to the additional/incremental miles

fuel_surcharge_rate_usd_per_miledouble or nullOptional

wait_time_before_charge_minutesdouble or nullOptional

wait_time_rate_usd_per_minutedouble or nullOptional

extra_stop_rate_usddouble or nullOptional

dangerous_goods_rate_usd_per_instancedouble or nullOptional

after_hours_rate_usd_per_instancedouble or nullOptional

weekend_rate_usd_per_instancedouble or nullOptional

holiday_rate_usd_per_instancedouble or nullOptional

Response

Successful Response

1	import { ChrtClient, ChrtEnvironment } from "@chrt-inc/typescript-sdk";
2
3	async function main() {
4	const client = new ChrtClient({
5	environment: ChrtEnvironment.Local,
6	token: "YOUR_TOKEN_HERE",
7	});
8	await client.billing.rateSheets.createV1({
9	payment_vector_type: "shipper_pay_forwarder",
10	schema_version: 1,
11	service_type: "on_demand",
12	});
13	}
14	main();

Authentication

Query parameters

Request

Response

Errors