VendOutPaymNACHAPayroll Class [AX 2012]

Generates a direct deposit output file in the NACHA format for the payroll application. The payroll class uses worker related information for the receiver whereas the base class uses vendor.

Syntax

class VendOutPaymNACHAPayroll extends VendOutPaym_NACHA

Run On

Called

Methods

	Method	Description
	addACHControlFieldPositions	Writes field alignment information to the output file to help verify the data. (Inherited from VendOutPaym_NACHA.)
	addACHHeaderFieldPositions	Writes field alignment information to the output file to help verify the data. (Inherited from VendOutPaym_NACHA.)
	addAlignment	Writes alignment markers to the output file to help verify the accuracy of the data. (Inherited from VendOutPaym_NACHA.)
	addBatchControlFieldPositions	Writes field alignment information to the output file to help verify the data. (Inherited from VendOutPaym_NACHA.)
	addBatchHeaderFieldPositions	This is a debug method that writes field alignment information to the output file to help verify the data. (Inherited from VendOutPaym_NACHA.)
	addDetailRecord	This method should be called from the VendOutPaymRecord_NACHA_XXX classes when you add a payment record to the output file. The transaction totals are incremented, and the Routing Hash is updated with the routing number of the bank account for the payment record. (Inherited from VendOutPaym_NACHA.)
	addGeneratePaymentLinesSort	Sorts the generated payment lines before they are processed. (Inherited from VendOutPaym_NACHA.)
	addHeaderControlRecord	Prints alignment markers and increments the record count when a header record (Control or Batch) is added to the output file, if the debug flag has been set. (Inherited from VendOutPaym_NACHA.)
	callPrinterSettings	Opens a printer settings dialog box for the specified payment document type. (Inherited from CustVendOutPaym.)
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	canGoBatch	Returns false in this class. (Inherited from RunBase.)
	canSwapBetweenCS	Controls whether a calledFrom class that is instantiated on the server should have its prompt executed on the client. (Inherited from RunBase.)
	caption	Returns the description from the current class by calling the static description method on the class if there is one. (Inherited from RunBase.)
	check	(Inherited from CustVendOutPaym.)
	checkBankAccountNumber	(Inherited from CustVendOutPaym.)
	checkCloseDialog	Must be called in the CloseOk method of a RunBase dialog box. (Inherited from RunBase.)
	checkUniquePaymMode	Determines whether more than one method of payment is included in the generation of payments, by using the QueryRun class object. (Inherited from CustVendOutPaym.)
	checkValues	(Inherited from CustVendOutPaym.)
	cleanupDialog	Provides a way to clean up after a dialog box has been canceled. (Inherited from RunBase.)
	close	Writes the batch control record, the ACH control record and, if it is specified, prints the control report and payment advice. (Overrides the close Method.)
	closeFile	Closes the file if it is open. (Inherited from CustVendOutPaym.)
	codepage	Retrieves the codepage. (Overrides the codepage Method.)
	configurationKey	Gets the ConfigurationKeyId for this class instance. (Overrides the configurationKey Method.)
	createACH_ControlRecord	Writes the ACH control record to the EFT output file. (Inherited from VendOutPaym_NACHA.)
	createACH_HeaderRecord	Writes the ACH Header record to the EFT output file. (Inherited from VendOutPaym_NACHA.)
	createBatchControlRecord	Writes the Batch Control record to the EFT output file. (Inherited from VendOutPaym_NACHA.)
	createBatchHeaderRecord	Writes the Batch Header record to the Electronic Funds Transfer (EFT) output file. (Overrides the createBatchHeaderRecord Method.)
	custVendOutPaymRecordRootClassId	Gets the class ID of the corresponding parent of the CustVendOutPaymRecord class. (Overrides the custVendOutPaymRecordRootClassId Method.)
	deleteFile	(Inherited from CustVendOutPaym.)
	dialog	Returns a class that contains the methods that are described by the RunBaseDialogableinterface. (Overrides the dialog Method.)
	dialogAddFileName	(Inherited from CustVendOutPaym.)
	dialogAddPrintDocument	(Inherited from CustVendOutPaym.)
	dialogAddPrintOption	(Inherited from CustVendOutPaym.)
	dialogClear	Clears the contents of the dialog box. (Inherited from RunBase.)
	dialogInit	Initializes the dialog box. (Inherited from RunBase.)
	dialogInternal	(Inherited from RunBase.)
	dialogMake	Obtains the dialog from a RunBase class. (Inherited from RunBase.)
	dialogPost	Makes it possible to add controls after the main dialog method has been run because this method is called after the dialog method is called. (Inherited from RunBase.)
	dialogPostInit	Called right after the RunBase.dialogInit Method method. (Inherited from RunBase.)
	dialogPostRun	Called after the Dialog.run Method class. (Inherited from RunBase.)
	dialogPrintOptionMenuItemPrefix	(Inherited from VendOutPaym.)
	dialogReInit	Reinitializes the dialog box. (Inherited from RunBase.)
	dialogSelectCtrl	When using the dialog class for dialog, this method is called whenever a control is selected. (Inherited from RunBase.)
	dialogTask	When using the Dialog Class class for dialog, this method is called from the task method in the dialog form. (Inherited from RunBase.)
	dialogUpdate	Updates the dialog, for example after reinitializing the query. (Inherited from RunBase.)
	dialogUpdateQuery	Updates the query in the dialog box. (Inherited from RunBase.)
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	fileEndFooter	Manages the writing of the file end footer for the output file.
	findPaymModeSpec	(Inherited from VendOutPaym.)
	findPaymModeTable	(Inherited from VendOutPaym.)
	generatePaymentLines	Manages the generation of the payroll payment lines for the output file. (Overrides the generatePaymentLines Method.)
	generatePaymentLines_BR	Throws an error of missing overload. (Inherited from CustVendOutPaym.)
	getBankRoutingNumber	Returns the bank account routing number (registration number) in whatever format is requested. (Inherited from VendOutPaym_NACHA.)
	getCustVendPaymModeTableBuffer	(Inherited from CustVendOutPaym.)
	getEffectiveDate	Gets the effectiveEntDate property.
	getFromDialog	Assigns the dialog values to the internal variables. (Overrides the getFromDialog Method.)
	getLast	Restores the pertinent values from the SysLastValue table. (Inherited from CustVendOutPaym.)
	getNextSequenceNumber	(Inherited from VendOutPaym_NACHA.)
	getOutPaymRecords	(Inherited from CustVendOutPaym.)
	getPaymentType	(Inherited from VendOutPaym.)
	getPrinterSettings	Returns the printer settings for the supplied payment document type. (Inherited from CustVendOutPaym.)
	getRunBase	(Inherited from RunBase.)
	getSumByCurrency	(Inherited from CustVendOutPaym.)
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	getTransactionCode	Returns the transaction code used in the output file. (Inherited from VendOutPaym_NACHA.)
	getTransactionCodeEmployee	Return the approprite NACHA Transaction Code based on the Bank Account Type
	getUniquePaymModeTable	Determines whether the generation of payment covers only one method of payment. If true, returns the unique method of payment record. (Inherited from CustVendOutPaym.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	inGetSaveLast	Returns true when the GetLast or SaveLast method is executed. (Inherited from RunBase.)
	init	(Inherited from VendOutPaym_NACHA.)
	initParmDefault	Initializes the internal variables. (Inherited from RunBase.)
	initVendPaymForVendorCoveredFee_JP	Initializes vendor payment for the payment fee. (Inherited from VendOutPaym.)
	interfaceName	Gets the name of the format that is displayed in the user interface. (Overrides the interfaceName Method.)
	isBankPrenote	Validates that the prenote is enabled for a particular bank. (Inherited from CustVendOutPaym.)
	isDebug	Determines if the DebugNACHA flag has been set. Currently, used to determine when to print alignment and field position descriptions to the output file. (Inherited from VendOutPaym_NACHA.)
	isElectronicPayment	Validates the payment type against the method of payment. (Inherited from VendOutPaym.)
	isExportFormatNACHA	Validates the export format against the method of payment. (Inherited from VendOutPaym_NACHA.)
	isOffsetAccountValid	(Inherited from CustVendOutPaym.)
	isPrenoteApproved	Validates pre-note status against a particular customer in a particular bank. (Inherited from VendOutPaym.)
	isSwappingPrompt	Determines whether values are being swapped between the client and server tiers. (Inherited from CustVendOutPaym.)
	lastValueDataAreaId	(Inherited from RunBase.)
	lastValueDesignName	(Inherited from CustVendOutPaym.)
	lastValueElementName	(Inherited from RunBase.)
	lastValueType	(Inherited from RunBase.)
	lastValueUserId	(Inherited from RunBase.)
	multipleBankAccountsAllowed	Determines whether the payment export format is designed to handle payments from more than one bank account per media. (Inherited from CustVendOutPaym.)
	mustLoadSaveQuery	Determines whether the last query must be loaded and saved when you leave the form. Called from the SysQueryForm. (Inherited from RunBase.)
	name	Returns the name of the RunBase class. (Inherited from RunBase.)
	new	Initializes a new instance of the CustVendOutPaym class. (Inherited from CustVendOutPaym.)
	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.)
	num2StrNACHA	Converts a currency value to the format '$$$$$$cc' where '$' represents a dollar value, and 'c' represents the cents value, without a decimal. (Inherited from VendOutPaym_NACHA.)
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	open	Opens the media and creates the header of the media. (Inherited from VendOutPaym_NACHA.)
	openFile	(Inherited from CustVendOutPaym.)
	output	A method that allows handling output operation by the concrete PaymentFormat implementation. (Inherited from CustVendOutPaym.)
	owner	Returns the instance that owns the object. (Inherited from Object.)
	pack	Serializes the current instance of the VendOutPaymNACHAPayroll class. (Overrides the pack Method.)
	packSysLastValues	Packs the data required for SysLastValues. (Overrides the packSysLastValues Method.)
	packValues	(Inherited from CustVendOutPaym.)
	parmBankAccountID	Gets or sets the BankAccountID parameter. (Inherited from CustVendOutPaym.)
	parmClientBank_RU	Gets or sets the ClientBank_RU parameter. (Inherited from CustVendOutPaym.)
	parmFile	Gets the File parameter. (Inherited from CustVendOutPaym.)
	parmFileASCII	Gets the FileASCII parameter. (Inherited from CustVendOutPaym.)
	parmFilename	Gets the Filename parameter. (Inherited from CustVendOutPaym.)
	parmLastValueDesignName	Gets or sets the LastValueDesignName parameter. (Inherited from CustVendOutPaym.)
	parmLedgerJournalId	Gets or sets the LedgerJournalId parameter. (Inherited from CustVendOutPaym.)
	parmPaymMode_W	Gets or sets the PaymMode_W parameter. (Inherited from CustVendOutPaym.)
	parmProgress	Gets or sets the Progress parameter. (Inherited from RunBase.)
	parmQueryRun	Gets or sets the QueryRun parameter. (Inherited from CustVendOutPaym.)
	prepareForRun	Allows subclasses to process the dialog box immediately before the dialog box.Run method. (Inherited from RunBase.)
	prepareTransRecords	(Inherited from CustVendOutPaym.)
	printAttendingNote	(Inherited from CustVendOutPaym.)
	printControlReport	(Inherited from VendOutPaym.)
	printDocument	(Inherited from CustVendOutPaym.)
	printPaymAdvice	Prints the Payment Advice report upon completion of generating the payment. (Inherited from VendOutPaym_NACHA.)
	printPaymOrder	(Inherited from CustVendOutPaym.)
	printPayStatement	Prints the Pay statement report upon completion of generating the payments.
	progressHide	Hides the Progress form. (Inherited from RunBase.)
	progressInit	Initializes the Progress object in RunBase. (Inherited from RunBase.)
	progressKill	Kills the Progress object in RunBase. (Inherited from RunBase.)
	prompt	(Inherited from RunBase.)
	promptPack	Wraps a call to the RunBase.pack Method method when packing in the RunBase.promptPrim Method method. (Inherited from RunBase.)
	promptUnpack	Unpacks what the promptPack method has packed. (Inherited from RunBase.)
	putToDialog	Enables setting the fields that were just added in the RunBase.dialog Method method. This method is called from the RunBase.promptPrim Method method directly following the RunBase.dialogMake Method method. (Inherited from RunBase.)
	queryRun	Returns the QueryRun object, which is used by the QueryPrompt class. (Inherited from RunBase.)
	releasePaymentOrderNum_RU	(Inherited from CustVendOutPaym.)
	reset	Resets the class to its default state. (Inherited from RunBase.)
	run	Contains the code that does the actual job of the class. (Inherited from CustVendOutPaym.)
	runBase	Returns the RunBase itself. (Inherited from RunBase.)
	runBaseDialogModifyType_RU	(Inherited from RunBase.)
	runReport	(Inherited from CustVendOutPaym.)
	saveLast	Persists the pertinent values to the SysLastValue table. (Inherited from CustVendOutPaym.)
	sequenceNum	(Inherited from CustVendOutPaym.)
	setEffectiveDate	Sets the effective date of the transaction. (Overrides the setEffectiveDate Method.)
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	showClearButton	Determines whether to add a Clear button to the dialog box. If you change the return value to true it will add the button. (Inherited from RunBase.)
	showDefaultButton	Determines whether a Default button is to be added to the dialog box. If you change the return value to true, it will add the button. (Inherited from RunBase.)
	showDialog	(Inherited from RunBase.)
	showIndexFields	If this method returns true, it will look for the first enabled index when you are adding query range fields to the dialog and if a data source does not have any ranges specified. It will also show the visible fields from that index. (Inherited from RunBase.)
	showQuerySelectButton	(Inherited from RunBase.)
	showQueryValues	Determines whether to add a select button to the dialog box. (Inherited from CustVendOutPaym.)
	time2StrHM_NA	Converts a time to a string with the format of HHMM, where HH represents hours and MM represents minutes, without a divider. (Inherited from VendOutPaym_NACHA.)
	toString	Returns a string that represents the current object. (Inherited from Object.)
	trackSequenceOnPaymMode	(Inherited from CustVendOutPaym.)
	unpack	Deserializes the _packedClass parameter value to an instance of the VendOutPaymNACHAPayroll class. (Overrides the unpack Method.)
	unpackSysLastValues	Unpacks the data required for SysLastValues. (Overrides the unpackSysLastValues Method.)
	unpackValues	(Inherited from CustVendOutPaym.)
	updateLedgerJournalTrans	Updates the LedgerJournalTrans record after processing it. (Inherited from CustVendOutPaym.)
	updatePrinterSettings	(Inherited from CustVendOutPaym.)
	updateQuery	Enables applying export format specific criteria on the QueryRun class object supplied to the class. (Inherited from CustVendOutPaym.)
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	validate	Validates the state of the internal variables. (Overrides the validate Method.)
	validateFileExist	(Inherited from VendOutPaym_NACHA.)
	validatePrenote	Validates pre-notes for the transaction record. (Inherited from VendOutPaym_NACHA.)
	vendPaym	Sets the VendPaym instance for a supplied LedgerJournalTrans buffer. (Overrides the vendPaym Method.)
	vendPaymPayroll	The Payroll application leverages the vendor payment process to disburse payments to workers.Most of the information set for the vendor is not relevant to payroll as it replaces the Vendor bank account with the worker bank account which is obtained from the related LedgerJournalTransPayrollDisbursement record. (Inherited from VendOutPaym.)
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::description	Gets the description of the class.

Top

Remarks

This class will be called during the payroll check printing process.

Inheritance Hierarchy

Object Class
  RunBase Class
    CustVendOutPaym Class
      VendOutPaym Class
        VendOutPaym_NACHA Class
          VendOutPaymNACHAPayroll Class