Skip to content

Latest commit

 

History

History
412 lines (305 loc) · 22.4 KB

Finance.Intrastat.DeclarationLines.md

File metadata and controls

412 lines (305 loc) · 22.4 KB
Raw
uid
Finance.Intrastat.DeclarationLines

Finance.Intrastat.DeclarationLines Entity

Namespace: Finance.Intrastat

Contains the details of the Intrastat declarations, issued by the enterprise companies. Entity: Its_Declaration_Lines

Default Visualization

Default Display Text Format:
{IntrastatDeclaration.EntityName}
Default Search Members:
IntrastatDeclaration.EntityName
Name Data Member:
IntrastatDeclaration.EntityName
Category: Definitions
Show in UI: ShownByDefault

Aggregate

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

Aggregate Parent:
Finance.Intrastat.Declarations
Aggregate Root:
Finance.Intrastat.Declarations

Attributes

Name Type Description
DeliveryTerms DeliveryTerms Delivery terms - classification according to Intrastat (which uses the common abbreviations). Required
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
InvoicedValueAmountBase Amount (10, 0) Invoiced value of the goods in the base currency. Currency: IntrastatDeclaration.EnterpriseCompany.BaseCurrency Required
LineAction LineAction Line action - 'NEW' = New, 'EDN' = Edited-New, 'EDO' = Edited-Old, 'DEL' = Deleted. Required Default("NEW")
LineNo int32 Consequtive line number within the intrastat declaration. Required Filter(eq)
NetMassKg decimal (14, 3) Net mass of the goods in kg. Required Filter(multi eq)
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.
QuantitySupplementaryUnit decimal (10, 0) nullable Quantity of the goods in the supplementary unit. null when no supplementary unit is specified.
StatisticalValueAmountBase Amount (10, 0) nullable Statistical value of the goods in the base currency. Currency: IntrastatDeclaration.EnterpriseCompany.BaseCurrency
TransactionNature TransactionNature Transaction nature, according to the Intrastat classification. Required
TransportMode TransportMode Transportation mode - type of transportation used. Required

References

Name Type Description
AdministrativeRegion AdministrativeRegions Administrative region of the enterprise company at the time of the declaration. Required Filter(multi eq)
IntrastatCommodityCode CommodityCodes The commodity code of the goods, according to the Intrastat commodity classification. Required Filter(multi eq)
IntrastatDeclaration Declarations The intrastat declaration, to which this line belongs. Required Filter(multi eq) Owner
OriginCountry Countries (nullable) The country of origin of the goods. null for outbound declarations. Filter(multi eq)
Party Parties (nullable) Partner to whom the goods are dispatched, or partner from whom the goods are received. Filter(multi eq) Introduced in version 22.1.5.58
PartyCountry Countries The country of the partner. Required Filter(multi eq)
TransportCountry Countries The country of the transportation company. Required Filter(multi eq)

Attribute Details

DeliveryTerms

Delivery terms - classification according to Intrastat (which uses the common abbreviations). Required

Type: DeliveryTerms
Category: System
Generic enum type for DeliveryTerms properties
Allowed Values (Finance.Intrastat.DeliveryTerms Enum Members)

Value Description
ExWorks ExWorks value. Stored as 'EXW'.
Database Value: 'EXW'
Model Value: 0
Domain API Value: 'ExWorks'
FrancoCarrier FrancoCarrier value. Stored as 'FCA'.
Database Value: 'FCA'
Model Value: 1
Domain API Value: 'FrancoCarrier'
FreeAlongsideShip FreeAlongsideShip value. Stored as 'FAS'.
Database Value: 'FAS'
Model Value: 2
Domain API Value: 'FreeAlongsideShip'
FreeOnBoard FreeOnBoard value. Stored as 'FOB'.
Database Value: 'FOB'
Model Value: 3
Domain API Value: 'FreeOnBoard'
CostAndFreightCF CostAndFreightCF value. Stored as 'CFR'.
Database Value: 'CFR'
Model Value: 4
Domain API Value: 'CostAndFreightCF'
CostInsuranceAndFreight CostInsuranceAndFreight value. Stored as 'CIF'.
Database Value: 'CIF'
Model Value: 5
Domain API Value: 'CostInsuranceAndFreight'
CarriagePaidTo CarriagePaidTo value. Stored as 'CPT'.
Database Value: 'CPT'
Model Value: 6
Domain API Value: 'CarriagePaidTo'
CarriageAndInsurancePaidTo CarriageAndInsurancePaidTo value. Stored as 'CIP'.
Database Value: 'CIP'
Model Value: 7
Domain API Value: 'CarriageAndInsurancePaidTo'
DeliveredAtPlace DeliveredAtPlace value. Stored as 'DAP'.
Database Value: 'DAP'
Model Value: 8
Domain API Value: 'DeliveredAtPlace'
DeliveredAtTerminal DeliveredAtTerminal value. Stored as 'DAT'.
Database Value: 'DAT'
Model Value: 9
Domain API Value: 'DeliveredAtTerminal'
DeliveredDutyPaid DeliveredDutyPaid value. Stored as 'DDP'.
Database Value: 'DDP'
Model Value: 10
Domain API Value: 'DeliveredDutyPaid'
DeliveredAtPlaceUnloaded DeliveredAtPlaceUnloaded value. Stored as 'DPU'.
Database Value: 'DPU'
Model Value: 11
Domain API Value: 'DeliveredAtPlaceUnloaded'

