Ledger
Retrieve a Ledger
API Overview
Authentication
Journal Entry
Ledger
Reports
Ledger
Retrieve a Ledger
GET
/
v0
/
business
/
{business_id}
/
ledger
/
{ledger_id}
curl --request GET \
--url https://api.sandbox.getasset.com/v0/business/{business_id}/ledger/{ledger_id} \
--header 'Authorization: Bearer <token>'{
"data": {
"name": "<string>",
"type": "asset",
"subtype": "current_asset",
"financial_account_type": "bank_account",
"debit_credit": "debit",
"sort_code": "<string>",
"editable": true,
"report_cash_flow": true,
"parent_id": "<string>",
"id": "<string>",
"business_id": "<string>"
}
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Response
200
application/json
Successful Response
The name of the ledger
Maximum length:
255The ledger type
Available options:
asset, liability, equity, revenue, expense The ledger subtype
Available options:
current_asset, fixed_asset, other_asset, uncategorized_asset, current_liability, long_term_liability, operating_revenue, other_inflow, cost_of_goods_sold, operating_expense, other_outflow, contribution, distribution, common_stock, preferred_stock, additional_capital, opening_balance, retained_earnings Indicates if the ledger is a debit or credit ledger
Available options:
debit, credit Whether lines can be manually added or removed from the Ledger
Whether the ledger is included in the cash flow report
The ID of the Ledger
The ID of the Business that is associated with the Ledger
Used for ledgers that are connected to real-world financial accounts
Available options:
bank_account, credit_card, prepaid_card, payments, payroll, loan, accounts_receivable, accounts_payable Used for grouping and sorting ledgers in reports
It indicates if this is a child ledger of another ledger in the chart of accounts.
curl --request GET \
--url https://api.sandbox.getasset.com/v0/business/{business_id}/ledger/{ledger_id} \
--header 'Authorization: Bearer <token>'{
"data": {
"name": "<string>",
"type": "asset",
"subtype": "current_asset",
"financial_account_type": "bank_account",
"debit_credit": "debit",
"sort_code": "<string>",
"editable": true,
"report_cash_flow": true,
"parent_id": "<string>",
"id": "<string>",
"business_id": "<string>"
}
}