Retrieve Account Information Via account_id

Specifications

Request


JSON PATHDescriptionExampleFormatRequired
account_idThe Identifier associated to Accountfcd0cecb-90dd-4ae2-879f-d0eda6fbddd4UUIDYes

Response


JSON PATHDescriptionExampleFormatRequired
account_idThe Identifier associated to Accountfcd0cecb-90dd-4ae2-879f-d0eda6fbddd4UUIDYes
account_profile_idThe Identifier of the Account Profile the Account is associated with84b1625e-f6d4-4d05-8b10-9d84ea42d292UUIDYes
main_account_idReturned if the the account_id is linked to a Main Accountc2c0e2a3-b1e4-44d1-9c37-5ec424e217e5UUIDNo
account_nameThe name of the Account if required. If provided, CLOWD9 will include this value in Account Reports and Vista displaysCLOWD9 ExpensesstringNo
external_idAn Identifier held on yours or a third party system018794671stringNo
account_statusThe status of the AccountactivestringNo
account_currency_codeThe Numeric currency code826stringYes
account_currencyThe Alpha (2-3) currency codeGBPstringYes
account_typeThe type of Account. Single or Multi currencysinglestringYes
account_balanceThe total balance of the account. This is not the amount that can be spent. A minus figure indicates a debit balance1000stringYes
available_account_balanceThe value that is available to be spent. A minus figure indicates a debit balance900stringYes
pending_authorized_amountThe total amount of authorized spend if applicable100stringYes
overdraft_valueThe agreed value of the Overdraft. This does not identify the value of the Overdraft used500stringYes
trace_idThe Identifier associated with the API15bfc289-de75-4668-bb11-3998aadf226dstringYes

Example

{
    "account_profile_id": "84b1625e-f6d4-4d05-8b10-9d84ea42d292",
    "account_id": "fcd0cecb-90dd-4ae2-879f-d0eda6fbddd4",  
    "main_account_id": "c2c0e2a3-b1e4-44d1-9c37-5ec424e217e5",       
    "account_name": "CLOWD9 Expenses",      
    "external_id": "018794671",  
    "account_currency_code": "826",
    "account_currency": "GBP",
    "account_type": "single",
    "account_balance": "1000",
    "avalible_account_balance": "100",
    "pending_authorized_amount": "900",
    "overdraft_value": "500",
    "trace_id": "15bfc289-de75-4668-bb11-3998aadf226d"
}