General
Server Side SDKs
Core API
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"
}Get Contacts
Retrieve Contacts from the database based on the ID
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"
}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
Body
Show child attributes
Show child attributes
asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc Show child attributes
Show child attributes
Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The ID that the accounting platform uses to identify this contact
The unique ID we assign for that data's information
The RootFi designated id for the company
The RootFi designated id for the organisation
The accounting platform from which the data is being retrieved
ZOHO_BOOKS, QUICKBOOKS_SANDBOX, QUICKBOOKS, XERO, TALLY, SAGE_CLOUD_ACCOUNTING, MS_DYNAMICS_365, SAGE_ZA_CLOUD_ACCOUNTING, MYOB_BUSINESS, WAVE, ODOO_ACCOUNTING, NETSUITE, WAFEQ, MEKARI_JURNAL, BUSY, ROOTFI_SANDBOX, QOYOD The latest date at which RootFi updated this data
The date at which RootFi first synced this data
The ISO-4217 currency code
Name of the customer on the accounting platform
Name of the contact person for the contact
The type of customer.
CUSTOMER, VENDOR Contact’s tax number
Contact’s identifying number
Contact’s email address
Contact’s website
Contact’s fax number
The mobile numbers associated with the contact
The phone numbers associated with the contact
The status of the contact on the accounting platform.
ACTIVE, ARCHIVED, UNKNOWN The date and time the contact was last updated
The currency associated with the contact
Show child attributes
Show child attributes
Currency associated with the account.
Show child attributes
Show child attributes
The ID that the accounting platform uses to identify this currency
The name of the currency
The code of the currency
The symbol of the currency
Is this the base currency of the organisation?
The exchange rate of the currency
The last ISO 8601 timestamp that the data was updated at
The addresses associated with the contact
Show child attributes
Show child attributes
The addresses associated with the contact
Show child attributes
Show child attributes
The ID of the address in the accounting platform
The type of address
BILLING, SHIPPING The data model that the address belongs to
The ID of the data model that the address belongs to
The street address
The locality Name
The city Name
The state Name
The country Name
The Portal Code
The time at which the address was last updated
The phone numbers associated with the contact
Show child attributes
Show child attributes
The phone number associated with the contact
Show child attributes
Show child attributes
The type of phone number
MOBILE, TELEPHONE, FAX The ID of the phone number in the accounting platform
The data model that the phone number belongs to
The ID of the data model that the phone number belongs to
The phone number
The time at which the phone number was last updated
The external links associated with the contact
Show child attributes
Show child attributes
The external links associated with the contact
Show child attributes
Show child attributes
The external link
The type of external link
EMAIL, WEBSITE The ID of the phone number in the accounting platform
The data model that the phone number belongs to
The ID of the data model that the phone number belongs to
The time at which the external link was last updated
The total count of the accounts
The time at which the request was received by the server
The time at which the response was sent by the server
The unique ID of the request