Site service service
This service handles all of the functionality for the Site service both from the LS One POS and the Site Manager.
This service has been broken down into multiple partial classes to organize the code and make finding the code for each functionality easier. Each section of this service will be explained separately
Configurations
For the POS to be able to use the Site service a site service profile needs to be configured. The various functionalities that use the site service can in some cases also have separate configurations such as gift cards and loyalty functionality.
The Site Manager also uses a site service profile to be able to connect to the Site service to get information about gift cards, inventory, loyalty and etc.
Main functionality
There are several functions in this service that are marked as Obsolete with messages of using another overloaded version of the same function.
The POS and Site Manager need to use very specific functions that partners doing customizations should not be using so in order to make clear which function should be used by partners we chose to mark the ones that should only be used in very limited and specific cases as obsolete.
Not all of the public functions are listed in the lists here below. Some of the functions should not be customized as they are used by the core of either the POS and/or Site Manager and should never be changed.
| Name | Description |
|---|---|
| Connect | Connects to the Site service using information on a Site service profile object |
| Disconnect | Disconnects the Site service connection |
| GetExceptionDisplayText | Returns a string that can be displayed to the user if an exception comes up when using the Site service |
| LoadConfiguration | Retrieves the configuration file from the Site service |
| SendConfiguration | Sends the Site service a new configuration file |
| SetAddress | This function sets the address and port number of the Site service that the POS or Site Manager should be communicating with. There are several overloaded functions with this name but only one should be used. The other ones have been marked as Obsolete with information on what other function should be used. |
| TestConnection | Tests the connection to see if it is alive and can be used |
| TestConnectionWithFeedback | Tests the connection and returns a string with the error message if the test was not successful |
Central returns
All the functions that have to do with returning sales that are not on the local POS system and need to be retrieved from the central Head office server. See also more information in the Transaction service
| Name | Description |
|---|---|
| GetTransactionListForReceiptID | Retrieves a list of transactions that have a specific Receipt ID |
| GetTransactionXML | Gets the XML for the transaction that has been selected |
| MarkItemsReturned | Marks items that were selected for return as returned |
Central suspension
All Site service functions related to central suspensions. Some of these functions are only used in the POS and other only used in the Site Manager.
See also more information in the Central suspension service
| Name | Description |
|---|---|
| DeleteSuspendedTransaction | Deletes a specific suspended transaction |
| GetSuspendedTransaction | Returns a specific suspended transaction |
| GetSuspendedTransactionAnswers | Retrieves answers that were entered when the transaction was suspended |
| GetSuspendedTransactionAnswersByType | Retrieves answers for a suspended transaction for a specific suspension type |
| GetSuspendedTransCount | Retrieves a count of suspended transactions for a specific terminal |
| GetSuspendedTransactionList | Gets a list of all suspended transaction |
| GetSuspendedTransactionListForStore | Gets a list of all suspended transaction for a store |
| RecallSuspendedTransaction | Recalls a specific transaction |
| Suspend transaction | Suspends a transaction to a central location |
Credit memo
All Site service functions related to credit memo functionality. Some of these functions are only used in the POS and other only used in the Site Manager.
See also more information in the Credit memo service
| Name | Description |
|---|---|
| AddToCreditVoucher | Adds an amount to a credit ememo |
| DeleteCreditVoucher | Deletes a specific credit memo |
| GetCreditVoucher | Returns information about a specific credit memo |
| GetCreditVoucherLines | Returns a list of transactions for a specific credit memo |
| IssueCreditVoucher | Creates a credit memo |
| SearchCreditVouchers | Returns a list of credit memos limited by the parameters sent in |
| ValidateCreditVoucher | Makes sure the credit memo being checked is valid and exists |
| UseCreditVoucher | Updates the usage of the credit memo |
Customer
All Site service functions related to customer functionality. Some of these functions are only used in the POS and other only used in the Site Manager.
See also more information in the Customer service
| Name | Description |
|---|---|
| CustomersDiscountedPurchasesStatus | Returns what the maximum amount of discounts for this customer is and what the current amount is |
| CustomerExists | Checks if the customer ID that is being searched for exists |
| DeleteCustomer | Deletes a specific customer |
| GetCustomer | Returns information about a specific customer |
| GetCustomers | Returns a list of customers |
| GetCustomerTransactionXML | Retrieves the XML necessary to display information about a sale in the receipt component |
| SaveCustomer | Saves information about a customer |
Customer ledger
All Site service functions related to customer ledger functionality. Some of these functions are only used in the POS and other only used in the Site Manager.
See also more information in the Customer service
| Name | Description |
|---|---|
| CustomerAccountCreditMemo | Creates a customer ledger entry for when a credit memo is used for payment |
| CustomerAccountPayment | Creates a customer ledger entry for when a customer account is used for payment |
| DeleteCustomerLedgerEntry | Deletes a specific customer ledger entry |
| GetCustomerBalance | Returns the credit balance for this customer |
| GetCustomerLedgerEntriesList | Returns a list of customer ledger entries for a customer |
| GetCustomerTotalSales | Returns the total sales amount for this customer |
| PaymentIntoCustomerAccount | Creates a customer ledger entry for when a payment is done into a customer account |
| SaveCustomerLedgerEntries | Saves customer ledger entries that have been created |
| ValidateCustomerStatus | Returns current balance information about the customer |
| UpdateRemainingAmount | Updates the remaining amount the customer has on the credit limit |
Customer orders
All Site service functions related to customer order functionality. Some of these functions are only used in the POS and other only used in the Site Manager.
See also more information in the Customer order service
| Name | Description |
|---|---|
| CreateCustomerOrder | Creates a new customer order |
| CreateReferenceNo | Creates a new unique reference number for a customer order |
| CustomerOrderSearch | Searches for a customer order using search criteria which is set as one of the parameters |
| SaveCustomerOrder | Saves changes to the customer order |
| SaveCustomerOrderDetails | Saves changes to information about a customer order not the actual order itself |
All Site service functions related to email functionality. Most of these functions are only used by the Site service itself
See also more information in the Transaction service
| Name | Description |
|---|---|
| GetEmail | Retrieves a specific email. This function is called by the Site service |
| GetEMails | Retrieves a list of emails that need to be sent. This function is called by the Site service |
| GetEMailCount | Retrieves how many emails have been sent or not been sent depending on parameters. This function is called by the Site service |
| GetEMailSetupForStore | Retrieves the email setup for the store through the Site service |
| IsEMailSetupForStore | Checks and returns if the store has been configured for sending emails |
| QueueEMailEntry | This function queues the email that has been created to be sent by the Site service |
| SaveEMailSetupForStore | Saves the email setup for the store through the Site service |
| SendQueuedEMailEntries | Sends any and all queued emails. This function is called by the Site service |
| TruncateEMailQueue | Deletes the emails that have been sent according to the configurations on the Site service profile |
Gift cards
All Site service functions related to gift card functionality. Some of these functions are only used in the POS and other only used in the Site Manager.
See also more information in the Gift card service and the Transaction service
| Name | Description |
|---|---|
| ActivateGiftCard | Activates an existing gift card |
| AddNewGiftCard | Creates a new gift card |
| AddToGiftCard | Adds an amount to the gift card |
| DeactivateGiftCard | Deactivates an existing gift card |
| DeleteGiftCard | Deletes a specific gift card |
| GetGiftCard | Returns information about a specific gift card |
| GetGiftCardLines | Returns a list of transactions for a gift card |
| MarkGiftCertificateIssued | Marks an existing gift card as issued |
| SearchGiftCards | Searches for gift cards according to the search criteria in the parameters |
| ValidateGiftCard | Validates that a gift card exists and is valid |
| UseGiftCard | Updates the usage of a gift card |
| UpdateGiftCardPaymentReceipt | Updates the gift card payment information after the transaction has been concluded |
Hospitality
All Site service functions related to hospitality functionality. This functionality has mostly to do with updating the table view and orders on the tables
See also more information in the Hospitality service
| Name | Description |
|---|---|
| ClearTerminalLocks | Clears all table locks that the terminal has |
| LoadHospitalityTableState | Retrieves information about all tables |
| LoadSpecificTableState | Retrieves information about a specific table |
| SaveHospitalityTableState | Saves the state of the table i.e. Locked, seated, printed and etc |
Inventory
The inventory functionality in the Site service has also been broken down into smaller code units to make finding and maintaining the code easier.
Most of these functions are only used in the Site Manager.
The service is broken into various partial classes that each have functions for one specific function within the inventory functionality. The service is divided into these functions:
- Goods receiving
- Purchase orders
- Reason codes
- Replenishment
- Reserve stock
- Stock counting
- Template (Inventory templates)
- Transfer orders
- Transfer requests
- Vendors
- Worksheets
When customizing the inventory the recommendation is to override the Site service itself rather than the Site service service but if the Site service should be bypassed altogether in a customization for the inventory then the Inventory service would be where that type of customization should be done.
See also more information in the Inventory service
Loyalty
All Site service functions related to the Loyalty functionality. Some of these functions are only used in the POS and other only used in the Site Manager.
See also more information in the Loyalty service and the Transaction service
| Name | Description |
|---|---|
| DeleteLoyaltyMSRCard | Deletes information about the MSR loyalty card |
| DeleteLoyaltyScheme | Deletes a loyalty scheme |
| DeleteLoyaltySchemeRule | Deletes a rule within a loyalty scheme |
| GetCustomerMSRCards | Gets all MSR card attached to a customer |
| GetLoyaltyMSRCard | Returns information about the MSR loyalty card |
| GetLoyaltyMSRCardTransCount | Returns the number of transactions attached to a MSR loyalty card |
| GetLoyaltyScheme | Returns information about a specific scheme |
| GetLoyaltySchemes | Returns a list of all loyalty schemes |
| GetLoyaltySchemeRule | Returns information about a specific rule within a scheme |
| GetLoyaltySchemeRules | Returns a list of all rules within a scheme |
| GetLoyaltyMSRCardTrans | Returns a specific transaction on an MSR loyalty card |
| GetLoyaltyTrans | Returns a list of all transactions attached to an MSR loyalty card |
| GetMaxLoyaltyMSRCardTransLnNum | Returns the maximum line number for the transactions attached to an MSR loyalty card |
| GetPointsExchangeRate | Get points exchange rates for payment |
| LoyaltyCardExistsForLoyaltyScheme | Returns true if the scheme has any cards attached to it |
| GetLoyaltyPointsStatus | Returns the loyalty point status of a specific card |
| SaveLoyaltyMSRCard | Saves information about a MSR loyalty card |
| SaveLoyaltyScheme | Saves a loyalty scheme |
| SaveLoyaltySchemeRule | Saves a rule for a loyalty scheme |
| UpdateIssuedLoyaltyPoints | Updates the loyalty card with the points accrued during the transaction |
| UpdateUsedLoyaltyPoints | Updates the loyalty card with used points during the transaction |
| UpdateLoyaltyCardCustomerID | Updates the customer ID attached to a loyalty card |
| UpdateIssuedLoyaltyPointsForCustomer | Updates the issued loyalty points for a specific customer |
LS Commerce
All Site service functions related to the LS Commerce functionality. All of these functions are used by the Site Manager.
| Name | Description |
|---|---|
| DeleteOmniLicense | Deletes a LS Commerce license |
| GetOmniLicense | Returns information about the LS Commerce license for the specific terminal |
| GetOmniLicenses | Returns a list of LS Commerce licenses |
| OmniLicenseKeyRecordExists | Checks if a specific license key exists |
| SaveOmniLicenses | Saves an LS Commerce license |
Reports
All Site service functions related to report functionality. All of these functions are only used in the Site Manager.
Reports that have to do with the inventory have to be run from Head office as the inventory information is stored there.
| Name | Description |
|---|---|
| ReportExists | Returns true if the report exists at head office |
| ReportRun | Runs a report from head office |
Retail item
All Site service functions related to item functionality.
| Name | Description |
|---|---|
| GetRetailItem | Retrieves information about an item from head office |
| GetRetailItemIncludeDeleted | Gets a list of items including the deleted ones |
| SaveRetailItem | Saves a retail item to head office |
| SaveUnitConversionRule | Saves a unit conversion rule at head office |
| SaveItemType | Updates an item to have a new item type |
Sales orders and Sales invoices
All Site service functions related to sales order functionality. All of these functions are only used in the POS.
See also more information in the Sales order service and the Sales invoice service
| Name | Description |
|---|---|
| CreatePackingSlip | Sends a message to the site service to create a packing slip (does not print it out at the POS) |
| CreatePickingList | Sends a message to the site service to create a picking list (does not print it out at the POS) |
| GetSalesInvoiceList | Returns a list of sales invoices |
| GetSalesOrder | Retrieves information about a sales order from head office |
| GetSalesOrderList | Returns a list of sales orders |
| PaySalesOrder | Sends information that a sales order has been paid for |
Serial numbers
All Site service functions related to serial number functionality. Some of these functions are only used in the POS and others only used in the Site Manager.
See also more information in the Item service and the Transaction service
| Name | Description |
|---|---|
| ClearReservedSerialNumbers | The list of serial numbers will be cleared. If they were reserved than this flag is removed, if they were manually entered than they will be deleted. |
| GetActiveSerialNumbersByItem | Get list of all serial numbers for a specific item. Only active serial numbers will be retrieved. Sold and reserved serial numbers will not be part of the list. |
| GetSerialNumber | Get information about a specific serial number for a specific item |
| GetSoldSerialNumbersByItem | Get list of all sold serial numbers for a specific item |
| ReserveSerialNumber | Serial number is marked as being reserved. If it is manually entered, then the serial number will be added to the database and marked as reserved. |
| UseSerialNumbers | Marks the items in the list as being sold (used). Part of the transaction conclude. Items are marked as used, set if manually entered and set the receipt ID |
Settings
This function is only used by the Site Manager
| Name | Description |
|---|---|
| GetDefaultTaxStoreID | Returns the ID of the default tax store configured at the central database |
Tax refund
All Site service functions related to tax refund functionality.
See also more information in the Tax free service
| Name | Description |
|---|---|
| GetTaxRefund | Gets information about a previous tax refund |
| SaveTaxRefund | Saves information about a tax refund |
POS Operations
Many operations in the POS directly call the Site service or the functions in the corresponding services call the Site service. Please see lists in each specific service on the operations that are called for each functionality.
Development pack
To find this service in the development pack go to DevPack\Source\Core\Common_services
See also
