Show / Hide Table of Contents

    Crm.Invoicing.InvoicesOptions Entity

    Namespace: Crm.Invoicing

    Default options for user document types for Invoices. Entity: Crm_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:
    General.DocumentTypes
    Aggregate Root:
    General.DocumentTypes

    Attributes

    Name Type Description
    CreatesVATEntries boolean Specifies whether the invoices of the current type create entries in the VAT ledges. If is used, for instance, to determine if null VAT entry should be automatically created when the invoice is voided. Required Default(true)
    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 Restricts the sign of the line amounts of the invoices. -1 =allow only negative, 0=allow all, 1=allow only positive 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. Filter(multi eq)
    DocumentType DocumentTypes The document type for which the invoice option applies. Required Filter(multi eq) Owner
    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. Filter(multi eq)

    Attribute Details

    CreatesVATEntries

    Specifies whether the invoices of the current type create entries in the VAT ledges. If is used, for instance, to determine if null VAT entry should be automatically created when the invoice is voided. Required Default(true)

    Type: boolean
    Category: System
    Supported Filters: NotFilterable
    Supports Order By: False
    Default Value: True
    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

    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

    Restricts the sign of the line amounts of the invoices. -1 =allow only negative, 0=allow all, 1=allow only positive 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 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

    Reference Details

    DefaultDealType

    When not null, specifies default VAT deal type. Filter(multi eq)

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

    DocumentType

    The document type for which the invoice option applies. Required Filter(multi eq) Owner

    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. Filter(multi eq)

    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

    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

    None

    Front-End Business Rules

    None

    API

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

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

    • Improve this Doc
    Back to top Generated by DocFX