Skip to main content

CompanyAttribute

Company-specific attribute containing business metadata and organizational properties.

Extends the base company interface with attribute functionality. Used to store additional company information such as business metadata, compliance data, organizational properties, and enterprise-specific configuration that are not part of the standard company schema.

Perfect for managing company-level business rules, compliance requirements, and organizational data that needs to be tracked and managed across the enterprise.

type CompanyAttribute implements Attribute {
  id: String!
  value: AttributeValue!
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  createdBy: Int
  lastModifiedBy: Int
  attributeDescription: AttributeDescription
  companyId: Int!
}

Fields​

CompanyAttribute.id ● String! non-null scalar​

Unique identifier for this attribute instance.

Auto-generated UUID that serves as the primary key for this specific attribute. Used to reference and manage individual attribute instances.

CompanyAttribute.value ● AttributeValue! non-null interface​

The actual value data stored in this attribute.

Contains the attribute value in the appropriate format based on the attribute description's type definition. The value structure varies depending on the attribute type (text, enum, color, etc.).

CompanyAttribute.createdAt ● DateTime! non-null scalar​

Timestamp when this attribute was originally created.

Records the exact date and time when this attribute instance was first created in the system. Used for audit trails and data lifecycle management.

CompanyAttribute.lastModifiedAt ● DateTime! non-null scalar​

Timestamp when this attribute was last modified.

Records the most recent date and time when any changes were made to this attribute's value or configuration. Updated automatically on each modification.

CompanyAttribute.createdBy ● Int scalar​

Identifier of the user who created this attribute.

References the user account that originally created this attribute instance. May be 0 for system-generated attributes or when user information is not available.

CompanyAttribute.lastModifiedBy ● Int scalar​

Identifier of the user who last modified this attribute.

References the user account that made the most recent changes to this attribute. May be 0 for system modifications or when user information is not available.

CompanyAttribute.attributeDescription ● AttributeDescription object​

Retrieve the attribute description that defines this company attribute's schema and behavior.

Returns the complete attribute description containing metadata, type definitions, display configuration, and localization settings. This description serves as the template that defines how this company attribute should behave and be presented.

Essential for understanding attribute constraints, available operations, and presentation requirements for company-specific attributes that extend company information.

CompanyAttribute.companyId ● Int! non-null scalar​

Unique identifier of the company that owns this attribute.

References the specific company in the business network that this attribute value is associated with. Used to establish the relationship between attributes and their parent companies for organizational and business management purposes.

Interfaces​

Attribute interface​

Base interface for all attribute types across different entity classes.

Attributes provide extensible metadata and properties for various entities in the system. Each attribute is associated with a specific entity type and contains typed values based on its attribute description schema.