Get by ID

GET

/billing/billing_ledgers/by_id/v1/:id

GET

/billing/billing_ledgers/by_id/v1/: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.billing.billingLedgers.getByIdV1("id");
8 }
9 main();

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

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

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

Successful Response

schema_versioninteger

_idstring

created_by_user_idstring

Must be a string starting with user_

created_by_org_idstring

Must be a string starting with org_

created_at_timestampdatetime

owned_by_org_idstring

Must be a string starting with org_

namestring<=512 characters

task_group_typeenum

commentsstring<=524288 characters

payment_origin_org_idstring

Must be a string starting with org_

payment_origin_off_chrt_shipper_org_idstring

payment_destination_org_idstring

Must be a string starting with org_

payment_destination_off_chrt_provider_org_idstring

payment_destination_driver_idstring

statusenum

inactive_at_timestampdatetime

Errors

422

Billing Ledgers Get by ID V1request Unprocessable Entity Error