ALalpacahq
Funding

Retrieve JIT Ledger Balances

Returns an array of objects that correspond to each ledger account.

get/v1/transfers/jit/{ledger_id}/balances

Request

  • Base URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets
  • URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets/v1/transfers/jit/{ledger_id}/balances
  • Auth
    HTTP basic

Path parameters

ledger_idstring required

Query parameters

start_datestring date

The start date (inclusive) of the ledgerbalances and activities.

end_datestring date

The end date (inclusive) of the ledgerbalances and activities.

Response

OK

activity_amountstring decimal

The number of transactions related to the ledger during the specified date range

ending_balancestring decimal

Ledger balance at the end of the date range

idstring

The ledger ID

ledger_namestring

The ledger name

ledger_nostring

The ledger account number

starting_balancestring decimal

Ledger balance at the beginning of the date range

Example response

{
  "transactions": [
    {
      "account_id": "06b9d76e-1733-460c-844e-48d1ae0f10c3",
      "account_name": "Just In Time Receivable - JITS",
      "account_no": "JTRJITS00",
      "amount": "1",
      "balance": "4186.36",
      "contra_account_name": "Just In Time Interest Income",
      "description": "debit balance = 4185.36, base_rate = 0.0375, spread = 0.05",
      "entry_type": "JNLC",
      "system_date": "2022-06-10"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.