Finance Utilities

In this article
Product Information
Release Notes

Technical guide - Web API Endpoint

The Web API endpoint connection allows files to processed against an external web service. This section provides details of how this can be consumed with two example, Web App and Function app.

Connection setup

The connection setup for Web API endpoint need to be specified here:

  • Cash and bank management > Setup > Advanced bank reconciliation setup > Financial utilities connections
    See guide for more details.
  • Accounts receivable > Setup > Finance utilities connections
    See guide for more details.
  • Organisation administration > Electronic reporting > Electronic reporting export connections
    See guide for more details.

Web API Types

Finance utilities can be configured to support different Web API types. The implementations available will be visible within a list accessible via the connections view. image

The list consists of the details of the Web API types implemented for processing data. image

Currently, the solution contains implementation for importing and exporting file. This has been configured to work for the following

  • Bank statement import. See guide
  • Customer remittance import. See guide
  • Accounts receivable save electronic report file to secure location. See guide.

File import/export processing

This section describes how to consume the web API connection types within an external web service using two examples, Function App and Web App.

Import file using Finance Utilities connections

The image describes an example implementation of an API endpoint to retrieve file for import which can be consumed via the Finance utitlities connection in FinOps. image

The image describes an example implementation of a function app. image

Export file using Finance Utilities connections

The image describes an example implementation of an API endpoint to retrieve the exported file received via the Finance utilities connections in FinOps. image

The image describes an example implementation of a function app. image

Note: The file passed a parameter called, file within FinOps when the ER file is exported. Please ensure that the external service extracts the file using the same parameter name as shown in the examples above.