List | Chrt

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

{
  "statements": [
    {
      "schema_version": 1,
      "_id": "stmt_8f3b2a1c9d4e",
      "settlement_type": "stripe_connect",
      "owned_by_org_id": "org_9c8d7e6f5a4b",
      "payment_vector_type": "shipper_pay_forwarder",
      "line_item_group_ids": [
        "lig_4a7c9e2b1f3d"
      ],
      "amount": 125000,
      "units": "usd_cents",
      "staged_by_user_id": "user_72f9d3a1b8e4",
      "payment_origin_org_id": "org_1a2b3c4d5e6f",
      "payment_origin_off_chrt_shipper_org_id": "offchrt_shipper_12345",
      "payment_destination_org_id": "org_6f5e4d3c2b1a",
      "payment_destination_driver_id": "driver_987654321",
      "status": "open",
      "stripe_invoice_id": "in_1J2K3L4M5N6O7P",
      "stripe_invoice_url": "https://dashboard.stripe.com/invoices/in_1J2K3L4M5N6O7P",
      "stripe_invoice_created_by_user_id": "user_5e4d3c2b1a9f",
      "stripe_invoice_status": "open",
      "staged_at_timestamp": "2024-04-10T14:22:00Z",
      "opened_at_timestamp": "2024-04-11T08:00:00Z",
      "paid_at_timestamp": null,
      "uncollectible_at_timestamp": null,
      "marked_open_by_user_id": "user_5e4d3c2b1a9f",
      "marked_paid_by_user_id": null,
      "marked_uncollectible_by_user_id": null
    }
  ],
  "total_count": 1
}

Lists statements with filtering, sorting, and pagination. | authz_personas=[statement_org_operators, statement_driver] | () -> (StatementsListRes)

Authentication

AuthorizationBearer

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

Query parameters

sort_byenumOptional

Field to sort by

Allowed values:

sort_orderenumOptional

Sort order (ascending or descending)

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

filter_statuslist of enums or nullOptional

Filter by statement status(es)

Allowed values:

filter_settlement_typeenum or nullOptional

Filter by settlement type

Allowed values:

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_gtestring or nullOptionalformat: "date-time"

Filter by staged_at_timestamp >= value

filter_staged_at_timestamp_ltestring or nullOptionalformat: "date-time"

Filter by staged_at_timestamp <= value

filter_opened_at_timestamp_gtestring or nullOptionalformat: "date-time"

Filter by opened_at_timestamp >= value

filter_opened_at_timestamp_ltestring or nullOptionalformat: "date-time"

Filter by opened_at_timestamp <= value

filter_paid_at_timestamp_gtestring or nullOptionalformat: "date-time"

Filter by paid_at_timestamp >= value

filter_paid_at_timestamp_ltestring or nullOptionalformat: "date-time"

Filter by paid_at_timestamp <= value

Response

Successful Response

statementslist of objects

total_countinteger

Authentication

Query parameters

Response

Errors