Skip to main content
POST
/
v4
/
core
/
integrations
Save settings
curl --request POST \
  --url https://api.integrations.commenda.io/v4/core/integrations \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "integrationType": "QUICKBOOKS",
  "clientId": "your-client-id",
  "clientSecret": "your-client-secret",
  "isRootfiIdentity": false,
  "isDisabled": false,
  "metadata": {
    "environment": "production"
  }
}
'
import requests

url = "https://api.integrations.commenda.io/v4/core/integrations"

payload = {
"integrationType": "QUICKBOOKS",
"clientId": "your-client-id",
"clientSecret": "your-client-secret",
"isRootfiIdentity": False,
"isDisabled": False,
"metadata": { "environment": "production" }
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
integrationType: 'QUICKBOOKS',
clientId: 'your-client-id',
clientSecret: 'your-client-secret',
isRootfiIdentity: false,
isDisabled: false,
metadata: {environment: 'production'}
})
};

fetch('https://api.integrations.commenda.io/v4/core/integrations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.integrations.commenda.io/v4/core/integrations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'integrationType' => 'QUICKBOOKS',
'clientId' => 'your-client-id',
'clientSecret' => 'your-client-secret',
'isRootfiIdentity' => false,
'isDisabled' => false,
'metadata' => [
'environment' => 'production'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.integrations.commenda.io/v4/core/integrations"

payload := strings.NewReader("{\n \"integrationType\": \"QUICKBOOKS\",\n \"clientId\": \"your-client-id\",\n \"clientSecret\": \"your-client-secret\",\n \"isRootfiIdentity\": false,\n \"isDisabled\": false,\n \"metadata\": {\n \"environment\": \"production\"\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.integrations.commenda.io/v4/core/integrations")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"integrationType\": \"QUICKBOOKS\",\n \"clientId\": \"your-client-id\",\n \"clientSecret\": \"your-client-secret\",\n \"isRootfiIdentity\": false,\n \"isDisabled\": false,\n \"metadata\": {\n \"environment\": \"production\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.integrations.commenda.io/v4/core/integrations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"integrationType\": \"QUICKBOOKS\",\n \"clientId\": \"your-client-id\",\n \"clientSecret\": \"your-client-secret\",\n \"isRootfiIdentity\": false,\n \"isDisabled\": false,\n \"metadata\": {\n \"environment\": \"production\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "integration": {
    "id": 123
  }
}

Authorizations

api_key
string
header
required

Your Commenda Integrations API key, sent in the api_key header.

Body

application/json
integrationType
enum<string>
required
Available options:
BUSY,
CLEARBOOKS,
FREEAGENT,
FRESHBOOKS,
KASHFLOW,
MEKARI_JURNAL,
MS_DYNAMICS_365,
MS_DYNAMICS_365_FO,
MYOB_BUSINESS,
NETSUITE,
ODOO_ACCOUNTING,
QOYOD,
QUICKBOOKS,
QUICKBOOKS_SANDBOX,
ROOTFI_SANDBOX,
SAGE_CLOUD_ACCOUNTING,
SAGE_ZA_CLOUD_ACCOUNTING,
SAGE_INTACCT,
TALLY,
WAFEQ,
WAVE,
XERO,
ZOHO_BOOKS,
PUZZLE_SANDBOX,
PUZZLE,
RILLET,
RILLET_SANDBOX,
AMAZON,
BIG_COMMERCE,
SHOPIFY,
SQUARESPACE,
WIX,
WOO_COMMERCE,
GOOGLE_PLAYSTORE,
CHARGEBEE,
MOLLIE,
PAYPAL,
PAYPAL_SANDBOX,
RAZORPAY,
SQUARE,
SQUARE_SANDBOX,
STRIPE,
STRIPE_TEST,
STRIPE_SANDBOX,
ZOHO_INVOICE,
PADDLE,
PADDLE_SANDBOX,
HUBSPOT,
PIPEDRIVE,
SALES_FORCE,
ZOHO_CRM,
GUSTO
Example:

"QUICKBOOKS"

clientId
string
Example:

"your-client-id"

clientSecret
string
Example:

"your-client-secret"

isRootfiIdentity
boolean
Example:

false

isDisabled
boolean
Example:

false

metadata
object
Example:
{ "environment": "production" }

Response

201 - application/json
integration
object
required