Table of Contents

Finance.Saft.ProfileCompanies Entity

Namespace: Finance.Saft

Companies, for which the SAF-T profile is applied. Entity: Saft_Profile_Companies (Introduced in version 26.2.0.42)

Default Visualization

Default Display Text Format:
{Profile.Name}
Default Search Members:
Profile.Name
Name Data Member:
Profile.Name
Category: Definitions
Show in UI: ShownByDefault
API access: ReadWrite

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Parent:
Finance.Saft.Profiles
Aggregate Root:
Finance.Saft.Profiles

Attributes

Name Type Description
ContactPerson string (254) Contact person for SAF-T-related matters. Required Filter(eq;like)
ContactPersonEmail string (254) Email address for SAF-T correspondence. Required Filter(eq;like)
ContactPersonJobTitle string (254) Official job title of the contact person. Required Filter(eq;like)
ContactPersonPhone string (254) Phone number for inquiries. Required Filter(eq;like)
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
IsPartOfGroup IsPartOfGroup Indicate whether the company is part of a group. Required Default(5) Filter(eq)
Notes string (max) nullable Internal notes, not included in the SAF-T file. Filter(like)
ObjectVersion int32 The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
TaxAccountingBasis TaxAccountingBasis Accounting basis: accrual, cash, or mixed. Required Default("ACC") Filter(eq)

References

Name Type Description
BeneficialOwnerCompany Companies (nullable) Legal entity that is the beneficial owner (if applicable). Filter(multi eq)
BeneficialOwnerPerson Persons (nullable) Natural person who is the beneficial owner (if applicable). Filter(multi eq)
EnterpriseCompany EnterpriseCompanies Legal entity whose data will be exported to SAF-T. Required Filter(multi eq)
Profile Profiles The SAF-T profile this company belongs to. Required Filter(multi eq) Owner

Attribute Details

ContactPerson

Contact person for SAF-T-related matters. Required Filter(eq;like)

Type: string (254)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

ContactPersonEmail

Email address for SAF-T correspondence. Required Filter(eq;like)

Type: string (254)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

ContactPersonJobTitle

Official job title of the contact person. Required Filter(eq;like)

Type: string (254)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

ContactPersonPhone

Phone number for inquiries. Required Filter(eq;like)

Type: string (254)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

IsPartOfGroup

Indicate whether the company is part of a group. Required Default(5) Filter(eq)

Type: IsPartOfGroup
Category: System
Allowed values for the IsPartOfGroup(Finance.Saft.ProfileCompanies.md#ispartofgroup) data attribute
Allowed Values (Finance.Saft.ProfileCompaniesRepository.IsPartOfGroup Enum Members)

Value Description
HeadOfLocalGroup HeadOfLocalGroup value. Stored as 1.
Database Value: 1
Model Value: 1
Domain API Value: 'HeadOfLocalGroup'
HeadOfMultinationalGroup HeadOfMultinationalGroup value. Stored as 2.
Database Value: 2
Model Value: 2
Domain API Value: 'HeadOfMultinationalGroup'
PartOfLocalGroup PartOfLocalGroup value. Stored as 3.
Database Value: 3
Model Value: 3
Domain API Value: 'PartOfLocalGroup'
PartOfMultinationalGroup PartOfMultinationalGroup value. Stored as 4.
Database Value: 4
Model Value: 4
Domain API Value: 'PartOfMultinationalGroup'
NotPartOfAGroup NotPartOfAGroup value. Stored as 5.
Database Value: 5
Model Value: 5
Domain API Value: 'NotPartOfAGroup'

Supported Filters: Equals
Supports Order By: False
Default Value: 5
Show in UI: ShownByDefault

Notes

Internal notes, not included in the SAF-T file. Filter(like)

Type: string (max) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

TaxAccountingBasis

Accounting basis: accrual, cash, or mixed. Required Default("ACC") Filter(eq)

Type: TaxAccountingBasis
Category: System
Allowed values for the TaxAccountingBasis(Finance.Saft.ProfileCompanies.md#taxaccountingbasis) data attribute
Allowed Values (Finance.Saft.ProfileCompaniesRepository.TaxAccountingBasis Enum Members)

Value Description
ACCRUAL ACCRUAL. Stored as 'ACC'.
Database Value: 'ACC'
Model Value: 0
Domain API Value: 'ACCRUAL'
Cash Cash. Stored as 'CSH'.
Database Value: 'CSH'
Model Value: 1
Domain API Value: 'Cash'
Mixed Mixed. Stored as 'MIX'.
Database Value: 'MIX'
Model Value: 2
Domain API Value: 'Mixed'

Supported Filters: Equals
Supports Order By: False
Default Value: ACCRUAL
Show in UI: ShownByDefault

Reference Details

BeneficialOwnerCompany

Legal entity that is the beneficial owner (if applicable). Filter(multi eq)

Type: Companies (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

BeneficialOwnerPerson

Natural person who is the beneficial owner (if applicable). Filter(multi eq)

Type: Persons (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

EnterpriseCompany

Legal entity whose data will be exported to SAF-T. Required Filter(multi eq)

Type: EnterpriseCompanies
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Profile

The SAF-T profile this company belongs to. Required Filter(multi eq) Owner

Type: Profiles
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

  • customPropertyCode
    The code of the custom property
    Type: string

  • search
    The search text - searches by value or description. Can contain wildcard character %.
    Type: string
    Optional: True
    Default Value: null

  • exactMatch
    If true the search text should be equal to the property value
    Type: boolean
    Optional: True
    Default Value: False

  • orderByDescription
    If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
    Type: boolean
    Optional: True
    Default Value: False

  • top
    The top clause - default is 10
    Type: int32
    Optional: True
    Default Value: 10

  • skip
    The skip clause - default is 0
    Type: int32
    Optional: True
    Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST

Parameters

  • user
    The user.
    Type: Users

  • notificationClass
    The notification class.
    Type: string

  • subject
    The notification subject.
    Type: string

  • priority
    The notification priority.
    Type: Systems.Core.NotificationsRepository.Priority
    Allowed values for the Priority(Systems.Core.Notifications.md#priority) data attribute
    Allowed Values (Systems.Core.NotificationsRepository.Priority Enum Members)

    Value Description
    Background Background value. Stored as 1.
    Model Value: 1
    Domain API Value: 'Background'
    Low Low value. Stored as 2.
    Model Value: 2
    Domain API Value: 'Low'
    Normal Normal value. Stored as 3.
    Model Value: 3
    Domain API Value: 'Normal'
    High High value. Stored as 4.
    Model Value: 4
    Domain API Value: 'High'
    Urgent Urgent value. Stored as 5.
    Model Value: 5
    Domain API Value: 'Urgent'

    Optional: True
    Default Value: Normal

CreateCopy

Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST

Business Rules

None

Front-End Business Rules

None

API

Domain API Entity Set: Finance_Saft_ProfileCompanies

Domain API Entity Type: Finance_Saft_ProfileCompany

Domain API Query: https://testdb.my.erp.net/api/domain/odata/Finance_Saft_ProfileCompanies?$top=10

Domain API Query Builder: https://testdb.my.erp.net/api/domain/querybuilder#Finance_Saft_ProfileCompanies?$top=10