Skip to main content

Documentation Index

Fetch the complete documentation index at: https://integrations.docs.commenda.io/llms.txt

Use this file to discover all available pages before exploring further.

The Contacts Data Model represents an individual or company that buys or sells goods or services from a business. This unified model simplifies handling contact-related information across various accounting platforms.
  • Unified contact properties: Essential contact details like name, contact person, currency, and tax number are standardized across different accounting platforms
  • Comprehensive contact information: Contacts can include associated data like contact persons, phone numbers, addresses, and external links for a more detailed representation of each contact
  • Status tracking: The model supports tracking the status of each contact, with values like ACTIVE, INACTIVE, SUSPENDED, ARCHIVED, and UNKNOWN, facilitating better organisation and reporting

​
Attributes

​
Contact Attributes

PropertyTypeDescription
rootfi_idintegerUnique identifier assigned by Commenda for this contact
rootfi_created_atstringTimestamp when this record was created in Commenda’s system (ISO 8601)
rootfi_updated_atstringTimestamp when this record was last updated in Commenda’s system (ISO 8601)
rootfi_company_idintegerCompany identifier this contact belongs to within Commenda
platform_idstringUnique identifier for this contact in the source accounting platform
namestringThe name of the contact
contact_namestringThe name of the contact person for the contact
typeenumThe type of contact
currency_idstringThe ISO-4217 currency code of the contact
tax_numberstringThe contact’s tax number
registration_numberstringThe contact’s identifying or registration number
statusenumThe status of the contact
updated_atstringThe date and time the contact was last updated
external_linksarrayExternal links for the contact
phone_numbersarrayPhone numbers for the contact
addressesarrayAddresses for the contact

​
Contact Type Enum Values

ValueDescription
CUSTOMERContact is a customer who receives invoices
VENDORContact is a vendor who provides bills
BOTHContact acts as both customer and vendor
UNKNOWNType cannot be determined from the platform

​
Status Enum Values

ValueDescription
ACTIVEContact is active and in good standing
INACTIVEContact has been voluntarily deactivated
SUSPENDEDContact is suspended due to payment/fraud issues
ARCHIVEDContact has been archived for record-keeping
UNKNOWNStatus cannot be determined from the platform

​
Expandable Attributes

Use the expand query parameter to include related objects:
  • expand=currency - Includes full Currency object details
  • expand=phone_numbers - Includes all PhoneNumber objects
  • expand=addresses - Includes all Address objects
  • expand=external_links - Includes all ExternalLink objects
  • expand=invoices - Includes all Invoice objects for this contact
  • expand=bills - Includes all Bill objects for this contact
  • expand=invoice_payments - Includes all InvoicePayment objects for this contact
  • expand=bill_payments - Includes all BillPayment objects for this contact
  • expand=expenses - Includes all Expense objects for this contact
  • expand=purchase_orders - Includes all PurchaseOrder objects for this contact
  • expand=sales_orders - Includes all SalesOrder objects for this contact
  • expand=bank_transactions - Includes all BankTransaction objects for this contact

​
Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for the contact
namestringThe name of the contact
contact_namestringThe name of the contact person for the contact
typeenumThe type of contact
currency_idstringThe ISO-4217 currency code of the contact
tax_numberstringThe contact’s tax number
registration_numberstringThe contact’s identifying or registration number
statusenumThe status of the contact
emailstringThe email address of the contact
websitestringThe website URL of the contact
telephonestringThe telephone number of the contact
mobilestringThe mobile phone number of the contact
faxstringThe fax number of the contact
addressesarrayAddresses for the contact
updated_atstringThe date and time the contact was last updated

​
Phone Numbers

PropertyTypeDescription
platform_idstringThe Platform's ID for the phone number
data_modelstringThe data model to which this number is linked. Values are: COMPANY_INFO, CONTACTS
data_model_idstringThe unique identifier for the data model associated with this number
numberstringThe number of the contact person.
typeenumThe type of the number. Values are: MOBILE, TELEPHONE, FAX.
updated_atdateThe date and time at which the number information was last updated in the accounting platform

​
Addresses

PropertyTypeDescription
platform_idstringPlatform's ID for the address
typeenumThe type of address. Values are: SHIPPING, BILLING, COMPANY, WAREHOUSE.
data_modelstringThe data model to which this address is linked. Observed values in current read mappers are COMPANY_INFO, CONTACT, INVOICE, BILL, INVOICE_CREDIT_NOTE, BILL_CREDIT_NOTE, PURCHASE_ORDER, SALES_ORDER, CASH_SALE, CASH_REFUND, and ORDER
data_model_idstringThe unique identifier for the data model associated with this address
streetstringThe street information of the address
street2stringSecondary street address line (suite, unit, etc.)
localitystringThe locality or neighborhood information of the address
citystringThe city information of the address
statestringThe state or region information of the address
countrystringThe country information of the address
postal_codestringThe postal or zip code of the address
updated_atdateThe date and time at which the address information was last updated in the accounting platform
PropertyTypeDescription
platform_idstringThe Platform's ID for the external link
data_modelstringThe data model to which this link is related. Values are: COMPANY_INFO, CONTACTS
data_model_idstringThe unique identifier for the data model associated with this link
linkstringThe URL or email data.
typeenumThe type of link. Values are: WEBSITE, EMAIL.
updated_atdateThe date and time at which the link information was last updated in the accounting platform
{
  "rootfi_id": 238858,
  "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",
  "name": "Acme Corporation",
  "contact_name": "John Doe",
  "type": "CUSTOMER",
  "currency_id": "00000000-0000-0000-0000-000000000000",
  "tax_number": "ODSPS1279G",
  "registration_number": "07CEUPK5322M1ZX",
  "status": "ACTIVE",
  "updated_at": "2024-01-24T11:11:59.000Z",
  "external_links": [],
  "phone_numbers": [],
  "addresses": []
}