AccountsIQ SOAP API Update Bulletin (04 07 2023) - 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:

  • Added new field - Revised budget to GetTrialBalanceForPeriod

    Status: Released Type: Enhancement

    GetTrialBalanceForPeriod API method returns WSBalance, this will now include OverallRevisedBudgetPeriodMovement and OverallRevisedBudgetBalance. WSBalance also includes a object called WSDepartmentBalance that now also includes OverallRevisedBudgetPeriodMovement and OverallRevisedBudgetBalance per department

    Note: The need to see revised budget was requested from one of our customers to match watch they were seeing on the front end.

  • Update Field requirement - Allow the external reference to be empty

    Status: Released Type: Enhancement

    You will not be required to provide the external reference in the Order object, when calling SaveOrder and SaveOrderGetBackOrderID

    Note: There was some confusion with one of our integrators as the front-end allows the field to be empty but the API was not allowing this.

  • Added new query filter to GetOrdersBy: FromLastModifiedDateInUTC

    Status: Released Type: Enhancement

    GetOrdersBy parameter WSGetInvoicesByQuery will now accept FromLastModifiedDateInUTC as a filter, allowing you to easily only get orders that have changed on/after the date specified.

    Example: You need to retrieve only the orders that have changed and ignore records that are unmodified after a certain date. You can pass this new filter FromLastModifiedDateInUTC and only get back the orders which have changed on/after the specified date.

  • Added new field - OrderNumber to GetOrdersBy and GetOrdersByPaged

    Status: Released Type: Enhancement

    GetOrdersBy and GetOrdersByPaged will now return OrderNumber in WSGetOrdersByQuery

    Note: When getting orders you can now read the order number directly. This may be useful to match or sort the orders, and to store it locally for further reference. Note that this field is not immutable.

  • Added new field - LastReconciledDate to GetBankAccountBalance

    Status: Released Type: Enhancement

    GetBankAccountBalance will now return the Last reconciled date.

    Note: The field will contain the latest date where a user has reconciled the bank transaction against bank statement in the system.

  • New Method added - GetInvoicePDFByTransactionIDAndReportStyleName

    Status: Released Type: Enhancement

    GetInvoicePDFByTransactionIDAndReportStyleName will allow you to get invoice PDF with a style of your choice

    Note: The style of the report can be changed if a different one is required.

  • New Method added - GetReportStyles

    Status: Released Type: Enhancement

    GetReportStyles will return a list of reports with their name and a list of styles for each report and each style will designate if they are the default style for that report.

    Note: This method is used to complement the GetInvoicePDFByTransactionIDAndReportStyleName method, as this method requires a style name that exists as a parameter.

For any questions, feedback or if you wish to unsubscribe from this mailing list, please email us at [email protected]

® 2023 AccountsIQ, Integration Team

⚠️ **GitHub.com Fallback** ⚠️