By ID

GET

/billing_new/chrt_ground_provider_rates/get/v1/:rate_id

GET

/billing_new/chrt_ground_provider_rates/get/v1/:rate_id

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.billingNew.chrtGroundProviderRates.getV1("rate_id");
}
main();

{
  "_id": "string",
  "created_at_timestamp": "2024-01-15T09:30:00Z",
  "currency_code": "USD",
  "invoice_type": "accounts_receivable",
  "owned_by_org_id": "string",
  "schema_version": 1,
  "updated_at_timestamp": "2024-01-15T09:30:00Z",
  "additional_mileage": {
    "ends_at_total_distance_miles": 1.1,
    "rate_per_mile": 1.1,
    "starts_at_total_distance_miles": 1.1,
    "sage_item_id": "string"
  },
  "after_hours": {
    "rate_per_instance": 1.1,
    "sage_item_id": "string"
  },
  "archived": false,
  "attempt": {
    "rate_per_instance": 1.1,
    "sage_item_id": "string"
  },
  "base_mileage": {
    "included_distance_miles": 1.1,
    "rate_per_instance": 1.1,
    "sage_item_id": "string"
  },
  "cargo_types": [
    "spare_parts"
  ],
  "comments": "string",
  "counterparty_driver_id": "string",
  "counterparty_off_chrt_org_data_id": "string",
  "counterparty_org_id": "string",
  "dangerous_goods": {
    "rate_per_instance": 1.1,
    "sage_item_id": "string"
  },
  "extra_stop": {
    "rate_per_instance": 1.1,
    "sage_item_id": "string"
  },
  "flat_fee": {
    "rate_per_instance": 1.1,
    "sage_item_id": "string"
  },
  "from_payables": {
    "combine": false,
    "margin": 0.5,
    "markup": 1.1,
    "sage_item_id": "string"
  },
  "fuel_surcharge": {
    "rate_per_mile": 1.1,
    "sage_item_id": "string"
  },
  "holiday": {
    "rate_per_instance": 1.1,
    "sage_item_id": "string"
  },
  "long_distance_surcharge": {
    "rate_per_mile": 1.1,
    "starts_at_total_distance_miles": 1.1,
    "sage_item_id": "string"
  },
  "name": "string",
  "pick_and_hold": {
    "rate_per_instance": 1.1,
    "sage_item_id": "string"
  },
  "service_line": "on_demand",
  "shipper_account_id": "string",
  "vehicle_types": [
    "sedan"
  ],
  "wait_time": {
    "included_minutes": 1.1,
    "rate_per_minute": 1.1,
    "sage_item_id": "string"
  },
  "weekend": {
    "rate_per_instance": 1.1,
    "sage_item_id": "string"
  }
}

Retrieves owner-scoped ground-provider rates. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (ChrtGroundProviderRates1)

Authentication

AuthorizationBearer

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

Path parameters

rate_idstringRequired

Response

Successful Response

_idstring

created_at_timestampstringformat: "date-time"

currency_codeenum

invoice_typeenum

Allowed values:

owned_by_org_idstring

Must be a string starting with org_

schema_versioninteger

updated_at_timestampstringformat: "date-time"

additional_mileageobject or nullOptional

after_hoursobject or nullOptional

archivedbooleanOptionalDefaults to false

attemptobject or nullOptional

base_mileageobject or nullOptional

cargo_typeslist of enumsOptional

commentsstring or nullOptional<=524288 characters

counterparty_driver_idstring or nullOptional

counterparty_off_chrt_org_data_idstring or nullOptional

counterparty_org_idstring or nullOptional

dangerous_goodsobject or nullOptional

extra_stopobject or nullOptional

flat_feeobject or nullOptional

from_payablesobject or nullOptional

fuel_surchargeobject or nullOptional

holidayobject or nullOptional

long_distance_surchargeobject or nullOptional

namestring or nullOptional

pick_and_holdobject or nullOptional

service_lineenumOptional

Allowed values:

shipper_account_idstring or nullOptional

vehicle_typeslist of enumsOptional

wait_timeobject or nullOptional

weekendobject or nullOptional

Errors

422

Unprocessable Entity Error