Create Contact

Create Contact

curl --request POST \
  --url https://api.rootfi.dev/v3/accounting/contacts \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "company_id": 123,
  "data": [
    {
      "name": "fguvkhg",
      "contact_name": null,
      "contact_type": "CUSTOMER",
      "currency_id": "00000000-0000-0000-0000-000000000000",
      "tax_number": null,
      "registration_number": null,
      "status": null,
      "email": "abc@gmail.com",
      "website": "www.abc.com",
      "telephone": "1234567890",
      "mobile": "1234567890",
      "fax": "1234567890",
      "addresses": [
        {
          "rootfi_id": 278264,
          "platform_id": "CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS",
          "street": "123 Main Street",
          "locality": "Main Street",
          "city": "New York",
          "state": "New York",
          "pincode": "123456",
          "country": "USA"
        }
      ]
    }
  ]
}
'

import requests

url = "https://api.rootfi.dev/v3/accounting/contacts"

payload = {
    "company_id": 123,
    "data": [
        {
            "name": "fguvkhg",
            "contact_name": None,
            "contact_type": "CUSTOMER",
            "currency_id": "00000000-0000-0000-0000-000000000000",
            "tax_number": None,
            "registration_number": None,
            "status": None,
            "email": "abc@gmail.com",
            "website": "www.abc.com",
            "telephone": "1234567890",
            "mobile": "1234567890",
            "fax": "1234567890",
            "addresses": [
                {
                    "rootfi_id": 278264,
                    "platform_id": "CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS",
                    "street": "123 Main Street",
                    "locality": "Main Street",
                    "city": "New York",
                    "state": "New York",
                    "pincode": "123456",
                    "country": "USA"
                }
            ]
        }
    ]
}
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({
    company_id: 123,
    data: [
      {
        name: 'fguvkhg',
        contact_name: null,
        contact_type: 'CUSTOMER',
        currency_id: '00000000-0000-0000-0000-000000000000',
        tax_number: null,
        registration_number: null,
        status: null,
        email: 'abc@gmail.com',
        website: 'www.abc.com',
        telephone: '1234567890',
        mobile: '1234567890',
        fax: '1234567890',
        addresses: [
          {
            rootfi_id: 278264,
            platform_id: 'CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS',
            street: '123 Main Street',
            locality: 'Main Street',
            city: 'New York',
            state: 'New York',
            pincode: '123456',
            country: 'USA'
          }
        ]
      }
    ]
  })
};

