Create | 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.createV1({
        payment_vector_type: "shipper_pay_forwarder",
        settlement_type: "stripe_connect",
    });
}
main();

{
  "schema_version": 1,
  "_id": "stmt_9f8b7c6d5a4e3f2b1c0d",
  "settlement_type": "stripe_connect",
  "owned_by_org_id": "org_abc123def456ghi789",
  "payment_vector_type": "shipper_pay_forwarder",
  "line_item_group_ids": [
    "lig_1234567890abcdef"
  ],
  "amount": 125000,
  "units": "usd_cents",
  "staged_by_user_id": "user_7a8b9c0d1e2f3g4h5i6j",
  "payment_origin_org_id": "org_shipper001",
  "payment_origin_off_chrt_shipper_org_id": "offchrt_shipper_987654321",
  "payment_destination_org_id": "org_forwarder002",
  "payment_destination_driver_id": "driver_1234abcd5678efgh",
  "status": "staged",
  "stripe_invoice_id": "in_1J2K3L4M5N6O7P8Q9R0S",
  "stripe_invoice_url": "https://dashboard.stripe.com/invoices/in_1J2K3L4M5N6O7P8Q9R0S",
  "stripe_invoice_created_by_user_id": "user_5f6e7d8c9b0a1b2c3d4e",
  "stripe_invoice_status": "draft",
  "staged_at_timestamp": "2024-01-15T09:30:00Z",
  "opened_at_timestamp": "2024-01-15T09:30:00Z",
  "paid_at_timestamp": "2024-01-15T09:30:00Z",
  "uncollectible_at_timestamp": "2024-01-15T09:30:00Z",
  "marked_open_by_user_id": "user_1a2b3c4d5e6f7g8h9i0j",
  "marked_paid_by_user_id": "user_0j9i8h7g6f5e4d3c2b1a",
  "marked_uncollectible_by_user_id": "user_abcdef1234567890"
}

Creates a new statement without LIG IDs, starting in STAGED status. Requires payment vector, origin, and destination. | authz: org_type=[courier, forwarder], min_org_role=operator | (CreateStatementReq) -> (Statement1)

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 statement

Allowed values:

payment_origin_org_idstring or nullOptional

Payment origin org ID (on-CHRT org)

payment_origin_off_chrt_shipper_org_idstring or nullOptional

Payment origin off-CHRT shipper org ID

payment_destination_org_idstring or nullOptional

Payment destination org ID (on-CHRT org)

payment_destination_driver_idstring or nullOptional

Payment destination driver ID

Response

Successful Response

schema_versioninteger

_idstring

settlement_typeenum

Allowed values:

owned_by_org_idstring

Must be a string starting with org_

payment_vector_typeenum

Allowed values:

line_item_group_idslist of strings or null

amountinteger or null

unitsenum or null

Allowed values:

staged_by_user_idstring or null

payment_origin_org_idstring or null

payment_origin_off_chrt_shipper_org_idstring or null

payment_destination_org_idstring or null

payment_destination_driver_idstring or null

statusenum or null

Allowed values:

stripe_invoice_idstring or null

stripe_invoice_urlstring or null

stripe_invoice_created_by_user_idstring or null

stripe_invoice_statusenum or null

staged_at_timestampstring or nullformat: "date-time"

opened_at_timestampstring or nullformat: "date-time"

paid_at_timestampstring or nullformat: "date-time"

uncollectible_at_timestampstring or nullformat: "date-time"

marked_open_by_user_idstring or null

marked_paid_by_user_idstring or null

marked_uncollectible_by_user_idstring or null

Authentication

Request

Response

Errors