Retrieve Account

GET 
/accounting/accounts/:id

Retrieve an Account with the given id.

Request

Path Parameters

id stringrequired

The ID of the account.

Query Parameters

credentialId stringrequired

The ID of the credential.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

account

object

remoteId string

accountName string

accountDescription

classification string

accountType string

accountStatus string

currentBalance

currency string

accountNumber

parentAccountId

companyId

id string

remoteDeleted boolean

Default value: true

createdAt string

updatedAt string

Example (from schema)

{
  "account": {
    "remoteId": "138",
    "accountName": "Internet & TV services",
    "accountDescription": {},
    "classification": "Expense",
    "accountType": "Expense",
    "accountStatus": "Active",
    "currentBalance": {},
    "currency": "USD",
    "accountNumber": {},
    "parentAccountId": {},
    "companyId": {},
    "id": "00000000-0000-0000-0000-000000000000",
    "remoteDeleted": false,
    "createdAt": "2024-02-22T11:12:54.946Z",
    "updatedAt": "2024-02-22T13:46:05.011Z"
  }
}

Result

{
  "account": {
    "remoteId": "138",
    "accountName": "Internet & TV services",
    "accountDescription": null,
    "classification": "Expense",
    "accountType": "Expense",
    "accountStatus": "Active",
    "currentBalance": null,
    "currency": "USD",
    "accountNumber": null,
    "parentAccountId": null,
    "companyId": null,
    "id": "00000000-0000-0000-0000-000000000000",
    "remoteDeleted": false,
    "createdAt": "2024-02-22T11:12:54.946Z",
    "updatedAt": "2024-02-22T13:46:05.011Z"
  }
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...