JiwaAPI

<back to all web services

INV_SOH1Query

Requires Authentication
INV_SOH1Query Parameters:
NameParameterData TypeRequiredDescription
InventoryIDquerystringNo
InventoryIDStartsWithquerystringNo
InventoryIDEndsWithquerystringNo
InventoryIDContainsquerystringNo
InventoryIDLikequerystringNo
InventoryIDBetweenquerystring[]No
InventoryIDInquerystring[]No
SOHquerydecimal?No
SOHGreaterThanOrEqualToquerydecimal?No
SOHGreaterThanquerydecimal?No
SOHLessThanquerydecimal?No
SOHLessThanOrEqualToquerydecimal?No
SOHNotEqualToquerydecimal?No
SOHBetweenqueryNullable<Decimal>[]No
SOHInqueryNullable<Decimal>[]No
Taxquerydecimal?No
TaxGreaterThanOrEqualToquerydecimal?No
TaxGreaterThanquerydecimal?No
TaxLessThanquerydecimal?No
TaxLessThanOrEqualToquerydecimal?No
TaxNotEqualToquerydecimal?No
TaxBetweenqueryNullable<Decimal>[]No
TaxInqueryNullable<Decimal>[]No
VOHquerydecimal?No
VOHGreaterThanOrEqualToquerydecimal?No
VOHGreaterThanquerydecimal?No
VOHLessThanquerydecimal?No
VOHLessThanOrEqualToquerydecimal?No
VOHNotEqualToquerydecimal?No
VOHBetweenqueryNullable<Decimal>[]No
VOHInqueryNullable<Decimal>[]No
IN_LogicalIDquerystringNo
IN_LogicalIDStartsWithquerystringNo
IN_LogicalIDEndsWithquerystringNo
IN_LogicalIDContainsquerystringNo
IN_LogicalIDLikequerystringNo
IN_LogicalIDBetweenquerystring[]No
IN_LogicalIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
INV_SOH1 Parameters:
NameParameterData TypeRequiredDescription
InventoryIDformstringNo
SOHformdecimal?No
Taxformdecimal?No
VOHformdecimal?No
IN_LogicalIDformstringNo
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_SOH1Query HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"InventoryID":"String","InventoryIDStartsWith":"String","InventoryIDEndsWith":"String","InventoryIDContains":"String","InventoryIDLike":"String","InventoryIDBetween":["String"],"InventoryIDIn":["String"],"SOH":0,"SOHGreaterThanOrEqualTo":0,"SOHGreaterThan":0,"SOHLessThan":0,"SOHLessThanOrEqualTo":0,"SOHNotEqualTo":0,"SOHBetween":[0],"SOHIn":[0],"Tax":0,"TaxGreaterThanOrEqualTo":0,"TaxGreaterThan":0,"TaxLessThan":0,"TaxLessThanOrEqualTo":0,"TaxNotEqualTo":0,"TaxBetween":[0],"TaxIn":[0],"VOH":0,"VOHGreaterThanOrEqualTo":0,"VOHGreaterThan":0,"VOHLessThan":0,"VOHLessThanOrEqualTo":0,"VOHNotEqualTo":0,"VOHBetween":[0],"VOHIn":[0],"IN_LogicalID":"String","IN_LogicalIDStartsWith":"String","IN_LogicalIDEndsWith":"String","IN_LogicalIDContains":"String","IN_LogicalIDLike":"String","IN_LogicalIDBetween":["String"],"IN_LogicalIDIn":["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":[{"InventoryID":"String","SOH":0,"Tax":0,"VOH":0,"IN_LogicalID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}