POST
/
accounting
/
contacts
/
all
curl --request POST \
  --url https://api.rootfi.dev/accounting/contacts/all \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "take": 10,
  "skip": 0,
  "orderBy": {
    "contact_name": "asc"
  },
  "filter": {
    "name": {
      "eq": "Mr. John Doe"
    }
  }
}'

{
  "data": {
    "data": [
      {
        "rootfi_id": 443583,
        "rootfi_company_id": 1672,
        "rootfi_organisation_id": 1,
        "rootfi_integration_type": "ZOHO_BOOKS",
        "rootfi_updated_at": "2023-10-25T13:39:41.201Z",
        "rootfi_created_at": "2023-10-25T13:39:41.216Z",
        "platform_id": "1013",
        "currency_id": null,
        "name": "Mr. John Doe",
        "contact_name": "Mr. John Doe",
        "contact_type": "CUSTOMER",
        "tax_number": null,
        "registration_number": null,
        "status": "ARCHIVED",
        "updated_at": "2023-09-25T00:00:00.000Z",
        "currency": {
          "data": {
            "platform_id": null,
            "name": null,
            "code": null,
            "symbol": null,
            "is_base_currency": null,
            "exchange_rate": null,
            "updated_at": null
          }
        },
        "addresses": {
          "data": [
            {
              "platform_id": "_CONTACTS_1013_BILLING",
              "data_model_id": "1013",
              "type": "BILLING",
              "data_model": "CONTACTS",
              "street": "123 Main Street",
              "locality": "Downtown",
              "city": "Metropolis",
              "state": "Stateville",
              "country": "Countryland",
              "pincode": "12345",
              "updated_at": "2023-11-06T10:00:00.000Z"
            }
          ]
        },
        "phone_numbers": {
          "data": [
            {
              "platform_id": "CONTACTS_3770712000001721005_MOBILE",
              "data_model_id": "3770712000001721005",
              "data_model": "CONTACTS",
              "number": "+919*********",
              "type": "MOBILE",
              "updated_at": "2023-11-05T00:00:00.000Z"
            }
          ]
        },
        "external_links": {
          "data": [
            {
              "platform_id": "CONTACTS_3770712000001721005_WEBSITE",
              "data_model_id": "3770712000001721005",
              "data_model": "CONTACTS",
              "link": "https://www.rootfi.dev",
              "type": "WEBSITE",
              "updated_at": "2023-11-05T00:00:00.000Z"
            }
          ]
        }
      }
    ],
    "total_count": 1
  },
  "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/all \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "take": 10,
  "skip": 0,
  "orderBy": {
    "contact_name": "asc"
  },
  "filter": {
    "name": {
      "eq": "Mr. John Doe"
    }
  }
}'

Authorizations

​
api_key
string
header
required

Body

application/json

Response

200 - application/json

The response is of type object.