JiwaAPI

<back to all web services

INV_ReceivalQuery

Requires Authentication
INV_ReceivalQuery Parameters:
NameParameterData TypeRequiredDescription
SlipNoquerystringNo
SlipNoStartsWithquerystringNo
SlipNoEndsWithquerystringNo
SlipNoContainsquerystringNo
SlipNoLikequerystringNo
SlipNoBetweenquerystring[]No
SlipNoInquerystring[]No
SuppPartquerystringNo
SuppPartStartsWithquerystringNo
SuppPartEndsWithquerystringNo
SuppPartContainsquerystringNo
SuppPartLikequerystringNo
SuppPartBetweenquerystring[]No
SuppPartInquerystring[]No
AccountNOquerystringNo
AccountNOStartsWithquerystringNo
AccountNOEndsWithquerystringNo
AccountNOContainsquerystringNo
AccountNOLikequerystringNo
AccountNOBetweenquerystring[]No
AccountNOInquerystring[]No
SourceIDquerystringNo
SourceIDStartsWithquerystringNo
SourceIDEndsWithquerystringNo
SourceIDContainsquerystringNo
SourceIDLikequerystringNo
SourceIDBetweenquerystring[]No
SourceIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
INV_Receival Parameters:
NameParameterData TypeRequiredDescription
SlipNoformstringNo
SuppPartformstringNo
AccountNOformstringNo
SourceIDformstringNo
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/INV_ReceivalQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"SlipNo":"String","SlipNoStartsWith":"String","SlipNoEndsWith":"String","SlipNoContains":"String","SlipNoLike":"String","SlipNoBetween":["String"],"SlipNoIn":["String"],"SuppPart":"String","SuppPartStartsWith":"String","SuppPartEndsWith":"String","SuppPartContains":"String","SuppPartLike":"String","SuppPartBetween":["String"],"SuppPartIn":["String"],"AccountNO":"String","AccountNOStartsWith":"String","AccountNOEndsWith":"String","AccountNOContains":"String","AccountNOLike":"String","AccountNOBetween":["String"],"AccountNOIn":["String"],"SourceID":"String","SourceIDStartsWith":"String","SourceIDEndsWith":"String","SourceIDContains":"String","SourceIDLike":"String","SourceIDBetween":["String"],"SourceIDIn":["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":[{"SlipNo":"String","SuppPart":"String","AccountNO":"String","SourceID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}