Logistics.Procurement.PurchaseInvoicesOptions Entity

Contains purchase invoice specific options for the different document types. Entity: Scm_Purchase_Invoices_Options

Default Visualization

Default Display Text Format:
{DocumentType.EntityName}
Default Search Members:
DocumentType.EntityName
Name Data Member:
DocumentType.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:
Systems.Documents.DocumentTypes
Aggregate Root:
Systems.Documents.DocumentTypes

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
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.
SignRestriction	SignRestriction	This option can restrict the sign of the Line Amounts for each detail line in purchase invoices of the specified document type. `Required` `Default(0)`
TotalAmountSignRestriction	TotalAmountSignRestriction	This option can restrict the sign of the Total Amounts of the purchase invoices of the specified document type. The restriction is applied upon document Release. `Required` `Default(0)`

References

Name	Type	Description
DocumentType	DocumentTypes	The document type, for which the options are specified. `Required` `Filter(multi eq)` `Owner`

Attribute Details

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: 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

SignRestriction

This option can restrict the sign of the Line Amounts for each detail line in purchase invoices of the specified document type. Required Default(0)

Type: SignRestriction
Category: System
Allowed values for the SignRestriction(Logistics.Procurement.PurchaseInvoicesOptions.md#signrestriction) data attribute
Allowed Values (Logistics.Procurement.PurchaseInvoicesOptionsRepository.SignRestriction Enum Members)

Value	Description
AllowAll	AllowAll value. Stored as 0. Database Value: 0 Model Value: 0 Domain API Value: 'AllowAll'
AllowOnlyPositive	AllowOnlyPositive value. Stored as 1. Database Value: 1 Model Value: 1 Domain API Value: 'AllowOnlyPositive'
AllowOnlyNegative	AllowOnlyNegative value. Stored as -1. Database Value: -1 Model Value: -1 Domain API Value: 'AllowOnlyNegative'

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

TotalAmountSignRestriction

This option can restrict the sign of the Total Amounts of the purchase invoices of the specified document type. The restriction is applied upon document Release. Required Default(0)

Type: TotalAmountSignRestriction
Category: System
Allowed values for the TotalAmountSignRestriction(Logistics.Procurement.PurchaseInvoicesOptions.md#totalamountsignrestriction) data attribute
Allowed Values (Logistics.Procurement.PurchaseInvoicesOptionsRepository.TotalAmountSignRestriction Enum Members)

Value	Description
AllowAll	AllowAll value. Stored as 0. Database Value: 0 Model Value: 0 Domain API Value: 'AllowAll'
AllowOnlyPositive	AllowOnlyPositive value. Stored as 1. Database Value: 1 Model Value: 1 Domain API Value: 'AllowOnlyPositive'
AllowOnlyNegative	AllowOnlyNegative value. Stored as -1. Database Value: -1 Model Value: -1 Domain API Value: 'AllowOnlyNegative'

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

Reference Details

DocumentType

The document type, for which the options are specified. Required Filter(multi eq) Owner

Type: DocumentTypes
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: HiddenByDefault

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