Create an integration

POST

/v:version/integrations

POST

/v:version/integrations

$ curl -X POST https://test.api.solvimon.com/v1/integrations \
>      -H "X-API-KEY: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "reference": "Stripe-account001",
>   "type": "PAYMENT_GATEWAY",
>   "name": "Stripe account 001",
>   "description": "Stripe connection for account 001",
>   "status": "ACTIVE",
>   "authentication": {
>     "api_key": {
>       "value": "sk_test_0123456789"
>     },
>     "client_credentials": {
>       "client_id": "f47ac10b58cc4372a5670e02b2c3d479",
>       "client_secret": "fkUN60GjzBXp9pcDZPxpBQ"
>     }
>   },
>   "payment_gateway": {
>     "variant": "STRIPE",
>     "stripe": {
>       "public_key": "pk_test_0§123456789",
>       "signing_secret": "whsec_0123456789"
>     }
>   },
>   "e_invoicing": {
>     "mandates": [
>       {
>         "name": "HU_B2B_REPORTING"
>       }
>     ],
>     "processor": "AVALARA"
>   }
> }'

1 {
2   "object_type": "string",
3   "id": "string",
4   "reference": "string",
5   "name": "string",
6   "description": "string",
7   "status": "DRAFT",
8   "message": "string",
9   "type": "PAYMENT_GATEWAY",
10   "authentication": {
11     "api_key": {
12       "header": "string",
13       "value": "string"
14     },
15     "client_credentials": {
16       "client_id": "string",
17       "client_secret": "string"
18     },
19     "username_password": {
20       "username": "string",
21       "password": "string"
22     }
23   },
24   "payment_gateway": {
25     "variant": "ADYEN",
26     "adyen": {
27       "company_account": "string",
28       "environment": "LIVE",
29       "live_prefix": "string",
30       "merchant_accounts": [
31         "string"
32       ],
33       "public_key": "string",
34       "signing_secret": "string",
35       "ownership": "PLATFORM",
36       "system_ownership_details": {
37         "account_holder_id": "string",
38         "balance_account_id": "string",
39         "legal_entity_id": "string"
40       },
41       "balance_platform_details": {
42         "account": "string",
43         "authentication": {
44           "api_key": {
45             "header": "string",
46             "value": "string"
47           },
48           "client_credentials": {
49             "client_id": "string",
50             "client_secret": "string"
51           },
52           "username_password": {
53             "username": "string",
54             "password": "string"
55           }
56         }
57       },
58       "legal_entity_manager_details": {
59         "authentication": {
60           "api_key": {
61             "header": "string",
62             "value": "string"
63           },
64           "client_credentials": {
65             "client_id": "string",
66             "client_secret": "string"
67           },
68           "username_password": {
69             "username": "string",
70             "password": "string"
71           }
72         }
73       },
74       "enabled_payment_methods": [
75         "string"
76       ]
77     },
78     "stripe": {
79       "public_key": "string",
80       "signing_secret": "string"
81     }
82   },
83   "e_invoicing": {
84     "mandates": [
85       {
86         "name": "string",
87         "country": "string",
88         "mappings": [
89           {
90             "target": "string",
91             "source": "string",
92             "description": "string"
93           }
94         ],
95         "condition_groups": [
96           {
97             "conditions": [
98               {
99                 "field": "string",
100                 "comparator_type": "EQUALS",
101                 "value": "string"
102               }
103             ]
104           }
105         ],
106         "include_pdf_in_einvoice": true,
107         "supported_file_formats": [
108           {
109             "type": "string",
110             "description": "string"
111           }
112         ]
113       }
114     ],
115     "processor": "AVALARA"
116   },
117   "data_export": {
118     "variant": "S3",
119     "s3": {
120       "bucket_name": "string",
121       "bucket_path": "string",
122       "bucket_region": "string"
123     },
124     "bigquery": {
125       "project_id": "string",
126       "dataset_id": "string",
127       "dataset_location": "string",
128       "gcs_bucket_name": "string",
129       "gcs_hmac_key_access_id": "string",
130       "gcs_hmac_key_secret": "string"
131     },
132     "gcs": {
133       "bucket_region": "string",
134       "bucket_name": "string",
135       "bucket_path": "string",
136       "flattening": true
137     },
138     "snowflake": {
139       "host": "string",
140       "role": "string",
141       "warehouse": "string",
142       "database": "string",
143       "schema": "string"
144     }
145   },
146   "tax_calculation": {
147     "billing_entity_id": "string",
148     "variant": "AVATAX",
149     "ava_tax": {
150       "company_code": "string"
151     },
152     "custom_tax_codes": [
153       {
154         "field": "INVOICE_COMMITMENT",
155         "value": "string"
156       }
157     ],
158     "enable_tax_filing": true
159   },
160   "linked_resources_configurations": [
161     {
162       "resource_type": "string",
163       "link_details": [
164         {
165           "base_url": "string",
166           "custom_field_reference": "string"
167         }
168       ]
169     }
170   ],
171   "email_provider": {
172     "variant": "SYSTEM",
173     "mailgun": {
174       "domain": "string",
175       "region": "US",
176       "plan": "string"
177     },
178     "delivery_window": {
179       "type": "DAY",
180       "value": 1
181     },
182     "use_localized_templates": true
183   }
184 }

Requires the INTEGRATION.CREATE 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

Headers

x-platform-idstringOptional

Platform ID.

Request

This endpoint expects an object.

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

A custom reference assigned to the integration.

typeenumRequired

The type of integration.

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

A custom name assigned to the integration.

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

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

linked_resources_configurationslist of objectsOptional

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

email_providerobjectOptional

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

Response

Created

object_typestring or nullRead-only

idstring or nullRead-only

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

statusenum or null

The status of the integration.

messagestring or nullRead-only

The message associated with the status of the integration.

typeenum

The type of 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

linked_resources_configurationslist of objects

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

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

409

Conflict Error

500

Internal Server Error