List by org

const url = 'https://localhost:8000/billing/rate_sheets/list_by_org/v1?sort_by=id&sort_order=asc&page=1&page_size=1&search=search&filter_archived=true&filter_payment_vector_type=shipper_pay_forwarder&filter_service_type=on_demand&filter_cargo_type=spare_parts&filter_vehicle_type=sedan';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "items": [
    {
      "schema_version": 1,
      "service_type": "on_demand",
      "owned_by_org_id": "org_9f8b7c6d5e4a3b2c1d0e",
      "owned_by_org_type": "courier",
      "payment_vector_type": "shipper_pay_forwarder",
      "_id": "rs_1234567890abcdef",
      "archived": true,
      "name": "Standard Courier Rate Sheet",
      "comments": "Includes rates for standard courier services with fuel surcharge adjustments.",
      "cargo_types": [
        "spare_parts"
      ],
      "vehicle_types": [
        "sedan"
      ],
      "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": 40,
      "weekend_rate_usd_per_instance": 30,
      "holiday_rate_usd_per_instance": 60
    }
  ],
  "total_count": 1
}

Lists rate sheets for the caller’s organization with filtering, sorting, pagination, and optional full-text search. | 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_byenumOptional

Sortable fields for rate sheet list.

Allowed values:

sort_orderenumOptional

Sort order (asc or desc)

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

searchstringOptional

Full-text search query

filter_archivedbooleanOptional

filter_payment_vector_typeenumOptional

Allowed values:

filter_service_typeenumOptional

Filter by service type (exact match)

Allowed values:

filter_cargo_typeenumOptional

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

filter_vehicle_typeenumOptional

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

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Rate Sheets List by Org V1request Unprocessable Entity Error