integrations

Test whether the integration connection is successful

Requires the INTEGRATION.VIEW permission.

post/v{version}/integrations/test-connection

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/integrations/test-connection
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

Query parameters

integration_typestring

The type of integration to test the connection for

e_invoicing_processorstring

The processor to connect with when testing an eInvoicing integration

tax_calculation_variantstring

The variant to connect with when testing a tax calculation integration

Headers

x-platform-idstring

Platform ID.

Request body

Response

OK

successfulboolean nullable
messagestring nullable
status'DRAFT' | 'PENDING' | 'TESTING' | 'ACTIVE' | 'ERROR' | 'DEPRECATED' | 'ARCHIVED'

The status the integration should be created with as a result of this test, if it differs from the default.

Changes

No recorded changes to this operation across all 1 revision of this API.