IPosTerminalOpenCloseEntity Interface

Represent the point of sales terminal open/close entity

(Ouverture/Clôture de caisse)

Namespace: EBP.Api.Interfaces.Invoicing.Module.Entities.Pos
Assembly: EBP.Api.XXX.Interfaces (in EBP.Api.XXX.Interfaces.dll) Version: 1.0.3.0

Syntax

Copy

[GuidAttribute("2cfefe36-bef7-44c1-a3cd-2d1ecaee9522")]
public interface IPosTerminalOpenCloseEntity : IInvoicingEntityBase, 
	IBusinessEntityBase, ISynchronizableEntityBase, IEntity, IApiEntity, IDisposable, 
	IEquatable<IProxy>

<GuidAttribute("2cfefe36-bef7-44c1-a3cd-2d1ecaee9522")>
Public Interface IPosTerminalOpenCloseEntity
	Inherits IInvoicingEntityBase, IBusinessEntityBase, ISynchronizableEntityBase, IEntity, 
	IApiEntity, IDisposable, IEquatable(Of IProxy)

The IPosTerminalOpenCloseEntity type exposes the following members.

Properties

	Name	Description
	AccountingExchangeGroupId	Gets or sets Accounting exchange group Id (Identifiant du lot comptable)
	AccountingExchangeGroupIdMember	Gets Accounting exchange group Id (Identifiant du lot comptable)
	AccountingTransferState	Gets or sets the accounting transfer state List of authorized values in AccountingTransferState (Transféré en comptabilité)
	AccountingTransferStateMember	Gets the accounting transfer state List of authorized values in AccountingTransferState (Transféré en comptabilité)
	AmountOfDeposit	Gets or sets the amount of deposit. (Montant des dépots)
	AmountOfDepositMember	Gets the amount of deposit. (Montant des dépots)
	AmountVatExcluded	Gets or sets the amount vat excluded. (Montant HT)
	AmountVatExcludedMember	Gets the amount vat excluded. (Montant HT)
	AmountVatIncluded	Gets or sets the amount vat included. (Montant TTC)
	AmountVatIncludedMember	Gets the amount vat included. (Montant TTC)
	CashRegisterGapAmount	Gets or sets the cash register gap amount. Only initialized when POS terminal is closed (Écart de caisse)
	CashRegisterGapAmountMember	Gets the cash register gap amount. Only initialized when POS terminal is closed (Écart de caisse)
	CloseAmount	Gets or sets the close amount. (Montant de clôture)
	CloseAmountMember	Gets the close amount. (Montant de clôture)
	CloseCashFunds	Gets the close cash funds.
	CloseDateTime	Gets or sets the close date time. (Date et heure de clôture)
	CloseDateTimeMember	Gets the close date time. (Date et heure de clôture)
	ClosedPeriodBeginning	Gets or sets the beginning of closed period (Début de période clôturée)
	ClosedPeriodBeginningMember	Gets the beginning of closed period (Début de période clôturée)
	ClosedPeriodEnding	Gets or sets the ending od closed period (Fin de période clôturée)
	ClosedPeriodEndingMember	Gets the ending od closed period (Fin de période clôturée)
	CloseTime	Gets or sets the close time.
	CloseTimeMember	Gets the close time.
	ColleagueDetail	Gets the colleague detail.
	CollectedAmount	Gets or sets the collected amount. (Montant encaissé)
	CollectedAmountMember	Gets the collected amount. (Montant encaissé)
	CreatedDate	Gets the Created Date (Inherited from IEntity.)
	CreatedUser	Gets the Created User (Inherited from IEntity.)
	DeliveryOrderAmountVatExcluded	Gets or sets the amount vat excluded for deliveries orders. (Montant HT des bons de livraison)
	DeliveryOrderAmountVatExcludedMember	Gets the amount vat excluded for deliveries orders. (Montant HT des bons de livraison)
	DeliveryOrderAmountVatIncluded	Gets or sets the amount vat included for deliveries orders. (Montant TTC des bons de livraison)
	DeliveryOrderAmountVatIncludedMember	Gets the amount vat included for deliveries orders. (Montant TTC des bons de livraison)
	DepositsAmountVatIncluded	Gets or sets the deposits amount vat included. (Montant TTC des acomptes)
	DepositsAmountVatIncludedMember	Gets the deposits amount vat included. (Montant TTC des acomptes)
	EntityCaption	Gets the caption of the current entity, using the content (Inherited from IEntity.)
	EntityLabel	Gets the entity Label (Inherited from IEntity.)
	Errors	Gets the collection of errors (Inherited from IEntity.)
	Hash	Gets the hash.
	Id	Id of the data (Code)
	IdMember	Id of the data (Code)
	IsDeleted	Gets if the mode matches a deleted mode (Inherited from IEntity.)
	IsEmptyLine	Indicates if the entity is an empty line of an entity collection (created in auto following the entityCollection options) (Inherited from IEntity.)
	ItemFamilyDetail	Gets the item family detail.
	LiquidatedAmount	Gets or sets the liquidated amount. (Montant non perçu)
	LiquidatedAmountMember	Gets the liquidated amount. (Montant non perçu)
	Members	List of the members. It allows to acces to members with the name (Inherited from IEntity.)
	Mode	Gets the entity mode (Inherited from IEntity.)
	ModifiedDate	Gets the Modified Date (Inherited from IEntity.)
	ModifiedUser	Gets the Modified User (Inherited from IEntity.)
	Notes	Gets or sets the notes in RTF format. (Notes) (Inherited from IBusinessEntityBase.)
	NotesClear	Gets or sets the notes in plain text format. (Notes en texte brut) (Inherited from IBusinessEntityBase.)
	NotesClearMember	Gets the notes in plain text format. (Notes en texte brut) (Inherited from IBusinessEntityBase.)
	NotesMember	Gets the notes in RTF format. (Notes) (Inherited from IBusinessEntityBase.)
	OpenAmount	Gets or sets the open amount. (Montant d'ouverture)
	OpenAmountMember	Gets the open amount. (Montant d'ouverture)
	OpenCashFunds	Gets the open cash funds.
	OpenDateTime	Gets or sets the open date time. (Date et heure d'ouverture)
	OpenDateTimeMember	Gets the open date time. (Date et heure d'ouverture)
	OpenTime	Gets or sets the open time.
	OpenTimeMember	Gets the open time.
	OrderAmountVatExcluded	Gets or sets the amount vat excluded for orders. (Montant HT des commandes)
	OrderAmountVatExcludedMember	Gets the amount vat excluded for orders. (Montant HT des commandes)
	OrderAmountVatIncluded	Gets or sets the amount vat included for orders. (Montant TTC des commandes)
	OrderAmountVatIncludedMember	Gets the amount vat included for orders. (Montant TTC des commandes)
	OwnerEntity	Gets the main entity that own all this items/collection (Inherited from IEntity.)
	Parent	Gets the parent entity collection, that own this item (Inherited from IEntity.)
	PaymentTypeDetail	Gets the payment type detail.
	PeriodType	Gets or sets the close period type (day, month, year) (Type de périodicité)
	PeriodTypeMember	Gets the close period type (day, month, year) (Type de périodicité)
	PosReceiptCount	Gets or sets the position receipt count. (Nombre de tickets)
	PosReceiptCountMember	Gets the position receipt count. (Nombre de tickets)
	PosTerminalComputerName	Gets the point of sales terminal computer name. (Nom du PC associé)
	PosTerminalComputerNameMember	Gets the point of sales terminal computer name. (Nom du PC associé)
	PosTerminalDefaultCustomerId	Gets the point of sales terminal default customer identifier. (Client par défaut)
	PosTerminalDefaultCustomerIdMember	Gets the point of sales terminal default customer identifier. (Client par défaut)
	PosTerminalDefaultSafeId	Gets the point of sales terminal default safe identifier. (Code du coffre-fort par défaut)
	PosTerminalDefaultSafeIdMember	Gets the point of sales terminal default safe identifier. (Code du coffre-fort par défaut)
	PosTerminalDefaultSerial	Gets the point of sales terminal default serial. (Série de documents)
	PosTerminalDefaultSerialMember	Gets the point of sales terminal default serial. (Série de documents)
	PosTerminalId	PosTerminalId of the data (Code caisse)
	PosTerminalIdMember	PosTerminalId of the data (Code caisse)
	PosTerminalShowHoldReceiptsForAllTerminals	Gets the point of sales terminal show hold receipts for all terminals. (Afficher les tickets en attente de toutes les caisses)
	PosTerminalShowHoldReceiptsForAllTerminalsMember	Gets the point of sales terminal show hold receipts for all terminals. (Afficher les tickets en attente de toutes les caisses)
	ReadOnly	Gets/Sets if the entity is in read only mode, to preserve from data changing (Inherited from IEntity.)
	ReturningChangeGiftVouchers	Gets or sets the returning change gift vouchers. (Rendu par chèque-cadeau enseigne)
	ReturningChangeGiftVouchersMember	Gets the returning change gift vouchers. (Rendu par chèque-cadeau enseigne)
	SaleInAccountAmountVatIncluded	Gets or sets the sale in account amount vat included. (Montant TTC vente en compte)
	SaleInAccountAmountVatIncludedMember	Gets the sale in account amount vat included. (Montant TTC vente en compte)
	SaleInAccountPaymentTypeDetail	Gets the sale in account payment type detail.
	Silent	Get/Sets if the entity is in silent mode (Inherited from IEntity.)
	SoldGiftVouchers	Gets or sets the sold gift vouchers. (Montant des chèques-cadeaux enseignes vendus)
	SoldGiftVouchersMember	Gets the sold gift vouchers. (Montant des chèques-cadeaux enseignes vendus)
	States	Gets the entity states (Inherited from IEntity.)
	TheoreticalCloseAmount	Gets or sets the theoretical close amount. Only initialized when POS terminal is closed (Montant théorique de caisse)
	TheoreticalCloseAmountMember	Gets the theoretical close amount. Only initialized when POS terminal is closed (Montant théorique de caisse)
	TotalCreditMemoBalanceDue	Gets or sets the total credit memo balance due. (Montant des avoirs non remboursés)
	TotalCreditMemoBalanceDueMember	Gets the total credit memo balance due. (Montant des avoirs non remboursés)
	UniqueId	Gets or sets the unique Id (Inherited from ISynchronizableEntityBase.)
	UniqueIdMember	Gets the unique Id (Inherited from ISynchronizableEntityBase.)
	UserId	Gets or sets the user identifier. (Code utilisateur)
	UserIdMember	Gets the user identifier. (Code utilisateur)
	VatDetail	Gets the vat detail.
	WithdrawalAmount	Gets or sets the withdrawal amount. (Montant des retraits)
	WithdrawalAmountMember	Gets the withdrawal amount. (Montant des retraits)

Top

Methods

	Name	Description
	Append	Method for add a new entity to the media. Update the entity to its default value. (Inherited from IEntity.)
	Cancel	Cancel the edit mode without saving, and reload the entity (Inherited from IEntity.)
	CancelEdit	Cancel the edit mode without saving, without reload the entity (Inherited from IEntity.)
	CheckData	Check the data of the entity (Inherited from IEntity.)
	Clear	Clear the entity content and reinitialize it to the default value (Inherited from IEntity.)
	Clone	Clone an entity (Inherited from IEntity.)
	CopyTo(IEntity)	Copy the entity content to another entity (Inherited from IEntity.)
	CopyTo(IEntity, Boolean)	Copy the entity content to another entity (Inherited from IEntity.)
	Delete	Method for delete a existing entity from the media (Inherited from IEntity.)
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
	Edit	Method to pass in edit mode a existing entity in the media (for exemple, add a lock for database) (Inherited from IEntity.)
	GetExtension	Gets the extension. (Inherited from IApiEntity.)
	Load	Method for loading the entity (Inherited from IEntity.)
	Save	Method for saving the entity to the media (Inherited from IEntity.)
	SetComplexMemberReadOnly	Set the read only property to a member (Inherited from IEntity.)
	ShowMessage	Method to display a message. The message is displayed if the UI has connected to the ShowMessage event (Inherited from IApiEntity.)

Top

Events

	Name	Description
	ModeChanged	Event raised on mode changed (Inherited from IEntity.)

Top

Remarks

The IPosTerminalOpenCloseEntity type can be instantiated with EBP.Api.Utils<TExtension>.GetInterface<T>

Copy

IPosTerminalOpenCloseEntity instance = Utils<ExtensionType>.GetInterface<IPosTerminalOpenCloseEntity>();

Reference

EBP.Api.Interfaces.Invoicing.Module.Entities.Pos Namespace

EBP.Api.Interfaces.EntityIEntity