Get by ID

GET

/billing/billing_ledger_periods/by_id/v1/:id

GET

/billing/billing_ledger_periods/by_id/v1/:id

1 const url = 'https://localhost:8000/billing/billing_ledger_periods/by_id/v1/id';
2 const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
3 
4 try {
5   const response = await fetch(url, options);
6   const data = await response.json();
7   console.log(data);
8 } catch (error) {
9   console.error(error);
10 }

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

_idstring

billing_ledger_idstring

cycleenum

opened_at_timestampdatetime

opened_by_org_idstring

Must be a string starting with org_

opened_by_user_idstring

Must be a string starting with user_

owned_by_org_idstring

Must be a string starting with org_

period_end_at_timestampdatetime

period_start_at_timestampdatetime

rate_usddouble

schema_versioninteger

closed_at_timestampdatetimeOptional

closed_by_org_idstringOptional

Must be a string starting with org_

closed_by_user_idstringOptional

Must be a string starting with user_

linked_task_group_idslist of stringsOptional

payment_destination_driver_idstringOptional

payment_destination_off_chrt_provider_org_data_idstringOptional

payment_destination_org_idstringOptional

Must be a string starting with org_

payment_origin_off_chrt_shipper_org_data_idstringOptional

payment_origin_org_idstringOptional

Must be a string starting with org_

statement_idstringOptional

statusenumOptional

Errors

422

Billing Ledger Periods Get by ID V1request Unprocessable Entity Error