Update an integration by its ID | Solvimon

curl -X PATCH https://test.api.solvimon.com/v1/integrations/ \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "reference": "intg-20240601-001",
  "name": "Stripe Payment Gateway",
  "description": "Integration for processing payments via Stripe",
  "type": "PAYMENT_GATEWAY",
  "linked_resources_configurations": [
    {
      "resource_type": "transaction",
      "link_details": [
        {
          "base_url": "https://api.stripe.com/v1/charges",
          "custom_field_reference": "charge_id"
        }
      ]
    }
  ]
}'

{
  "reference": "intg-20240601-001",
  "name": "Stripe Payment Gateway",
  "description": "Integration for processing payments via Stripe",
  "type": "PAYMENT_GATEWAY",
  "linked_resources_configurations": [
    {
      "resource_type": "transaction",
      "link_details": [
        {
          "base_url": "https://api.stripe.com/v1/charges",
          "custom_field_reference": "charge_id"
        }
      ]
    }
  ],
  "object_type": "integration",
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "DRAFT",
  "message": "Integration update pending approval",
  "authentication": {
    "api_key": {
      "header": "Authorization",
      "value": "Bearer sk_live_4eC39HqLyjWDarjtT1zdp7dc"
    },
    "client_credentials": {
      "client_id": "stripe-client-12345",
      "client_secret": "s3cr3tC1i3ntS3cr3t"
    },
    "username_password": {
      "username": "stripe_user",
      "password": "P@ssw0rd123!"
    }
  },
  "payment_gateway": {
    "variant": "ADYEN",
    "adyen": {
      "company_account": "ACCT-987654321",
      "environment": "LIVE",
      "live_prefix": "live_",
      "merchant_accounts": [
        "merchant_001",
        "merchant_002"
      ],
      "public_key": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAn...",
      "signing_secret": "s3cr3tS1gn1ngK3y"
    },
    "stripe": {
      "public_key": "pk_live_51H8xY2Lz...",
      "signing_secret": "whsec_1234567890abcdef"
    }
  },
  "e_invoicing": {
    "mandates": [
      {
        "name": "EU VAT Compliance",
        "country": "DE",
        "mappings": [
          {
            "target": "invoice_number",
            "source": "external_invoice_id",
            "description": "Maps external invoice ID to internal invoice number"
          }
        ],
        "condition_groups": [
          {
            "conditions": [
              {
                "field": "country",
                "comparator_type": "EQUALS",
                "value": "DE"
              }
            ]
          }
        ],
        "supported_file_formats": [
          {
            "type": "XML",
            "description": "Standard XML format for e-invoicing"
          }
        ]
      }
    ],
    "processor": "AVALARA"
  },
  "data_export": {
    "variant": "S3",
    "s3": {
      "bucket_name": "company-data-exports",
      "bucket_path": "integrations/stripe",
      "bucket_region": "us-east-1"
    },
    "bigquery": {
      "project_id": "company-data-project",
      "dataset_id": "integration_exports",
      "dataset_location": "US",
      "gcs_bucket_name": "company-gcs-bucket",
      "gcs_hmac_key_access_id": "GOOG1EXAMPLEKEYID",
      "gcs_hmac_key_secret": "EXAMPLESECRETKEY1234567890"
    },
    "gcs": {
      "bucket_region": "us-central1",
      "bucket_name": "company-gcs-bucket",
      "bucket_path": "exports/stripe",
      "flattening": true
    },
    "snowflake": {
      "host": "sfaccount.region.snowflakecomputing.com",
      "role": "DATA_ENGINEER",
      "warehouse": "COMPUTE_WH",
      "database": "INTEGRATIONS_DB",
      "schema": "STRIPE_EXPORTS"
    }
  },
  "tax_calculation": {
    "billing_entity_id": "billing-entity-123",
    "variant": "AVATAX",
    "ava_tax": {
      "company_code": "COMPANY123"
    },
    "custom_tax_codes": [
      {
        "field": "INVOICE_COMMITMENT",
        "value": "STANDARD_RATE"
      }
    ],
    "enable_tax_filing": true
  },
  "email_provider": {
    "variant": "SYSTEM",
    "mailgun": {
      "domain": "mg.companydomain.com",
      "region": "US",
      "plan": "premium"
    },
    "delivery_window": {
      "type": "DAY",
      "value": 1
    },
    "use_localized_templates": true
  }
}

Requires the INTEGRATION.UPDATE permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

resourceIdstringRequiredDefaults to

The ID of the resource to be requested.

Request

This endpoint expects an object.

referencestringRequiredformat: "^\S+$"0-256 characters

A custom reference assigned to the integration.

namestringRequiredformat: "^.*$"0-256 characters

A custom name assigned to the integration.

descriptionstringRequiredformat: "^.*$"0-256 characters

typeenumRequired

The type of integration.

Allowed values:

linked_resources_configurationslist of objectsRequired

Details from the resources configurations from Solvimon linked to external integration system

statusenum or nullOptional

The status of the integration.

authenticationobjectOptional

The authentication information used for the integration

payment_gatewayobjectOptional

e_invoicingobjectOptional

Integration to do eInvoicing

data_exportobjectOptional

tax_calculationobjectOptional

Integration to calculate tax

email_providerobjectOptional

Email provider integration settings. Applicable when the integration type is EMAIL_PROVIDER.

Response

referencestringformat: "^\S+$"0-256 characters

A custom reference assigned to the integration.

namestringformat: "^.*$"0-256 characters

A custom name assigned to the integration.

descriptionstringformat: "^.*$"0-256 characters

typeenum

The type of integration.

Allowed values:

linked_resources_configurationslist of objects

Details from the resources configurations from Solvimon linked to external integration system

object_typestring or nullRead-only

idstring or nullRead-only

statusenum or null

The status of the integration.

messagestring or nullRead-only

The message associated with the status of the integration.

authenticationobject

The authentication information used for the integration

payment_gatewayobject

e_invoicingobject

Integration to do eInvoicing

data_exportobject

tax_calculationobject

Integration to calculate tax

email_providerobject

Email provider integration settings. Applicable when the integration type is EMAIL_PROVIDER.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors