Get by ID

GET

/billing/billing_ledger_periods/by_id/v1/:id

GET

/billing/billing_ledger_periods/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.billingLedgerPeriods.getByIdV1("id");
8 }
9 main();

1 {
2   "schema_version": 1,
3   "_id": "_id",
4   "billing_ledger_id": "billing_ledger_id",
5   "owned_by_org_id": "owned_by_org_id",
6   "period_start_at_timestamp": "2024-01-15T09:30:00Z",
7   "period_end_at_timestamp": "2024-01-15T09:30:00Z",
8   "cycle": "daily",
9   "rate_usd": 1.1,
10   "opened_by_user_id": "opened_by_user_id",
11   "opened_by_org_id": "opened_by_org_id",
12   "opened_at_timestamp": "2024-01-15T09:30:00Z",
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": "open",
19   "closed_by_user_id": "closed_by_user_id",
20   "closed_by_org_id": "closed_by_org_id",
21   "closed_at_timestamp": "2024-01-15T09:30:00Z",
22   "linked_task_group_ids": [
23     "linked_task_group_ids"
24   ],
25   "statement_id": "statement_id"
26 }

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

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

Successful Response

schema_versioninteger

_idstring

billing_ledger_idstring

owned_by_org_idstring

Must be a string starting with org_

period_start_at_timestampdatetime

period_end_at_timestampdatetime

cycleenum

rate_usddouble

opened_by_user_idstring

Must be a string starting with user_

opened_by_org_idstring

Must be a string starting with org_

opened_at_timestampdatetime

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

closed_by_user_idstring

Must be a string starting with user_

closed_by_org_idstring

Must be a string starting with org_

closed_at_timestampdatetime

linked_task_group_idslist of strings

statement_idstring

Errors

422

Billing Ledger Periods Get by ID V1request Unprocessable Entity Error