Relaxed Validation for Closed Year Transactions

We are updating the AccountRight API validation rule for closed year transactions in AccountRight 2020.2 release. Any transaction in closed years can only be viewed or reversed (to be recorded in a none-closed year) via the AccountRight API in the current state.

There are times when an adjustment may be needed for closed years. We are offering more flexibility for the end-users, especially for accountants in order to allow such adjustments:

For new Essentials files created after 18/5/2020 and AccountRight files created in 2020.2 and later - you can create, reverse, edit and delete transactions in any year.
For new Essentials files created before 18/5/2020 and existing AccountRIght files in older version upgraded to 2020.2 - you can create, reverse, edit and delete transactions for the current and future years. For prior years you can only create and reverse transactions.

From the AccountRIght API perspective, this update will not result in any endpoint contract update but only relaxes validation. In order to record, update or delete a transaction from a closed year, the end-user need to be assigned the Transact In Closed Financial Years permission or marked as an Administrator user type for AccountRight or new Essentials:

Below table explains permission differences between AccountRight version before and after AccountRight 2020.2:


	AR 2020.1 or before		AR 2020.2 or later
Request Channel	Via AR & New Essentials UIs	Via AR API	Via AR & New Essentials UIs	Via AR API
Current or future financial years	Read, Record, Update, Reverse and Delete	GET, POST, PUT and DELETE	Read, Record, Update, Reverse and Delete	GET, POST, PUT and DELETE
Closed financial years	Read and Reverse	GET and POST	Read, Record, Update1, Reverse and Delete1	GET, POST, PUT1 and DELETE1

HTTP Request Outcome Matxtrix:

AccountRight 2020.2 API Condition Matrix
Action	Permission	Current Financial Year Record	Previous Financial Year Record	Error Code
GET	Yes	200 OK	200 OK
GET	No	200 OK	200 OK
PUT	Yes	200 OK	200 OK*1
PUT	No	200 OK	400 Bad Request	4226
POST	Yes	201 Created	201 Created
POST	No	201 Created	400 Bad Request	4226
DELETE	Yes	200 OK	200 OK*1
DELETE	No	200 OK	400 Bad Request	4226

*1 Only available for new Essentials files created after DATE and AccountRight files created in 2020.2.

Validation	If attempted to insert, update, delete for previous financial year record with role entitlement Transact In Closed Financial Years, will return validation warning To enable this warning validation append ?warningsAsErrors=true at the end of the request URL				{ "Name": "TransactionDateBeforeCurrentFinancialYearStart", "Message": "Making changes to a period you have already prepared reports for could have compliance implications", "Severity": "Warning" } OR { "Name": "DatePriorToBeginningOfFinancialYear", "Message": "Making changes to a period you have already prepared reports for could have compliance implications", "Severity": "Warning" }
	If attempted to insert, update, delete for previous financial year record without role entitlement Transact In Closed Financial Years, will hit new validation error				{ "Name": "ValidationError", "Message": "BusinessEvent_DateOccurred_BeforeFinancialYear_NoPermission", "ErrorCode": 4226, "Severity": "Error" }

IMPORTANT
Recording, updating or deleting a transaction from a closed year will potentially result in account balance updates, redoing reconciliation, etc. It is highly recommended to prepare a prompt before an end-user makes such an action.

In order to prepare a prompt, we would recommend you to call below endpoint:

/{cf_uri}/GeneralLedger/AccountingProperties
```
{
 "Items": [
 {
 "ConversionDate": "2015-07-01T00:00:00",
 "CurrentFinancialYear": 2020,
 "LastMonthFinancialYear": 6,
  .
  .
```
Confirm if the end-user entered transaction date is before current financial year. A transaction within or post currently financial year can be processed in the same manner, but if a transaction is to be recorded, updated or deleted before currently financial year, prompt for confirmation to action.

An example of warming prompt from AccountRight:

Articles in this section

Comments

Articles in this section

Related articles