Create Contact

Create a contact.

POST /accounting/contacts

Create Contacts

cURL

curl --request POST \
  --url https://api.rootfi.dev/accounting/contacts \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "company_id": 1,
  "data": [
    {
      "name": "Rootfi Test",
      "contact_name": "Rootfi Test",
      "contact_type": "CUSTOMER",
      "currency_id": "GBP",
      "tax_number": "1234567890",
      "registration_number": "1234567890",
      "email": ""
    }
  ]
}
'

200

{
  "data": {
    "status": "SUCCESS",
    "upload_job_id": "xQm2K441VosP8W4",
    "data": [
      {
        "job_id": "aXI9pUDA5T7E2LS",
        "status": "success",
        "response": {
          "platform_id": "3770712000001686001",
          "currency_id": "3770712000000000099",
          "name": "Mr. John Doe",
          "contact_name": "John Doe",
          "contact_type": "CUSTOMER",
          "tax_number": "ODSPS1279G",
          "registration_number": "07CEUPK5322M1ZX",
          "status": "ACTIVE",
          "updated_at": "2023-11-01T00:00:00.000Z",
          "raw_data": {
            "platform_id": "1013",
            "name": "Mr. John Doe",
            "contact_name": "Mr. John Doe",
            "contact_type": "CUSTOMER",
            "currency_id": "1",
            "status": "ARCHIVED"
          }
        },
        "error": null
      }
    ]
  },
  "request_timestamp": "2023-10-25T13:39:41.201Z",
  "response_timestamp": "2023-10-25T13:39:41.201Z",
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}

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

Create contacts

company_id · integer · required

The company ID

Example:

1

data · accountingtypesContactsWriteRequestFields · object[] · required

The data to be passed through to the integration platform

Show child attributes

Response

200 - application/json

data · accountingtypesCreateContactsResponseData · object · required

Show child attributes

request_timestamp · string<date-time> · required

The time at which the request was received by the server

response_timestamp · string<date-time> · required

The time at which the response was sent by the server

request_id · string · required

The unique ID of the request