FinancialYearSettingModel
Less than to read
A Financial Year Setting is used to to set the type, beginning, end, and number of periods of a year used to calculate accounting reports. The financial setting can either be for a specific app enrollment id via a sync or, when the financial year setting is manually created, will cover all account data without an app enrollment id.
Methods
The following API methods use this data model.
- Retrieve Financial Year Setting
- Update Financial Year Setting
- Create Financial Year Setting
- Query Financial Year Settings
Read-Only Fields
These fields are assigned by the API server and cannot be changed.
financialYearSettingId
uuid, read-only
The unique ID of this record, automatically assigned by Sage Network when this record is added to the Sage Network.
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 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.
created
date-time, read-only
The date on which this financial year setting record was created.
createdUserId
uuid, read-only
The ID number of the user who created this financial year setting.
modified
date-time, read-only
The date on which this financial year setting record was last modified.
modifiedUserId
uuid, read-only
The ID number of the user who most recently modified this financial year setting.
Required Fields
totalPeriods
Total number of periods in the year. For Calendar year types this should always be 12. For Fiscal year types this can either be 12 or 13 for a 4 week 13 period year.
Optional Fields
yearType
string, nullable, 0-8 characters
The type of financial year, either Calendar or Fiscal.
startDate
date, nullable, 0-5 characters
The start date of the financial year. Should be entered in MM-DD format.
endDate
date, nullable, 0-5 characters
The end date of the financial year. Should be entered in MM-DD format.