Help Page Home - TaxCodes
GET TaxCode/id
Returns a single Tax Code detail record.
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 |
| id | The Id/key of this resource. | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
TaxCodeDetail| Name | Description | Type | Additional information |
|---|---|---|---|
| Notes | Custom notes associated with this tax code (if any). | string |
None. |
| Id | The Id/key of this resource. | integer |
None. |
| Code | The actual tax code. | string |
None. |
| Name | The name of this tax code. | string |
None. |
| Rate | The rate associated with this tax code. | decimal number |
None. |
| PostingAccountId | The account tax amounts are posted to when used in transactions. | integer |
None. |
| IsSale | Tax code could be used in Sale transactions. | boolean |
None. |
| IsPurchase | Tax code could be used in Purchase transactions. | boolean |
None. |
| IsPayroll | Tax code could be used in Payroll transactions. NOTE: This only applies to inbuilt tax codes. | boolean |
None. |
| IsInbuilt | Indicates if the Tax code was generated by the system. | boolean |
None. |
| IsShared | Indicates if the tax code is shared. | boolean |
None. |
| IsActive | Indicates if the tax code is currently set to active. | boolean |
None. |
| CreatedDateUtc | The date and time that this resource was created in UTC. | date |
None. |
| LastModifiedDateUtc | The date and time that this resource was last modified in UTC. | date |
None. |
| LastModifiedByUserId | The user id that last modified this resource | integer |
None. |
| LastUpdatedId | The unique Id for this version of the record which is required to be passed in when next updating this resource. | string |
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:
{
"Notes": "some notes",
"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-27T18:00:11.9713223Z",
"LastModifiedDateUtc": "2025-10-26T18:00:11.9713223Z",
"LastModifiedByUserId": 123,
"LastUpdatedId": "AAAAAAkh==",
"_links": [
{
"rel": "self",
"href": "https://api.saasu.com/TaxCode/1?FileId=123",
"method": "GET",
"title": null
},
{
"rel": "list",
"href": "https://api.saasu.com/TaxCodes?FileId=123",
"method": "GET",
"title": null
}
]
}
application/xml, text/xml
Sample:
<TaxCodeDetail 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/TaxCode/1?FileId=123</href>
<method>GET</method>
</Link>
<Link>
<rel>list</rel>
<href>https://api.saasu.com/TaxCodes?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-27T18:00:11.9713223Z</CreatedDateUtc>
<LastModifiedDateUtc>2025-10-26T18:00:11.9713223Z</LastModifiedDateUtc>
<LastModifiedByUserId>123</LastModifiedByUserId>
<LastUpdatedId>AAAAAAkh==</LastUpdatedId>
<Notes>some notes</Notes>
</TaxCodeDetail>