Update off-CHRT settlement state

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.updateOffChrtSettlementStateV1("statement_id", {
        new_status: "open",
    });
}
main();

{
  "schema_version": 1,
  "_id": "stmt_9f8b7c6d5e4a3b2c1d0e",
  "settlement_type": "off_chrt",
  "owned_by_org_id": "org_7a8b9c0d1e2f3g4h",
  "payment_vector_type": "shipper_pay_forwarder",
  "line_item_group_ids": [
    "lig_1234567890abcdef"
  ],
  "amount": 125000,
  "units": "usd_cents",
  "staged_by_user_id": "user_42a7f9c8d6e1b3f0",
  "payment_origin_org_id": "org_1a2b3c4d5e6f7g8h",
  "payment_origin_off_chrt_shipper_org_id": "org_shipper_001",
  "payment_destination_org_id": "org_9h8g7f6e5d4c3b2a",
  "payment_destination_driver_id": "driver_5f4e3d2c1b0a9e8d",
  "status": "open",
  "stripe_invoice_id": "in_1J2K3L4M5N6O7P8Q",
  "stripe_invoice_url": "https://dashboard.stripe.com/invoices/in_1J2K3L4M5N6O7P8Q",
  "stripe_invoice_created_by_user_id": "user_7c6d5e4a3b2c1d0e",
  "stripe_invoice_status": "open",
  "staged_at_timestamp": "2024-04-10T08:15:00Z",
  "opened_at_timestamp": "2024-04-11T09:00:00Z",
  "paid_at_timestamp": "2024-04-15T14:30:00Z",
  "uncollectible_at_timestamp": "2024-04-20T12:00:00Z",
  "marked_open_by_user_id": "user_123abc456def7890",
  "marked_paid_by_user_id": "user_098zyx765wvu4321",
  "marked_uncollectible_by_user_id": "user_567ghi890jkl1234"
}

Updates the status of an off-CHRT settlement statement. Used to manually transition OFF_CHRT statements between STAGED, OPEN, PAID, and VOID. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators] | (StatementStatusEnum1) -> (Statement1)

Authentication

AuthorizationBearer

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

Path parameters

statement_idstringRequired

Request

This endpoint expects an object.

new_statusenumRequired

Allowed values:

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

Path parameters

Request

Response

Errors