Create ad-hoc

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.billing.lineItemGroups.adHocCreateV1({});
}
main();

{
  "schema_version": 1,
  "_id": "_id",
  "line_items": [
    {
      "item": "base_rate",
      "quantity": 1.1,
      "rate": 1.1,
      "amount": 1.1,
      "schema_version": 1,
      "units": "usd",
      "comments": "comments",
      "adjustment": 1.1,
      "adjustment_comments": "adjustment_comments",
      "created_at_timestamp": "2024-01-15T09:30:00Z",
      "uuid_str": "uuid_str"
    }
  ],
  "owned_by_org_id": "owned_by_org_id",
  "payment_vector_type": "shipper_pay_forwarder",
  "settlement_type": "stripe_connect",
  "is_ad_hoc": true,
  "task_group_id": "task_group_id",
  "order_id": "order_id",
  "order_short_id": "order_short_id",
  "order_off_chrt_reference_id": "order_off_chrt_reference_id",
  "rate_sheet_id": "rate_sheet_id",
  "line_item_group_s3_object_metadata_ids": [
    "line_item_group_s3_object_metadata_ids"
  ],
  "statement_id": "statement_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_driver_id": "payment_destination_driver_id",
  "status": "staged",
  "messages": [
    {
      "message": "message",
      "user_id": "user_id",
      "org_id": "org_id",
      "timestamp": "2024-01-15T09:30:00Z"
    }
  ]
}

Creates an ad-hoc line item group. Optionally associates 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:

task_group_idstringOptional

Optional task group ID to associate this ad-hoc LIG with (e.g. for adding extra charges to a flight TG)

payment_origin_org_idstringOptional

Payment origin org ID (on-CHRT org)

payment_origin_off_chrt_shipper_org_idstringOptional

Payment origin off-CHRT shipper org ID

payment_destination_org_idstringOptional

Payment destination org ID (on-CHRT org)

payment_destination_driver_idstringOptional

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:

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 Create V1request Unprocessable Entity Error