Get quote for task group

import { ChrtClient, ChrtEnvironment } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        environment: ChrtEnvironment.Local,
        token: "YOUR_TOKEN_HERE",
    });
    await client.billing.lineItemGroups.quoteV1("task_group_id", {
        payment_vector_type: "shipper_pay_forwarder",
    });
}
main();

{
  "task_group_id": "tg-9f8b7c6d5e4a3b2c1d0e",
  "rate_sheet_id": "rs-2024-04-01-standard",
  "line_items": [
    {
      "item": "base_rate",
      "quantity": 3.5,
      "rate": 45.75,
      "amount": 154.13,
      "schema_version": 1,
      "units": "usd",
      "comments": "Base rate for standard delivery",
      "adjustment": -5,
      "adjustment_comments": "Promotional discount applied",
      "created_at_timestamp": "2024-04-20T14:22:00Z",
      "uuid_str": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ]
}

Calculates a quote (line item group preview) for a task group and payment vector without persisting any data. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators, shipper_org_operators] | () -> (Quote)

Authentication

AuthorizationBearer

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

Path parameters

task_group_idstringRequired

Query parameters

payment_vector_typeenumRequired

The payment vector type to calculate a quote for.

Allowed values:

rate_sheet_idstring or nullOptional

Optional rate sheet ID to use. Must match the payment_vector_type. If not provided, rate sheet is resolved using standard priority.

Response

Successful Response

task_group_idstring

rate_sheet_idstring

line_itemslist of objects

Authentication

Path parameters

Query parameters

Response

Errors