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 platformsComprehensive contact information : Contacts can include associated addresses for billing and shipping purposesStatus tracking : The model supports tracking contact account status with values like ACTIVE, INACTIVE, SUSPENDED, ARCHIVED, and UNKNOWN
Attributes Property Type Description rootfi_id integer Unique identifier assigned by Commenda for this contact rootfi_created_at string Timestamp when this record was created in Commenda’s system (ISO 8601) rootfi_updated_at string Timestamp when this record was last updated in Commenda’s system (ISO 8601) rootfi_company_id integer Company identifier this contact belongs to within Commenda platform_id string Unique identifier for this contact in the source payment platform name string Full name or business name of the contact (e.g., “Acme Corporation”) tax_number string Tax identification number (e.g., EIN, VAT number, SSN) type enum Type of customer relationship status enum Current status of the customer account created_at string Original creation timestamp from the source platform (ISO 8601) updated_at string Last modification timestamp from the source platform (ISO 8601) addresses array Collection of Address objects for billing and shipping
Type Enum Values Value Description 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 Value Description 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 Property Type Description type enum Indicates the purpose of this address (SHIPPING, BILLING, COMPANY, WAREHOUSE) street string Street address including building/suite number city string City name state string State, province, or region (typically 2-letter code) postal_code string ZIP code or postal code country string ISO 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 Property Type Description platform_id string The Platform’s ID for the contact name string Name of the contact on the platform created_at string The ISO 8601 timestamp at which the data was created tax_number string Contact’s tax number (i.e. GST, EIN, VAT) status string Current status of the contact account updated_at string The ISO 8601 timestamp at which the information was updated on the platform addresses array The addresses associated with the contact
The Contact Response Object
{ "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" } ] }
