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 business entity that receives invoices and makes payments. In payment contexts, contacts can be clients, subscribers, or any entity with financial transactions. This unified model simplifies handling contact-related information across various payment platforms.
  • Unified contact properties: Essential contact details like name, tax number, and status are standardized across different payment platforms
  • Comprehensive contact information: Contacts can include associated addresses for billing and shipping purposes
  • Status tracking: The model supports tracking contact account status with values like ACTIVE, INACTIVE, SUSPENDED, ARCHIVED, and UNKNOWN

​
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 payment platform
namestringFull name or business name of the contact (e.g., “Acme Corporation”)
tax_numberstringTax identification number (e.g., EIN, VAT number, SSN)
typeenumType of customer relationship
statusenumCurrent status of the customer account
created_atstringOriginal creation timestamp from the source platform (ISO 8601)
updated_atstringLast modification timestamp from the source platform (ISO 8601)
addressesarrayCollection of Address objects for billing and shipping

​
Type Enum Values

ValueDescription
CUSTOMERContact is a customer who makes purchases
VENDORContact is a vendor who supplies products
BOTHContact acts as both customer and vendor
UNKNOWNType cannot be determined

​
Status Enum Values

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

​
Address Attributes

PropertyTypeDescription
typeenumIndicates the purpose of this address (SHIPPING, BILLING, COMPANY, WAREHOUSE)
streetstringStreet address including building/suite number
citystringCity name
statestringState, province, or region (typically 2-letter code)
postal_codestringZIP code or postal code
countrystringISO 3166-1 alpha-2 country code (e.g., “US”, “GB”)

​
Expandable Attributes

Use the expand query parameter to include related objects:
  • expand=addresses - Includes full Address objects

​
Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for the contact
namestringName of the contact on the platform
created_atstringThe ISO 8601 timestamp at which the data was created
tax_numberstringContact’s tax number (i.e. GST, EIN, VAT)
statusstringCurrent status of the contact account
updated_atstringThe ISO 8601 timestamp at which the information was updated on the platform
addressesarrayThe addresses associated with the contact
{
  "rootfi_id": 12345,
  "rootfi_created_at": "2025-01-01T00:00:00Z",
  "rootfi_updated_at": "2025-01-15T10:30:00Z",
  "rootfi_company_id": 999,
  "platform_id": "cust_stripe_001",
  "name": "Acme Corporation",
  "tax_number": "12-3456789",
  "status": "ACTIVE",
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-15T10:30:00Z",
  "addresses": [
    {
      "type": "BILLING",
      "street": "123 Main St",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country": "US"
    }
  ]
}