Solvimon integrations API
The integrations API from Solvimon — 7 operation(s) for integrations.
The integrations API from Solvimon — 7 operation(s) for integrations.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/solvimon-integrations-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
title: Configuration alertRules Integrations API
version: 1.0.0
servers:
- url: https://test.api.solvimon.com
description: The TEST environment for our API
- url: https://api.solvimon.com
description: The live environment for our API
tags:
- name: integrations
paths:
/v{version}/integrations:
get:
operationId: getIntegrations
summary: Get a list of integrations
description: Requires the INTEGRATION.VIEW permission.
tags:
- integrations
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: limit
in: query
description: The amount of records shown in the list
required: false
schema:
type: integer
- name: page
in: query
description: The page which is going to be shown
required: false
schema:
type: integer
- name: order_by
in: query
description: The parameter by which the response is ordered.
required: false
schema:
type: string
- name: order_direction
in: query
description: The order direction by which the response is ordered.
required: false
schema:
type: string
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationResponseWrapper'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
post:
operationId: postIntegrations
summary: Create an integration
description: Requires the INTEGRATION.CREATE permission.
tags:
- integrations
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Integration'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationCreateRequest'
/v{version}/integrations/e-invoicing/default-mandates:
get:
operationId: getIntegrationsEInvoicingDefaultMandates
summary: Get a list of mandates
description: Requires the INTEGRATION.VIEW permission.
tags:
- integrations
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: limit
in: query
description: The amount of records shown in the list
required: false
schema:
type: integer
- name: page
in: query
description: The page which is going to be shown
required: false
schema:
type: integer
- name: order_by
in: query
description: The parameter by which the response is ordered.
required: false
schema:
type: string
- name: order_direction
in: query
description: The order direction by which the response is ordered.
required: false
schema:
type: string
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/EInvoicingMandate'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/v{version}/integrations/test-connection:
post:
operationId: postIntegrationsTestConnection
summary: Test whether the integration connection is successful
description: Requires the INTEGRATION.VIEW permission.
tags:
- integrations
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: integration_type
in: query
description: The type of integration to test the connection for
required: false
schema:
type: string
- name: e_invoicing_processor
in: query
description: The processor to connect with when testing an eInvoicing integration
required: false
schema:
type: string
- name: tax_calculation_variant
in: query
description: The variant to connect with when testing a tax calculation integration
required: false
schema:
type: string
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TestConnectionResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationSettingsCreateRequest'
/v{version}/integrations/{resourceId}:
get:
operationId: getIntegrationsByResourceId
summary: Get an integration by its ID
description: Requires the INTEGRATION.VIEW permission.
tags:
- integrations
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource to be requested.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Integration'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
delete:
operationId: deleteIntegrationsByResourceId
summary: Deleting an integration by its ID
description: Requires the INTEGRATION.DELETE permission.
tags:
- integrations
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource to be requested.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Integration'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
patch:
operationId: patchIntegrationsByResourceId
summary: Update an integration by its ID
description: Requires the INTEGRATION.UPDATE permission.
tags:
- integrations
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource to be requested.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Integration'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationUpdateRequest'
/v{version}/integrations/{resourceId}/deprecate:
post:
operationId: postIntegrationsByResourceIdDeprecate
summary: Deprecate an integration
description: Requires the INTEGRATION.UPDATE permission.
tags:
- integrations
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource for which the action is posted.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Integration'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/v{version}/integrations/{resourceId}/activate:
post:
operationId: postIntegrationsByResourceIdActivate
summary: Activate an integration
description: Requires the INTEGRATION.UPDATE permission.
tags:
- integrations
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource for which the action is posted.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Integration'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/v{version}/integrations/{resourceId}/archive:
post:
operationId: postIntegrationsByResourceIdArchive
summary: Archive an integration
description: Requires the INTEGRATION.UPDATE permission.
tags:
- integrations
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource for which the action is posted.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Integration'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
components:
schemas:
IntegrationLinkedResourceConfigurationCreateRequest:
type: object
properties:
resource_type:
type: string
link_details:
type: array
items:
$ref: '#/components/schemas/IntegrationLinkDetail'
title: IntegrationLinkedResourceConfigurationCreateRequest
EInvoicingIntegrationProcessor:
type: string
enum:
- AVALARA
title: EInvoicingIntegrationProcessor
ApiError:
type: object
properties:
type:
$ref: '#/components/schemas/ApiErrorType'
code:
$ref: '#/components/schemas/ApiErrorCode'
field:
type:
- string
- 'null'
message:
type: string
resource_id:
type:
- string
- 'null'
resource_type:
oneOf:
- $ref: '#/components/schemas/ApiErrorResourceType'
- type: 'null'
required:
- type
- code
- message
title: ApiError
PaymentGatewayIntegrationUpdateRequest:
type: object
properties:
variant:
$ref: '#/components/schemas/PaymentGatewayIntegrationUpdateRequestVariant'
description: The variant of payment integration.
adyen:
$ref: '#/components/schemas/AdyenPaymentGatewayIntegration'
stripe:
$ref: '#/components/schemas/StripePaymentGatewayIntegration'
title: PaymentGatewayIntegrationUpdateRequest
AdyenPaymentGatewayIntegrationEnvironment:
type: string
enum:
- LIVE
- TEST
title: AdyenPaymentGatewayIntegrationEnvironment
TestConnectionResponse:
type: object
properties:
successful:
type:
- boolean
- 'null'
message:
type:
- string
- 'null'
title: TestConnectionResponse
IntegrationType:
type: string
enum:
- PAYMENT_GATEWAY
- E_INVOICING
- TAX_CALCULATION
- DATA_EXPORT
- EMAIL_PROVIDER
description: The type of integration.
title: IntegrationType
TaxCalculationIntegrationUpdateRequest:
type: object
properties:
billing_entity_id:
type: string
description: The id of the billing entity for which this integration is used
variant:
$ref: '#/components/schemas/TaxCalculationIntegrationUpdateRequestVariant'
description: The variant that provides the tax calculation
ava_tax:
$ref: '#/components/schemas/AvaTaxCalculationIntegration'
description: Details for an AvaTax integration
custom_tax_codes:
type: array
items:
$ref: '#/components/schemas/CustomTaxCode'
description: 'Optional: custom codes that are used to link specific taxes to the tax calculation (e.g. commitments, missing product codes, etc.)'
enable_tax_filing:
type: boolean
description: Determines whether invoices will be sent to the tax integration, or just calculations
title: TaxCalculationIntegrationUpdateRequest
IntegrationLinkedResourceConfigurationUpdateRequest:
type: object
properties:
resource_type:
type: string
link_details:
type: array
items:
$ref: '#/components/schemas/IntegrationLinkDetail'
title: IntegrationLinkedResourceConfigurationUpdateRequest
IntegrationCreateRequestStatus:
type: string
enum:
- DRAFT
- PENDING
- TESTING
- ACTIVE
- ERROR
- DEPRECATED
- ARCHIVED
description: The status of the integration.
title: IntegrationCreateRequestStatus
AdyenPaymentGatewayIntegrationOwnership:
type: string
enum:
- PLATFORM
- SYSTEM
title: AdyenPaymentGatewayIntegrationOwnership
BalancePlatformDetails:
type: object
properties:
account:
type: string
authentication:
$ref: '#/components/schemas/AuthenticationSettings'
title: BalancePlatformDetails
UsernamePassword:
type: object
properties:
username:
type: string
password:
type: string
title: UsernamePassword
TaxCalculationIntegrationUpdateRequestVariant:
type: string
enum:
- AVATAX
description: The variant that provides the tax calculation
title: TaxCalculationIntegrationUpdateRequestVariant
EInvoicingIntegration:
type: object
properties:
mandates:
type: array
items:
$ref: '#/components/schemas/EInvoicingMandate'
description: The mandates that are used for eInvoicing
processor:
$ref: '#/components/schemas/EInvoicingIntegrationProcessor'
title: EInvoicingIntegration
DataExportIntegrationUpdateRequest:
type: object
properties:
variant:
$ref: '#/components/schemas/DataExportIntegrationUpdateRequestVariant'
description: The variant of payment integration.
s3:
$ref: '#/components/schemas/S3'
bigquery:
$ref: '#/components/schemas/BigQuery'
gcs:
$ref: '#/components/schemas/Gcs'
snowflake:
$ref: '#/components/schemas/Snowflake'
transport_type:
type:
- string
- 'null'
title: DataExportIntegrationUpdateRequest
IntegrationCreateRequest:
type: object
properties:
object_type:
type:
- string
- 'null'
id:
type:
- string
- 'null'
reference:
type: string
description: A custom reference assigned to the integration.
name:
type: string
description: A custom name assigned to the integration.
description:
type: string
status:
oneOf:
- $ref: '#/components/schemas/IntegrationCreateRequestStatus'
- type: 'null'
description: The status of the integration.
message:
type:
- string
- 'null'
description: The message associated with the status of the integration.
type:
$ref: '#/components/schemas/IntegrationCreateRequestType'
description: The type of integration.
authentication:
$ref: '#/components/schemas/AuthenticationSettingsCreateRequest'
description: The authentication information used for the integration
payment_gateway:
$ref: '#/components/schemas/PaymentGatewayIntegrationCreateRequest'
e_invoicing:
$ref: '#/components/schemas/EInvoicingIntegrationCreateRequest'
description: Integration to do eInvoicing
data_export:
$ref: '#/components/schemas/DataExportIntegrationCreateRequest'
tax_calculation:
$ref: '#/components/schemas/TaxCalculationIntegrationCreateRequest'
description: Integration to calculate tax
linked_resources_configurations:
type: array
items:
$ref: '#/components/schemas/IntegrationLinkedResourceConfigurationCreateRequest'
description: Details from the resources configurations from Solvimon linked to external integration system
email_provider:
$ref: '#/components/schemas/EmailProviderIntegrationCreateRequest'
description: Email provider integration settings. Applicable when the integration type is EMAIL_PROVIDER.
required:
- reference
- type
title: IntegrationCreateRequest
AuthenticationSettingsCreateRequest:
type: object
properties:
api_key:
$ref: '#/components/schemas/AuthenticationSettingsApiKeyCreateRequest'
client_credentials:
$ref: '#/components/schemas/ClientCredentialsCreateRequest'
username_password:
$ref: '#/components/schemas/UsernamePasswordCreateRequest'
title: AuthenticationSettingsCreateRequest
EInvoicingIntegrationCreateRequestProcessor:
type: string
enum:
- AVALARA
title: EInvoicingIntegrationCreateRequestProcessor
TaxCalculationIntegrationCreateRequest:
type: object
properties:
billing_entity_id:
type: string
description: The id of the billing entity for which this integration is used
variant:
$ref: '#/components/schemas/TaxCalculationIntegrationCreateRequestVariant'
description: The variant that provides the tax calculation
ava_tax:
$ref: '#/components/schemas/AvaTaxCalculationIntegration'
description: Details for an AvaTax integration
custom_tax_codes:
type: array
items:
$ref: '#/components/schemas/CustomTaxCode'
description: 'Optional: custom codes that are used to link specific taxes to the tax calculation (e.g. commitments, missing product codes, etc.)'
enable_tax_filing:
type: boolean
description: Determines whether invoices will be sent to the tax integration, or just calculations
title: TaxCalculationIntegrationCreateRequest
TaxCalculationIntegrationVariant:
type: string
enum:
- AVATAX
description: The variant that provides the tax calculation
title: TaxCalculationIntegrationVariant
AuthenticationSettingsApiKey:
type: object
properties:
header:
type:
- string
- 'null'
value:
type:
- string
- 'null'
title: AuthenticationSettingsApiKey
ClientCredentials:
type: object
properties:
client_id:
type: string
client_secret:
type: string
title: ClientCredentials
UsernamePasswordCreateRequest:
type: object
properties:
username:
type: string
password:
type: string
title: UsernamePasswordCreateRequest
AvaTaxCalculationIntegration:
type: object
properties:
company_code:
type: string
description: Links a billing entity to a company in AvaTax
title: AvaTaxCalculationIntegration
TaxCalculationIntegration:
type: object
properties:
billing_entity_id:
type: string
description: The id of the billing entity for which this integration is used
variant:
$ref: '#/components/schemas/TaxCalculationIntegrationVariant'
description: The variant that provides the tax calculation
ava_tax:
$ref: '#/components/schemas/AvaTaxCalculationIntegration'
description: Details for an AvaTax integration
custom_tax_codes:
type: array
items:
$ref: '#/components/schemas/CustomTaxCode'
description: 'Optional: custom codes that are used to link specific taxes to the tax calculation (e.g. commitments, missing product codes, etc.)'
enable_tax_filing:
type: boolean
description: Determines whether invoices will be sent to the tax integration, or just calculations
title: TaxCalculationIntegration
ApiErrorCode:
type: string
enum:
- RESOURCE_NOT_FOUND
- RESOURCES_NOT_FOUND
- UNABLE_TO_PROCESS_INSTRUCTIONS
- BAD_REQUEST
- UNSUPPORTED_MEDIA_TYPE
- RESOURCE_ALREADY_EXISTS
- CUSTOM_FIELD_VALUE_ALREADY_EXISTS
- COULD_NOT_CREATE_RESOURCE
- COULD_NOT_UPDATE_RESOURCE
- COULD_NOT_DELETE_RESOURCE
- MISSING_VERSION
- UNSUPPORTED_VERSION
- UNAUTHORISED
- CUSTOMER_NOT_FOUND
- PLATFORM_NOT_FOUND
- PRICING_PLAN_NOT_FOUND
- PRODUCT_NOT_FOUND
- PRODUCT_ITEM_NOT_FOUND
- PRICING_NOT_FOUND
- PRICING_ITEM_NOT_FOUND
- USER_NOT_FOUND
- METER_NOT_FOUND
- METER_VALUE_NOT_FOUND
- METER_PROPERTY_NOT_FOUND
- PRICING_ITEM_SUMMARIES_NOT_FOUND
- MISSING_ID
- INVALID_ID
- MISSING_REFERENCE
- MISSING_FIELD
- INVALID_FIELD
- INVALID_OPERATION
- INTERNAL_ERROR
- USER_NOT_ALLOWED
- IDEMPOTENCY_CHECK_FAILED
- INVALID_REQUEST
title: ApiErrorCode
DataExportIntegrationCreateRequest:
type: object
properties:
variant:
$ref: '#/components/schemas/DataExportIntegrationCreateRequestVariant'
description: The variant of payment integration.
s3:
$ref: '#/components/schemas/S3'
bigquery:
$ref: '#/components/schemas/BigQuery'
gcs:
$ref: '#/components/schemas/Gcs'
snowflake:
$ref: '#/components/schemas/Snowflake'
transport_type:
type:
- string
- 'null'
title: DataExportIntegrationCreateRequest
AdyenPaymentGatewayIntegration:
type: object
properties:
company_account:
type: string
environment:
$ref: '#/components/schemas/AdyenPaymentGatewayIntegrationEnvironment'
live_prefix:
type: string
merchant_accounts:
type: array
items:
type: string
public_key:
type: string
signing_secret:
type: string
ownership:
$ref: '#/components/schemas/AdyenPaymentGatewayIntegrationOwnership'
system_ownership_details:
$ref: '#/components/schemas/SystemOwnershipDetails'
balance_platform_details:
$ref: '#/components/schemas/BalancePlatformDetails'
legal_entity_manager_details:
$ref: '#/components/schemas/LegalEntityManagerDetails'
en
# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/solvimon/refs/heads/main/openapi/solvimon-integrations-api-openapi.yml