FinancialAccountModel
Less than to read
An Financial account refers to records of assets, liabilities, income, expenses, and equity.
Methods
The following API methods use this data model.
- Create Financial Account
- Retrieve Financial Account
- Update Financial Account
- Query Financial Accounts
Read-Only Fields
These fields are assigned by the API server and cannot be changed.
financialAccountId
uuid, read-only
The unique identifier for the Financial Account.
groupKey
uuid, read-only
The GroupKey uniquely identifies a single Sage Network account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created.
For more information, see Accounts and GroupKeys.
appEnrollmentId
uuid, nullable, read-only
The App Enrollment Id for the Financial Account.
created
date-time, read-only
The date the FinancialAccount was created.
createdUserId
uuid, read-only
The user that has created the Financial Account.
modified
date-time, read-only
The date the Financial Account was modified.
modifiedUserId
uuid, read-only
The user that has modified the Financial Account.
Optional Fields
code
string, nullable, 0-255 characters
The code for the Financial Account. Can either be a general ledger or an account code.
erpKey
string, nullable, 0-255 characters
The External Id for the Financial Account.
name
string, nullable, 0-100 characters
The name of the Financial Account.
status
string, nullable, 0-8 characters
The status of the Financial Account. Possible values are active, inactive, deleted or archived.
cashflowType
string, nullable, 0-25 characters
The cashflow type for the Financial Account. Examples include cash, financing, investment or operation.
description
string, nullable, 0-500 characters
The description for the Financial Account.
classification
string, nullable, 0-10 characters
The classification for the Financial Account. Possible values are Asset, Equity, Expense, Liability or Income.
category
string, nullable, 0-100 characters
The category for the Financial Account. Examples include Current Asset, Current Liability, Common Stock
subcategory
string, nullable, 0-100 characters
The subcategory for the Financial Account. Examples include Cash, Property, Bank Loan, etc.