Choose rate sheet

PUT

/billing_new/orders/pricing/rate_sheet_selection/v1/:order_id

PUT

/billing_new/orders/pricing/rate_sheet_selection/v1/:order_id

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.billingNew.orders.updateRateSheetSelectionV1("order_id", {
        rate_sheet_id: "string",
        relationship_type: "receivable",
        task_group_id: "string",
    });
}
main();

{
  "order_billing_state": {
    "_id": "string",
    "created_at_timestamp": "2024-01-15T09:30:00Z",
    "created_by_user_id": "string",
    "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
    "last_edited_by_user_id": "string",
    "order_id": "string",
    "owned_by_org_id": "string",
    "schema_version": 1,
    "enabled_surcharge_types": [
      "equipment"
    ],
    "rate_sheet_selections": [
      {
        "rate_sheet_id": "string",
        "relationship_type": "receivable",
        "selection_source": "default",
        "task_group_id": "string",
        "counterparty_driver_id": "string",
        "counterparty_off_chrt_org_data_id": "string",
        "counterparty_org_id": "string"
      }
    ],
    "unpriced_reasons": [
      {
        "code": "no_rate_sheet",
        "rate_sheet_id": "string",
        "relationship_type": "receivable",
        "rule_key": "string",
        "task_group_id": "string",
        "task_id": "string"
      }
    ]
  },
  "agreed_prices": [
    {
      "relationship_type": "receivable",
      "task_group_id": "string",
      "bid_thread_id": "string",
      "counterparty_driver_id": "string",
      "counterparty_off_chrt_org_data_id": "string",
      "counterparty_org_id": "string",
      "order_billing_quote_id": "string"
    }
  ],
  "invoice_line_items": [
    {
      "_id": "string",
      "created_at_timestamp": "2024-01-15T09:30:00Z",
      "created_by_user_id": "string",
      "currency_code": "USD",
      "description": "string",
      "invoice_type": "accounts_receivable",
      "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
      "last_edited_by_user_id": "string",
      "line_item_type": "base_rate",
      "owned_by_org_id": "string",
      "quantity": 1.1,
      "schema_version": 1,
      "total_amount": 1.1,
      "unit_price": 1.1,
      "awb_number": "string",
      "billing_line_key": "string",
      "billing_period_id": "string",
      "counterparty_driver_id": "string",
      "counterparty_off_chrt_org_data_id": "string",
      "counterparty_org_id": "string",
      "currency_conversion": {
        "conversion_rate": 1.1,
        "source_currency_code": "USD",
        "source_unit_price": 1.1,
        "description": "string"
      },
      "edited_by_user": false,
      "export_ref__sage__item_id": "string",
      "generated_by_pricing": false,
      "invoice_id": "string",
      "needs_review": false,
      "order_id": "string",
      "rate_sheet_id": "string",
      "rate_sheet_revision": 1,
      "shipper_account_id": "string",
      "source_order_billing_quote_id": "string",
      "status": "draft",
      "task_group_id": "string",
      "task_ids": [
        "string"
      ],
      "task_short_ids": [
        "string"
      ],
      "tax_percentage": 1.1,
      "unit": "each"
    }
  ],
  "task_group_ids": [
    "string"
  ],
  "unpriced_reasons": [
    {
      "code": "no_rate_sheet",
      "rate_sheet_id": "string",
      "relationship_type": "receivable",
      "rule_key": "string",
      "task_group_id": "string",
      "task_id": "string"
    }
  ]
}

Chooses the rate sheet for one billing relationship on one segment of an order, overriding the default, or marks it not billed (rate_sheet_id null), then re-prices. | authz: allowed_org_types=[provider], min_org_role=operator | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (OrderRateSheetSelectionUpdateReq) -> (OrderPricingRes)

Authentication

AuthorizationBearer

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

Path parameters

order_idstringRequired

Request

This endpoint expects an object.

rate_sheet_idstring or nullRequired

relationship_typeenumRequired

Allowed values:

task_group_idstringRequired

counterparty_driver_idstring or nullOptional

counterparty_off_chrt_org_data_idstring or nullOptional

counterparty_org_idstring or nullOptional

Response

Successful Response

order_billing_stateobject or null

agreed_priceslist of objectsOptional

Relationships priced by a bid or quote; filled when the order is re-priced, empty on a plain read.

invoice_line_itemslist of objectsOptional

task_group_idslist of stringsOptional

The order's task groups, in order.

unpriced_reasonslist of objectsOptional

Errors

422

Unprocessable Entity Error