Retrieve (via POST) expanded

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.statements.expandedRetrieveV1({
        statement_id: "stmt_9f8b7c6d5e4a3b2c1d0e",
    });
}
main();

{
  "statement": {
    "schema_version": 1,
    "_id": "stmt_9f8b7c6d5e4a3b2c1d0e",
    "settlement_type": "stripe_connect",
    "owned_by_org_id": "org_9876543210fedcba",
    "payment_vector_type": "shipper_pay_forwarder",
    "line_item_group_ids": [
      "lig_1234567890abcdef"
    ],
    "amount": 125000,
    "units": "usd_cents",
    "staged_by_user_id": "user_42a1b2c3d4e5f6g7h8i9",
    "payment_origin_org_id": "org_123abc456def789ghi",
    "payment_origin_off_chrt_shipper_org_id": "offchrt_shipper_001",
    "payment_destination_org_id": "org_456def789ghi123abc",
    "payment_destination_driver_id": "driver_0011223344556677",
    "status": "staged",
    "stripe_invoice_id": "in_1J2K3L4M5N6O7P8Q9R",
    "stripe_invoice_url": "https://dashboard.stripe.com/invoices/in_1J2K3L4M5N6O7P8Q9R",
    "stripe_invoice_created_by_user_id": "user_42a1b2c3d4e5f6g7h8i9",
    "stripe_invoice_status": "draft",
    "staged_at_timestamp": "2024-01-15T09:30:00Z",
    "opened_at_timestamp": "2024-01-16T10:00:00Z",
    "paid_at_timestamp": "2024-01-20T15:45:00Z",
    "uncollectible_at_timestamp": "2024-02-01T12:00:00Z",
    "marked_open_by_user_id": "user_abc123def456ghi789",
    "marked_paid_by_user_id": "user_xyz987uvw654rst321",
    "marked_uncollectible_by_user_id": "user_lmn456opq789rst012"
  },
  "line_item_groups": [
    {
      "schema_version": 1,
      "_id": "lig_1234567890abcdef",
      "line_items": [
        {
          "item": "base_rate",
          "quantity": 150.5,
          "rate": 800,
          "amount": 120400,
          "schema_version": 1,
          "units": "usd_cents",
          "comments": "Base rate for transportation service",
          "adjustment": -5000,
          "adjustment_comments": "Discount applied for early payment",
          "created_at_timestamp": "2024-01-14T08:00:00Z",
          "uuid_str": "uuid_123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "owned_by_org_id": "org_9876543210fedcba",
      "payment_vector_type": "shipper_pay_forwarder",
      "settlement_type": "stripe_connect",
      "task_group_id": "taskgrp_001122334455",
      "rate_sheet_id": "rate_9876543210abcd",
      "line_item_group_s3_object_metadata_ids": [
        "s3meta_abcdef1234567890"
      ],
      "statement_id": "stmt_9f8b7c6d5e4a3b2c1d0e",
      "payment_origin_org_id": "org_123abc456def789ghi",
      "payment_origin_off_chrt_shipper_org_id": "offchrt_shipper_001",
      "payment_destination_org_id": "org_456def789ghi123abc",
      "payment_destination_driver_id": "driver_0011223344556677",
      "status": "staged",
      "messages": [
        {
          "message": "Reviewed and approved by billing team.",
          "user_id": "user_42a1b2c3d4e5f6g7h8i9",
          "org_id": "org_9876543210fedcba",
          "timestamp": "2024-01-15T10:15:00Z"
        }
      ]
    }
  ]
}

Retrieves a statement with its associated LineItemGroups expanded. | authz_personas=[statement_org_operators, statement_driver] | (StatementExpandedRetrieveReq) -> (StatementExpandedRes)

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

statement_idstringRequired

Response

Successful Response

statementobject

line_item_groupslist of objects

Authentication

Request

Response

Errors