Skip to main content
POST
/
v4
/
core
/
invite-links
Create
curl --request POST \
  --url https://api.integrations.commenda.io/v4/core/invite-links \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "integration": "QUICKBOOKS",
  "companyName": "Acme Inc",
  "syncFrom": "2024-01-01T00:00:00Z",
  "syncConfig": [
    {
      "frequency": "DAILY",
      "data_model": "INVOICE",
      "category": "ACCOUNTING",
      "scope_access": {
        "READ": true,
        "CREATE": false,
        "UPDATE": false,
        "DELETE": false
      },
      "enabled": true,
      "interval": 1,
      "sync_from": "2024-01-01T00:00:00Z"
    }
  ]
}
'
import requests

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

payload = {
"integration": "QUICKBOOKS",
"companyName": "Acme Inc",
"syncFrom": "2024-01-01T00:00:00Z",
"syncConfig": [
{
"frequency": "DAILY",
"data_model": "INVOICE",
"category": "ACCOUNTING",
"scope_access": {
"READ": True,
"CREATE": False,
"UPDATE": False,
"DELETE": False
},
"enabled": True,
"interval": 1,
"sync_from": "2024-01-01T00:00:00Z"
}
]
}
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({
integration: 'QUICKBOOKS',
companyName: 'Acme Inc',
syncFrom: '2024-01-01T00:00:00Z',
syncConfig: [
{
frequency: 'DAILY',
data_model: 'INVOICE',
category: 'ACCOUNTING',
scope_access: {READ: true, CREATE: false, UPDATE: false, DELETE: false},
enabled: true,
interval: 1,
sync_from: '2024-01-01T00:00:00Z'
}
]
})
};

fetch('https://api.integrations.commenda.io/v4/core/invite-links', 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/invite-links",
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([
'integration' => 'QUICKBOOKS',
'companyName' => 'Acme Inc',
'syncFrom' => '2024-01-01T00:00:00Z',
'syncConfig' => [
[
'frequency' => 'DAILY',
'data_model' => 'INVOICE',
'category' => 'ACCOUNTING',
'scope_access' => [
'READ' => true,
'CREATE' => false,
'UPDATE' => false,
'DELETE' => false
],
'enabled' => true,
'interval' => 1,
'sync_from' => '2024-01-01T00:00:00Z'
]
]
]),
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/invite-links"

payload := strings.NewReader("{\n \"integration\": \"QUICKBOOKS\",\n \"companyName\": \"Acme Inc\",\n \"syncFrom\": \"2024-01-01T00:00:00Z\",\n \"syncConfig\": [\n {\n \"frequency\": \"DAILY\",\n \"data_model\": \"INVOICE\",\n \"category\": \"ACCOUNTING\",\n \"scope_access\": {\n \"READ\": true,\n \"CREATE\": false,\n \"UPDATE\": false,\n \"DELETE\": false\n },\n \"enabled\": true,\n \"interval\": 1,\n \"sync_from\": \"2024-01-01T00:00:00Z\"\n }\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/invite-links")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"integration\": \"QUICKBOOKS\",\n \"companyName\": \"Acme Inc\",\n \"syncFrom\": \"2024-01-01T00:00:00Z\",\n \"syncConfig\": [\n {\n \"frequency\": \"DAILY\",\n \"data_model\": \"INVOICE\",\n \"category\": \"ACCOUNTING\",\n \"scope_access\": {\n \"READ\": true,\n \"CREATE\": false,\n \"UPDATE\": false,\n \"DELETE\": false\n },\n \"enabled\": true,\n \"interval\": 1,\n \"sync_from\": \"2024-01-01T00:00:00Z\"\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"integration\": \"QUICKBOOKS\",\n \"companyName\": \"Acme Inc\",\n \"syncFrom\": \"2024-01-01T00:00:00Z\",\n \"syncConfig\": [\n {\n \"frequency\": \"DAILY\",\n \"data_model\": \"INVOICE\",\n \"category\": \"ACCOUNTING\",\n \"scope_access\": {\n \"READ\": true,\n \"CREATE\": false,\n \"UPDATE\": false,\n \"DELETE\": false\n },\n \"enabled\": true,\n \"interval\": 1,\n \"sync_from\": \"2024-01-01T00:00:00Z\"\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "inviteLink": {
      "id": 123,
      "inviteLinkId": "<string>",
      "companyId": 123
    }
  },
  "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

api_key
string
header
required

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

Body

application/json
integration
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"

companyName
string
required
Example:

"Acme Inc"

syncFrom
string<date-time>
Example:

"2024-01-01T00:00:00Z"

syncConfig
object[]

Response

201 - application/json

The created invite link.

data
object
required
request_id
string<uuid>
required