Regulatory.Saft.DeclarationExportCustomers

Contains Customers included in SAF-T export

General

Namespace: Regulatory.Saft
Repository: Regulatory.Saft.DeclarationExportCustomers
Base Table: Saft_Declaration_Export_Customers
Introduced In Version: 27.1.0.86
API access: ReadWrite

Visualization

Display Format: {Name}
Search Members: RegistrationNumber; Name
Code Member: RegistrationNumber
Name Member: Name
Category: Definitions
Show in UI: ShownByDefault

Track Changes

Min level: 1 - Track last changes only
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 Tree

Regulatory.Saft.DeclarationExportCustomers

Attributes

Name	Type	Description
AccountId	string (5)	Account`Required`
City	string (35)	City or other place of client address`Required`
ClosingCreditBalance	decimal (18, 2)	Closing Credit Balance`Required`
ClosingDebitBalance	decimal (18, 2)	Closing Debit Balance`Required`
Country	string (2)	Country`Required`
CustomerId	string (35)	Customer Id`Required`
ExportSequence	int32	Monotonc sequence within Declaration Export`Required` `Filter(ge;le)` `ORD` `Introduced in version 27.1.0.89`
Name	string (70) nullable	Name
NameLatin	string (70) nullable	Name in Latin script
OpeningCreditBalance	decimal (18, 2)	Opening Credit Balance`Required`
OpeningDebitBalance	decimal (18, 2)	Opening Debit Balance`Required`
RegistrationNumber	string (35)	Client Registration Number`Required`
RelatedParty	string (1)	Related Party`Required`
StreetName	string (70) nullable	Street name

References

Name	Type	Description
SaftDeclarationExport	DeclarationExports	Saft Declaration Export

System Attributes

Name	Type	Description
Id	guid
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.
ExternalId	string	The id of the object, when it is imported/synchronized with external system. Used by sync apps to identify the object in external systems. [Filter(multi eq)] [ORD] [Introduced in version 24.1.0.89]
ExternalSystem	string	The name of the external system from which the object is imported/synchronized. [Filter(multi eq)] [Introduced in version 24.1.0.89]
AggregateLastUpdateTimeUtc	datetime	The exact server time (in UTC) of the last modification of the object represented by this system object. null means that it is unknown. [Filter(ge;le)] [ORD] [Introduced in version 19.1]
AdditionalDataJson	string	Extensible JSON object for storing this entity's custom or optional attributes. [Introduced in version 26.3.100.4]
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Attribute Details

AccountId

AccountRequired

Type: string (5)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 5
Show in UI: ShownByDefault

City

City or other place of client addressRequired

Type: string (35)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 35
Show in UI: ShownByDefault

ClosingCreditBalance

Closing Credit BalanceRequired

Type: decimal (18, 2)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

ClosingDebitBalance

Closing Debit BalanceRequired

Type: decimal (18, 2)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

Country

CountryRequired

Type: string (2)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2
Show in UI: ShownByDefault

CustomerId

Customer IdRequired

Type: string (35)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 35
Show in UI: ShownByDefault

ExportSequence

Monotonc sequence within Declaration ExportRequired Filter(ge;le) ORD Introduced in version 27.1.0.89

Type: int32
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: True
Show in UI: ShownByDefault

Name

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

NameLatin

Name in Latin script

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

OpeningCreditBalance

Opening Credit BalanceRequired

Type: decimal (18, 2)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

OpeningDebitBalance

Opening Debit BalanceRequired

Type: decimal (18, 2)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

RegistrationNumber

Client Registration NumberRequired

Type: string (35)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 35
Show in UI: ShownByDefault

RelatedParty

Related PartyRequired

Type: string (1)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 1
Show in UI: ShownByDefault

StreetName

Street name

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

Id

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

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

ExternalId

The id of the object, when it is imported/synchronized with external system. Used by sync apps to identify the object in external systems. [Filter(multi eq)] [ORD] [Introduced in version 24.1.0.89]

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

ExternalSystem

The name of the external system from which the object is imported/synchronized. [Filter(multi eq)] [Introduced in version 24.1.0.89]

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

AggregateLastUpdateTimeUtc

The exact server time (in UTC) of the last modification of the object represented by this system object. null means that it is unknown. [Filter(ge;le)] [ORD] [Introduced in version 19.1]

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

AdditionalDataJson

Extensible JSON object for storing this entity's custom or optional attributes. [Introduced in version 26.3.100.4]

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

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

Reference Details

SaftDeclarationExport

Saft Declaration Export

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

API Methods

Methods that can be invoked in public APIs.

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

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

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

GetOrCreateExtensibleDataObject

Gets an existing extensible data object associated with the specified entity, or creates a new one if none exists. The newly created extensible data object is immediately commited to the database.
Return Type: ExtensibleDataObjects
Declaring Type: EntityObject
Domain API Request: GET

GetPropertyAllowedValues

Gets the allowed values for the specified property for this entity object.
Return Type: Collection Of ErpNet.Model.OData.ValueTextPair
Declaring Type: EntityObject
Domain API Request: GET

Parameters

propertyName
The name of the attribute or reference
Type: string
search
The search text - searches by display text. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
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

Business Rules

None

Front-End Business Rules

None

API

Domain API Entity Set: Regulatory_Saft_DeclarationExportCustomers

Domain API Entity Type: Regulatory_Saft_DeclarationExportCustomer

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

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

Table of Contents

Regulatory.Saft.DeclarationExportCustomers

General

Visualization

Track Changes

Aggregate

Attributes

References

System Attributes

Attribute Details

AccountId

City

ClosingCreditBalance

ClosingDebitBalance

Country

CustomerId

ExportSequence

Name

NameLatin

OpeningCreditBalance

OpeningDebitBalance

RegistrationNumber

RelatedParty

StreetName

Id

ObjectVersion

ExternalId

ExternalSystem

AggregateLastUpdateTimeUtc

AdditionalDataJson

DisplayText

Reference Details

SaftDeclarationExport

API Methods

CreateCopy

CreateNotification

GetAllowedCustomPropertyValues

GetOrCreateExtensibleDataObject

GetPropertyAllowedValues

Business Rules

Front-End Business Rules

API