GET | /Queries/TX_Main | Retrieves a list of tax rates. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TaxID | query | string | No | |
TaxIDStartsWith | query | string | No | |
TaxIDEndsWith | query | string | No | |
TaxIDContains | query | string | No | |
TaxIDLike | query | string | No | |
TaxIDBetween | query | string[] | No | |
TaxIDIn | query | string[] | No | |
Description | query | string | No | |
DescriptionStartsWith | query | string | No | |
DescriptionEndsWith | query | string | No | |
DescriptionContains | query | string | No | |
DescriptionLike | query | string | No | |
DescriptionBetween | query | string[] | No | |
DescriptionIn | query | string[] | No | |
TaxRate | query | decimal? | No | |
TaxRateGreaterThanOrEqualTo | query | decimal? | No | |
TaxRateGreaterThan | query | decimal? | No | |
TaxRateLessThan | query | decimal? | No | |
TaxRateLessThanOrEqualTo | query | decimal? | No | |
TaxRateNotEqualTo | query | decimal? | No | |
TaxRateBetween | query | Nullable<Decimal>[] | No | |
TaxRateIn | query | Nullable<Decimal>[] | No | |
LastSavedDateTime | query | DateTime? | No | |
LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeGreaterThan | query | DateTime? | No | |
LastSavedDateTimeLessThan | query | DateTime? | No | |
LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
LastSavedDateTimeBetween | query | Nullable<DateTime>[] | No | |
LastSavedDateTimeIn | query | Nullable<DateTime>[] | No | |
S1 | query | string | No | |
S1StartsWith | query | string | No | |
S1EndsWith | query | string | No | |
S1Contains | query | string | No | |
S1Like | query | string | No | |
S1Between | query | string[] | No | |
S1In | query | string[] | No | |
S2 | query | string | No | |
S2StartsWith | query | string | No | |
S2EndsWith | query | string | No | |
S2Contains | query | string | No | |
S2Like | query | string | No | |
S2Between | query | string[] | No | |
S2In | query | string[] | No | |
S3 | query | string | No | |
S3StartsWith | query | string | No | |
S3EndsWith | query | string | No | |
S3Contains | query | string | No | |
S3Like | query | string | No | |
S3Between | query | string[] | No | |
S3In | query | string[] | No | |
S4 | query | string | No | |
S4StartsWith | query | string | No | |
S4EndsWith | query | string | No | |
S4Contains | query | string | No | |
S4Like | query | string | No | |
S4Between | query | string[] | No | |
S4In | query | string[] | No | |
DefaultRate | query | int? | No | |
DefaultRateGreaterThanOrEqualTo | query | int? | No | |
DefaultRateGreaterThan | query | int? | No | |
DefaultRateLessThan | query | int? | No | |
DefaultRateLessThanOrEqualTo | query | int? | No | |
DefaultRateNotEqualTo | query | int? | No | |
DefaultRateBetween | query | Nullable<Int32>[] | No | |
DefaultRateIn | query | Nullable<Int32>[] | No | |
GSTTaxGroup | query | int? | No | |
GSTTaxGroupGreaterThanOrEqualTo | query | int? | No | |
GSTTaxGroupGreaterThan | query | int? | No | |
GSTTaxGroupLessThan | query | int? | No | |
GSTTaxGroupLessThanOrEqualTo | query | int? | No | |
GSTTaxGroupNotEqualTo | query | int? | No | |
GSTTaxGroupBetween | query | int[] | No | |
GSTTaxGroupIn | query | int[] | No | |
DefaultRateInGroup | query | bool? | No | |
BASCode | query | int? | No | |
BASCodeGreaterThanOrEqualTo | query | int? | No | |
BASCodeGreaterThan | query | int? | No | |
BASCodeLessThan | query | int? | No | |
BASCodeLessThanOrEqualTo | query | int? | No | |
BASCodeNotEqualTo | query | int? | No | |
BASCodeBetween | query | Nullable<Int32>[] | No | |
BASCodeIn | query | Nullable<Int32>[] | No | |
Disabled | query | bool? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TaxID | form | string | No | |
Description | form | string | No | |
TaxRate | form | decimal? | No | |
LastSavedDateTime | form | DateTime? | No | |
S1 | form | string | No | |
S2 | form | string | No | |
S3 | form | string | No | |
S4 | form | string | No | |
DefaultRate | form | int? | No | |
GSTTaxGroup | form | int | No | |
DefaultRateInGroup | form | bool | No | |
BASCode | form | int? | No | |
Disabled | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Queries/TX_Main HTTP/1.1 Host: api.jiwa.com.au Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfTX_Main7kRqkrSv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <Offset>0</Offset> <Total>0</Total> <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables"> <d2p1:TX_Main> <d2p1:_x003C_BASCode_x003E_k__BackingField>0</d2p1:_x003C_BASCode_x003E_k__BackingField> <d2p1:_x003C_DefaultRateInGroup_x003E_k__BackingField>false</d2p1:_x003C_DefaultRateInGroup_x003E_k__BackingField> <d2p1:_x003C_DefaultRate_x003E_k__BackingField>0</d2p1:_x003C_DefaultRate_x003E_k__BackingField> <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField> <d2p1:_x003C_Disabled_x003E_k__BackingField>false</d2p1:_x003C_Disabled_x003E_k__BackingField> <d2p1:_x003C_GSTTaxGroup_x003E_k__BackingField>0</d2p1:_x003C_GSTTaxGroup_x003E_k__BackingField> <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField> <d2p1:_x003C_S1_x003E_k__BackingField>String</d2p1:_x003C_S1_x003E_k__BackingField> <d2p1:_x003C_S2_x003E_k__BackingField>String</d2p1:_x003C_S2_x003E_k__BackingField> <d2p1:_x003C_S3_x003E_k__BackingField>String</d2p1:_x003C_S3_x003E_k__BackingField> <d2p1:_x003C_S4_x003E_k__BackingField>String</d2p1:_x003C_S4_x003E_k__BackingField> <d2p1:_x003C_TaxID_x003E_k__BackingField>String</d2p1:_x003C_TaxID_x003E_k__BackingField> <d2p1:_x003C_TaxRate_x003E_k__BackingField>0</d2p1:_x003C_TaxRate_x003E_k__BackingField> </d2p1:TX_Main> </Results> <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </Meta> <ResponseStatus> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </Meta> </ResponseError> </Errors> <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </Meta> </ResponseStatus> </QueryResponseOfTX_Main7kRqkrSv>