integrations

Create an integration

Requires the INTEGRATION.CREATE permission.

post/v{version}/integrations

Request

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

Path parameters

versionstring required

version

Headers

x-platform-idstring

Platform ID.

Request body

object_typestring nullable
idstring nullable
referencestring required

A custom reference assigned to the integration.

namestring

A custom name assigned to the integration.

descriptionstring
status'DRAFT' | 'PENDING' | 'TESTING' | 'ACTIVE' | 'ERROR' | 'DEPRECATED' | 'ARCHIVED'

The status of the integration.

messagestring nullable

The message associated with the status of the integration.

type'PAYMENT_GATEWAY' | 'E_INVOICING' | 'TAX_CALCULATION' | 'DATA_EXPORT' | 'EMAIL_PROVIDER' | 'ERP' required

The type of integration.

variant'DEFAULT' | 'PARAGON_MULTI_ACCOUNT'

The variant of the integration.

Response

Created

object_typestring nullable
idstring nullable
referencestring

A custom reference assigned to the integration.

namestring

A custom name assigned to the integration.

descriptionstring
status'DRAFT' | 'PENDING' | 'TESTING' | 'ACTIVE' | 'ERROR' | 'DEPRECATED' | 'ARCHIVED'

The status of the integration.

messagestring nullable

The message associated with the status of the integration.

type'PAYMENT_GATEWAY' | 'E_INVOICING' | 'TAX_CALCULATION' | 'DATA_EXPORT' | 'EMAIL_PROVIDER' | 'ERP'

The type of integration.

variant'DEFAULT' | 'PARAGON_MULTI_ACCOUNT'

The variant of the integration.

Changes

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