Create Contacts

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": ""
    }
  ]
}'

{
  "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"
}

POST

accounting

contacts

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": ""
    }
  ]
}'

{
  "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

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": ""
    }
  ]
}'

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

data.currency_id

string | null

The ISO-4217 currency code

data.name

string | null

Name of the customer on the accounting platform

data.contact_name

string | null

Name of the contact person for the contact

data.contact_type

enum<string> | null

The type of customer.

Available options:

CUSTOMER,

VENDOR

data.tax_number

string | null

Contact’s tax number

data.registration_number

string | null

Contact’s identifying number

data.email

string | null

Contact’s email address

data.website

string | null

Contact’s website

data.fax

string | null

Contact’s fax number

data.mobile

string | null

The mobile numbers associated with the contact

data.telephone

string | null

The phone numbers associated with the contact

data.addresses

object[] | null

Array of addresses associated with the contact

data.raw_data

object

A JSON containing fields that you can directly pass to the accounting platform.

Response

200 - application/json

data

accountingtypesCreateContactsResponseData · object

required

Show child attributes

data.status

enum<string>

required

The status of the job.

Available options:

SUCCESS,

FAILED,

CREATED,

RUNNING

data.upload_job_id

string

required

The ID of the job.

data.data

accountingtypesContactssResponse · object[]

required

Show child attributes

data.data.job_id

string

required

The ID of the job.

data.data.status

enum<string>

required

The status of the job.

Available options:

success,

failed

data.data.response

accountingtypesContactsWriteAndUpdateResponseFields · object

required

Show child attributes

data.data.response.platform_id

string

required

The ID that the accounting platform uses to identify this contact

data.data.response.currency_id

string | null

The ISO-4217 currency code

data.data.response.name

string | null

Name of the customer on the accounting platform

data.data.response.contact_name

string | null

Name of the contact person for the contact

data.data.response.contact_type

enum<string> | null

The type of customer.

Available options:

CUSTOMER,

VENDOR

data.data.response.tax_number

string | null

Contact’s tax number

data.data.response.registration_number

string | null

Contact’s identifying number

data.data.response.email

string | null

Contact’s email address

data.data.response.website

string | null

Contact’s website

data.data.response.fax

string | null

Contact’s fax number

data.data.response.mobile

string | null

The mobile numbers associated with the contact

data.data.response.telephone

string | null

The phone numbers associated with the contact

data.data.response.status

enum<string> | null

The status of the contact on the accounting platform.

Available options:

ACTIVE,

ARCHIVED,

UNKNOWN

data.data.response.updated_at

string | null

The date and time the contact was last updated

data.data.response.raw_data

object

The raw JSON response we get from the accounting platform for that data

data.data.error

ErrorObject · object

The error message if the job failed.

Show child attributes

data.data.error.code

string

required

data.data.error.message

string

required

data.data.error.platform_error

string

required

data.data.error.raw_data

object

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

Create Contact Update Contact

⌘I

General

Server Side SDKs

Core API

Unified API

Create Contacts

Authorizations

Body

Response