Mark uncollectible (off-chrt)

POST

/billing/statements/mark_uncollectible_off_chrt/v1/:statement_id

POST

/billing/statements/mark_uncollectible_off_chrt/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.markUncollectibleOffChrtV1("statement_id");
8 }
9 main();

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

Off-chrt manual write-off: OPEN → UNCOLLECTIBLE. Cascades attached LineItemGroups OPEN → UNCOLLECTIBLE. Stripe-Connect statements transition via Stripe webhook + sync_invoice/v1, not this route. | 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

_idstring

owned_by_org_idstring

Must be a string starting with org_

schema_versioninteger

settlement_typeenum

amountinteger

billing_ledger_period_idslist of strings

line_item_group_idslist of strings

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_

opened_at_timestampdatetime

order_group_idstring

order_group_short_idstring

order_idslist of strings

order_off_chrt_reference_idslist of strings

order_short_idslist of strings

paid_at_timestampdatetime

payment_destination_driver_idstring

payment_destination_off_chrt_provider_org_idstring

payment_destination_off_chrt_vendor_idstring

payment_destination_org_idstring

Must be a string starting with org_

payment_origin_off_chrt_shipper_org_idstring

payment_origin_org_idstring

Must be a string starting with org_

staged_at_timestampdatetime

staged_by_user_idstring

Must be a string starting with user_

statusenum

stripe_invoice_created_by_user_idstring

Must be a string starting with user_

stripe_invoice_idstring

stripe_invoice_statusenum

stripe_invoice_urlstring

uncollectible_at_timestampdatetime

unitsenum

Errors

422

Statements Mark Uncollectible off Chrt V1request Unprocessable Entity Error