Adjust line item

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.adjustLineItemV1("line_item_group_id", {
        line_item_uuid_str: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        adjustment: -15.75,
    });
}
main();

{
  "schema_version": 1,
  "_id": "lig_9f8b7c6d5e4a3b2c1d0e",
  "line_items": [
    {
      "item": "base_rate",
      "quantity": 10,
      "rate": 150.5,
      "amount": 1505,
      "schema_version": 1,
      "units": "usd",
      "comments": "Initial base rate for shipment",
      "adjustment": -15.75,
      "adjustment_comments": "Discount applied due to delay",
      "created_at_timestamp": "2024-01-15T09:30:00Z",
      "uuid_str": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "owned_by_org_id": "org_forwarder_001",
  "payment_vector_type": "shipper_pay_forwarder",
  "settlement_type": "stripe_connect",
  "task_group_id": "tg_1234567890abcdef",
  "rate_sheet_id": "rs_abcdef1234567890",
  "line_item_group_s3_object_metadata_ids": [
    "s3obj_20240115_093000"
  ],
  "statement_id": "stmt_20240115_0001",
  "payment_origin_org_id": "org_shipper_123",
  "payment_origin_off_chrt_shipper_org_id": "offchrt_shipper_456",
  "payment_destination_org_id": "org_forwarder_001",
  "payment_destination_driver_id": "driver_789",
  "status": "adjustable",
  "messages": [
    {
      "message": "Adjustment applied to base rate due to service delay.",
      "user_id": "user_operator_001",
      "org_id": "org_forwarder_001",
      "timestamp": "2024-01-15T09:45:00Z"
    }
  ]
}

Adjusts a line item within a line item group. LIG must be ADJUSTABLE. Adjustment can be negative beyond item.amount to serve as a credit. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (AdjustLineItemReq) -> (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.

line_item_uuid_strstringRequired

UUID of the line item to adjust

adjustmentdoubleRequired

Adjustment amount (can be positive or negative, can exceed item.amount negatively for credits)

adjustment_commentsstring or nullOptional

Comments explaining the adjustment

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

Path parameters

Request

Response

Errors