Update settlement type

POST

/billing/statements/update_settlement_type/v1/:statement_id

POST

/billing/statements/update_settlement_type/v1/:statement_id

1 const url = 'https://localhost:8000/billing/statements/update_settlement_type/v1/statement_id';
2 const options = {
3   method: 'POST',
4   headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5   body: '{"settlement_type":"stripe_connect"}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

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_data_id": "payment_destination_off_chrt_provider_org_data_id",
31   "payment_destination_org_id": "payment_destination_org_id",
32   "payment_origin_off_chrt_shipper_org_data_id": "payment_origin_off_chrt_shipper_org_data_id",
33   "payment_origin_org_id": "payment_origin_org_id",
34   "staged_at_timestamp": "2024-01-15T09:30:00Z",
35   "staged_by_user_id": "staged_by_user_id",
36   "status": "staged",
37   "stripe_invoice_created_by_user_id": "stripe_invoice_created_by_user_id",
38   "stripe_invoice_id": "stripe_invoice_id",
39   "stripe_invoice_status": "draft",
40   "stripe_invoice_url": "stripe_invoice_url",
41   "uncollectible_at_timestamp": "2024-01-15T09:30:00Z",
42   "units": "usd"
43 }

Flips a STAGED Statement’s settlement_type between STRIPE_CONNECT and OFF_CHRT and cascades the new value onto every attached LineItemGroup. Rejects if the new value matches the current value. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[statement_owner_operators] | (StatementUpdateSettlementTypeReq) -> (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.

settlement_typeenumRequired

Allowed values:

Response

Successful Response

_idstring

owned_by_org_idstring

Must be a string starting with org_

schema_versioninteger

settlement_typeenum

amountintegerOptional

billing_ledger_period_idslist of stringsOptional

line_item_group_idslist of stringsOptional

marked_open_by_user_idstringOptional

Must be a string starting with user_

marked_paid_by_user_idstringOptional

Must be a string starting with user_

marked_uncollectible_by_user_idstringOptional

Must be a string starting with user_

opened_at_timestampdatetimeOptional

order_group_idstringOptional

order_group_short_idstringOptional

order_idslist of stringsOptional

order_off_chrt_reference_idslist of stringsOptional

order_short_idslist of stringsOptional

paid_at_timestampdatetimeOptional

payment_destination_driver_idstringOptional

payment_destination_off_chrt_provider_org_data_idstringOptional

payment_destination_org_idstringOptional

Must be a string starting with org_

payment_origin_off_chrt_shipper_org_data_idstringOptional

payment_origin_org_idstringOptional

Must be a string starting with org_

staged_at_timestampdatetimeOptional

staged_by_user_idstringOptional

Must be a string starting with user_

statusenumOptional

stripe_invoice_created_by_user_idstringOptional

Must be a string starting with user_

stripe_invoice_idstringOptional

stripe_invoice_statusenumOptional

stripe_invoice_urlstringOptional

uncollectible_at_timestampdatetimeOptional

unitsenumOptional

Errors

422

Statements Update Settlement Type V1request Unprocessable Entity Error