As announced in the Account Code Changes Coming Soon article, we are in the process of standardizing the data structures across our products to offer simplified processes. This change, however, is intended as preparation for our future improvement, and there is no direct impact to AccountRight users at this stage.
‘DisplayID’ property in the GeneralLedger/Account endpoint now supports alpha-numeric values as well as a numeric format when ‘UseAlphaAccountIdentifier’ Boolean property is marked as true in the Company/Preferences endpoint.
Currently, this Boolean property is Read-only and marked as false by default in AccountRight files. More details on this property can be found in the Account Code Changes Coming Soon article.
Moving forward, when POSTing or PUTing Accounts you will need to use the `DisplayID` property over the `Number` field to set the Account Number.
The Number field will eventually be removed but will remain during a transition period to help you make the necessary changes to your code.
To help you get a better understanding of what will happen when POSTing/PUTing using the GeneralLedger/Account endpoint, we have created a table below (GET and DELETE requests will not be affected):
|
|
Parameters in request |
|||
|
Request Type |
Number: Yes DisplayID: No UseAlphaAccountIdentifier: False |
Number: Yes DisplayID: Yes UseAlphaAccountIdentifier: False |
Number: Yes DisplayID: Yes UseAlphaAccountIdentifier: False |
Number: Yes DisplayID: No UseAlphaAccountIdentifier: False |
|
POST/PUT
|
2XX – OK We will create the Identifier value based on <Classification>-<Number>
|
2XX – OK We will use the DisplayId as source of truth and ignore the Number If DisplayID is not the same as formatting <Classification>-<Number> |
2XX – OK We will use the DisplayId as source of truth and ignore the Number
|
4XX – Error DisplayID must be supplied
|
|
Validation |
· Must be a 4 digit number · Must be unique within the Account Classification |
· Prefix number will be validated against valid Classification type · Prefix type must be same as Classification type of the Account · Digits after dash need to be 4 numeric characters · Must be unique within the Account Classification type |
· 10 alphanumeric characters |
|
|
|
Parameters in request | ||||
|
Request |
ParentAccount: null UseAlphaAccountIdentifier: False |
ParentAccount: null UseAlphaAccountIdentifier: False |
ParentAccount.UUID:null UseAlphaAccountIdentifier: False |
ParentAccount.UUID:invalid UseAlphaAccountIdentifier: False |
ParentAccount.UUID:valid UseAlphaAccountIdentifier: False |
|
POST/PUT |
2XX - OK |
4XX – Error ParentAccount must be supplied |
4XX – Error ParentAccount.UUID must be supplied |
4XX – Error |
2XX - OK |
|
Validation |
· No additional validation |
· Parent account must exist · Parent account must be of the same Classification · Parent account must be a header |
|
||
Comments
0 comments
Article is closed for comments.