JiwaAPI

<back to all web services

SM_CustomerReturnsQuery

Requires Authentication
SM_CustomerReturnsQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
TaskIDquerystringNo
TaskIDStartsWithquerystringNo
TaskIDEndsWithquerystringNo
TaskIDContainsquerystringNo
TaskIDLikequerystringNo
TaskIDBetweenquerystring[]No
TaskIDInquerystring[]No
InventoryIDquerystringNo
InventoryIDStartsWithquerystringNo
InventoryIDEndsWithquerystringNo
InventoryIDContainsquerystringNo
InventoryIDLikequerystringNo
InventoryIDBetweenquerystring[]No
InventoryIDInquerystring[]No
PartNoquerystringNo
PartNoStartsWithquerystringNo
PartNoEndsWithquerystringNo
PartNoContainsquerystringNo
PartNoLikequerystringNo
PartNoBetweenquerystring[]No
PartNoInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
CommentLinequerybool?No
Quantityquerydecimal?No
QuantityGreaterThanOrEqualToquerydecimal?No
QuantityGreaterThanquerydecimal?No
QuantityLessThanquerydecimal?No
QuantityLessThanOrEqualToquerydecimal?No
QuantityNotEqualToquerydecimal?No
QuantityBetweenqueryNullable<Decimal>[]No
QuantityInqueryNullable<Decimal>[]No
PriceExGSTquerydecimal?No
PriceExGSTGreaterThanOrEqualToquerydecimal?No
PriceExGSTGreaterThanquerydecimal?No
PriceExGSTLessThanquerydecimal?No
PriceExGSTLessThanOrEqualToquerydecimal?No
PriceExGSTNotEqualToquerydecimal?No
PriceExGSTBetweenqueryNullable<Decimal>[]No
PriceExGSTInqueryNullable<Decimal>[]No
GSTIDquerystringNo
GSTIDStartsWithquerystringNo
GSTIDEndsWithquerystringNo
GSTIDContainsquerystringNo
GSTIDLikequerystringNo
GSTIDBetweenquerystring[]No
GSTIDInquerystring[]No
GSTRatequerydecimal?No
GSTRateGreaterThanOrEqualToquerydecimal?No
GSTRateGreaterThanquerydecimal?No
GSTRateLessThanquerydecimal?No
GSTRateLessThanOrEqualToquerydecimal?No
GSTRateNotEqualToquerydecimal?No
GSTRateBetweenqueryNullable<Decimal>[]No
GSTRateInqueryNullable<Decimal>[]No
GSTAmountquerydecimal?No
GSTAmountGreaterThanOrEqualToquerydecimal?No
GSTAmountGreaterThanquerydecimal?No
GSTAmountLessThanquerydecimal?No
GSTAmountLessThanOrEqualToquerydecimal?No
GSTAmountNotEqualToquerydecimal?No
GSTAmountBetweenqueryNullable<Decimal>[]No
GSTAmountInqueryNullable<Decimal>[]No
LineTotalIncGSTquerydecimal?No
LineTotalIncGSTGreaterThanOrEqualToquerydecimal?No
LineTotalIncGSTGreaterThanquerydecimal?No
LineTotalIncGSTLessThanquerydecimal?No
LineTotalIncGSTLessThanOrEqualToquerydecimal?No
LineTotalIncGSTNotEqualToquerydecimal?No
LineTotalIncGSTBetweenqueryNullable<Decimal>[]No
LineTotalIncGSTInqueryNullable<Decimal>[]No
Processedquerybool?No
InvoiceIDquerystringNo
InvoiceIDStartsWithquerystringNo
InvoiceIDEndsWithquerystringNo
InvoiceIDContainsquerystringNo
InvoiceIDLikequerystringNo
InvoiceIDBetweenquerystring[]No
InvoiceIDInquerystring[]No
InvoiceLineIDquerystringNo
InvoiceLineIDStartsWithquerystringNo
InvoiceLineIDEndsWithquerystringNo
InvoiceLineIDContainsquerystringNo
InvoiceLineIDLikequerystringNo
InvoiceLineIDBetweenquerystring[]No
InvoiceLineIDInquerystring[]No
DisplayOrderqueryint?No
DisplayOrderGreaterThanOrEqualToqueryint?No
DisplayOrderGreaterThanqueryint?No
DisplayOrderLessThanqueryint?No
DisplayOrderLessThanOrEqualToqueryint?No
DisplayOrderNotEqualToqueryint?No
DisplayOrderBetweenqueryNullable<Int32>[]No
DisplayOrderInqueryNullable<Int32>[]No
PhysicalItemquerybool?No
UseSerialsquerybool?No
QuantityDecimalPlacesqueryshort?No
QuantityDecimalPlacesGreaterThanOrEqualToqueryshort?No
QuantityDecimalPlacesGreaterThanqueryshort?No
QuantityDecimalPlacesLessThanqueryshort?No
QuantityDecimalPlacesLessThanOrEqualToqueryshort?No
QuantityDecimalPlacesNotEqualToqueryshort?No
QuantityDecimalPlacesBetweenqueryNullable<Int16>[]No
QuantityDecimalPlacesInqueryNullable<Int16>[]No
SellPriceIsIncTaxquerybool?No
CreditReasonIDquerystringNo
CreditReasonIDStartsWithquerystringNo
CreditReasonIDEndsWithquerystringNo
CreditReasonIDContainsquerystringNo
CreditReasonIDLikequerystringNo
CreditReasonIDBetweenquerystring[]No
CreditReasonIDInquerystring[]No
CreditIntoStockquerybool?No
NotesquerystringNo
NotesStartsWithquerystringNo
NotesEndsWithquerystringNo
NotesContainsquerystringNo
NotesLikequerystringNo
NotesBetweenquerystring[]No
NotesInquerystring[]No
UserDefinedBit1querybool?No
UserDefinedBit2querybool?No
UserDefinedBit3querybool?No
UserDefinedString1querystringNo
UserDefinedString1StartsWithquerystringNo
UserDefinedString1EndsWithquerystringNo
UserDefinedString1ContainsquerystringNo
UserDefinedString1LikequerystringNo
UserDefinedString1Betweenquerystring[]No
UserDefinedString1Inquerystring[]No
UserDefinedString2querystringNo
UserDefinedString2StartsWithquerystringNo
UserDefinedString2EndsWithquerystringNo
UserDefinedString2ContainsquerystringNo
UserDefinedString2LikequerystringNo
UserDefinedString2Betweenquerystring[]No
UserDefinedString2Inquerystring[]No
UserDefinedString3querystringNo
UserDefinedString3StartsWithquerystringNo
UserDefinedString3EndsWithquerystringNo
UserDefinedString3ContainsquerystringNo
UserDefinedString3LikequerystringNo
UserDefinedString3Betweenquerystring[]No
UserDefinedString3Inquerystring[]No
UserDefinedDate1queryDateTime?No
UserDefinedDate1GreaterThanOrEqualToqueryDateTime?No
UserDefinedDate1GreaterThanqueryDateTime?No
UserDefinedDate1LessThanqueryDateTime?No
UserDefinedDate1LessThanOrEqualToqueryDateTime?No
UserDefinedDate1NotEqualToqueryDateTime?No
UserDefinedDate1BetweenqueryNullable<DateTime>[]No
UserDefinedDate1InqueryNullable<DateTime>[]No
UserDefinedDate2queryDateTime?No
UserDefinedDate2GreaterThanOrEqualToqueryDateTime?No
UserDefinedDate2GreaterThanqueryDateTime?No
UserDefinedDate2LessThanqueryDateTime?No
UserDefinedDate2LessThanOrEqualToqueryDateTime?No
UserDefinedDate2NotEqualToqueryDateTime?No
UserDefinedDate2BetweenqueryNullable<DateTime>[]No
UserDefinedDate2InqueryNullable<DateTime>[]No
UserDefinedDate3queryDateTime?No
UserDefinedDate3GreaterThanOrEqualToqueryDateTime?No
UserDefinedDate3GreaterThanqueryDateTime?No
UserDefinedDate3LessThanqueryDateTime?No
UserDefinedDate3LessThanOrEqualToqueryDateTime?No
UserDefinedDate3NotEqualToqueryDateTime?No
UserDefinedDate3BetweenqueryNullable<DateTime>[]No
UserDefinedDate3InqueryNullable<DateTime>[]No
UserDefinedFloat1querydecimal?No
UserDefinedFloat1GreaterThanOrEqualToquerydecimal?No
UserDefinedFloat1GreaterThanquerydecimal?No
UserDefinedFloat1LessThanquerydecimal?No
UserDefinedFloat1LessThanOrEqualToquerydecimal?No
UserDefinedFloat1NotEqualToquerydecimal?No
UserDefinedFloat1BetweenqueryNullable<Decimal>[]No
UserDefinedFloat1InqueryNullable<Decimal>[]No
UserDefinedFloat2querydecimal?No
UserDefinedFloat2GreaterThanOrEqualToquerydecimal?No
UserDefinedFloat2GreaterThanquerydecimal?No
UserDefinedFloat2LessThanquerydecimal?No
UserDefinedFloat2LessThanOrEqualToquerydecimal?No
UserDefinedFloat2NotEqualToquerydecimal?No
UserDefinedFloat2BetweenqueryNullable<Decimal>[]No
UserDefinedFloat2InqueryNullable<Decimal>[]No
UserDefinedFloat3querydecimal?No
UserDefinedFloat3GreaterThanOrEqualToquerydecimal?No
UserDefinedFloat3GreaterThanquerydecimal?No
UserDefinedFloat3LessThanquerydecimal?No
UserDefinedFloat3LessThanOrEqualToquerydecimal?No
UserDefinedFloat3NotEqualToquerydecimal?No
UserDefinedFloat3BetweenqueryNullable<Decimal>[]No
UserDefinedFloat3InqueryNullable<Decimal>[]No
SY_Plugin_RecIDqueryGuid?No
SY_Plugin_RecIDInqueryNullable<Guid>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SM_CustomerReturns Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
LastSavedDateTimeformDateTimeNo
TaskIDformstringNo
InventoryIDformstringNo
PartNoformstringNo
DescriptionformstringNo
CommentLineformbool?No
Quantityformdecimal?No
PriceExGSTformdecimal?No
GSTIDformstringNo
GSTRateformdecimal?No
GSTAmountformdecimal?No
LineTotalIncGSTformdecimal?No
Processedformbool?No
InvoiceIDformstringNo
InvoiceLineIDformstringNo
DisplayOrderformint?No
PhysicalItemformbool?No
UseSerialsformbool?No
QuantityDecimalPlacesformshort?No
SellPriceIsIncTaxformbool?No
CreditReasonIDformstringNo
CreditIntoStockformbool?No
NotesformstringNo
UserDefinedBit1formbool?No
UserDefinedBit2formbool?No
UserDefinedBit3formbool?No
UserDefinedString1formstringNo
UserDefinedString2formstringNo
UserDefinedString3formstringNo
UserDefinedDate1formDateTime?No
UserDefinedDate2formDateTime?No
UserDefinedDate3formDateTime?No
UserDefinedFloat1formdecimal?No
UserDefinedFloat2formdecimal?No
UserDefinedFloat3formdecimal?No
SY_Plugin_RecIDformGuid?No
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/SM_CustomerReturnsQuery 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"],"LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"LastSavedDateTimeIn":["0001-01-01T00:00:00.0000000"],"TaskID":"String","TaskIDStartsWith":"String","TaskIDEndsWith":"String","TaskIDContains":"String","TaskIDLike":"String","TaskIDBetween":["String"],"TaskIDIn":["String"],"InventoryID":"String","InventoryIDStartsWith":"String","InventoryIDEndsWith":"String","InventoryIDContains":"String","InventoryIDLike":"String","InventoryIDBetween":["String"],"InventoryIDIn":["String"],"PartNo":"String","PartNoStartsWith":"String","PartNoEndsWith":"String","PartNoContains":"String","PartNoLike":"String","PartNoBetween":["String"],"PartNoIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"CommentLine":false,"Quantity":0,"QuantityGreaterThanOrEqualTo":0,"QuantityGreaterThan":0,"QuantityLessThan":0,"QuantityLessThanOrEqualTo":0,"QuantityNotEqualTo":0,"QuantityBetween":[0],"QuantityIn":[0],"PriceExGST":0,"PriceExGSTGreaterThanOrEqualTo":0,"PriceExGSTGreaterThan":0,"PriceExGSTLessThan":0,"PriceExGSTLessThanOrEqualTo":0,"PriceExGSTNotEqualTo":0,"PriceExGSTBetween":[0],"PriceExGSTIn":[0],"GSTID":"String","GSTIDStartsWith":"String","GSTIDEndsWith":"String","GSTIDContains":"String","GSTIDLike":"String","GSTIDBetween":["String"],"GSTIDIn":["String"],"GSTRate":0,"GSTRateGreaterThanOrEqualTo":0,"GSTRateGreaterThan":0,"GSTRateLessThan":0,"GSTRateLessThanOrEqualTo":0,"GSTRateNotEqualTo":0,"GSTRateBetween":[0],"GSTRateIn":[0],"GSTAmount":0,"GSTAmountGreaterThanOrEqualTo":0,"GSTAmountGreaterThan":0,"GSTAmountLessThan":0,"GSTAmountLessThanOrEqualTo":0,"GSTAmountNotEqualTo":0,"GSTAmountBetween":[0],"GSTAmountIn":[0],"LineTotalIncGST":0,"LineTotalIncGSTGreaterThanOrEqualTo":0,"LineTotalIncGSTGreaterThan":0,"LineTotalIncGSTLessThan":0,"LineTotalIncGSTLessThanOrEqualTo":0,"LineTotalIncGSTNotEqualTo":0,"LineTotalIncGSTBetween":[0],"LineTotalIncGSTIn":[0],"Processed":false,"InvoiceID":"String","InvoiceIDStartsWith":"String","InvoiceIDEndsWith":"String","InvoiceIDContains":"String","InvoiceIDLike":"String","InvoiceIDBetween":["String"],"InvoiceIDIn":["String"],"InvoiceLineID":"String","InvoiceLineIDStartsWith":"String","InvoiceLineIDEndsWith":"String","InvoiceLineIDContains":"String","InvoiceLineIDLike":"String","InvoiceLineIDBetween":["String"],"InvoiceLineIDIn":["String"],"DisplayOrder":0,"DisplayOrderGreaterThanOrEqualTo":0,"DisplayOrderGreaterThan":0,"DisplayOrderLessThan":0,"DisplayOrderLessThanOrEqualTo":0,"DisplayOrderNotEqualTo":0,"DisplayOrderBetween":[0],"DisplayOrderIn":[0],"PhysicalItem":false,"UseSerials":false,"QuantityDecimalPlaces":0,"QuantityDecimalPlacesGreaterThanOrEqualTo":0,"QuantityDecimalPlacesGreaterThan":0,"QuantityDecimalPlacesLessThan":0,"QuantityDecimalPlacesLessThanOrEqualTo":0,"QuantityDecimalPlacesNotEqualTo":0,"QuantityDecimalPlacesBetween":[0],"QuantityDecimalPlacesIn":[0],"SellPriceIsIncTax":false,"CreditReasonID":"String","CreditReasonIDStartsWith":"String","CreditReasonIDEndsWith":"String","CreditReasonIDContains":"String","CreditReasonIDLike":"String","CreditReasonIDBetween":["String"],"CreditReasonIDIn":["String"],"CreditIntoStock":false,"Notes":"String","NotesStartsWith":"String","NotesEndsWith":"String","NotesContains":"String","NotesLike":"String","NotesBetween":["String"],"NotesIn":["String"],"UserDefinedBit1":false,"UserDefinedBit2":false,"UserDefinedBit3":false,"UserDefinedString1":"String","UserDefinedString1StartsWith":"String","UserDefinedString1EndsWith":"String","UserDefinedString1Contains":"String","UserDefinedString1Like":"String","UserDefinedString1Between":["String"],"UserDefinedString1In":["String"],"UserDefinedString2":"String","UserDefinedString2StartsWith":"String","UserDefinedString2EndsWith":"String","UserDefinedString2Contains":"String","UserDefinedString2Like":"String","UserDefinedString2Between":["String"],"UserDefinedString2In":["String"],"UserDefinedString3":"String","UserDefinedString3StartsWith":"String","UserDefinedString3EndsWith":"String","UserDefinedString3Contains":"String","UserDefinedString3Like":"String","UserDefinedString3Between":["String"],"UserDefinedString3In":["String"],"UserDefinedDate1":"0001-01-01T00:00:00.0000000","UserDefinedDate1GreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","UserDefinedDate1GreaterThan":"0001-01-01T00:00:00.0000000","UserDefinedDate1LessThan":"0001-01-01T00:00:00.0000000","UserDefinedDate1LessThanOrEqualTo":"0001-01-01T00:00:00.0000000","UserDefinedDate1NotEqualTo":"0001-01-01T00:00:00.0000000","UserDefinedDate1Between":["0001-01-01T00:00:00.0000000"],"UserDefinedDate1In":["0001-01-01T00:00:00.0000000"],"UserDefinedDate2":"0001-01-01T00:00:00.0000000","UserDefinedDate2GreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","UserDefinedDate2GreaterThan":"0001-01-01T00:00:00.0000000","UserDefinedDate2LessThan":"0001-01-01T00:00:00.0000000","UserDefinedDate2LessThanOrEqualTo":"0001-01-01T00:00:00.0000000","UserDefinedDate2NotEqualTo":"0001-01-01T00:00:00.0000000","UserDefinedDate2Between":["0001-01-01T00:00:00.0000000"],"UserDefinedDate2In":["0001-01-01T00:00:00.0000000"],"UserDefinedDate3":"0001-01-01T00:00:00.0000000","UserDefinedDate3GreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","UserDefinedDate3GreaterThan":"0001-01-01T00:00:00.0000000","UserDefinedDate3LessThan":"0001-01-01T00:00:00.0000000","UserDefinedDate3LessThanOrEqualTo":"0001-01-01T00:00:00.0000000","UserDefinedDate3NotEqualTo":"0001-01-01T00:00:00.0000000","UserDefinedDate3Between":["0001-01-01T00:00:00.0000000"],"UserDefinedDate3In":["0001-01-01T00:00:00.0000000"],"UserDefinedFloat1":0,"UserDefinedFloat1GreaterThanOrEqualTo":0,"UserDefinedFloat1GreaterThan":0,"UserDefinedFloat1LessThan":0,"UserDefinedFloat1LessThanOrEqualTo":0,"UserDefinedFloat1NotEqualTo":0,"UserDefinedFloat1Between":[0],"UserDefinedFloat1In":[0],"UserDefinedFloat2":0,"UserDefinedFloat2GreaterThanOrEqualTo":0,"UserDefinedFloat2GreaterThan":0,"UserDefinedFloat2LessThan":0,"UserDefinedFloat2LessThanOrEqualTo":0,"UserDefinedFloat2NotEqualTo":0,"UserDefinedFloat2Between":[0],"UserDefinedFloat2In":[0],"UserDefinedFloat3":0,"UserDefinedFloat3GreaterThanOrEqualTo":0,"UserDefinedFloat3GreaterThan":0,"UserDefinedFloat3LessThan":0,"UserDefinedFloat3LessThanOrEqualTo":0,"UserDefinedFloat3NotEqualTo":0,"UserDefinedFloat3Between":[0],"UserDefinedFloat3In":[0],"SY_Plugin_RecID":"00000000000000000000000000000000","SY_Plugin_RecIDIn":["00000000000000000000000000000000"],"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","TaskID":"String","InventoryID":"String","PartNo":"String","Description":"String","CommentLine":false,"Quantity":0,"PriceExGST":0,"GSTID":"String","GSTRate":0,"GSTAmount":0,"LineTotalIncGST":0,"Processed":false,"InvoiceID":"String","InvoiceLineID":"String","DisplayOrder":0,"PhysicalItem":false,"UseSerials":false,"QuantityDecimalPlaces":0,"SellPriceIsIncTax":false,"CreditReasonID":"String","CreditIntoStock":false,"Notes":"String","UserDefinedBit1":false,"UserDefinedBit2":false,"UserDefinedBit3":false,"UserDefinedString1":"String","UserDefinedString2":"String","UserDefinedString3":"String","UserDefinedDate1":"0001-01-01T00:00:00.0000000","UserDefinedDate2":"0001-01-01T00:00:00.0000000","UserDefinedDate3":"0001-01-01T00:00:00.0000000","UserDefinedFloat1":0,"UserDefinedFloat2":0,"UserDefinedFloat3":0,"SY_Plugin_RecID":"00000000000000000000000000000000"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}