JiwaAPI

<back to all web services

PI_ReceiptsQuery

Requires Authentication
PI_ReceiptsQuery Parameters:
NameParameterData TypeRequiredDescription
PI_ReceiptsIDquerystringNo
PI_ReceiptsIDStartsWithquerystringNo
PI_ReceiptsIDEndsWithquerystringNo
PI_ReceiptsIDContainsquerystringNo
PI_ReceiptsIDLikequerystringNo
PI_ReceiptsIDBetweenquerystring[]No
PI_ReceiptsIDInquerystring[]No
PI_MainIDquerystringNo
PI_MainIDStartsWithquerystringNo
PI_MainIDEndsWithquerystringNo
PI_MainIDContainsquerystringNo
PI_MainIDLikequerystringNo
PI_MainIDBetweenquerystring[]No
PI_MainIDInquerystring[]No
RE_MainIDquerystringNo
RE_MainIDStartsWithquerystringNo
RE_MainIDEndsWithquerystringNo
RE_MainIDContainsquerystringNo
RE_MainIDLikequerystringNo
RE_MainIDBetweenquerystring[]No
RE_MainIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
PI_Receipts Parameters:
NameParameterData TypeRequiredDescription
PI_ReceiptsIDformstringNo
PI_MainIDformstringNo
RE_MainIDformstringNo
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/PI_ReceiptsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"PI_ReceiptsID":"String","PI_ReceiptsIDStartsWith":"String","PI_ReceiptsIDEndsWith":"String","PI_ReceiptsIDContains":"String","PI_ReceiptsIDLike":"String","PI_ReceiptsIDBetween":["String"],"PI_ReceiptsIDIn":["String"],"PI_MainID":"String","PI_MainIDStartsWith":"String","PI_MainIDEndsWith":"String","PI_MainIDContains":"String","PI_MainIDLike":"String","PI_MainIDBetween":["String"],"PI_MainIDIn":["String"],"RE_MainID":"String","RE_MainIDStartsWith":"String","RE_MainIDEndsWith":"String","RE_MainIDContains":"String","RE_MainIDLike":"String","RE_MainIDBetween":["String"],"RE_MainIDIn":["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":[{"PI_ReceiptsID":"String","PI_MainID":"String","RE_MainID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}