List

GET

/billing/billing_ledger_periods/list/v1

GET

/billing/billing_ledger_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.billing.billingLedgerPeriods.listV1({
8         sort_by: "period_end_at_timestamp",
9         sort_order: "asc",
10         page: 1,
11         page_size: 1,
12         filter_billing_ledger_id: "filter_billing_ledger_id",
13         filter_owned_by_org_id: "filter_owned_by_org_id",
14         filter_statement_id: "filter_statement_id",
15         filter_attached_to_statement: true,
16         filter_period_end_at_timestamp_before: "2024-01-15T09:30:00Z",
17         filter_period_end_at_timestamp_after: "2024-01-15T09:30:00Z",
18     });
19 }
20 main();

1 {
2   "items": [
3     {
4       "schema_version": 1,
5       "_id": "blp_1234567890abcdef",
6       "billing_ledger_id": "bl_9876543210fedcba",
7       "owned_by_org_id": "org_abc123def456",
8       "period_start_at_timestamp": "2024-01-01T00:00:00Z",
9       "period_end_at_timestamp": "2024-01-31T23:59:59Z",
10       "cycle": "monthly",
11       "rate_usd": 1500.75,
12       "opened_by_user_id": "user_12345abcde",
13       "opened_by_org_id": "org_abc123def456",
14       "opened_at_timestamp": "2024-01-01T08:00:00Z",
15       "payment_origin_org_id": "org_xyz789uvw123",
16       "payment_origin_off_chrt_shipper_org_id": "offchrt_shipper_001",
17       "payment_destination_org_id": "org_def456ghi789",
18       "payment_destination_off_chrt_provider_org_id": "offchrt_provider_002",
19       "payment_destination_driver_id": "driver_555aaa999",
20       "status": "open",
21       "closed_by_user_id": null,
22       "closed_by_org_id": null,
23       "closed_at_timestamp": null,
24       "linked_task_group_ids": [
25         "tg_0011223344"
26       ],
27       "statement_id": null
28     }
29   ],
30   "total_count": 1
31 }

Lists billing ledger periods the caller’s org owns or is a payment counterparty on. | authz_personas=[billing_ledger_period_org_operators] | () -> (BillingLedgerPeriodListRes)

Authentication

AuthorizationBearer

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

Query parameters

sort_byenumOptional

Field to sort by.

Allowed values:

sort_orderenumOptional

Sort order (asc or desc).

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

filter_billing_ledger_idstringOptional

Filter by parent billing ledger id.

filter_owned_by_org_idstringOptional

Filter by owner org id.

filter_statusenumOptional

Filter by status(es). Multi-select.

Allowed values:

filter_statement_idstringOptional

Filter to periods rolled into this statement.

filter_attached_to_statementbooleanOptional

Filter by whether the period is bundled into a statement (statement_id is not None if true, is None if false). Used by the statement-bundling worklist to find unbundled periods.

filter_period_end_at_timestamp_beforedatetimeOptional

Filter to periods whose period_end_at_timestamp is strictly before this instant. Combined with filter_status=open this yields the ‘needs cycling’ worklist.

filter_period_end_at_timestamp_afterdatetimeOptional

Filter to periods whose period_end_at_timestamp is strictly after this instant.

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Billing Ledger Periods List V1request Unprocessable Entity Error