fetch('https://api.rootfi.dev/v3/accounting/contacts', 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.rootfi.dev/v3/accounting/contacts",
  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([
    'company_id' => 123,
    'data' => [
        [
                'name' => 'fguvkhg',
                'contact_name' => null,
                'contact_type' => 'CUSTOMER',
                'currency_id' => '00000000-0000-0000-0000-000000000000',
                'tax_number' => null,
                'registration_number' => null,
                'status' => null,
                'email' => 'abc@gmail.com',
                'website' => 'www.abc.com',
                'telephone' => '1234567890',
                'mobile' => '1234567890',
                'fax' => '1234567890',
                'addresses' => [
                                [
                                                                'rootfi_id' => 278264,
                                                                'platform_id' => 'CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS',
                                                                'street' => '123 Main Street',
                                                                'locality' => 'Main Street',
                                                                'city' => 'New York',
                                                                'state' => 'New York',
                                                                'pincode' => '123456',
                                                                'country' => 'USA'
                                ]
                ]
        ]
    ]
  ]),
  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.rootfi.dev/v3/accounting/contacts"

	payload := strings.NewReader("{\n  \"company_id\": 123,\n  \"data\": [\n    {\n      \"name\": \"fguvkhg\",\n      \"contact_name\": null,\n      \"contact_type\": \"CUSTOMER\",\n      \"currency_id\": \"00000000-0000-0000-0000-000000000000\",\n      \"tax_number\": null,\n      \"registration_number\": null,\n      \"status\": null,\n      \"email\": \"abc@gmail.com\",\n      \"website\": \"www.abc.com\",\n      \"telephone\": \"1234567890\",\n      \"mobile\": \"1234567890\",\n      \"fax\": \"1234567890\",\n      \"addresses\": [\n        {\n          \"rootfi_id\": 278264,\n          \"platform_id\": \"CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS\",\n          \"street\": \"123 Main Street\",\n          \"locality\": \"Main Street\",\n          \"city\": \"New York\",\n          \"state\": \"New York\",\n          \"pincode\": \"123456\",\n          \"country\": \"USA\"\n        }\n      ]\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.rootfi.dev/v3/accounting/contacts")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"company_id\": 123,\n  \"data\": [\n    {\n      \"name\": \"fguvkhg\",\n      \"contact_name\": null,\n      \"contact_type\": \"CUSTOMER\",\n      \"currency_id\": \"00000000-0000-0000-0000-000000000000\",\n      \"tax_number\": null,\n      \"registration_number\": null,\n      \"status\": null,\n      \"email\": \"abc@gmail.com\",\n      \"website\": \"www.abc.com\",\n      \"telephone\": \"1234567890\",\n      \"mobile\": \"1234567890\",\n      \"fax\": \"1234567890\",\n      \"addresses\": [\n        {\n          \"rootfi_id\": 278264,\n          \"platform_id\": \"CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS\",\n          \"street\": \"123 Main Street\",\n          \"locality\": \"Main Street\",\n          \"city\": \"New York\",\n          \"state\": \"New York\",\n          \"pincode\": \"123456\",\n          \"country\": \"USA\"\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rootfi.dev/v3/accounting/contacts")

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  \"company_id\": 123,\n  \"data\": [\n    {\n      \"name\": \"fguvkhg\",\n      \"contact_name\": null,\n      \"contact_type\": \"CUSTOMER\",\n      \"currency_id\": \"00000000-0000-0000-0000-000000000000\",\n      \"tax_number\": null,\n      \"registration_number\": null,\n      \"status\": null,\n      \"email\": \"abc@gmail.com\",\n      \"website\": \"www.abc.com\",\n      \"telephone\": \"1234567890\",\n      \"mobile\": \"1234567890\",\n      \"fax\": \"1234567890\",\n      \"addresses\": [\n        {\n          \"rootfi_id\": 278264,\n          \"platform_id\": \"CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS\",\n          \"street\": \"123 Main Street\",\n          \"locality\": \"Main Street\",\n          \"city\": \"New York\",\n          \"state\": \"New York\",\n          \"pincode\": \"123456\",\n          \"country\": \"USA\"\n        }\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "rootfi_id": 238858,
    "rootfi_deleted_at": null,
    "rootfi_created_at": "2024-01-24T11:11:59.779Z",
    "rootfi_updated_at": "2024-01-24T11:11:59.000Z",
    "rootfi_company_id": 1109,
    "platform_id": "123456_1",
    "platform_unique_id": "123456",
    "currency_id": "00000000-0000-0000-0000-000000000000",
    "name": "fguvkhg",
    "contact_name": null,
    "contact_type": "CUSTOMER",
    "tax_number": null,
    "registration_number": null,
    "status": null,
    "updated_at": "2023-12-26T00:00:00.000Z",
    "external_links": [
      {
        "rootfi_id": 278264,
        "platform_id": "CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_WEBSITE",
        "link": "https://www.google.com",
        "type": "WEBSITE"
      }
    ],
    "phone_numbers": [
      {
        "rootfi_id": 278264,
        "platform_id": "CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_PHONE",
        "number": "1234567890",
        "type": "MOBILE"
      }
    ],
    "addresses": [
      {
        "rootfi_id": 278264,
        "platform_id": "CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS",
        "street": "123 Main Street",
        "locality": "Main Street",
        "city": "New York",
        "state": "New York",
        "pincode": "123456",
        "country": "USA"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

POST

accounting

contacts

Create Contact

curl --request POST \
  --url https://api.rootfi.dev/v3/accounting/contacts \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "company_id": 123,
  "data": [
    {
      "name": "fguvkhg",
      "contact_name": null,
      "contact_type": "CUSTOMER",
      "currency_id": "00000000-0000-0000-0000-000000000000",
      "tax_number": null,
      "registration_number": null,
      "status": null,
      "email": "abc@gmail.com",
      "website": "www.abc.com",
      "telephone": "1234567890",
      "mobile": "1234567890",
      "fax": "1234567890",
      "addresses": [
        {
          "rootfi_id": 278264,
          "platform_id": "CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS",
          "street": "123 Main Street",
          "locality": "Main Street",
          "city": "New York",
          "state": "New York",
          "pincode": "123456",
          "country": "USA"
        }
      ]
    }
  ]
}
'

import requests

url = "https://api.rootfi.dev/v3/accounting/contacts"

payload = {
    "company_id": 123,
    "data": [
        {
            "name": "fguvkhg",
            "contact_name": None,
            "contact_type": "CUSTOMER",
            "currency_id": "00000000-0000-0000-0000-000000000000",
            "tax_number": None,
            "registration_number": None,
            "status": None,
            "email": "abc@gmail.com",
            "website": "www.abc.com",
            "telephone": "1234567890",
            "mobile": "1234567890",
            "fax": "1234567890",
            "addresses": [
                {
                    "rootfi_id": 278264,
                    "platform_id": "CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS",
                    "street": "123 Main Street",
                    "locality": "Main Street",
                    "city": "New York",
                    "state": "New York",
                    "pincode": "123456",
                    "country": "USA"
                }
            ]
        }
    ]
}
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({
    company_id: 123,
    data: [
      {
        name: 'fguvkhg',
        contact_name: null,
        contact_type: 'CUSTOMER',
        currency_id: '00000000-0000-0000-0000-000000000000',
        tax_number: null,
        registration_number: null,
        status: null,
        email: 'abc@gmail.com',
        website: 'www.abc.com',
        telephone: '1234567890',
        mobile: '1234567890',
        fax: '1234567890',
        addresses: [
          {
            rootfi_id: 278264,
            platform_id: 'CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS',
            street: '123 Main Street',
            locality: 'Main Street',
            city: 'New York',
            state: 'New York',
            pincode: '123456',
            country: 'USA'
          }
        ]
      }
    ]
  })
};

