Create | Chrt

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.billing.statements.createV1({
        settlement_type: "stripe_connect",
    });
}
main();

{
  "schema_version": 1,
  "_id": "_id",
  "settlement_type": "stripe_connect",
  "owned_by_org_id": "owned_by_org_id",
  "payment_vector_type": "shipper_pay_forwarder",
  "line_item_group_ids": [
    "line_item_group_ids"
  ],
  "order_ids": [
    "order_ids"
  ],
  "order_short_ids": [
    "order_short_ids"
  ],
  "order_off_chrt_reference_ids": [
    "order_off_chrt_reference_ids"
  ],
  "amount": 1,
  "units": "usd",
  "staged_by_user_id": "staged_by_user_id",
  "payment_origin_org_id": "payment_origin_org_id",
  "payment_origin_off_chrt_shipper_org_id": "payment_origin_off_chrt_shipper_org_id",
  "payment_destination_org_id": "payment_destination_org_id",
  "payment_destination_driver_id": "payment_destination_driver_id",
  "status": "staged",
  "stripe_invoice_id": "stripe_invoice_id",
  "stripe_invoice_url": "stripe_invoice_url",
  "stripe_invoice_created_by_user_id": "stripe_invoice_created_by_user_id",
  "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": "marked_open_by_user_id",
  "marked_paid_by_user_id": "marked_paid_by_user_id",
  "marked_uncollectible_by_user_id": "marked_uncollectible_by_user_id"
}

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_idstringOptional

Payment origin org ID (on-CHRT org)

payment_origin_off_chrt_shipper_org_idstringOptional

Payment origin off-CHRT shipper org ID

payment_destination_org_idstringOptional

Payment destination org ID (on-CHRT org)

payment_destination_driver_idstringOptional

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

order_idslist of strings

order_short_idslist of strings

order_off_chrt_reference_idslist of strings

amountinteger

unitsenum

Allowed values:

staged_by_user_idstring

Must be a string starting with user_

payment_origin_org_idstring

Must be a string starting with org_

payment_origin_off_chrt_shipper_org_idstring

payment_destination_org_idstring

Must be a string starting with org_

payment_destination_driver_idstring

statusenum

Allowed values:

stripe_invoice_idstring

stripe_invoice_urlstring

stripe_invoice_created_by_user_idstring

Must be a string starting with user_

stripe_invoice_statusenum

staged_at_timestampdatetime

opened_at_timestampdatetime

paid_at_timestampdatetime

uncollectible_at_timestampdatetime

marked_open_by_user_idstring

Must be a string starting with user_

marked_paid_by_user_idstring

Must be a string starting with user_

marked_uncollectible_by_user_idstring

Must be a string starting with user_

Errors

422

Statements Create V1request Unprocessable Entity Error