Regulatory.Saft.DeclarationExports

Each record in the table represents a distinct SAF-T declaration export operation.

General

Namespace: Regulatory.Saft
Repository: Regulatory.Saft.DeclarationExports
Base Table: Saft_Declaration_Exports
Introduced In Version: 27.1.0.81
API access: ReadWrite

Visualization

Display Format: {CompanyName}
Search Members: BeneficialOwnerCountryCode; CompanyName
Code Member: BeneficialOwnerCountryCode
Name Member: CompanyName
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 Parent:
Regulatory.Saft.SaftDeclarations
Aggregate Root:
Regulatory.Saft.SaftDeclarations

Attributes

Name	Type	Description
ApplicationVersion	string (18)	ERP.net Version Used to Generate the ExportRequired
AuditFileDateCreated	datetime	Creation date of odit file (value of AuditFileDateCreated)Required Filter(ge;le)
BeneficialOwnerCountryCode	string (2) nullable	Country Code of the Beneficial Owner
BeneficialOwnerEGN	string (35) nullable	Personal Identification Number of the Bulgarian Beneficial Owne
BeneficialOwner NameCyrillicBG	string (70) nullable	Name of the Bulgarian Beneficial Owner
BeneficialOwner NameLatinForeign	string (70) nullable	Name of the Foreign Beneficial Owner
CompanyCity	string (35) nullable	City or Other Locality
CompanyCountryCode	string (2) nullable	Country Code
CompanyName	string (70) nullable	Official Name of the Taxable Person
CompanyRegistrationNumber	string (35) nullable	Company Registration Number or Other Registration Number of the Taxable Person
CompanyStreetName	string (70) nullable	Registered Address of the Taxable Person
ContactPersonEmail	string (70) nullable	Email Address of the Contact Person
ContactPersonJobTitle	string (35) nullable	Position or Role of the Contact Person
ContactPersonName	string (127) nullable	Contact Person Name
ContactPersonPhone	string (18) nullable	Contact Person Phone Number
CreatedOn	datetime	Date and time of record creationRequired Default(Now) Filter(ge;le)
DefaultCurrencyCode	string (3)	Primary currency code of the SAF-T file.Required
ErrorMessage	string (max) nullable	Information about the error that occurred during failed generation.
ExportType	ExportType	Export type: monthly(M), annual(Y) or on-demand(D).Required Filter(multi eq)
FileName	string (254) nullable	Name of generated SAF-T fileFilter(like)
GeneratedByUserId	guid nullable	User who started generation. Filter(multi eq)
GeneratedOn	datetime nullable	Date and Time of successful generation of report(data preparation).Filter(ge;le)
IsPartOfGroup	int32 nullable	Indicates whether the company belongs to a group of enterprises.
ReleasedEndTime	datetime	The end of the Released Time range used to select data.Required Filter(ge;le)
ReleasedStartTime	datetime	The beginning of the Released Time range used to select data.Required Filter(ge;le)
SchemaVersion	string (9)	The version of the SAF-T schema used to generate the file.Required
SelectionEndDate	date	End Date of the Export PeriodRequired Filter(eq;ge;le)
SelectionStartDate	date	Start Date of the Export PeriodRequired Filter(eq;ge;le)
Status	Status	Current status: Pending(P), Generating(G), Completed(C), Failed(F), Cancelled(N)Required Filter(multi eq)
TaxAccountingBasis	string (18)	Accounting Basis Used in the SAF-T FileRequired Filter(eq)
UltimateOwnerCountryCode	string (2) nullable	Country Code of the Ultimate Owner
UltimateOwnerName CyrillicBG	string (70) nullable	Name of the Bulgarian Ultimate Owner
UltimateOwnerName CyrillicForeign	string (70) nullable	Name of the Foreign Ultimate Owner in Cyrillic
UltimateOwnerName LatinForeign	string (70) nullable	Name of the Foreign Ultimate Owner in Latin Script
UltimateOwnerUICBG	string (35) nullable	UIC of the Bulgarian Ultimate Owner

References

Name	Type	Description
SaftDeclaration	SaftDeclarations	SAF-T declaration

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.
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Attribute Details

ApplicationVersion

ERP.net Version Used to Generate the ExportRequired

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

AuditFileDateCreated

Creation date of odit file (value of AuditFileDateCreated)Required Filter(ge;le)

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

BeneficialOwnerCountryCode

Country Code of the Beneficial Owner

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

BeneficialOwnerEGN

Personal Identification Number of the Bulgarian Beneficial Owne

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

