Close

PATCH

/billing_new/billing_periods/close/v1/:billing_period_id

PATCH

/billing_new/billing_periods/close/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.closeV1("billing_period_id");
8 }
9 main();

1 {
2   "billing_period": {
3     "_id": "_id",
4     "amount": 1.1,
5     "created_at_timestamp": "2024-01-15T09:30:00Z",
6     "created_by_user_id": "created_by_user_id",
7     "currency_code": "USD",
8     "cycle": "daily",
9     "description": "description",
10     "invoice_type": "accounts_receivable",
11     "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
12     "last_edited_by_user_id": "last_edited_by_user_id",
13     "owned_by_org_id": "owned_by_org_id",
14     "period_end_at_timestamp": "2024-01-15T09:30:00Z",
15     "period_start_at_timestamp": "2024-01-15T09:30:00Z",
16     "schema_version": 1,
17     "closed_at_timestamp": "2024-01-15T09:30:00Z",
18     "closed_by_user_id": "closed_by_user_id",
19     "counterparty_driver_id": "counterparty_driver_id",
20     "counterparty_off_chrt_org_data_id": "counterparty_off_chrt_org_data_id",
21     "counterparty_org_id": "counterparty_org_id",
22     "name": "name",
23     "shipper_account_id": "shipper_account_id",
24     "status": "open",
25     "task_group_ids": [
26       "task_group_ids"
27     ]
28   },
29   "invoice": {
30     "_id": "_id",
31     "created_at_timestamp": "2024-01-15T09:30:00Z",
32     "created_by_user_id": "created_by_user_id",
33     "currency_code": "USD",
34     "invoice_type": "accounts_receivable",
35     "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
36     "last_edited_by_user_id": "last_edited_by_user_id",
37     "owned_by_org_id": "owned_by_org_id",
38     "period_end_at_timestamp": "2024-01-15T09:30:00Z",
39     "period_start_at_timestamp": "2024-01-15T09:30:00Z",
40     "schema_version": 1,
41     "approved_at_timestamp": "2024-01-15T09:30:00Z",
42     "approved_by_user_id": "approved_by_user_id",
43     "counterparty_account_ids": [
44       "counterparty_account_ids"
45     ],
46     "counterparty_driver_id": "counterparty_driver_id",
47     "counterparty_off_chrt_org_data_id": "counterparty_off_chrt_org_data_id",
48     "counterparty_org_id": "counterparty_org_id",
49     "description": "description",
50     "export_ref__sage__customer_id": "export_ref__sage__customer_id",
51     "export_ref__sage__department_id": "export_ref__sage__department_id",
52     "file_exported_at_timestamp": "2024-01-15T09:30:00Z",
53     "file_exported_by_user_id": "file_exported_by_user_id",
54     "invoice_line_item_ids": [
55       "invoice_line_item_ids"
56     ],
57     "merge_exported_at_timestamp": "2024-01-15T09:30:00Z",
58     "merge_exported_by_user_id": "merge_exported_by_user_id",
59     "merge_invoice_id": "merge_invoice_id",
60     "merge_invoice_number": "merge_invoice_number",
61     "merge_invoice_url": "merge_invoice_url",
62     "merge_linked_account_id": "merge_linked_account_id",
63     "merge_remote_id": "merge_remote_id",
64     "merge_remote_was_deleted": true,
65     "merge_status": "draft",
66     "name": "name",
67     "status": "draft",
68     "stripe_exported_at_timestamp": "2024-01-15T09:30:00Z",
69     "stripe_exported_by_user_id": "stripe_exported_by_user_id",
70     "stripe_invoice_id": "stripe_invoice_id",
71     "stripe_invoice_number": "stripe_invoice_number",
72     "stripe_invoice_url": "stripe_invoice_url",
73     "stripe_status": "draft",
74     "stripe_was_deleted": true,
75     "total_amount": 1.1,
76     "void_reason": "void_reason",
77     "voided_at_timestamp": "2024-01-15T09:30:00Z",
78     "voided_by_user_id": "voided_by_user_id"
79   },
80   "invoice_line_item": {
81     "_id": "_id",
82     "created_at_timestamp": "2024-01-15T09:30:00Z",
83     "created_by_user_id": "created_by_user_id",
84     "currency_code": "USD",
85     "description": "description",
86     "invoice_type": "accounts_receivable",
87     "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
88     "last_edited_by_user_id": "last_edited_by_user_id",
89     "line_item_type": "base_rate",
90     "owned_by_org_id": "owned_by_org_id",
91     "quantity": 1.1,
92     "schema_version": 1,
93     "unit_price": 1.1,
94     "awb_number": "awb_number",
95     "billing_period_id": "billing_period_id",
96     "counterparty_driver_id": "counterparty_driver_id",
97     "counterparty_off_chrt_org_data_id": "counterparty_off_chrt_org_data_id",
98     "counterparty_org_id": "counterparty_org_id",
99     "export_ref__sage__item_id": "export_ref__sage__item_id",
100     "invoice_id": "invoice_id",
101     "order_id": "order_id",
102     "rate_sheet_id": "rate_sheet_id",
103     "shipper_account_id": "shipper_account_id",
104     "status": "draft",
105     "task_group_id": "task_group_id",
106     "tax_percentage": 1.1,
107     "unit": "each"
108   }
109 }

Closes an open billing period and creates one approved line item on the matching draft invoice. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (BillingPeriodExpanded1)

Authentication

AuthorizationBearer

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

Path parameters

billing_period_idstringRequired

Response

Successful Response

billing_periodobject

invoiceobject or nullOptional

invoice_line_itemobject or nullOptional

Errors

422

Billing Periods Close V1request Unprocessable Entity Error