Crm.Invoicing.InvoicesOptions

Default options for user document types for Invoices

General

Namespace: Crm.Invoicing
Repository: Crm.Invoicing.InvoicesOptions
Base Table: Crm_Invoices_Options
API access: ReadWrite

Visualization

Display Format: {DocumentType.EntityName}
Search Members: DocumentType.EntityName
Name Member: DocumentType.EntityName
Category: Definitions
Show in UI: ShownByDefault

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:
Systems.Documents.DocumentTypes
Aggregate Root:
Systems.Documents.DocumentTypes

Attributes

Name	Type	Description
CreatesVATEntries	boolean	Specifies whether voiding the invoice should create automatically voiding VAT entry.`Required` `Default(true)`
SignRestriction	SignRestriction	Restricts the sign of the line amounts of the invoices - positive, negative or all amounts.`Required` `Default(0)`
TotalAmountSignRestriction	SignRestriction	Restricts the sign of the total amount (amount to pay) of the invoices. -1 =allow only negative, 0=allow all, 1=allow only positive amounts`Required` `Default(0)`

References

Name	Type	Description
DefaultDealType	DealTypes (nullable)	When not NULL, specifies default VAT deal type.
DocumentType	DocumentTypes	The document type for which the invoice option applies.
VATDeviationDocument AmountType	DocumentAmountTypes (nullable)	Document amount that contains the difference between the total amount of the invoice formed by unit prices with VAT and the amount formed by unit prices without VAT.

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

CreatesVATEntries

Specifies whether voiding the invoice should create automatically voiding VAT entry.Required Default(true)

Type: boolean
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault

SignRestriction

Restricts the sign of the line amounts of the invoices - positive, negative or all amounts.Required Default(0)

Type: SignRestriction
Category: System
Generic enum type for SignRestriction properties
Allowed Values (General.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

Restricts the sign of the total amount (amount to pay) of the invoices. -1 =allow only negative, 0=allow all, 1=allow only positive amountsRequired Default(0)

Type: SignRestriction
Category: System
Generic enum type for SignRestriction properties
Allowed Values (General.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

Id

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

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

DefaultDealType

When not NULL, specifies default VAT deal type.

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

DocumentType

The document type for which the invoice option applies.

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

VATDeviationDocumentAmountType

Document amount that contains the difference between the total amount of the invoice formed by unit prices with VAT and the amount formed by unit prices without VAT.

Type: DocumentAmountTypes (nullable)
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

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