Add line item to ad-hoc LIG

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.billing.lineItemGroups.adHocAddLineItemV1("line_item_group_id", {
        item: "base_rate",
        quantity: 3.5,
        rate: 150.75,
    });
}
main();

{
  "schema_version": 1,
  "_id": "lig_9f8e7d6c5b4a3210",
  "line_items": [
    {
      "item": "base_rate",
      "quantity": 3.5,
      "rate": 150.75,
      "amount": 542.625,
      "schema_version": 1,
      "units": "usd",
      "comments": "Base rate for expedited delivery",
      "adjustment": 10,
      "adjustment_comments": "Seasonal surcharge applied",
      "created_at_timestamp": "2024-06-05T14:00:00Z",
      "uuid_str": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "owned_by_org_id": "org_courier_001",
  "payment_vector_type": "shipper_pay_forwarder",
  "settlement_type": "stripe_connect",
  "is_ad_hoc": true,
  "task_group_id": "tg_123abc456def7890",
  "order_id": "ord_987zyx654wvu3210",
  "order_short_id": "ORD12345",
  "order_off_chrt_reference_id": "ref_20240605_001",
  "rate_sheet_id": "rs_2024_summer_promo",
  "line_item_group_s3_object_metadata_ids": [
    "s3obj_20240605_lig_metadata_01"
  ],
  "statement_id": "stmt_20240605_01",
  "payment_origin_org_id": "org_shipper_123",
  "payment_origin_off_chrt_shipper_org_id": "offchrt_shipper_456",
  "payment_destination_org_id": "org_forwarder_789",
  "payment_destination_driver_id": "driver_abc123",
  "status": "staged",
  "messages": [
    {
      "message": "Line item added successfully.",
      "user_id": "user_operator_001",
      "org_id": "org_courier_001",
      "timestamp": "2024-06-05T14:05:00Z"
    }
  ]
}

Adds a line item to an ad-hoc line item group. LIG must be ad-hoc (is_ad_hoc=True) and ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (LineItemClientCreate1) -> (LineItemGroup1)

Authentication

AuthorizationBearer

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

Path parameters

line_item_group_idstringRequired

Request

This endpoint expects an object.

itemenumRequired

quantitydoubleRequired

ratedoubleRequired

schema_versionintegerOptionalDefaults to 1

unitsenumOptional

Allowed values:

commentsstringOptional

adjustmentdoubleOptional

adjustment_commentsstringOptional

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:

is_ad_hocbooleanDefaults to false

task_group_idstring

order_idstring

order_short_idstring

order_off_chrt_reference_idstringformat: "^[A-Za-z0-9._~\-]{1,64}$"1-64 characters

Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, ’.’, ’_’, ’~’, ’-’ (RFC 3986 unreserved).

rate_sheet_idstring

line_item_group_s3_object_metadata_idslist of strings

statement_idstring

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_driver_idstring

statusenum

messageslist of objects

Errors

422

Ad Hoc Add Line Item V1request Unprocessable Entity Error