Create ad-hoc

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.adHoc.createV1({
        payment_vector_type: "shipper_pay_forwarder",
        settlement_type: "stripe_connect",
    });
}
main();

{
  "schema_version": 1,
  "_id": "lig_8f3b2c9d-4e7a-4a1e-9f3d-2b7e5a1c9d3f",
  "line_items": [
    {
      "item": "base_rate",
      "quantity": 10.5,
      "rate": 150.75,
      "amount": 1665.38,
      "schema_version": 1,
      "units": "usd",
      "comments": "Standard base rate for shipment",
      "adjustment": 15,
      "adjustment_comments": "Seasonal surcharge applied",
      "created_at_timestamp": "2024-01-15T09:30:00Z",
      "uuid_str": "li_3a9f7e2b-1c4d-4f6a-8b2e-7d9f1a3c5b6e"
    }
  ],
  "owned_by_org_id": "org_forwarder_12345",
  "payment_vector_type": "shipper_pay_forwarder",
  "settlement_type": "stripe_connect",
  "task_group_id": "null",
  "rate_sheet_id": "null",
  "line_item_group_s3_object_metadata_ids": [
    "s3obj_20240115_093000_01"
  ],
  "statement_id": "stmt_5d7f9a3b-2c1e-4f8a-9b3d-6e7f1a2c4b5d",
  "payment_origin_org_id": "org_shipper_67890",
  "payment_origin_off_chrt_shipper_org_id": "offchrt_shipper_001",
  "payment_destination_org_id": "org_forwarder_12345",
  "payment_destination_driver_id": "driver_98765",
  "status": "staged",
  "messages": [
    {
      "message": "Initial ad-hoc line item group created and staged for review.",
      "user_id": "user_admin_001",
      "org_id": "org_forwarder_12345",
      "timestamp": "2024-01-15T09:30:00Z"
    }
  ]
}

Creates an ad-hoc line item group (not associated with a TaskGroup). Starts as ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator | (CreateAdHocLineItemGroupReq) -> (LineItemGroup1)

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

payment_vector_typeenumRequired

Payment vector type

Allowed values:

settlement_typeenumRequired

Settlement type for this line item group

Allowed values:

payment_origin_org_idstring or nullOptional

Payment origin org ID (on-CHRT org)

payment_origin_off_chrt_shipper_org_idstring or nullOptional

Payment origin off-CHRT shipper org ID

payment_destination_org_idstring or nullOptional

Payment destination org ID (on-CHRT org)

payment_destination_driver_idstring or nullOptional

Payment destination driver ID

Response

Successful Response

schema_versioninteger

_idstring

line_itemslist of objects

owned_by_org_idstring

Must be a string starting with org_

payment_vector_typeenum

Allowed values:

settlement_typeenum

Allowed values:

task_group_idstring or null

rate_sheet_idstring or null

line_item_group_s3_object_metadata_idslist of strings or null

statement_idstring or null

payment_origin_org_idstring or null

payment_origin_off_chrt_shipper_org_idstring or null

payment_destination_org_idstring or null

payment_destination_driver_idstring or null

statusenum or null

messageslist of objects or null

Authentication

Request

Response

Errors