This class is an instantion of the Command class, that executes a command pertaining to fetching tax zone information, in the default case from the database. This class should only be instantiated by dispatchMBAPI() found in include/mbapi/mbapi.php. Something similar to the following XML should be passed to dispatchMBAPI() when you want to call the GetTaxZones command:
<mbapi> <command><!-- None --></command> <showXMLHeader><!-- None --></showXMLHeader> <params> <taxZoneID><!-- int --></taxZoneID> <countriesISO2><!-- string --></countriesISO2> <taxZoneName><!-- string --></taxZoneName> <taxZoneAmountLessThan><!-- double --></taxZoneAmountLessThan> <taxZoneAmount><!-- double --></taxZoneAmount> <taxZoneAmountGreaterThan><!-- double --></taxZoneAmountGreaterThan> <taxZoneDescription><!-- string --></taxZoneDescription> <taxZoneActive><!-- int --></taxZoneActive> <ledgerAccountID><!-- int --></ledgerAccountID> <taxZoneStackable><!-- int --></taxZoneStackable> <getTaxZoneGroupData><!-- int --></getTaxZoneGroupData> <sortDir><!-- None --></sortDir> <sortColumn><!-- None --></sortColumn> <recordOffset><!-- None --></recordOffset> <numRecords><!-- None --></numRecords> </params> </mbapi>
None
mbapi
command
showXMLHeader
params
taxZoneID
The ID of the tax zone to fetch. This will always select at most 1 zone.
countriesISO2
The 2 character ISO 3166 code for the country associated with the zones to fetch.
taxZoneName
The name of the tax to fetch. This is the pipe-delimited list of states/regions that will be taxed in the above country code. This can also be a to represent all regions in the country.
taxZoneAmountLessThan
The maximum tax represented as a decimal number. 17.5 = 17.5%
taxZoneAmount
The exact tax represented as a decimal number. 17.5 = 17.5%
taxZoneAmountGreaterThan
The minimum tax represented as a decimal number. 17.5 = 17.5%
taxZoneDescription
The description of the tax zones to fetch. This is searched with a LIKE clause.
taxZoneActive
Set to 1 to retrieve only zones that are active.
ledgerAccountID
Set to a ledger account id to retrieve tax zones that submit into a certain ledger account.
taxZoneStackable
Sets whether a tax zone is stackable or not.
getTaxZoneGroupData
Set to 1 to retrieve the data for the tax zone groups this zone is related to.
sortDir
sortColumn
recordOffset
numRecords