Supported Filters: NotFilterable
Supports Order By: False
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

InvoicedValueAmountBase

Invoiced value of the goods in the base currency. Currency: IntrastatDeclaration.EnterpriseCompany.BaseCurrency Required

Type: Amount (10, 0)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

LineAction

Line action - 'NEW' = New, 'EDN' = Edited-New, 'EDO' = Edited-Old, 'DEL' = Deleted. Required Default("NEW")

Type: LineAction
Category: System
Allowed values for the LineAction(Finance.Intrastat.DeclarationLines.md#lineaction) data attribute
Allowed Values (Finance.Intrastat.DeclarationLinesRepository.LineAction Enum Members)

Value Description
New New value. Stored as 'NEW'.
Database Value: 'NEW'
Model Value: 0
Domain API Value: 'New'
EditedNew EditedNew value. Stored as 'EDN'.
Database Value: 'EDN'
Model Value: 1
Domain API Value: 'EditedNew'
EditedOld EditedOld value. Stored as 'EDO'.
Database Value: 'EDO'
Model Value: 2
Domain API Value: 'EditedOld'
Deleted Deleted value. Stored as 'DEL'.
Database Value: 'DEL'
Model Value: 3
Domain API Value: 'Deleted'

Supported Filters: NotFilterable
Supports Order By: False
Default Value: New
Show in UI: ShownByDefault

LineNo

Consequtive line number within the intrastat declaration. Required Filter(eq)

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

Back-End Default Expression:
( obj.IntrastatDeclaration.Lines.Select( c => c.LineNo).DefaultIfEmpty( 0).Max( ) + 10)

Front-End Recalc Expressions:
( obj.IntrastatDeclaration.Lines.Select( c => c.LineNo).DefaultIfEmpty( 0).Max( ) + 10)

NetMassKg

Net mass of the goods in kg. Required Filter(multi eq)

Type: decimal (14, 3)
Category: System
Supported Filters: Equals, EqualsIn
Supports Order By: False
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

QuantitySupplementaryUnit

Quantity of the goods in the supplementary unit. null when no supplementary unit is specified.

Type: decimal (10, 0) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

StatisticalValueAmountBase

Statistical value of the goods in the base currency. Currency: IntrastatDeclaration.EnterpriseCompany.BaseCurrency

Type: Amount (10, 0) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

TransactionNature

Transaction nature, according to the Intrastat classification. Required

Type: TransactionNature
Category: System
Generic enum type for TransactionNature properties
Allowed Values (Finance.Intrastat.TransactionNature Enum Members)

Value Description
OutrightPurchaseOrSale OutrightPurchaseOrSale value. Stored as '11'.
Database Value: '11'
Model Value: 0
Domain API Value: 'OutrightPurchaseOrSale'
SupplyForSale SupplyForSale value. Stored as '12'.
Database Value: '12'
Model Value: 1
Domain API Value: 'SupplyForSale'
BarterTrade BarterTrade value. Stored as '13'.
Database Value: '13'
Model Value: 2
Domain API Value: 'BarterTrade'
FinancialLeasing FinancialLeasing value. Stored as '14'.
Database Value: '14'
Model Value: 3
Domain API Value: 'FinancialLeasing'
OtherTransactions OtherTransactions value. Stored as '19'.
Database Value: '19'
Model Value: 4
Domain API Value: 'OtherTransactions'
ReturnStokilizing ReturnStokilizing value. Stored as '21'.
Database Value: '21'
Model Value: 5
Domain API Value: 'ReturnStokilizing'
ReplacementFor
ReturnedGoods		 ReplacementFor
ReturnedGoods value. Stored as '22'.
Database Value: '22'
Model Value: 6
Domain API Value: 'ReplacementFor
ReturnedGoods'
ReplacementOfGoods
NotBeingReturned		 ReplacementOfGoods
NotBeingReturned value. Stored as '23'.
Database Value: '23'
Model Value: 7
Domain API Value: 'ReplacementOfGoods
NotBeingReturned'
ReturnOrExchange
OfOtherGoods		 ReturnOrExchange
OfOtherGoods value. Stored as '29'.
Database Value: '29'
Model Value: 8
Domain API Value: 'ReturnOrExchange
OfOtherGoods'
SpecificTransactions SpecificTransactions value. Stored as '60'.
Database Value: '60'
Model Value: 9
Domain API Value: 'SpecificTransactions'
OperationsOnJointProjects OperationsOnJointProjects value. Stored as '70'.
Database Value: '70'
Model Value: 10
Domain API Value: 'OperationsOnJointProjects'
TransactionsOf
ConstructionMaterials
AndEquipment		 TransactionsOf
ConstructionMaterials
AndEquipment value. Stored as '80'.
Database Value: '80'
Model Value: 11
Domain API Value: 'TransactionsOf
ConstructionMaterials
AndEquipment'
OtherTransactionsLeasing OtherTransactionsLeasing value. Stored as '91'.
Database Value: '91'
Model Value: 12
Domain API Value: 'OtherTransactionsLeasing'
OtherTransactionsOther OtherTransactionsOther value. Stored as '99'.
Database Value: '99'
Model Value: 13
Domain API Value: 'OtherTransactionsOther'
DealsThatInclude
PropertyTransfers
WithoutFinancial
CompensationOr
CompensationIn
Kind		 DealsThatInclude
PropertyTransfers
WithoutFinancial
CompensationOr
CompensationIn
Kind value. Stored as '30'.
Database Value: '30'
Model Value: 14
Domain API Value: 'DealsThatInclude
PropertyTransfers
WithoutFinancial
CompensationOr
CompensationIn
Kind'
GoodsThatAreExpected
ToBeReturnedTo
Sender		 GoodsThatAreExpected
ToBeReturnedTo
Sender value. Stored as '41'.
Database Value: '41'
Model Value: 15
Domain API Value: 'GoodsThatAreExpected
ToBeReturnedTo
Sender'
GoodsThatAreNot
ExpectedToBeReturned
ToSender		 GoodsThatAreNot
ExpectedToBeReturned
ToSender value. Stored as '42'.
Database Value: '42'
Model Value: 16
Domain API Value: 'GoodsThatAreNot
ExpectedToBeReturned
ToSender'
GoodsThatAreReturned
ToSender		 GoodsThatAreReturned
ToSender value. Stored as '51'.
Database Value: '51'
Model Value: 17
Domain API Value: 'GoodsThatAreReturned
ToSender'
GoodsThatAreNot
ReturnedToSender		 GoodsThatAreNot
ReturnedToSender value. Stored as '52'.
Database Value: '52'
Model Value: 18
Domain API Value: 'GoodsThatAreNot
ReturnedToSender'

Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

TransportMode

Transportation mode - type of transportation used. Required

Type: TransportMode
Category: System
Generic enum type for TransportMode properties
Allowed Values (Finance.Intrastat.TransportMode Enum Members)

Value Description
Shipping Shipping value. Stored as '1'.
Database Value: '1'
Model Value: 0
Domain API Value: 'Shipping'
RailwayTransport RailwayTransport value. Stored as '2'.
Database Value: '2'
Model Value: 1
Domain API Value: 'RailwayTransport'
RoadTransport RoadTransport value. Stored as '3'.
Database Value: '3'
Model Value: 2
Domain API Value: 'RoadTransport'
AirTransport AirTransport value. Stored as '4'.
Database Value: '4'
Model Value: 3
Domain API Value: 'AirTransport'
Mail Mail value. Stored as '5'.
Database Value: '5'
Model Value: 4
Domain API Value: 'Mail'
FixedTransport
Installations		 FixedTransport
Installations value. Stored as '7'.
Database Value: '7'
Model Value: 5
Domain API Value: 'FixedTransport
Installations'
RiverTransport RiverTransport value. Stored as '8'.
Database Value: '8'
Model Value: 6
Domain API Value: 'RiverTransport'
SelfPropelled SelfPropelled value. Stored as '9'.
Database Value: '9'
Model Value: 7
Domain API Value: 'SelfPropelled'

Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

AdministrativeRegion

Administrative region of the enterprise company at the time of the declaration. Required Filter(multi eq)

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

IntrastatCommodityCode

The commodity code of the goods, according to the Intrastat commodity classification. Required Filter(multi eq)

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

IntrastatDeclaration

The intrastat declaration, to which this line belongs. Required Filter(multi eq) Owner

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

OriginCountry

The country of origin of the goods. null for outbound declarations. Filter(multi eq)

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

Party

Partner to whom the goods are dispatched, or partner from whom the goods are received. Filter(multi eq) Introduced in version 22.1.5.58

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

PartyCountry

The country of the partner. Required Filter(multi eq)

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

TransportCountry

The country of the transportation company. Required Filter(multi eq)

Type: Countries
Category: System
Supported Filters: Equals, EqualsIn
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

Creates a notification and sends 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 subject.
    Type: string

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

[!list limit=1000 erp.entity=Finance.Intrastat.DeclarationLines erp.type=business-rule default-text="None"]

Front-End Business Rules

[!list limit=1000 erp.entity=Finance.Intrastat.DeclarationLines erp.type=front-end-business-rule default-text="None"]

API

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

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