TaxReport Class [AX 2012]

The TaxReport class is a parent class that is used by some country or region-specific tax reports, such as the TaxReport_BE class.

Syntax

class TaxReport extends RunBaseBatch

Run On

Called

Methods

	Method	Description
	allowSaveLast	(Inherited from RunBaseBatch.)
	batchInfo	Returns the BatchInfo class. This class is the API for the batch table. (Inherited from RunBaseBatch.)
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	canDisplayReport	Determines whether the report should be generated.
	canGoBatch	Returns false. (Overrides the canGoBatch Method.)
	canGoBatchJournal	Determines whether the class is shown in the list of Journal types. (Inherited from RunBaseBatch.)
	canSwapBetweenCS	Controls whether a calledFrom class that is instantiated on the server should have its prompt executed on the client. (Inherited from RunBase.)
	caption	Retrieves the description from the current class by calling the static description method of the class if there is one. (Inherited from RunBaseBatch.)
	checkCloseDialog	Must be called in the CloseOk method of a RunBase dialog box. (Inherited from RunBase.)
	checkExciseType_IN	Checks whether the tax type is Excise for given parameter.
	checkForUpdate	Performs a verification of the tax report version.
	checkForUpdate_IN	Checks whether can be updated.
	checkTaxType_IN	Gets the tax type.
	cleanupDialog	Provides a way to clean up after a dialog box has been canceled. (Inherited from RunBase.)
	dialog	Returns a class that contains the methods that are described by the RunBaseDialogable interface. (Overrides the dialog Method.)
	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	Executes after the dialog method has been called. (Inherited from RunBaseBatch.)
	dialogPostInit	Called right after the RunBase.dialogInit Method method. (Inherited from RunBase.)
	dialogPostRun	Called after the Dialog.run Method class. (Inherited from RunBase.)
	dialogReInit	Reinitializes the dialog box. (Inherited from RunBase.)
	dialogSelectCtrl	Occurs when a control is selected when the dialog class for a dialog box is used. (Overrides the dialogSelectCtrl Method.)
	dialogSettlementAccountMenuItem	Adds the menu item for a settlement account for the Belgium tax report layout to the dialog window.
	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.)
	dialogUpdate_modified
	dialogUpdateQuery	Updates the query in the dialog box. (Inherited from RunBase.)
	doBatch	(Inherited from RunBaseBatch.)
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	excisePLANumberSequence_IN	Gets the excise PLA number sequence.
	excisePLAPost_IN	Excise post PLA registers.
	exciseUpdatePLARegisters_IN	Gets the excise update PLA registers.
	exciseUpdateRGRegister_IN	Inserts records into the ExciseRG23ARegister_IN and ExciseRG23CRegister_IN tables.
	fromDate	Shows the fromDate variable.
	getDialogValues	This method has no functionality in TaxReport. It should be overridden in derived classes to retrieve values entered in the dialog box and store them in variables.
	getFromDialog	Assigns the dialog box values to the internal variables. (Overrides the getFromDialog Method.)
	getLast	Gets the last choice stored in the last value table. (Inherited from RunBaseBatch.)
	getRG23AIIOrRG23CIINumberSeq_IN	Gets the excise RG23A or RG23C number sequence.
	getRunBase	(Inherited from RunBase.)
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	groupName_IN	Gets the group name.
	gtaInterimAmount_IN	Gets the GTA interim amount.
	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	Gives RunBase the same profile as, for example, a FormRun class. This method is not used in the standard application. (Inherited from RunBase.)
	initBatch	(Inherited from RunBaseBatch.)
	initParmDefault	Initializes the internal variables. (Inherited from RunBase.)
	isCorrections_IN	Checks the corrections.
	isGTAPartialPaym_IN	Gets the GTA partial payment factor.
	isInBatch	Determines whether the RunBaseBatch is actually being run from a batch server. (Inherited from RunBaseBatch.)
	isIndianSettlement_IN	Returns true if Indian settlement is allowed.
	isSwappingPrompt	Checks if the program is currently swapping from server to client. (Inherited from RunBase.)
	lastValueDataAreaId	(Inherited from RunBase.)
	lastValueDesignName	(Inherited from RunBase.)
	lastValueElementName	(Inherited from RunBase.)
	lastValueType	(Inherited from RunBase.)
	lastValueUserId	(Inherited from RunBase.)
	mustGoBatch	(Inherited from RunBaseBatch.)
	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 TaxReport class. (Overrides the new Method.)
	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.)
	pack	Serializes the current instance of the TaxReport class. (Overrides the pack Method.)
	parmAdjustedTaxAmount_IN	Gets or sets the AdjustedTaxAmount_IN parameter.
	parmCurrentBatch	Gets or sets the CurrentBatch parameter. (Inherited from RunBaseBatch.)
	parmExcessAmount_IN	Gets or sets the ExcessAmount_IN parameter.
	parmExcessRecPosting_IN	Gets or sets the ExcessRecPosting_IN parameter.
	parmExciseRecordType_IN	Gets or sets the ExciseRecordType parameter.
	parmFileName	Gets or sets the FileName parameter.
	parmInBatch	Gets or sets the InBatch parameter. (Inherited from RunBaseBatch.)
	parmisIndianSettlement_IN	Gets or sets the isIndianSettlement_IN parameter.
	parmIsPayableAccount_IN	Gets or sets the isPayableAccount parameter.
	parmIsRecoverableAccount_IN	Gets or sets the isRecoverableAccount parameter.
	parmPreviousTransaction_IN	Gets or sets the PreviousTransaction_IN parameter.
	parmProgress	Gets or sets the Progress parameter. (Inherited from RunBase.)
	parmSettlementAccount	Sets the settlementAccount field for the settlement account dimension.
	parmTaxAmounts_IN	Gets or sets the TaxAmounts_IN parameter.
	parmTaxRepVersion	Gets or sets the taxRepVersion value for the tax report.
	post	Posts the four ledger transactions.
	postToInterimPLA_IN	Checks whether to post to interim PLA.
	postVat
	prepareForRun	Allows subclasses to process the dialog box immediately before the execution of the dialog box.Run method. (Inherited from RunBaseBatch.)
	printout	Executes the report.
	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	Displays the dialog from the class dialog and waits for user input. (Inherited from RunBaseBatch.)
	promptPack	Wraps a call to the RunBase.pack Method when packing in the RunBase.promptPrim Method. (Inherited from RunBaseBatch.)
	promptUnpack	(Overrides the promptUnpack Method.)
	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.)
	reportingVersionUpdate	Calls the TaxReportPeriod::versionSumUp Method on the TaxReportPeriod table.
	reset	Resets the class to its default state. (Inherited from RunBase.)
	run	Contains the code that does the actual job of the class. (Overrides the run Method.)
	runBase	Returns the RunBase itself. (Inherited from RunBase.)
	runBaseDialogModifyType_RU	(Inherited from RunBase.)
	runsImpersonated	Indicates whether the batch job will be run with the account of the user who created the job. (Inherited from RunBaseBatch.)
	saveAndPostLegacy
	saveAndPostRetrieveAccountsAndAmounts
	saveAndPostWithDistributions
	saveLast	Saves the last choice by using the RunBase.pack Method. (Inherited from RunBaseBatch.)
	saveOffsetTaxTrans
	setIndirectTax_IN	Sets the indirect tax.
	setPostingType_IN	Sets the posting type.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	settleOtherAmounts	Settles other amounts like roundings and penny differences.
	showBatchTab	(Inherited from RunBaseBatch.)
	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 a Select button is to be added to the dialog box. If you change the return value to true, the button will be added. (Inherited from RunBase.)
	taxPeriod	Returns the taxPeriod variable.
	taxRegistrationGroupName_IN	Gets the name of the tax registration group.
	taxRegistrationNumber_IN	Gets the tax registration number.
	taxReported	Indicates whether the report is set for updating.
	taxReportVoucher	Sets the fields in the TaxReportVoucher table, based on the variables in this class.
	taxRepVersion	Returns the variable taxRepVersion.
	toDate	Displays the variable toDate
	toString	Returns a string that represents the current object. (Inherited from Object.)
	transDate	Displays the variable transactionDate.
	unpack	Deserializes the packedClass parameter value to an instance of the TaxReport class. (Overrides the unpack Method.)
	update	Returns the variable updateNow.
	updateAndPost	Sets the variables versionMax and versionMin, and then calls the UpdateAndPostTaxTrans method of this class.
	updateAndPostTaxtrans	Sums up the transactions in the TaxTrans table, and calls the TaxPurchaseTaxPost class and the SaveAndPost method in this class.
	updateAndPostTaxtrans_IN	Updates and posts a tax transaction.
	updateAndPostTaxtransRealized
	updateNow	Creates the ledger or the vendor transactions and inserts a record in the TaxReportVoucher table.
	updateTaxRegistrationGroup_IN	Updates the tax registration group.
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	usePublicSectorPostingByDimensions
	validate	Validates the instance of the TaxReport class. (Overrides the validate Method.)
	voucher	Returns the voucher variable.
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::counterMax	Returns the version of the tax report period.
	::counterMin	Returns a counter that depends on the version of the specified values.
	::main	Provides an entry point for the TaxReport class when it is called from a command.
	::postTaxtrans_IN	Posts a tax transaction.
	::runIL
	::taxVersion	Returns the tax version in the format of the extended data type Name.
	::taxVersion_IN	Gets the generated name for given tax version

Top

Remarks

The following country or region reports use this class directly:

• TaxReport_DE

• TaxReport_NL

• TaxReport_NO

• TaxReport_SE

• TaxReport_UK

• TaxReport_US

The Italian report TaxReport_IT uses a class that is named TaxReport_IT that is derived directly from this TaxReport class.

The Belgium and Austrian reports named TaxReport_BE and TaxReport_AU use classes named TaxReport_BE and TaxReport_AU, which both are derived from a class named TaxReportAdjustTrans, which again is derived from this TaxReport class.

Inheritance Hierarchy

Object Class
  RunBase Class
    RunBaseBatch Class
      TaxReport Class
        TaxReport_EvatNL Class
        TaxReport_IT Class
        TaxReportAdjustTrans Class
        TaxSalesTaxPayment_IN Class