FinancialAccountBalanceHistoryModel

Represents a balance for a financial account for a given period of time.

Methods

The following API methods use this data model.

• Retrieve Balance History
• Update Balance History
• Create Balance History
• Query Balance History

Read-Only Fields

These fields are assigned by the API server and cannot be changed.

financialAccountBalanceHistoryId

uuid, read-only

The unique ID of this record, automatically assigned by Lockstep when this record is
added to the Lockstep platform.

groupKey

uuid, read-only

The GroupKey uniquely identifies a single Lockstep Platform 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 AppEnrollmentId of the application that imported this record. For accounts
with more than one financial system connected, this field identifies the originating
financial system that produced this record. This value is null if this record
was not loaded from an external ERP or financial system.

balanceTypeName

string, nullable, read-only

The name of the BalanceType for this record.

created

date-time, read-only

The date on which this financial account balance history record was created.

createdUserId

uuid, read-only

The ID number of the user who created this financial account balance history.

modified

date-time, read-only

The date on which this financial account balance history record was modified.

modifiedUserId

uuid, read-only

The ID number of the user who most recently modified this financial account balance history.

Required Fields

financialAccountId

uuid, min 1 characters

The id of the Financial Account that this balance history is for.

financialYear

int32

The financial year that this period falls under

periodNumber

int32

The period number (1-12 or 1-13) that this balance history is for

periodStartDate

date-time

The start date of this period.

periodEndDate

date-time

The end date of this period.

balance

double

The current or end balance of this period.

balanceType

FinancialAccountBalanceType

Financial Account Balance Types

Optional Fields

status

string, nullable

The status of this period. The status should be Closed if the books for this period have been closed,
if not the status should be Open. The status can also be Deleted if there was a recalculation that needed
to occur, for example due to a change in financial year settings.