AccountsIQ SOAP API Update Bulletin (24 02 2022) - accountsIQ/API-Wiki GitHub Wiki
Welcome to the API update bulletin!
You are receiving this as a registered user on our API who has opted in during your initial setup. This bulletin will notify you of any changes, additions and bug fixes made to the API in general.
These changes should not affect existing integrations. An update will only be required if you wish to take advantage of the new methods or fields added, unless otherwise stated.
Please refer to the API wiki for more details on the API, and contact us if you require a Postman Collection to be sent to you.
Changes are:
New API method
Status: Released Type: Enhancement
Following feedback from various API users, we are now providing a method to return individual allocations for a transaction. One popular example would be to figure out when an invoice was paid, for example. The new GetAllocationsByTransactionId method retrieves a list of allocations linked to a specific transaction based on its unique transaction ID.
Examples: Get when an invoice was first paid. Get when an invoice was fully paid. Get the list of invoice transaction IDs and match partial allocation amounts that a payment is offsetting.
New field added to WSAllocationEntryDTO
Status: Released Type: Enhancement
AllocationId has been added to WSAllocationEntryDTO class to help better identify allocations that are returned in a list.
Examples: This is useful when methods like GetAllocationsForTransactionsCreatedBetween or GetAllocationsBetween are used and there are many allocations to view, but you may need to track down a specific allocation. Previously, the only way to do that was by date but now you can use the ID.
New fields added to Invoice and Order
Status: Released Type: Enhancement
ExternalApproverName, AuthorUserName and ApprovalStatusName has been added to Invoice and Order
Examples: This will help identify approval user information and the current status of the invoice or order. Any method returning an invoice or an order will have these fields added.
Ensure that a GL Account exists when trying to save invoice lines on Create Batch Purchases or Create Batch Sales web methods.
Examples: The error before was generic and non-descriptive. It will now return a message similar to this: GL Account {example GL Account} does not exist. The ErrorCode and Status field will not change, only the error message.
Ensure that a GL Account on invoice lines are not of type control on Create Batch Purchases or Create Batch Sales web methods.
Examples: The error before was generic and non-descriptive. It will now return a message similar to this: Lines with GL account control type cannot be used. The GL control accounts are {example control GL Account}.
Examples: The error before was generic and non-descriptive. It will now return a message similar to this: Purchases/Sales {example account code} does not exist. The ErrorCode and Status field will not change, only the error message.
Validation Added For GL Account Type on Journal when Posting Journals
Status: Released Type: Enhancement
Ensure that a journals line GL Account exists when trying to post a journal.
Examples: The error before was generic and non-descriptive. It will now return a message similar to this: Lines with GL account control type cannot be used. The GL control accounts are {example control GL Account}. The ErrorCode and Status field will not change, only the error message.