fetch('https://api.rootfi.dev/v3/accounting/contacts', 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.rootfi.dev/v3/accounting/contacts",
  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([
    'company_id' => 123,
    'data' => [
        [
                'name' => 'fguvkhg',
                'contact_name' => null,
                'contact_type' => 'CUSTOMER',
                'currency_id' => '00000000-0000-0000-0000-000000000000',
                'tax_number' => null,
                'registration_number' => null,
                'status' => null,
                'email' => 'abc@gmail.com',
                'website' => 'www.abc.com',
                'telephone' => '1234567890',
                'mobile' => '1234567890',
                'fax' => '1234567890',
                'addresses' => [
                                [
                                                                'rootfi_id' => 278264,
                                                                'platform_id' => 'CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS',
                                                                'street' => '123 Main Street',
                                                                'locality' => 'Main Street',
                                                                'city' => 'New York',
                                                                'state' => 'New York',
                                                                'pincode' => '123456',
                                                                'country' => 'USA'
                                ]
                ]
        ]
    ]
  ]),
  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.rootfi.dev/v3/accounting/contacts"

	payload := strings.NewReader("{\n  \"company_id\": 123,\n  \"data\": [\n    {\n      \"name\": \"fguvkhg\",\n      \"contact_name\": null,\n      \"contact_type\": \"CUSTOMER\",\n      \"currency_id\": \"00000000-0000-0000-0000-000000000000\",\n      \"tax_number\": null,\n      \"registration_number\": null,\n      \"status\": null,\n      \"email\": \"abc@gmail.com\",\n      \"website\": \"www.abc.com\",\n      \"telephone\": \"1234567890\",\n      \"mobile\": \"1234567890\",\n      \"fax\": \"1234567890\",\n      \"addresses\": [\n        {\n          \"rootfi_id\": 278264,\n          \"platform_id\": \"CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS\",\n          \"street\": \"123 Main Street\",\n          \"locality\": \"Main Street\",\n          \"city\": \"New York\",\n          \"state\": \"New York\",\n          \"pincode\": \"123456\",\n          \"country\": \"USA\"\n        }\n      ]\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.rootfi.dev/v3/accounting/contacts")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"company_id\": 123,\n  \"data\": [\n    {\n      \"name\": \"fguvkhg\",\n      \"contact_name\": null,\n      \"contact_type\": \"CUSTOMER\",\n      \"currency_id\": \"00000000-0000-0000-0000-000000000000\",\n      \"tax_number\": null,\n      \"registration_number\": null,\n      \"status\": null,\n      \"email\": \"abc@gmail.com\",\n      \"website\": \"www.abc.com\",\n      \"telephone\": \"1234567890\",\n      \"mobile\": \"1234567890\",\n      \"fax\": \"1234567890\",\n      \"addresses\": [\n        {\n          \"rootfi_id\": 278264,\n          \"platform_id\": \"CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS\",\n          \"street\": \"123 Main Street\",\n          \"locality\": \"Main Street\",\n          \"city\": \"New York\",\n          \"state\": \"New York\",\n          \"pincode\": \"123456\",\n          \"country\": \"USA\"\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rootfi.dev/v3/accounting/contacts")

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  \"company_id\": 123,\n  \"data\": [\n    {\n      \"name\": \"fguvkhg\",\n      \"contact_name\": null,\n      \"contact_type\": \"CUSTOMER\",\n      \"currency_id\": \"00000000-0000-0000-0000-000000000000\",\n      \"tax_number\": null,\n      \"registration_number\": null,\n      \"status\": null,\n      \"email\": \"abc@gmail.com\",\n      \"website\": \"www.abc.com\",\n      \"telephone\": \"1234567890\",\n      \"mobile\": \"1234567890\",\n      \"fax\": \"1234567890\",\n      \"addresses\": [\n        {\n          \"rootfi_id\": 278264,\n          \"platform_id\": \"CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS\",\n          \"street\": \"123 Main Street\",\n          \"locality\": \"Main Street\",\n          \"city\": \"New York\",\n          \"state\": \"New York\",\n          \"pincode\": \"123456\",\n          \"country\": \"USA\"\n        }\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "rootfi_id": 238858,
    "rootfi_deleted_at": null,
    "rootfi_created_at": "2024-01-24T11:11:59.779Z",
    "rootfi_updated_at": "2024-01-24T11:11:59.000Z",
    "rootfi_company_id": 1109,
    "platform_id": "123456_1",
    "platform_unique_id": "123456",
    "currency_id": "00000000-0000-0000-0000-000000000000",
    "name": "fguvkhg",
    "contact_name": null,
    "contact_type": "CUSTOMER",
    "tax_number": null,
    "registration_number": null,
    "status": null,
    "updated_at": "2023-12-26T00:00:00.000Z",
    "external_links": [
      {
        "rootfi_id": 278264,
        "platform_id": "CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_WEBSITE",
        "link": "https://www.google.com",
        "type": "WEBSITE"
      }
    ],
    "phone_numbers": [
      {
        "rootfi_id": 278264,
        "platform_id": "CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_PHONE",
        "number": "1234567890",
        "type": "MOBILE"
      }
    ],
    "addresses": [
      {
        "rootfi_id": 278264,
        "platform_id": "CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS",
        "street": "123 Main Street",
        "locality": "Main Street",
        "city": "New York",
        "state": "New York",
        "pincode": "123456",
        "country": "USA"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

A contact is an individual or company that buys or sells goods or services from a business. Commonly referred to a customer on a corresponding invoice or a vendor for a bill

Additional Required Fields

To successfully create a contact, certain fields must be included in the raw_data object of the request body. The required fields are as follows:

Integration	Field	Description	Required
MS_DYNAMICS_365_FO	CustomerGroupId	The customer group ID to which the contact belongs. This should be passed if the contact_type is CUSTOMER.	Yes
MS_DYNAMICS_365_FO	VendorGroupId	The vendor group ID to which the contact belongs. This should be passed if the contact_type is VENDOR.	Yes
MYOB_BUSINESS	tax_code	The tax code to which the contact belongs.	Yes
SAGE_ZA_CLOUD_ACCOUNTING	code	The code of the contact.	Yes

Authorizations

api_key

string

header

required

Body

application/json

company_id

integer

required

The ID of the company in the accounting platform

data

accountingWriteContactFields · object[]

required

The data of the Contacts endpoint

Show child attributes

run_async

boolean | null

Run the request asynchronously

Response

data

accountingContactObject · object | null

Show child attributes

sync_id

string | null

The sync id of the request

General

Server Side SDKs

Core API

Unified API

Additional Required Fields

Authorizations

Body

Response

​Additional Required Fields

Authorizations

Body

Response

Additional Required Fields