Enter your credentials to Maventa testing environment, to authenticate and try things out with the Swagger UI. This will fetch a Bearer token using OAuth2 with the endpoint POST https://ax-stage.maventa.com/oauth2/token. The token is stored in your browser's session storage (cleared when you close the tab) and used in Swagger calls done from this documentation website. The token is valid for 1 hour.

Never use your production credentials here. This is only for testing the Maventa test environment in the Swagger UI.
All None
eui global company lookup document:receive document:send invoice:receive invoice:send company:read company:write validate receivables:assignments analysis billing:reports partner:invoice_delivery_actions partner:lookups partner:takeovers partner:lyanthe_scan_service fi_bank_message:send fi_bank_message:receive
Cancel Sign In
Search
Debt collection and reminder services Amili Kassavirta Amili Perintä Other Mass Printing Service Detect Supplier Activation Maventa Connector Embeddable User Interface

Detect

Detect is an automated checking service for suppliers and purchase invoices. Detect checks and notifications aim to support companies in supplier management, automating invoice handling, spotting potential fraud attempts as well as in general preventing mistakes in payments and bookings. The service is integrated as part of invoice receiving, so the notifications can be shown to the company always in the right context.

Currently the following checks are available in the service

Check descriptions

Check descriptions

Close

How does Detect service work

Detect is integrated as part of incoming invoice handling over the REST API.

Integration requirements

Process

  1. Activate Detect PATCH/v1/services/detect/checks
  2. Fetch results GET /v1/invoices/{id}/detect_results
  3. Present results

Contractual requirements

Building the integration

Detect uses the AutoXchange API (REST)

Authentication

General instructions for REST API authentication are explained at REST API: Authentication

For Detect, authenticate as a company and select the authentication scope analysis.

Example flow - activation & usage

1. Service activation

To take the service into use for company, user activates the checks they want to start using. Note that before activating the service the user needs to be shown and accept the General service disclaimer.

DO:

  1. Show user the General service disclaimer.

  2. Show available checks and their descriptions

    • Use GET/v1/definitions/detect/checks endpoint to see the available checks and information related to them
      • all the information e.g. what registers are used for which checks are available over this endpoint.
  3. Activate the checks for a company

    • Use PATCH/v1/services/detect/checks to activate checks
      • Give the checks you want to activate (array of strings) for the specific company
      • After you receive status `OK, the checks have been successfully activated. From now on these checks will be automatically triggered for the company’s incoming invoices
    • Use GET/v1/services/detect/checks to return the detect settings and see which checks are activated.

Example check activation in user interface

Checks activation

Checks activation

Close

2. Checks are run on incoming invoices

After activation all company’s incoming invoices are automatically checked. When running the checks is ready, the invoice is released to customer’s inbox and check results are made available over the REST API.

Invoice and the attachments are downloaded as usual (see invoice receiving). Detect check results are downloaded with an own API call.

DO:

Fetch the check results from Maventa

Fetch results

Fetch results

Close

3. Notifications are displayed to user

After check results are fetched, relevant notifications are shown to user.

If something is spotted on the invoice, this is shown to user by notification message as part of handling the incoming invoices.

DO:

Example result visualisation in user interface

detect check results

detect check results

Close

4. Check/service closing

Same method that is used to activate the checks is used to deactivate them:

Closing the service happens by deactivating all the checks.

General Disclaimer

Visma does not warrant that the customers use of the check services will be uninterrupted or error-free, or that the service and/or the information obtained by the customer through the Services will meet the customers requirements. The customer acknowledges and agrees that the check services will evolve over time and that functionality may be added and removed from time to time.

The customer assumes sole responsibility for results obtained from the use of the check services and for conclusions drawn from them. Visma shall have no liability for any damage caused by errors or omissions in any information, instructions, warnings or flags provided to the customer in connection with the check services, or the customer’s actions or non-actions in response to such information.

Back to top