JiwaAPI

<back to all web services

IN_CreditorQuery

Requires Authentication
IN_CreditorQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
InventoryIDquerystringNo
InventoryIDStartsWithquerystringNo
InventoryIDEndsWithquerystringNo
InventoryIDContainsquerystringNo
InventoryIDLikequerystringNo
InventoryIDBetweenquerystring[]No
InventoryIDInquerystring[]No
CreditorIDquerystringNo
CreditorIDStartsWithquerystringNo
CreditorIDEndsWithquerystringNo
CreditorIDContainsquerystringNo
CreditorIDLikequerystringNo
CreditorIDBetweenquerystring[]No
CreditorIDInquerystring[]No
PartNoquerystringNo
PartNoStartsWithquerystringNo
PartNoEndsWithquerystringNo
PartNoContainsquerystringNo
PartNoLikequerystringNo
PartNoBetweenquerystring[]No
PartNoInquerystring[]No
SupplierUPCquerystringNo
SupplierUPCStartsWithquerystringNo
SupplierUPCEndsWithquerystringNo
SupplierUPCContainsquerystringNo
SupplierUPCLikequerystringNo
SupplierUPCBetweenquerystring[]No
SupplierUPCInquerystring[]No
SpareFloat1querydecimal?No
SpareFloat1GreaterThanOrEqualToquerydecimal?No
SpareFloat1GreaterThanquerydecimal?No
SpareFloat1LessThanquerydecimal?No
SpareFloat1LessThanOrEqualToquerydecimal?No
SpareFloat1NotEqualToquerydecimal?No
SpareFloat1BetweenqueryNullable<Decimal>[]No
SpareFloat1InqueryNullable<Decimal>[]No
SpareFloat2querydecimal?No
SpareFloat2GreaterThanOrEqualToquerydecimal?No
SpareFloat2GreaterThanquerydecimal?No
SpareFloat2LessThanquerydecimal?No
SpareFloat2LessThanOrEqualToquerydecimal?No
SpareFloat2NotEqualToquerydecimal?No
SpareFloat2BetweenqueryNullable<Decimal>[]No
SpareFloat2InqueryNullable<Decimal>[]No
SpareFloat3querydecimal?No
SpareFloat3GreaterThanOrEqualToquerydecimal?No
SpareFloat3GreaterThanquerydecimal?No
SpareFloat3LessThanquerydecimal?No
SpareFloat3LessThanOrEqualToquerydecimal?No
SpareFloat3NotEqualToquerydecimal?No
SpareFloat3BetweenqueryNullable<Decimal>[]No
SpareFloat3InqueryNullable<Decimal>[]No
SpareString1querystringNo
SpareString1StartsWithquerystringNo
SpareString1EndsWithquerystringNo
SpareString1ContainsquerystringNo
SpareString1LikequerystringNo
SpareString1Betweenquerystring[]No
SpareString1Inquerystring[]No
SpareString2querystringNo
SpareString2StartsWithquerystringNo
SpareString2EndsWithquerystringNo
SpareString2ContainsquerystringNo
SpareString2LikequerystringNo
SpareString2Betweenquerystring[]No
SpareString2Inquerystring[]No
SpareString3querystringNo
SpareString3StartsWithquerystringNo
SpareString3EndsWithquerystringNo
SpareString3ContainsquerystringNo
SpareString3LikequerystringNo
SpareString3Betweenquerystring[]No
SpareString3Inquerystring[]No
SpareDate1queryDateTime?No
SpareDate1GreaterThanOrEqualToqueryDateTime?No
SpareDate1GreaterThanqueryDateTime?No
SpareDate1LessThanqueryDateTime?No
SpareDate1LessThanOrEqualToqueryDateTime?No
SpareDate1NotEqualToqueryDateTime?No
SpareDate1BetweenqueryNullable<DateTime>[]No
SpareDate1InqueryNullable<DateTime>[]No
SpareDate2queryDateTime?No
SpareDate2GreaterThanOrEqualToqueryDateTime?No
SpareDate2GreaterThanqueryDateTime?No
SpareDate2LessThanqueryDateTime?No
SpareDate2LessThanOrEqualToqueryDateTime?No
SpareDate2NotEqualToqueryDateTime?No
SpareDate2BetweenqueryNullable<DateTime>[]No
SpareDate2InqueryNullable<DateTime>[]No
SpareDate3queryDateTime?No
SpareDate3GreaterThanOrEqualToqueryDateTime?No
SpareDate3GreaterThanqueryDateTime?No
SpareDate3LessThanqueryDateTime?No
SpareDate3LessThanOrEqualToqueryDateTime?No
SpareDate3NotEqualToqueryDateTime?No
SpareDate3BetweenqueryNullable<DateTime>[]No
SpareDate3InqueryNullable<DateTime>[]No
DefaultSupplierquerybool?No
IN_Region_RecIDquerystringNo
IN_Region_RecIDStartsWithquerystringNo
IN_Region_RecIDEndsWithquerystringNo
IN_Region_RecIDContainsquerystringNo
IN_Region_RecIDLikequerystringNo
IN_Region_RecIDBetweenquerystring[]No
IN_Region_RecIDInquerystring[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
IN_Creditor Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
InventoryIDformstringNo
CreditorIDformstringNo
PartNoformstringNo
SupplierUPCformstringNo
SpareFloat1formdecimal?No
SpareFloat2formdecimal?No
SpareFloat3formdecimal?No
SpareString1formstringNo
SpareString2formstringNo
SpareString3formstringNo
SpareDate1formDateTime?No
SpareDate2formDateTime?No
SpareDate3formDateTime?No
DefaultSupplierformbool?No
IN_Region_RecIDformstringNo
ItemNoformintNo
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/IN_CreditorQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"InventoryID":"String","InventoryIDStartsWith":"String","InventoryIDEndsWith":"String","InventoryIDContains":"String","InventoryIDLike":"String","InventoryIDBetween":["String"],"InventoryIDIn":["String"],"CreditorID":"String","CreditorIDStartsWith":"String","CreditorIDEndsWith":"String","CreditorIDContains":"String","CreditorIDLike":"String","CreditorIDBetween":["String"],"CreditorIDIn":["String"],"PartNo":"String","PartNoStartsWith":"String","PartNoEndsWith":"String","PartNoContains":"String","PartNoLike":"String","PartNoBetween":["String"],"PartNoIn":["String"],"SupplierUPC":"String","SupplierUPCStartsWith":"String","SupplierUPCEndsWith":"String","SupplierUPCContains":"String","SupplierUPCLike":"String","SupplierUPCBetween":["String"],"SupplierUPCIn":["String"],"SpareFloat1":0,"SpareFloat1GreaterThanOrEqualTo":0,"SpareFloat1GreaterThan":0,"SpareFloat1LessThan":0,"SpareFloat1LessThanOrEqualTo":0,"SpareFloat1NotEqualTo":0,"SpareFloat1Between":[0],"SpareFloat1In":[0],"SpareFloat2":0,"SpareFloat2GreaterThanOrEqualTo":0,"SpareFloat2GreaterThan":0,"SpareFloat2LessThan":0,"SpareFloat2LessThanOrEqualTo":0,"SpareFloat2NotEqualTo":0,"SpareFloat2Between":[0],"SpareFloat2In":[0],"SpareFloat3":0,"SpareFloat3GreaterThanOrEqualTo":0,"SpareFloat3GreaterThan":0,"SpareFloat3LessThan":0,"SpareFloat3LessThanOrEqualTo":0,"SpareFloat3NotEqualTo":0,"SpareFloat3Between":[0],"SpareFloat3In":[0],"SpareString1":"String","SpareString1StartsWith":"String","SpareString1EndsWith":"String","SpareString1Contains":"String","SpareString1Like":"String","SpareString1Between":["String"],"SpareString1In":["String"],"SpareString2":"String","SpareString2StartsWith":"String","SpareString2EndsWith":"String","SpareString2Contains":"String","SpareString2Like":"String","SpareString2Between":["String"],"SpareString2In":["String"],"SpareString3":"String","SpareString3StartsWith":"String","SpareString3EndsWith":"String","SpareString3Contains":"String","SpareString3Like":"String","SpareString3Between":["String"],"SpareString3In":["String"],"SpareDate1":"0001-01-01T00:00:00.0000000","SpareDate1GreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","SpareDate1GreaterThan":"0001-01-01T00:00:00.0000000","SpareDate1LessThan":"0001-01-01T00:00:00.0000000","SpareDate1LessThanOrEqualTo":"0001-01-01T00:00:00.0000000","SpareDate1NotEqualTo":"0001-01-01T00:00:00.0000000","SpareDate1Between":["0001-01-01T00:00:00.0000000"],"SpareDate1In":["0001-01-01T00:00:00.0000000"],"SpareDate2":"0001-01-01T00:00:00.0000000","SpareDate2GreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","SpareDate2GreaterThan":"0001-01-01T00:00:00.0000000","SpareDate2LessThan":"0001-01-01T00:00:00.0000000","SpareDate2LessThanOrEqualTo":"0001-01-01T00:00:00.0000000","SpareDate2NotEqualTo":"0001-01-01T00:00:00.0000000","SpareDate2Between":["0001-01-01T00:00:00.0000000"],"SpareDate2In":["0001-01-01T00:00:00.0000000"],"SpareDate3":"0001-01-01T00:00:00.0000000","SpareDate3GreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","SpareDate3GreaterThan":"0001-01-01T00:00:00.0000000","SpareDate3LessThan":"0001-01-01T00:00:00.0000000","SpareDate3LessThanOrEqualTo":"0001-01-01T00:00:00.0000000","SpareDate3NotEqualTo":"0001-01-01T00:00:00.0000000","SpareDate3Between":["0001-01-01T00:00:00.0000000"],"SpareDate3In":["0001-01-01T00:00:00.0000000"],"DefaultSupplier":false,"IN_Region_RecID":"String","IN_Region_RecIDStartsWith":"String","IN_Region_RecIDEndsWith":"String","IN_Region_RecIDContains":"String","IN_Region_RecIDLike":"String","IN_Region_RecIDBetween":["String"],"IN_Region_RecIDIn":["String"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"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":[{"RecID":"String","InventoryID":"String","CreditorID":"String","PartNo":"String","SupplierUPC":"String","SpareFloat1":0,"SpareFloat2":0,"SpareFloat3":0,"SpareString1":"String","SpareString2":"String","SpareString3":"String","SpareDate1":"0001-01-01T00:00:00.0000000","SpareDate2":"0001-01-01T00:00:00.0000000","SpareDate3":"0001-01-01T00:00:00.0000000","DefaultSupplier":false,"IN_Region_RecID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}