Get an Account by ID - Bookeeping.ai Docs

GET

accounts

{id}

Get an Account by ID

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

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

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

The id of the account. Expected to be a valid object id like 666666666666666666666666

Response

Get an Account by ID executed successfully

message

string

Success message

metaData

object

Show child attributes

metaData.warnings

string[]

Any validation warnings

data

object

Show child attributes

data._id

string

required

The id of the account

data.projectId

string

required

The project id of the account

data.accountType

enum<string>

required

The type of the account

Available options:

Depository,

Credit,

Loan,

Investment,

Other

data.createdAt

string<date-time>

required

The created at of the account

data.updatedAt

string<date-time>

required

The updated at of the account

data.nickName

string | null

data.accountName

string | null

data.accountNumber

string | null

Delete an AccountDelete an Account

⌘I

Get an Account by ID

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

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

Routes

Authorizations

Path Parameters

Response