List

GET

/billing_new/billing_periods/list/v1

GET

/billing_new/billing_periods/list/v1

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.listV1({
8         filter_counterparty_driver_id: "filter_counterparty_driver_id",
9         filter_counterparty_off_chrt_org_data_id: "filter_counterparty_off_chrt_org_data_id",
10         filter_counterparty_org_id: "filter_counterparty_org_id",
11         filter_currency_codes: [
12             "USD",
13         ],
14         filter_invoice_types: [
15             "accounts_receivable",
16         ],
17         filter_period_end_at_timestamp_gte: "2024-01-15T09:30:00Z",
18         filter_period_end_at_timestamp_lte: "2024-01-15T09:30:00Z",
19         filter_period_start_at_timestamp_gte: "2024-01-15T09:30:00Z",
20         filter_period_start_at_timestamp_lte: "2024-01-15T09:30:00Z",
21         filter_shipper_account_id: "filter_shipper_account_id",
22         filter_statuses: [
23             "open",
24         ],
25         filter_task_group_id: "filter_task_group_id",
26         page: 1,
27         page_size: 1,
28         sort_by: "created_at_timestamp",
29         sort_order: "asc",
30     });
31 }
32 main();

1 {
2   "items": [
3     {
4       "billing_period": {
5         "_id": "_id",
6         "amount": 1.1,
7         "created_at_timestamp": "2024-01-15T09:30:00Z",
8         "created_by_user_id": "created_by_user_id",
9         "currency_code": "USD",
10         "cycle": "daily",
11         "description": "description",
12         "invoice_type": "accounts_receivable",
13         "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
14         "last_edited_by_user_id": "last_edited_by_user_id",
15         "owned_by_org_id": "owned_by_org_id",
16         "period_end_at_timestamp": "2024-01-15T09:30:00Z",
17         "period_start_at_timestamp": "2024-01-15T09:30:00Z",
18         "schema_version": 1
19       },
20       "invoice": {
21         "_id": "_id",
22         "created_at_timestamp": "2024-01-15T09:30:00Z",
23         "created_by_user_id": "created_by_user_id",
24         "currency_code": "USD",
25         "invoice_type": "accounts_receivable",
26         "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
27         "last_edited_by_user_id": "last_edited_by_user_id",
28         "owned_by_org_id": "owned_by_org_id",
29         "period_end_at_timestamp": "2024-01-15T09:30:00Z",
30         "period_start_at_timestamp": "2024-01-15T09:30:00Z",
31         "schema_version": 1
32       },
33       "invoice_line_item": {
34         "_id": "_id",
35         "created_at_timestamp": "2024-01-15T09:30:00Z",
36         "created_by_user_id": "created_by_user_id",
37         "currency_code": "USD",
38         "description": "description",
39         "invoice_type": "accounts_receivable",
40         "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
41         "last_edited_by_user_id": "last_edited_by_user_id",
42         "line_item_type": "base_rate",
43         "owned_by_org_id": "owned_by_org_id",
44         "quantity": 1.1,
45         "schema_version": 1,
46         "unit_price": 1.1
47       }
48     }
49   ],
50   "total_count": 1
51 }

Lists owner-scoped billing periods with generated line items and invoices. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (BillingPeriodListRes)

Authentication

AuthorizationBearer

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

Query parameters

sort_byenum or nullOptional

Field to sort by.

sort_orderenum or nullOptional

Sort order.

Allowed values:

pageinteger or nullOptional>=1Defaults to 1

page_sizeinteger or nullOptional1-100Defaults to 20

filter_statusesenum or nullOptional

Filter by one or more billing-period statuses.

Allowed values:

filter_invoice_typesenum or nullOptional

Filter by one or more invoice types.

Allowed values:

filter_currency_codesenum or nullOptional

Filter by one or more currency codes.

filter_counterparty_org_idstring or nullOptional

Filter by an on-CHRT counterparty organization.

filter_counterparty_off_chrt_org_data_idstring or nullOptional

Filter by an off-CHRT counterparty organization.

filter_counterparty_driver_idstring or nullOptional

Filter by a driver counterparty.

filter_shipper_account_idstring or nullOptional

Filter by an associated shipper account.

filter_task_group_idstring or nullOptional

Filter by an attributed TaskGroup.

filter_period_start_at_timestamp_gtedatetime or nullOptional

Filter by period start greater than or equal.

filter_period_start_at_timestamp_ltedatetime or nullOptional

Filter by period start less than or equal.

filter_period_end_at_timestamp_gtedatetime or nullOptional

Filter by period end greater than or equal.

filter_period_end_at_timestamp_ltedatetime or nullOptional

Filter by period end less than or equal.

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Billing Periods List V1request Unprocessable Entity Error