List for courier org

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.listForCourierOrgV1({});
}
main();

{
  "line_item_groups": [
    {
      "schema_version": 1,
      "_id": "lig_8f7a3c2d9b1e4f3a9c7d6e5b",
      "line_items": [
        {
          "item": "base_rate",
          "quantity": 12.5,
          "rate": 45.75,
          "amount": 550.38,
          "schema_version": 1,
          "units": "usd",
          "comments": "Base rate for standard delivery",
          "adjustment": -5,
          "adjustment_comments": "Discount applied for early booking",
          "created_at_timestamp": "2024-01-15T09:30:00Z",
          "uuid_str": "a3f1c9d2-4b7e-4f8a-9c3d-6b5e7f4a1c2d"
        }
      ],
      "owned_by_org_id": "org_courier_12345",
      "payment_vector_type": "shipper_pay_forwarder",
      "settlement_type": "stripe_connect",
      "task_group_id": "tg_4b2d1f7e8a9c3d6b5e7f4a1c",
      "rate_sheet_id": "rs_9d8c7b6a5e4f3d2c1b0a9e8f",
      "line_item_group_s3_object_metadata_ids": [
        "s3obj_20240115_093000_01"
      ],
      "statement_id": "stmt_20240115_0001",
      "payment_origin_org_id": "org_shipper_67890",
      "payment_origin_off_chrt_shipper_org_id": null,
      "payment_destination_org_id": "org_forwarder_54321",
      "payment_destination_driver_id": "driver_98765",
      "status": "staged",
      "messages": [
        {
          "message": "Initial line item group created and awaiting rate confirmation.",
          "user_id": "user_abc123",
          "org_id": "org_courier_12345",
          "timestamp": "2024-01-15T09:30:00Z"
        }
      ]
    }
  ],
  "total_count": 1
}

Lists line item groups for the authenticated courier organization with filtering and pagination. | org_type=[courier], min_org_role=operator | () -> (LineItemGroupListRes)

Authentication

AuthorizationBearer

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

Query parameters

filter_driver_idstring or nullOptional

Filter by driver ID (payment_destination_driver_id)

filter_statuslist of enums or nullOptional

Filter by line item group status(es)

filter_attached_to_statementboolean or nullOptional

Filter by whether line item group is attached to a statement

filter_payment_roleenum or nullOptional

Filter by payment role: origin (courier pays) or destination (courier receives). Returns both if not specified.

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

Response

Successful Response

line_item_groupslist of objects

total_countinteger

Authentication

Query parameters

Response

Errors