Update

PATCH

/billing_new/billing_periods/update/v1/:billing_period_id

PATCH

/billing_new/billing_periods/update/v1/:billing_period_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.billingNew.billingPeriods.updateV1("billing_period_id", {});
8 }
9 main();

1 {
2   "_id": "_id",
3   "amount": 1.1,
4   "created_at_timestamp": "2024-01-15T09:30:00Z",
5   "created_by_user_id": "created_by_user_id",
6   "currency_code": "USD",
7   "cycle": "daily",
8   "description": "description",
9   "invoice_type": "accounts_receivable",
10   "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
11   "last_edited_by_user_id": "last_edited_by_user_id",
12   "owned_by_org_id": "owned_by_org_id",
13   "period_end_at_timestamp": "2024-01-15T09:30:00Z",
14   "period_start_at_timestamp": "2024-01-15T09:30:00Z",
15   "schema_version": 1,
16   "closed_at_timestamp": "2024-01-15T09:30:00Z",
17   "closed_by_user_id": "closed_by_user_id",
18   "counterparty_driver_id": "counterparty_driver_id",
19   "counterparty_off_chrt_org_data_id": "counterparty_off_chrt_org_data_id",
20   "counterparty_org_id": "counterparty_org_id",
21   "name": "name",
22   "shipper_account_id": "shipper_account_id",
23   "status": "open",
24   "task_group_ids": [
25     "task_group_ids"
26   ]
27 }

Updates an open owner-scoped billing period. | authz: allowed_org_types=[provider], min_org_role=operator | (BillingPeriodClientUpdate1) -> (BillingPeriod1)

Authentication

AuthorizationBearer

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

Path parameters

billing_period_idstringRequired

Request

This endpoint expects an object.

amountdoubleOptional

currency_codeenumOptional

cycleenumOptional

Allowed values:

descriptionstringOptional1-32768 characters

namestringOptional<=255 characters

name__set_to_NonebooleanOptionalDefaults to false

period_end_at_timestampdatetimeOptional

period_start_at_timestampdatetimeOptional

shipper_account_idstringOptional

shipper_account_id__set_to_NonebooleanOptionalDefaults to false

Response

Successful Response

_idstring

amountdouble

created_at_timestampdatetime

created_by_user_idstring

Must be a string starting with user_

currency_codeenum

cycleenum

descriptionstring1-32768 characters

invoice_typeenum

last_edited_at_timestampdatetime

last_edited_by_user_idstring

Must be a string starting with user_

owned_by_org_idstring

Must be a string starting with org_

period_end_at_timestampdatetime

period_start_at_timestampdatetime

schema_versioninteger

closed_at_timestampdatetimeOptional

closed_by_user_idstringOptional

Must be a string starting with user_

counterparty_driver_idstringOptional

counterparty_off_chrt_org_data_idstringOptional

counterparty_org_idstringOptional

Must be a string starting with org_

namestringOptional<=255 characters

shipper_account_idstringOptional

statusenumOptional

task_group_idslist of stringsOptional

Errors

422

Billing Periods Update V1request Unprocessable Entity Error