Help Page Home - TaxCodes
GET TaxCodes
Returns a list of Tax Code detail records.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| WsAccessKey | The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access. | string |
Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred. |
| FileId | Specifies the file id of the file to perform the operation upon. | integer |
Required |
| Page | Specifies the page number of the result set to return. | integer |
None. |
| PageSize | Specifies the number of records on each page of results. Maximum page size is 100. Defaults to 25 if not specified. | integer |
None. |
| IsActive | Filter records that are either Active (IsActive=true) or Inactive (IsActive=false). | boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
TaxCodesResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| TaxCodes | The list of tax codes. | Collection of TaxCodeSummary |
None. |
| _links | Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. | Collection of Link |
None. |
Response Formats
application/json, text/json
Sample:
{
"TaxCodes": [
{
"Id": 1,
"Code": "G1",
"Name": "Sale Inc GST",
"Rate": 0.1,
"PostingAccountId": 123,
"IsSale": true,
"IsPurchase": false,
"IsPayroll": true,
"IsInbuilt": false,
"IsShared": true,
"IsActive": true,
"CreatedDateUtc": "2024-10-28T21:19:13.3786055Z",
"LastModifiedDateUtc": "2025-10-27T21:19:13.3786055Z",
"LastModifiedByUserId": 123,
"LastUpdatedId": "AAAAAAkh==",
"_links": [
{
"rel": "detail",
"href": "https://api.saasu.com/TaxCode/1?FileId=123",
"method": "GET",
"title": null
}
]
},
{
"Id": 2,
"Code": "G1,G2",
"Name": "Sale Exports",
"Rate": 0.1,
"PostingAccountId": 456,
"IsSale": true,
"IsPurchase": false,
"IsPayroll": true,
"IsInbuilt": false,
"IsShared": true,
"IsActive": true,
"CreatedDateUtc": "2024-10-28T21:19:13.3796792Z",
"LastModifiedDateUtc": "2025-10-27T21:19:13.3796792Z",
"LastModifiedByUserId": 123,
"LastUpdatedId": "AAAAAAkh==",
"_links": [
{
"rel": "detail",
"href": "https://api.saasu.com/TaxCode/2?FileId=123",
"method": "GET",
"title": null
}
]
}
],
"_links": [
{
"rel": "self",
"href": "https://api.saasu.com/TaxCodes?FileId=123",
"method": "GET",
"title": null
},
{
"rel": "next",
"href": "https://api.saasu.com/TaxCodes?FileId=123&Page=2&PageSize=25",
"method": "GET",
"title": null
}
]
}
application/xml, text/xml
Sample:
<TaxCodesResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<_links>
<Link>
<rel>self</rel>
<href>https://api.saasu.com/TaxCodes?FileId=123</href>
<method>GET</method>
</Link>
<Link>
<rel>next</rel>
<href>https://api.saasu.com/TaxCodes?FileId=123&Page=2&PageSize=25</href>
<method>GET</method>
</Link>
</_links>
<TaxCodes>
<TaxCodeSummary>
<_links>
<Link>
<rel>detail</rel>
<href>https://api.saasu.com/TaxCode/1?FileId=123</href>
<method>GET</method>
</Link>
</_links>
<Id>1</Id>
<Code>G1</Code>
<Name>Sale Inc GST</Name>
<Rate>0.1</Rate>
<PostingAccountId>123</PostingAccountId>
<IsSale>true</IsSale>
<IsPurchase>false</IsPurchase>
<IsPayroll>true</IsPayroll>
<IsInbuilt>false</IsInbuilt>
<IsShared>true</IsShared>
<IsActive>true</IsActive>
<CreatedDateUtc>2024-10-28T21:19:13.3786055Z</CreatedDateUtc>
<LastModifiedDateUtc>2025-10-27T21:19:13.3786055Z</LastModifiedDateUtc>
<LastModifiedByUserId>123</LastModifiedByUserId>
<LastUpdatedId>AAAAAAkh==</LastUpdatedId>
</TaxCodeSummary>
<TaxCodeSummary>
<_links>
<Link>
<rel>detail</rel>
<href>https://api.saasu.com/TaxCode/2?FileId=123</href>
<method>GET</method>
</Link>
</_links>
<Id>2</Id>
<Code>G1,G2</Code>
<Name>Sale Exports</Name>
<Rate>0.1</Rate>
<PostingAccountId>456</PostingAccountId>
<IsSale>true</IsSale>
<IsPurchase>false</IsPurchase>
<IsPayroll>true</IsPayroll>
<IsInbuilt>false</IsInbuilt>
<IsShared>true</IsShared>
<IsActive>true</IsActive>
<CreatedDateUtc>2024-10-28T21:19:13.3796792Z</CreatedDateUtc>
<LastModifiedDateUtc>2025-10-27T21:19:13.3796792Z</LastModifiedDateUtc>
<LastModifiedByUserId>123</LastModifiedByUserId>
<LastUpdatedId>AAAAAAkh==</LastUpdatedId>
</TaxCodeSummary>
</TaxCodes>
</TaxCodesResponse>