JiwaAPI

<back to all web services

KitTaxQuery

Requires Authentication
KitTaxQuery Parameters:
NameParameterData TypeRequiredDescription
Taxquerydecimal?No
TaxGreaterThanOrEqualToquerydecimal?No
TaxGreaterThanquerydecimal?No
TaxLessThanquerydecimal?No
TaxLessThanOrEqualToquerydecimal?No
TaxNotEqualToquerydecimal?No
TaxBetweenqueryNullable<Decimal>[]No
TaxInqueryNullable<Decimal>[]No
LNqueryshort?No
LNGreaterThanOrEqualToqueryshort?No
LNGreaterThanqueryshort?No
LNLessThanqueryshort?No
LNLessThanOrEqualToqueryshort?No
LNNotEqualToqueryshort?No
LNBetweenqueryNullable<Int16>[]No
LNInqueryNullable<Int16>[]No
InvIDquerystringNo
InvIDStartsWithquerystringNo
InvIDEndsWithquerystringNo
InvIDContainsquerystringNo
InvIDLikequerystringNo
InvIDBetweenquerystring[]No
InvIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
KitTax Parameters:
NameParameterData TypeRequiredDescription
Taxformdecimal?No
LNformshort?No
InvIDformstringNo
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 .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/KitTaxQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Tax":0,"TaxGreaterThanOrEqualTo":0,"TaxGreaterThan":0,"TaxLessThan":0,"TaxLessThanOrEqualTo":0,"TaxNotEqualTo":0,"TaxBetween":[0],"TaxIn":[0],"LN":0,"LNGreaterThanOrEqualTo":0,"LNGreaterThan":0,"LNLessThan":0,"LNLessThanOrEqualTo":0,"LNNotEqualTo":0,"LNBetween":[0],"LNIn":[0],"InvID":"String","InvIDStartsWith":"String","InvIDEndsWith":"String","InvIDContains":"String","InvIDLike":"String","InvIDBetween":["String"],"InvIDIn":["String"],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"Tax":0,"LN":0,"InvID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}