api_relations

⚠️ Important: Some fields in this table will be deprecated on Wednesday, January 7th, 2025. Please review the Deprecated Fields section below and migrate to the recommended alternatives.

This table provides relation (customer/contact) data from Simplicate.

Description

The api_relations table exposes relation entities from Simplicate, which represent customers, contacts, and other business relationships. Internal relations are excluded from this table.

Fields

Field Name	Type	Description
relation_id	Integer	Unique identifier for the business relation
account_manager_id	Integer	Identifier of the account manager (employee) for this relation
customer_group_organization_id	Integer	Identifier of the customer group organization
relation	String	Name of the company or organization
relation_number	String	Human-readable relation number or customer code
relation_type	String	Type of business relation (e.g., customer, prospect, supplier)
relation_industry	String	Industry sector or business category of the relation
customer_group	String	Name of the customer group this relation belongs to

Deprecated Fields

⚠️ Deprecation Notice: The following fields will be deprecated on Wednesday, January 7th, 2025. Please migrate to the recommended alternatives.

Deprecated Field	Type	Recommended Alternative
key_relation_id	Integer	relation_id
key_account_manager_id	Integer	account_manager_id
key_customer_group_organization_id	Integer	customer_group_organization_id
relation_name	String	relation
industry	String	relation_industry
customer_group_name	String	customer_group

Related Tables

• api_projects - Projects via relation_id
• api_invoices - Invoices via relation_id
• api_invoicelines - Invoice lines via relation_id
• api_employees - Account manager via account_manager_id
• api_relation_custom_fields - Custom fields via relation_id