Tax Solutions
- Get Tax Solution Object Definition
- List Tax Solutions
- List Tax Solutions (Legacy)
- Get Tax Solution
- Get Tax Solution by Name
NEW!
A tax solution provides the underlying mechanism (tax engine) for capturing and reporting taxes. (AU, GB, ZA only)
The tax solution also includes information about the GL accounts for input and output taxes as well as the start date of the first tax submission period.
Get Tax Solution Object Definition
lookup
List all the fields and relationships for the tax solution object:
<lookup>
<object>TAXSOLUTION</object>
</lookup>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use TAXSOLUTION |
docparid | Optional | string | Used to indicate the document type, such as Inventory Transfer , Sales Order , Purchase Order and so forth . You must use this to take advantage of any custom fields on the specified document type. |
List Tax Solutions
query
List the record number, tax solution ID, and tax calculation method for each tax solution:
<query>
<object>TAXSOLUTION</object>
<select>
<field>RECORDNO</field>
<field>SOLUTIONID</field>
<field>TAXMETHOD</field>
</select>
</query>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use TAXSOLUTION |
select | Required | sequence | One or more field names and an optional aggregate function such as count or sum . Returning all fields is not supported. |
filter | Optional | object | Query filter expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL). |
orderby | Optional | object | Provide an order element with a field name and choose an ascending or descending sort order, for example: <order> <field>RECORDNO</field> <descending/> </order> |
options | Optional | object | Set the caseinsensitive element to true for a case-insensitive query: <caseinsensitive>true</caseinsensitive> In a multi-entity company, set the showprivate element to true to query data in private entities: <showprivate>true</showprivate> |
pagesize | Optional | integer | Custom page size between 1 and 2000 items (Default: 100 ) |
offset | Optional | integer | Point at which to start indexing into records (Default: 0 ) |
docparid | Optional | string | Document type, such as Sales Order , Purchase Order , or Inventory Transfer |
List Tax Solutions (Legacy)
readByQuery
<readByQuery>
<object>TAXSOLUTION</object>
<fields>*</fields>
<query></query>
<pagesize>100</pagesize>
</readByQuery>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use TAXSOLUTION |
fields | Optional | string | Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value. |
query | Required | string | SQL-like query based on fields on the object. The following operators are supported: < , > , >= , <= , = , like , not like , in , not in , IS NOT NULL , IS NULL , AND , OR . Illegal XML characters must be properly encoded, and single quotes must be escaped with backslashes ('Jane\'s Deli' ). Joins are not supported. |
pagesize | Optional | integer | Custom page size between 1 and 1000 items (Default: 100 ) |
Get Tax Solution
read
<read>
<object>TAXSOLUTION</object>
<keys>2</keys>
<fields>*</fields>
</read>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use TAXSOLUTION |
keys | Required | string | Record number of the tax solution |
fields | Optional | string | Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value. |
Get Tax Solution by Name
read
<readByName>
<object>TAXSOLUTION</object>
<keys>Australia - GST</keys>
<fields>*</fields>
</readByName>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use TAXSOLUTION |
keys | Required | string | Tax solution name (TAXSOLUTIONID ) |
fields | Optional | string | Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value. |