Retrieve a Ledger

Retrieve a Ledger

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",
    "debit_credit": "debit",
    "report_cash_flow": true,
    "id": "<string>",
    "business_id": "<string>",
    "financial_account_type": "bank_account",
    "sort_code": "<string>",
    "parent_id": "<string>"
  }
}

GET

business

{business_id}

ledger

{ledger_id}

Retrieve a Ledger

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",
    "debit_credit": "debit",
    "report_cash_flow": true,
    "id": "<string>",
    "business_id": "<string>",
    "financial_account_type": "bank_account",
    "sort_code": "<string>",
    "parent_id": "<string>"
  }
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

business_id

string<biz_string>

required

ledger_id

string<ldg_string>

required

Response

Successful Response

data

LedgerPublic · object

required

Show child attributes

data.name

string

required

The name of the ledger

Maximum string length: 255

data.type

enum<string>

required

The ledger type

Available options:

asset,

liability,

equity,

revenue,

expense

data.subtype

enum<string>

required

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,

memo

data.debit_credit

enum<string>

required

Indicates if the ledger is a debit or credit ledger

Available options:

debit,

credit

data.report_cash_flow

boolean

required

Whether the ledger is included in the cash flow report

data.id

string<ldg_string>

required

The ID of the Ledger

data.business_id

string<biz_string>

required

The ID of the Business that is associated with the Ledger

data.financial_account_type

enum<string> | null

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

data.sort_code

string | null

Used for grouping and sorting ledgers in reports

data.parent_id

string<ldg_string> | null

It indicates if this is a child ledger of another ledger in the chart of accounts.

Create a Ledger Delete a Ledger

⌘I

API Overview

Authentication

Business

Journal Entry

Ledger

Reports

Transaction

Invoice

Bill

Request

Document

Webhooks

Authorizations

Path Parameters

Response