Get Accounts - Bookeeping.ai Docs

GET

accounts

Get Accounts

curl --request GET \
  --url https://api.bookeeping.ai/public-api/v1/accounts \
  --header 'Authorization: Bearer <token>'

{
  "message": "<string>",
  "metaData": {
    "warnings": [
      "<string>"
    ]
  },
  "data": {
    "accounts": [
      {
        "_id": "<string>",
        "projectId": "<string>",
        "accountType": "Depository",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "nickName": "<string>",
        "accountName": "<string>",
        "accountNumber": "<string>"
      }
    ],
    "count": 123
  }
}

Authorizations

Authorization

string

header

required

API key for authentication. Get your key from the Dashboard > Settings > API Access.

Query Parameters

page

string

The page number 1 - n

limit

string

The number of items per page. Max is 250. Default is 10.

sortKey

enum<string>

The key to sort the items by. Default is _id.

Available options:

_id,

name,

createdAt,

updatedAt,

transactionDate

sortOrder

enum<string>

The order to sort the items by. Default is 1. -1 for descending. 1 for ascending.

Available options:

1,

-1

query

string

Response

Get Accounts executed successfully

message

string

Success message

metaData

object

Show child attributes

metaData.warnings

string[]

Any validation warnings

data

object

Show child attributes

data.accounts

object[]

required

The accounts

Show child attributes

data.accounts._id

string

required

The id of the account

data.accounts.projectId

string

required

The project id of the account

data.accounts.accountType

enum<string>

required

The type of the account

Available options:

Depository,

Credit,

Loan,

Investment,

Other

data.accounts.createdAt

string<date-time>

required

The created at of the account

data.accounts.updatedAt

string<date-time>

required

The updated at of the account

data.accounts.nickName

string | null

data.accounts.accountName

string | null

data.accounts.accountNumber

string | null

data.count

number

required

The count of the accounts

Get an Account by IDGet an Account by ID

⌘I

Get Accounts

curl --request GET \
  --url https://api.bookeeping.ai/public-api/v1/accounts \
  --header 'Authorization: Bearer <token>'

{
  "message": "<string>",
  "metaData": {
    "warnings": [
      "<string>"
    ]
  },
  "data": {
    "accounts": [
      {
        "_id": "<string>",
        "projectId": "<string>",
        "accountType": "Depository",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "nickName": "<string>",
        "accountName": "<string>",
        "accountNumber": "<string>"
      }
    ],
    "count": 123
  }
}

Routes

Authorizations

Query Parameters

Response