List expanded

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.billing.statements.expandedListV1({
        sort_by: "amount",
        sort_order: "asc",
        page: 1,
        page_size: 1,
        filter_settlement_type: "stripe_connect",
        filter_order_id: "filter_order_id",
        filter_payment_origin_org_id: "filter_payment_origin_org_id",
        filter_payment_destination_org_id: "filter_payment_destination_org_id",
        filter_owned_by_org_id: "filter_owned_by_org_id",
        filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_opened_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_opened_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_paid_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_paid_at_timestamp_lte: "2024-01-15T09:30:00Z",
    });
}
main();

{
  "statements": [
    {
      "statement": {
        "schema_version": 1,
        "_id": "stmt_8f3b2c9d7a4e",
        "settlement_type": "stripe_connect",
        "owned_by_org_id": "org_9a7b6c5d4e3f",
        "payment_vector_type": "shipper_pay_forwarder"
      },
      "line_item_groups": [
        {
          "schema_version": 1,
          "_id": "lig_4d2f1a7b9c8e",
          "line_items": [
            {
              "item": "base_rate",
              "quantity": 3.5,
              "rate": 150,
              "amount": 525,
              "units": "usd",
              "comments": "Base rate for standard delivery",
              "created_at_timestamp": "2024-04-10T14:22:00Z",
              "uuid_str": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
            }
          ],
          "owned_by_org_id": "org_9a7b6c5d4e3f",
          "payment_vector_type": "shipper_pay_forwarder",
          "settlement_type": "stripe_connect",
          "is_ad_hoc": false,
          "task_group_id": "tg_7e6d5c4b3a21",
          "order_id": "order_1234567890",
          "order_short_id": "ORD1234",
          "rate_sheet_id": "rs_9876543210",
          "line_item_group_s3_object_metadata_ids": []
        }
      ],
      "task_groups": [
        {
          "schema_version": 1,
          "_id": "tg_7e6d5c4b3a21",
          "order_id": "order_1234567890",
          "order_short_id": "ORD1234",
          "created_by_org_id": "org_9a7b6c5d4e3f",
          "created_by_user_id": "user_abc123def456",
          "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
          "task_group_type": "chrt_ground_courier",
          "task_ids": [
            "task_001",
            "task_002"
          ],
          "courier_org_id": "org_1a2b3c4d5e6f",
          "driver_id": "driver_789xyz",
          "service_type": "on_demand",
          "task_group_s3_object_metadata_ids": [],
          "status": "draft",
          "order_cancelled": false,
          "messages": []
        }
      ]
    }
  ],
  "total_count": 1
}

Lists statements with expanded LIGs and task groups, using filtering, sorting, and pagination. | authz_personas=[statement_org_operators, statement_driver] | () -> (StatementsExpandedListRes)

Authentication

AuthorizationBearer

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

Query parameters

sort_byenum or nullOptional

Field to sort by

Allowed values:

sort_orderenum or nullOptional

Sort order (ascending or descending)

Allowed values:

pageinteger or nullOptional>=1Defaults to 1

page_sizeinteger or nullOptional1-100Defaults to 20

filter_statusenum or nullOptional

Filter by statement status(es)

Allowed values:

filter_settlement_typeenum or nullOptional

Filter by settlement type

Allowed values:

filter_order_idstring or nullOptional

Filter by order ID (returns statements whose order_ids list contains this value)

filter_payment_origin_org_idstring or nullOptional

Filter by payment origin org ID

filter_payment_destination_org_idstring or nullOptional

Filter by payment destination org ID

filter_owned_by_org_idstring or nullOptional

Filter by owned by org ID

filter_staged_at_timestamp_gtedatetime or nullOptional

Filter by staged_at_timestamp >= value

filter_staged_at_timestamp_ltedatetime or nullOptional

Filter by staged_at_timestamp <= value

filter_opened_at_timestamp_gtedatetime or nullOptional

Filter by opened_at_timestamp >= value

filter_opened_at_timestamp_ltedatetime or nullOptional

Filter by opened_at_timestamp <= value

filter_paid_at_timestamp_gtedatetime or nullOptional

Filter by paid_at_timestamp >= value

filter_paid_at_timestamp_ltedatetime or nullOptional

Filter by paid_at_timestamp <= value

Response

Successful Response

statementslist of objects

total_countinteger

Authentication

Query parameters

Response

Errors