JiwaAPI

<back to all web services

TX_MainQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/TX_MainRetrieves a list of tax rates.
TX_MainQuery Parameters:
NameParameterData TypeRequiredDescription
TaxIDquerystringNo
TaxIDStartsWithquerystringNo
TaxIDEndsWithquerystringNo
TaxIDContainsquerystringNo
TaxIDLikequerystringNo
TaxIDBetweenquerystring[]No
TaxIDInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
TaxRatequerydecimal?No
TaxRateGreaterThanOrEqualToquerydecimal?No
TaxRateGreaterThanquerydecimal?No
TaxRateLessThanquerydecimal?No
TaxRateLessThanOrEqualToquerydecimal?No
TaxRateNotEqualToquerydecimal?No
TaxRateBetweenqueryNullable<Decimal>[]No
TaxRateInqueryNullable<Decimal>[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
S1querystringNo
S1StartsWithquerystringNo
S1EndsWithquerystringNo
S1ContainsquerystringNo
S1LikequerystringNo
S1Betweenquerystring[]No
S1Inquerystring[]No
S2querystringNo
S2StartsWithquerystringNo
S2EndsWithquerystringNo
S2ContainsquerystringNo
S2LikequerystringNo
S2Betweenquerystring[]No
S2Inquerystring[]No
S3querystringNo
S3StartsWithquerystringNo
S3EndsWithquerystringNo
S3ContainsquerystringNo
S3LikequerystringNo
S3Betweenquerystring[]No
S3Inquerystring[]No
S4querystringNo
S4StartsWithquerystringNo
S4EndsWithquerystringNo
S4ContainsquerystringNo
S4LikequerystringNo
S4Betweenquerystring[]No
S4Inquerystring[]No
DefaultRatequeryint?No
DefaultRateGreaterThanOrEqualToqueryint?No
DefaultRateGreaterThanqueryint?No
DefaultRateLessThanqueryint?No
DefaultRateLessThanOrEqualToqueryint?No
DefaultRateNotEqualToqueryint?No
DefaultRateBetweenqueryNullable<Int32>[]No
DefaultRateInqueryNullable<Int32>[]No
GSTTaxGroupqueryint?No
GSTTaxGroupGreaterThanOrEqualToqueryint?No
GSTTaxGroupGreaterThanqueryint?No
GSTTaxGroupLessThanqueryint?No
GSTTaxGroupLessThanOrEqualToqueryint?No
GSTTaxGroupNotEqualToqueryint?No
GSTTaxGroupBetweenqueryint[]No
GSTTaxGroupInqueryint[]No
DefaultRateInGroupquerybool?No
BASCodequeryint?No
BASCodeGreaterThanOrEqualToqueryint?No
BASCodeGreaterThanqueryint?No
BASCodeLessThanqueryint?No
BASCodeLessThanOrEqualToqueryint?No
BASCodeNotEqualToqueryint?No
BASCodeBetweenqueryNullable<Int32>[]No
BASCodeInqueryNullable<Int32>[]No
Disabledquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
TX_Main Parameters:
NameParameterData TypeRequiredDescription
TaxIDformstringNo
DescriptionformstringNo
TaxRateformdecimal?No
LastSavedDateTimeformDateTime?No
S1formstringNo
S2formstringNo
S3formstringNo
S4formstringNo
DefaultRateformint?No
GSTTaxGroupformintNo
DefaultRateInGroupformboolNo
BASCodeformint?No
DisabledformboolNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"TaxID":"String","Description":"String","TaxRate":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","S1":"String","S2":"String","S3":"String","S4":"String","DefaultRate":0,"BASCode":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}