Accounts

Data Model

Field	Type	Description	Nullable?
id	string	account identifier	false
name	string	account name	false
type	string	account type	false
subtype	string	account subtype	false
current_balance	number	account's current balance	false
currency	string	account's default currency	false
limit	number	the acount's credit limit (if applicable)	true
is_hidden	boolean	indicates if the account's balance and transactions are included in budget calculations	false
mask	string	The last 2-4 characters of the account's account number	false

Get Accounts

GET https://api.omnimoney.app/v1/accounts

Headers

Name	Type	Description
Authentication	string	Bearer ACCESS_TOKEN

200 Accounts successfully retrieved.

{
    "accounts": [
        {
            "id": "a8da8742-07hs-412c-84c1-472e4cf1e226",
            "name": "Main Checking Account",
            "type": "depository",
            "subtype": "checking",
            "current_balance": 250,
            "currency": "USD",
            "limit": null,
            "is_hidden": false,
            "mask": "1234"
        },
        ...
    ]
}

Get Account

GET https://api.omnimoney.app/v1/accounts/:account_id

Path Parameters

Name	Type	Description
account_id	string	The account's identifier

Headers

Name	Type	Description
Authentication	string	Bearer ACCESS_TOKEN

200

{
    "account": {
        "id": "a8da8742-07hs-412c-84c1-472e4cf1e226",
        "name": "Main Checking Account",
        "type": "depository",
        "subtype": "checking",
        "current_balance": 250,
        "currency": "USD",
        "limit": null,
        "is_hidden": false,
        "mask": "1234"
    }
}

401 Response when the given access token does not have permission to view the account

404 Response when there's no account with the given identifier

Update Account

PUT https://api.omnimoney.app/v1/accounts/:account_id

Path Parameters

Name	Type	Description
account_id	string	The account's identifier

Headers

Name	Type	Description
Authentication	string	Bearer ACCESS_TOKEN

Request Body

Name	Type	Description
fields	object	An object with the fields and updated values. The account fields that are available for updating are: name (string) current_balance (number)* currency (string)* limit (number)* is_hidden (boolean) mask (string) *Cannot be updated for synced accounts

200

{
    "account": {
        "id": "a8da8742-07hs-412c-84c1-472e4cf1e226",
        "name": "New Name",
        "type": "depository",
        "subtype": "checking",
        "current_balance": 500,
        "currency": "USD",
        "limit": null,
        "is_hidden": false,
        "mask": "1234"
    }
}

400 Response when the request is invalid. Responses could be

401 Response when the given access token does not have permission to update the account

404 Response when there's no account with the given identifier

Here's an example of the request body

{
    "fields": {
        "name": "New Name",
        "current_balance": 500
    }
}