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"
        }
      ]
    }
  ]
}'
{
  "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"
      }
    ]
  }
}
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:
IntegrationFieldDescriptionRequired
MS_DYNAMICS_365_FOCustomerGroupIdThe customer group ID to which the contact belongs. This should be passed if the contact_type is CUSTOMER.Yes
MS_DYNAMICS_365_FOVendorGroupIdThe vendor group ID to which the contact belongs. This should be passed if the contact_type is VENDOR.Yes
MYOB_BUSINESStax_codeThe tax code to which the contact belongs.Yes
SAGE_ZA_CLOUD_ACCOUNTINGcodeThe code of the contact.Yes

Authorizations

​
api_key
string
header
required

Body

application/json
​
data
accountingWriteContactFields · object[]
required

The data of the Contacts endpoint

​
company_id
integer
required

The ID of the company in the accounting platform

​
run_async
boolean | null

Run the request asynchronously

Response

​
data
object
​
sync_id
string | null

The sync id of the request