Quote PPD rate-sheet materialization

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.shipping.taskGroups.quoteForProviderPayDriverV1("task_group_id", {
        driver_id: "driver_id",
    });
}
main();

{
  "task_group_id": "task_group_id",
  "rate_sheet_id": "rate_sheet_id",
  "rate_sheet_owned_by_org_id": "rate_sheet_owned_by_org_id",
  "line_items": [
    {
      "item": "base_rate",
      "rate": 1.1,
      "quantity": 1.1,
      "_id": "_id",
      "provenance": "rate_sheet",
      "schema_version": 1,
      "comments": "comments",
      "units": "usd",
      "adjustment": 1.1,
      "adjustment_comments": "adjustment_comments",
      "ad_hoc__submitted_by_user_id": "ad_hoc__submitted_by_user_id",
      "ad_hoc__submitted_by_org_id": "ad_hoc__submitted_by_org_id",
      "ad_hoc__status": "pending",
      "rate_sheet_id": "rate_sheet_id",
      "pro_forma__bid_thread_id": "pro_forma__bid_thread_id",
      "created_at_timestamp": "2024-01-15T09:30:00Z",
      "line_item_s3_object_metadata_ids": [
        "line_item_s3_object_metadata_ids"
      ]
    }
  ],
  "total_amount": 1.1,
  "owned_by_org_id": "owned_by_org_id",
  "payment_origin_org_id": "payment_origin_org_id",
  "payment_origin_off_chrt_shipper_org_id": "payment_origin_off_chrt_shipper_org_id",
  "payment_destination_org_id": "payment_destination_org_id",
  "payment_destination_off_chrt_provider_org_id": "payment_destination_off_chrt_provider_org_id",
  "payment_destination_driver_id": "payment_destination_driver_id"
}

Preview the LineItem materialization that would result from applying a rate sheet to the PPD vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (executor -> driver). Auto-resolves the rate sheet via RateSheetMapping1 for the requested driver unless body.rate_sheet_id is provided. PPD is on-chrt-executor only — TGs with an off-chrt executor are 400’d. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_provider_pay_driver/v1 then attach_lig_to_provider_pay_driver/v1. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | (TaskGroupQuoteForProviderPayDriverClientReq) -> (TaskGroupQuoteResp)

Preview the LineItem materialization that would result from applying a rate sheet to the PPD vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (executor -> driver). Auto-resolves the rate sheet via RateSheetMapping1 for the requested driver unless body.rate_sheet_id is provided. PPD is on-chrt-executor only — TGs with an off-chrt executor are 400'd. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_provider_pay_driver/v1 then attach_lig_to_provider_pay_driver/v1. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | (TaskGroupQuoteForProviderPayDriverClientReq) -> (TaskGroupQuoteResp)

Authentication

AuthorizationBearer

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

Path parameters

task_group_idstringRequired

Request

This endpoint expects an object.

driver_idstringRequired

rate_sheet_idstringOptional

Response

Successful Response

task_group_idstring

rate_sheet_idstring

rate_sheet_owned_by_org_idstring

Must be a string starting with org_

line_itemslist of objects

total_amountdouble

owned_by_org_idstring

Must be a string starting with org_

payment_origin_org_idstring

Must be a string starting with org_

payment_origin_off_chrt_shipper_org_idstring

payment_destination_org_idstring

Must be a string starting with org_

payment_destination_off_chrt_provider_org_idstring

payment_destination_driver_idstring

Errors

422

Task Groups Quote for Provider Pay Driver V1request Unprocessable Entity Error