RetailTransactionService Class [AX 2012]

Article
2014-04-11

Syntax

class RetailTransactionService

Run On

Called

Methods

	Method	Description
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	new	Initializes a new instance of the Object class. (Inherited from Object.)
	notify	Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
	notifyAll	Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	owner	Returns the instance that owns the object. (Inherited from Object.)
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	toString	Returns a string that represents the current object. (Inherited from Object.)
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::activateDevice	Activate the device.
	::addDiscountLineXml	Adds Sales Discount Line XML for the given SalesLine InventTransId
	::addToGiftCard	Method is used for creating the record in RetailGiftCardTransactions table.Initially the gift card is marked as reserved. Call giftCardRelease to clear the reservation.
	::authenticateDevice	Authenticate the device.
	::cancelCustomerOrder
	::cashDisbursementSlipExist_RU	Checks whether the specified disbursement order number exists in Cash transactions.
	::cashDisbursementSlipIsUsedInPayment_RU	Checks whether the specified disbursement order number is used in payment transactions.
	::changeStoreForTerminal	Change the store for a terminal.
	::clockIn	Registers clock-in for the worker specified.
	::clockOut	Registers clock-out for the worker specified.
	::convertCustomerQuoteToOrder	Converts a quotation to sales order.
	::createAddress
	::createCashDisbursementSlip_RU	Creates cash disbursement slip.
	::createCustomerOrder	Creates a customer order from the given details.
	::createCustomerQuote	Creates a sales quotation from the given details.
	::createCustomerReturnOrder	Creates a customer return order from the given details.
	::createDiscountLines	Create Retail Sales Discount Line records for the given sales line xml fragment
	::createExtendedLogOn
	::createInventoryJournal
	::createPackingSlip	Creates the packing slip for sales order transaction.
	::createPickingList	Creates the picking list for a sales order transaction.
	::createPickListForCustomerOrder	Creates a picking list for the given items.
	::createReturnOrder
	::createWishList	Creates a wish list.
	::createWishListLine	Creates a wish list line.
	::creditVoucherCreate	Creates the record in the RetailCreditVoucherTable table.
	::creditVoucherUpdate	Updates the record in the RetailCreditVoucherTable table.
	::creditVoucherValidate	Validates the credit vouchers.
	::creditVoucherVoid	Checks the status of the credit voucher i.e., voucher exists or voided or not voided.
	::creditVoucherVoidPayment	Checks for the status of the credit voucher.
	::customerNew	Creates a new customer.
	::customerStatus	Checks the status of a customer account.
	::dateToDateTimeStringWithOffset	Convert a date value to a standard datetime string format plus offset based on timezone setting of the current leagl entity.
	::dateToString
	::deactivateAddress
	::deactivateDevice	Activate the device.
	::deleteExtendedLogOn
	::deleteInventoryJournal	Delete a journal record from InventJournalTable and InventJournalTrans tables.
	::deleteWishList	Deletes a wish list.
	::deleteWishListLine	Deletes a wish list line.
	::echoRequest
	::findDuplicateSalesOrder	Method verifies whether the requested customer order details are already created or not.
	::getCalculatedBalanceMST
	::getChannelIdFromStoreId	Method to retun the channelid from the storeId if the store id has a value
	::getChannelSalesOrderDetail
	::getCityRecId_RU	Gets primary key value for Cities table based on natural key fields
	::getCreditMemo	Get credit memo balance and currency code.
	::getCustomer	Gets the customer details for a given customer account.
	::getCustomerBalance	This method will retrive the customer account balance.
	::getCustomerHistory	Get customer history summary and sales orders
	::getCustomerOrder	Gets the customer order for the given ID.
	::getCustomerOrderList	Gets the customer order details for the given customer.
	::getCustomerOrdersForPackSlip	Gets customer orders for pack slip creation
	::getCustomerQuote	Gets the quotation for the given quotation ID.
	::getDistrictRecId_RU	Gets record id for districts based on natural key fields
	::getEFDocumentXML_BR
	::getGiftCardBalance
	::getInfologMessages
	::getInventDimValues
	::getInventJournal	Gets an inventory journal object in XML format
	::getInventJournals	Gets a list of inventory journals for stock counting.
	::GetLoyaltyCardRewardPointsStatus	Gets the reward point status of the loyalty card(s) including Issued, Used, Expired, and Active points.
	::GetLoyaltyCardTransactions	Get loyalty card transaction
	::getLoyaltyPointsStatus
	::getLoyaltyPointsStatusExtended	Gets the loyalty card extended information.
	::getLoyaltyPointStatus	The function calculates the used, issued, and expired points, depending on the table and enumeration value.
	::getManagerHistory	Gets a logbook of time registrations for the manager.
	::getManagerHistoryUtc	Gets a logbook of time registrations for the manager in UTC time zone.
	::getOpenPurchaseOrders	Gets a list of open purchase orders for a location
	::getOpenTransferOrders	Gets a list of open transfer orders for a store.
	::getPackingSlips	Gets the list of packing slip journals for the given location.
	::getPickingList	Gets the details of a picking list.
	::getPickingLists	Gets a list of picking lists for a store.
	::getProductData	Gets the product details based on item ID range.
	::getProductsByCategory	Gets the products by category.
	::getProductsByKeyword	Gets the products by keyword search.
	::getPurchaseOrder	Gets the details of a purchase order
	::getReturnLocationByInfocode	Finds return policy and new location for print labels
	::getReturnLocationByReasonCode	Finds return policy and new location for print labels
	::getReturnReasonCodes	Gets the reason codes.
	::getSalesInvoice	Gets a salesInvoice container that contains data from the CustTrans and CustTable tables.
	::getSalesInvoiceDetail	Get the details of a sales invoice
	::getSalesInvoiceList	Gets a list of CustTrans records.
	::getSalesInvoicesBySalesId	Gets a list of sales invoices for a sales order.
	::getSalesOrder	Gets a container that contains data from the SalesTable and CustTable tables.
	::getSalesOrderDetail	Gets the details of a sales order.
	::getSalesOrderList	Gets s list of sales orders from the SalesTable table.
	::getSalesOrderListForPrepayments	Gets a list of the sales orders from the SalesTable for prepayments.
	::getShipments
	::getTerminalData	Returns the container that contains the value of the RetailTransactionServiceProfile.RetailTSData method if the record exists.
	::getTransaction
	::getTransactionByTransactionId	Method is used for retrieving the sales transactions. Performs the following: 1.Adds transaction details.2.Adds item details.3.Adds loyalty.Performs the following validation: 1.No transaction for the transaction ID.
	::getTransactionSalesTrans	Retrieves the sales transactions.
	::getTransferOrder	Gets the details of a transfer order.
	::getWishLists	Gets a list of wish lists
	::getWorkerCurrentTimeRegistrationState	Gets an information about the current worker's time registration status.
	::getWorkerHistory	Gets a history of time registrations for the worker specified.
	::getWorkerHistoryUtc	Gets a history of time registrations for the worker specified in UTC time zone.
	::giftCardAddTo	Creates the record in the RetailGiftCardTransactions table.
	::giftCardGetBalance	Returns the status of the gift card.
	::giftCardIssue	Creates the record in the RetailGiftCardTransactions table.
	::giftCardPayment	Creates the record in the RetailGiftCardTransactions table.
	::giftCardRelease	Method is used to release a gift card, after it has been issued.
	::giftCardValidate	Validates the gift cards.
	::giftCardVoid	Checks the status of the gift card.
	::giftCardVoidPayment	Checks for the status of the gift card.
	::inventoryLookup
	::InventoryLookupOnDate_BR
	::inventoryStatus	Initializes the fields of an InventDim record by using the values of the InventDimCombination fields.
	::issueCreditMemo
	::issueGiftCard	This issues a gift card that is not reserved to a terminal / store. This is used for supporting POS 5/61/62 To issue a reserved gift card use the method issueReservedGiftCard
	::IssueLoyaltyCard	Issues a loyalty card, and joins the loyalty programs that are associated to the specificed channel.If channel recId is not provided, joins all available loyalty programs.
	::issueReservedGiftCard	Method is used for creating the record in RetailGiftCardTransactions table.Initially the gift card is marked as reserved. Call giftCardRelease to clear the reservation.
	::loyaltyIssuedPointsUpdate	Creates a record in the RetailLoyaltyMSRCardTrans table for Issued points.
	::loyaltyPointStatusGet	Calculates the used, issued, expired points, depending on the table and base enumerator.
	::loyaltyUsedPointsUpdate	Creates a record in the RetailLoyaltyMSRCardTrans table for used points.
	::MarkItemsReturned	Method updates the RetailTransactionSalesTrans.returnQty with the value in returnQty if the RetailTransactionSalesTrans.returnQty + returnQty > RetailTransactionSalesTrans.qty field.
	::newCustomer	Method is used for creating new customer.
	::newCustomerFromDirParty	Method is used for creating new customer using existing dirParty record.
	::packingSlipForCustomerOrder
	::parseSerializedFilteringCriteria
	::paySalesInvoice	Processes the payment for a sales invoice.
	::paySalesOrder	Processes the payment for a sales order.
	::PostLoyaltyCardRewardPointTrans	Posts reward points to the PostLoyaltyCardRewardPointTrans table.
	::realToString	Convert a money value to a standard string format
	::record2XmlNode	Converts a table record to an XmlElement.
	::retailServerStaffInfo	Method gets the staff Id and returns detail information about the staff and permissions for staff.
	::retailServerStaffLogOff	Method deletes the record from RetailStaffLoginLog table.
	::retailServerStaffLogOn	Method is used for updating the RetailStaffLoginLog.staffId with the value in _staffId if the record exists in RetailStaffLoginLog; else creates the record in RetailStaffLoginLogtable.
	::returnTransactionSalesTrans	Updates the returnQty value of a set of RetailTransactionSalesTrans records by using the value in the returnQty value.
	::searchCustomerOrderList
	::searchOrderList	Method returns a list of retail transactions that match the passed in criteria.
	::sendEmail	Send an email using the specified template.
	::setTaxInformationForJournalLine_IN	Sets India tax information of journal lines based on the set up on retail store.
	::settleCustomerOrder	Settles a customer order.
	::staffChangePassword	Method is used for updating the RetailStaffLoginLog.staffId with the value in _staffId if the record exists in RetailStaffLoginLog; else creates the record in RetailStaffLoginLogtable.
	::staffIsPasswordValid	Validates that the password that is entered by the user is the correct password.
	::staffLogin	Creates or updates a RetailStaffLoginLog record by using the specified staffId value.
	::staffLogOff	Method deletes the record from RetailStaffLoginLog table.
	::staffLogOn	Method is used for updating the RetailStaffLoginLog.staffId with the value in _staffId if the record exists in RetailStaffLoginLog; else creates the record in RetailStaffLoginLogtable.
	::staffLogout	Deletes a record from RetailStaffLoginLog table.
	::startBreak	Registers break for the worker specified.
	::updateAddress	Updates the record in the LogisticsPostalAddress table.
	::updateChannelPublishingStatus	Update the publishing status of a channel
	::updateCreditMemo
	::updateCustomer
	::updateCustomerOrder	Updates the customer order.
	::updateCustomerQuote	Updates a sales quotation from the given details.
	::updateInventDimValues	Updates the inventory dimension values from the xml document.
	::updateInventoryJournal	Updates an inventory journal document in AX.
	::updateIssuedLoyaltyPoints
	::updatePickingList
	::updatePurchaseOrder	Update a purchase order.
	::updateStaffPassword	Updates employee password.
	::updateTransferOrder	Update a transfer order.
	::updateUsedLoyaltyPoints
	::updateWishList	Updates a wish list.
	::updateWishListLine	Updates a wish list line.
	::upsertLogisticsElectronicAddress	Inserts or updates the electronic address based on the locator.
	::utcDateTimeToDateTimeStringWithOffset	Convert a utc datetime value to a standard datetime string format plus offset based on timezone setting of the UTC.
	::utcDateTimeToString
	::validateCreditMemo
	::validateCustomerStatus
	::validateGiftCard
	::voidCreditMemo
	::voidCreditMemoPayment
	::voidGiftCard
	::voidGiftCardPayment

Top

Inheritance Hierarchy

Object Class
RetailTransactionService Class

Share via

RetailTransactionService Class [AX 2012]

Syntax

Run On

Methods

Inheritance Hierarchy

Additional resources