Void (Stripe Connect)

POST

/billing/statements/void_invoice/v1/:statement_id

POST

/billing/statements/void_invoice/v1/:statement_id

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.billing.statements.voidInvoiceV1("statement_id");
8 }
9 main();

1 {
2   "schema_version": 1,
3   "_id": "_id",
4   "settlement_type": "stripe_connect",
5   "owned_by_org_id": "owned_by_org_id",
6   "line_item_group_ids": [
7     "line_item_group_ids"
8   ],
9   "billing_ledger_period_ids": [
10     "billing_ledger_period_ids"
11   ],
12   "order_ids": [
13     "order_ids"
14   ],
15   "order_short_ids": [
16     "order_short_ids"
17   ],
18   "order_off_chrt_reference_ids": [
19     "order_off_chrt_reference_ids"
20   ],
21   "amount": 1,
22   "units": "usd",
23   "staged_by_user_id": "staged_by_user_id",
24   "payment_origin_org_id": "payment_origin_org_id",
25   "payment_origin_off_chrt_shipper_org_id": "payment_origin_off_chrt_shipper_org_id",
26   "payment_destination_org_id": "payment_destination_org_id",
27   "payment_destination_off_chrt_provider_org_id": "payment_destination_off_chrt_provider_org_id",
28   "payment_destination_driver_id": "payment_destination_driver_id",
29   "status": "staged",
30   "stripe_invoice_id": "stripe_invoice_id",
31   "stripe_invoice_url": "stripe_invoice_url",
32   "stripe_invoice_created_by_user_id": "stripe_invoice_created_by_user_id",
33   "stripe_invoice_status": "draft",
34   "staged_at_timestamp": "2024-01-15T09:30:00Z",
35   "opened_at_timestamp": "2024-01-15T09:30:00Z",
36   "paid_at_timestamp": "2024-01-15T09:30:00Z",
37   "uncollectible_at_timestamp": "2024-01-15T09:30:00Z",
38   "marked_open_by_user_id": "marked_open_by_user_id",
39   "marked_paid_by_user_id": "marked_paid_by_user_id",
40   "marked_uncollectible_by_user_id": "marked_uncollectible_by_user_id"
41 }

Stripe-Connect transition: OPEN → STAGED. Voids the Stripe invoice, clears stripe_* fields on the Statement, and cascades attached LineItemGroups OPEN → FINALIZED so they remain re-bundleable into a new Statement. Reversible — the Statement can be re-opened with a fresh open_invoice/v1. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[statement_owner_operators] | () -> (Statement1)

Authentication

AuthorizationBearer

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

Path parameters

statement_idstringRequired

Response

Successful Response

schema_versioninteger

_idstring

settlement_typeenum

owned_by_org_idstring

Must be a string starting with org_

line_item_group_idslist of strings

billing_ledger_period_idslist of strings

order_idslist of strings

order_short_idslist of strings

order_off_chrt_reference_idslist of strings

amountinteger

unitsenum

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_off_chrt_provider_org_idstring

payment_destination_driver_idstring

statusenum

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 Void Invoice V1request Unprocessable Entity Error