BeneficialOwnerNameCyrillicBG

Name of the Bulgarian Beneficial Owner

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

BeneficialOwnerNameLatinForeign

Name of the Foreign Beneficial Owner

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

CompanyCity

City or Other Locality

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

CompanyCountryCode

Country Code

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

CompanyName

Official Name of the Taxable Person

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

CompanyRegistrationNumber

Company Registration Number or Other Registration Number of the Taxable Person

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

CompanyStreetName

Registered Address of the Taxable Person

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

ContactPersonEmail

Email Address of the Contact Person

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

ContactPersonJobTitle

Position or Role of the Contact Person

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

ContactPersonName

Contact Person Name

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

ContactPersonPhone

Contact Person Phone Number

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

CreatedOn

Date and time of record creationRequired Default(Now) Filter(ge;le)

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDateTime
Show in UI: ShownByDefault

DefaultCurrencyCode

Primary currency code of the SAF-T file.Required

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

ErrorMessage

Information about the error that occurred during failed generation.

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

ExportType

Export type: monthly(M), annual(Y) or on-demand(D).Required Filter(multi eq)

Type: ExportType
Category: System
Allowed values for the ExportType(Regulatory.Saft.DeclarationExports.md#exporttype) data attribute
Allowed Values (Regulatory.Saft.DeclarationExportsRepository.ExportType Enum Members)

Value	Description
Monthly	Monthly value. Stored as 'M'. Database Value: 'M' Model Value: 0 Domain API Value: 'Monthly'
Annual	Annual value. Stored as 'Y'. Database Value: 'Y' Model Value: 1 Domain API Value: 'Annual'
OnDemand	OnDemand value. Stored as 'D'. Database Value: 'D' Model Value: 2 Domain API Value: 'OnDemand'

Supported Filters: Equals, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

FileName

Name of generated SAF-T fileFilter(like)

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

GeneratedByUserId

User who started generation. Filter(multi eq)

Type: guid nullable
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

GeneratedOn

Date and Time of successful generation of report(data preparation).Filter(ge;le)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

IsPartOfGroup

Indicates whether the company belongs to a group of enterprises.

Type: int32 nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

ReleasedEndTime

The end of the Released Time range used to select data.Required Filter(ge;le)

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

ReleasedStartTime

The beginning of the Released Time range used to select data.Required Filter(ge;le)

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

SchemaVersion

The version of the SAF-T schema used to generate the file.Required

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

SelectionEndDate

End Date of the Export PeriodRequired Filter(eq;ge;le)

Type: date
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

SelectionStartDate

Start Date of the Export PeriodRequired Filter(eq;ge;le)

Type: date
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Status

Current status: Pending(P), Generating(G), Completed(C), Failed(F), Cancelled(N)Required Filter(multi eq)

Type: Status
Category: System
Allowed values for the Status(Regulatory.Saft.DeclarationExports.md#status) data attribute
Allowed Values (Regulatory.Saft.DeclarationExportsRepository.Status Enum Members)

Value	Description
Pending	Pending value. Stored as 'P'. Database Value: 'P' Model Value: 0 Domain API Value: 'Pending'
Generating	Generating value. Stored as 'G'. Database Value: 'G' Model Value: 1 Domain API Value: 'Generating'
Completed	Completed value. Stored as 'C'. Database Value: 'C' Model Value: 2 Domain API Value: 'Completed'
Failed	Failed value. Stored as 'F'. Database Value: 'F' Model Value: 3 Domain API Value: 'Failed'
Cancelled	Cancelled value. Stored as 'N'. Database Value: 'N' Model Value: 4 Domain API Value: 'Cancelled'

Supported Filters: Equals, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

TaxAccountingBasis

Accounting Basis Used in the SAF-T FileRequired Filter(eq)

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

UltimateOwnerCountryCode

Country Code of the Ultimate Owner

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

UltimateOwnerNameCyrillicBG

Name of the Bulgarian Ultimate Owner

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

UltimateOwnerNameCyrillicForeign

Name of the Foreign Ultimate Owner in Cyrillic

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

UltimateOwnerNameLatinForeign

Name of the Foreign Ultimate Owner in Latin Script

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

UltimateOwnerUICBG

UIC of the Bulgarian Ultimate Owner

Type: string (35) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 35
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

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

SaftDeclaration

SAF-T declaration

Type: SaftDeclarations
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
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_DeclarationExports

Domain API Entity Type: Regulatory_Saft_DeclarationExport

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

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