List

GET

/billing/billing_ledgers/list/v1

GET

/billing/billing_ledgers/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.billingLedgers.listV1({
8         sort_by: "created_at_timestamp",
9         sort_order: "asc",
10         page: 1,
11         page_size: 1,
12         filter_task_group_type: "chrt_ground_provider",
13         filter_payment_origin_org_id: "filter_payment_origin_org_id",
14         filter_payment_destination_org_id: "filter_payment_destination_org_id",
15     });
16 }
17 main();

1 {
2   "items": [
3     {
4       "schema_version": 1,
5       "_id": "_id",
6       "created_by_user_id": "created_by_user_id",
7       "created_by_org_id": "created_by_org_id",
8       "created_at_timestamp": "2024-01-15T09:30:00Z",
9       "owned_by_org_id": "owned_by_org_id",
10       "name": "name",
11       "task_group_type": "chrt_ground_provider",
12       "comments": "comments",
13       "payment_origin_org_id": "payment_origin_org_id",
14       "payment_origin_off_chrt_shipper_org_id": "payment_origin_off_chrt_shipper_org_id",
15       "payment_destination_org_id": "payment_destination_org_id",
16       "payment_destination_off_chrt_provider_org_id": "payment_destination_off_chrt_provider_org_id",
17       "payment_destination_driver_id": "payment_destination_driver_id",
18       "status": "active",
19       "inactive_at_timestamp": "2024-01-15T09:30:00Z"
20     }
21   ],
22   "total_count": 1
23 }

Lists billing ledgers the caller’s org owns or is a payment counterparty on. | authz_personas=[billing_ledger_org_operators] | () -> (BillingLedgerListRes)

Authentication

AuthorizationBearer

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

Query parameters

sort_by"created_at_timestamp"Optional

Field to sort by.

sort_orderenumOptional

Sort order (asc or desc).

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

filter_statusenumOptional

Filter by status(es). Multi-select.

Allowed values:

filter_task_group_typeenumOptional

Filter to ledgers scoped to this TaskGroup type. Omit to include both type-scoped and type-agnostic ledgers.

Allowed values:

filter_payment_origin_org_idstringOptional

Filter by payment origin on-chrt org id.

filter_payment_destination_org_idstringOptional

Filter by payment destination on-chrt org id.

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Billing Ledgers List V1request Unprocessable Entity Error