Update

PUT

/billing_new/rate_sheets/update/v1/:rate_sheet_id

PUT

/billing_new/rate_sheets/update/v1/:rate_sheet_id

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.billingNew.rateSheets.updateV1("rate_sheet_id", {
        expected_revision: 1,
        rate_sheet: {
            currency_code: "USD",
            invoice_type: "accounts_receivable",
            name: "string",
            rules: [],
            schema_version: 1,
            task_group_type: "chrt_ground_provider",
        },
    });
}
main();

{
  "_id": "string",
  "created_at_timestamp": "2024-01-15T09:30:00Z",
  "created_by_user_id": "string",
  "currency_code": "USD",
  "invoice_type": "accounts_receivable",
  "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
  "last_edited_by_user_id": "string",
  "name": "string",
  "owned_by_org_id": "string",
  "rules": [
    {
      "charged_per": "order",
      "export_ref__sage__item_id": "string",
      "flat_rate": 1.1,
      "line_item_description": "string",
      "rule_key": "string",
      "rule_type": "string"
    }
  ],
  "schema_version": 1,
  "task_group_type": "chrt_ground_provider",
  "applies_to_service_lines": [
    "on_demand"
  ],
  "archived_at_timestamp": "2024-01-15T09:30:00Z",
  "archived_by_user_id": "string",
  "counterparty_driver_id": "string",
  "counterparty_off_chrt_org_data_id": "string",
  "counterparty_org_id": "string",
  "effective_ends_at_timestamp": "2024-01-15T09:30:00Z",
  "effective_starts_at_timestamp": "2024-01-15T09:30:00Z",
  "effective_time_zone_name": "America/New_York",
  "revision": 1
}

Replaces an active rate sheet’s fields and rules; orders priced later use the new rules. | authz: allowed_org_types=[provider], min_org_role=operator | (RateSheetUpdateReq) -> (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.

expected_revisionintegerRequired>=1

rate_sheetobjectRequired

Response

Successful Response

_idstring

created_at_timestampstringformat: "date-time"

created_by_user_idstring

Must be a string starting with user_

currency_codeenum

invoice_typeenum

Allowed values:

last_edited_at_timestampstringformat: "date-time"

last_edited_by_user_idstring

Must be a string starting with user_

namestringformat: "\S"1-255 characters

owned_by_org_idstring

Must be a string starting with org_

ruleslist of objects

schema_versioninteger

task_group_typeenum

Allowed values:

applies_to_service_lineslist of enumsOptional

Allowed values:

archived_at_timestampstring or nullOptionalformat: "date-time"

archived_by_user_idstring or nullOptional

counterparty_driver_idstring or nullOptional

counterparty_off_chrt_org_data_idstring or nullOptional

counterparty_org_idstring or nullOptional

effective_ends_at_timestampstring or nullOptionalformat: "date-time"

effective_starts_at_timestampstring or nullOptionalformat: "date-time"

effective_time_zone_namestringOptionalDefaults to UTC

IANA time zone name (e.g. America/New_York).

revisionintegerOptional>=1Defaults to 1

Errors

422

Unprocessable Entity Error