JiwaAPI

<back to all web services

v_SalesInformationQuery

Requires Authentication
v_SalesInformationQuery Parameters:
NameParameterData TypeRequiredDescription
InvoiceLineIDquerystringNo
InvoiceLineIDStartsWithquerystringNo
InvoiceLineIDEndsWithquerystringNo
InvoiceLineIDContainsquerystringNo
InvoiceLineIDLikequerystringNo
InvoiceLineIDBetweenquerystring[]No
InvoiceLineIDInquerystring[]No
InvoiceNoquerystringNo
InvoiceNoStartsWithquerystringNo
InvoiceNoEndsWithquerystringNo
InvoiceNoContainsquerystringNo
InvoiceNoLikequerystringNo
InvoiceNoBetweenquerystring[]No
InvoiceNoInquerystring[]No
StaffIDquerystringNo
StaffIDStartsWithquerystringNo
StaffIDEndsWithquerystringNo
StaffIDContainsquerystringNo
StaffIDLikequerystringNo
StaffIDBetweenquerystring[]No
StaffIDInquerystring[]No
IN_LogicalIDquerystringNo
IN_LogicalIDStartsWithquerystringNo
IN_LogicalIDEndsWithquerystringNo
IN_LogicalIDContainsquerystringNo
IN_LogicalIDLikequerystringNo
IN_LogicalIDBetweenquerystring[]No
IN_LogicalIDInquerystring[]No
IN_PhysicalIDquerystringNo
IN_PhysicalIDStartsWithquerystringNo
IN_PhysicalIDEndsWithquerystringNo
IN_PhysicalIDContainsquerystringNo
IN_PhysicalIDLikequerystringNo
IN_PhysicalIDBetweenquerystring[]No
IN_PhysicalIDInquerystring[]No
BranchIDquerystringNo
BranchIDStartsWithquerystringNo
BranchIDEndsWithquerystringNo
BranchIDContainsquerystringNo
BranchIDLikequerystringNo
BranchIDBetweenquerystring[]No
BranchIDInquerystring[]No
PartNoquerystringNo
PartNoStartsWithquerystringNo
PartNoEndsWithquerystringNo
PartNoContainsquerystringNo
PartNoLikequerystringNo
PartNoBetweenquerystring[]No
PartNoInquerystring[]No
PartDescriptionquerystringNo
PartDescriptionStartsWithquerystringNo
PartDescriptionEndsWithquerystringNo
PartDescriptionContainsquerystringNo
PartDescriptionLikequerystringNo
PartDescriptionBetweenquerystring[]No
PartDescriptionInquerystring[]No
Quantityquerydecimal?No
QuantityGreaterThanOrEqualToquerydecimal?No
QuantityGreaterThanquerydecimal?No
QuantityLessThanquerydecimal?No
QuantityLessThanOrEqualToquerydecimal?No
QuantityNotEqualToquerydecimal?No
QuantityBetweenqueryNullable<Decimal>[]No
QuantityInqueryNullable<Decimal>[]No
LineTotalIncGSTquerydecimal?No
LineTotalIncGSTGreaterThanOrEqualToquerydecimal?No
LineTotalIncGSTGreaterThanquerydecimal?No
LineTotalIncGSTLessThanquerydecimal?No
LineTotalIncGSTLessThanOrEqualToquerydecimal?No
LineTotalIncGSTNotEqualToquerydecimal?No
LineTotalIncGSTBetweenqueryNullable<Decimal>[]No
LineTotalIncGSTInqueryNullable<Decimal>[]No
LineTaxTotalquerydecimal?No
LineTaxTotalGreaterThanOrEqualToquerydecimal?No
LineTaxTotalGreaterThanquerydecimal?No
LineTaxTotalLessThanquerydecimal?No
LineTaxTotalLessThanOrEqualToquerydecimal?No
LineTaxTotalNotEqualToquerydecimal?No
LineTaxTotalBetweenqueryNullable<Decimal>[]No
LineTaxTotalInqueryNullable<Decimal>[]No
LineTotalExGSTquerydecimal?No
LineTotalExGSTGreaterThanOrEqualToquerydecimal?No
LineTotalExGSTGreaterThanquerydecimal?No
LineTotalExGSTLessThanquerydecimal?No
LineTotalExGSTLessThanOrEqualToquerydecimal?No
LineTotalExGSTNotEqualToquerydecimal?No
LineTotalExGSTBetweenqueryNullable<Decimal>[]No
LineTotalExGSTInqueryNullable<Decimal>[]No
LineCostquerydecimal?No
LineCostGreaterThanOrEqualToquerydecimal?No
LineCostGreaterThanquerydecimal?No
LineCostLessThanquerydecimal?No
LineCostLessThanOrEqualToquerydecimal?No
LineCostNotEqualToquerydecimal?No
LineCostBetweenqueryNullable<Decimal>[]No
LineCostInqueryNullable<Decimal>[]No
LineProfitquerydecimal?No
LineProfitGreaterThanOrEqualToquerydecimal?No
LineProfitGreaterThanquerydecimal?No
LineProfitLessThanquerydecimal?No
LineProfitLessThanOrEqualToquerydecimal?No
LineProfitNotEqualToquerydecimal?No
LineProfitBetweenqueryNullable<Decimal>[]No
LineProfitInqueryNullable<Decimal>[]No
ClassificationDescriptionquerystringNo
ClassificationDescriptionStartsWithquerystringNo
ClassificationDescriptionEndsWithquerystringNo
ClassificationDescriptionContainsquerystringNo
ClassificationDescriptionLikequerystringNo
ClassificationDescriptionBetweenquerystring[]No
ClassificationDescriptionInquerystring[]No
Category1DescriptionAtTimeOfSalequerystringNo
Category1DescriptionAtTimeOfSaleStartsWithquerystringNo
Category1DescriptionAtTimeOfSaleEndsWithquerystringNo
Category1DescriptionAtTimeOfSaleContainsquerystringNo
Category1DescriptionAtTimeOfSaleLikequerystringNo
Category1DescriptionAtTimeOfSaleBetweenquerystring[]No
Category1DescriptionAtTimeOfSaleInquerystring[]No
Category2DescriptionAtTimeOfSalequerystringNo
Category2DescriptionAtTimeOfSaleStartsWithquerystringNo
Category2DescriptionAtTimeOfSaleEndsWithquerystringNo
Category2DescriptionAtTimeOfSaleContainsquerystringNo
Category2DescriptionAtTimeOfSaleLikequerystringNo
Category2DescriptionAtTimeOfSaleBetweenquerystring[]No
Category2DescriptionAtTimeOfSaleInquerystring[]No
Category3DescriptionAtTimeOfSalequerystringNo
Category3DescriptionAtTimeOfSaleStartsWithquerystringNo
Category3DescriptionAtTimeOfSaleEndsWithquerystringNo
Category3DescriptionAtTimeOfSaleContainsquerystringNo
Category3DescriptionAtTimeOfSaleLikequerystringNo
Category3DescriptionAtTimeOfSaleBetweenquerystring[]No
Category3DescriptionAtTimeOfSaleInquerystring[]No
DebtorIDquerystringNo
DebtorIDStartsWithquerystringNo
DebtorIDEndsWithquerystringNo
DebtorIDContainsquerystringNo
DebtorIDLikequerystringNo
DebtorIDBetweenquerystring[]No
DebtorIDInquerystring[]No
DebtorClassificationIDquerystringNo
DebtorClassificationIDStartsWithquerystringNo
DebtorClassificationIDEndsWithquerystringNo
DebtorClassificationIDContainsquerystringNo
DebtorClassificationIDLikequerystringNo
DebtorClassificationIDBetweenquerystring[]No
DebtorClassificationIDInquerystring[]No
ProcessDatequeryDateTime?No
ProcessDateGreaterThanOrEqualToqueryDateTime?No
ProcessDateGreaterThanqueryDateTime?No
ProcessDateLessThanqueryDateTime?No
ProcessDateLessThanOrEqualToqueryDateTime?No
ProcessDateNotEqualToqueryDateTime?No
ProcessDateBetweenqueryNullable<DateTime>[]No
ProcessDateInqueryNullable<DateTime>[]No
InventoryIDquerystringNo
InventoryIDStartsWithquerystringNo
InventoryIDEndsWithquerystringNo
InventoryIDContainsquerystringNo
InventoryIDLikequerystringNo
InventoryIDBetweenquerystring[]No
InventoryIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_SalesInformation Parameters:
NameParameterData TypeRequiredDescription
InvoiceLineIDformstringNo
InvoiceNoformstringNo
StaffIDformstringNo
IN_LogicalIDformstringNo
IN_PhysicalIDformstringNo
BranchIDformstringNo
PartNoformstringNo
PartDescriptionformstringNo
Quantityformdecimal?No
LineTotalIncGSTformdecimal?No
LineTaxTotalformdecimal?No
LineTotalExGSTformdecimal?No
LineCostformdecimal?No
LineProfitformdecimal?No
ClassificationDescriptionformstringNo
Category1DescriptionAtTimeOfSaleformstringNo
Category2DescriptionAtTimeOfSaleformstringNo
Category3DescriptionAtTimeOfSaleformstringNo
DebtorIDformstringNo
DebtorClassificationIDformstringNo
ProcessDateformDateTime?No
InventoryIDformstringNo
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/v_SalesInformationQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"InvoiceLineID":"String","InvoiceLineIDStartsWith":"String","InvoiceLineIDEndsWith":"String","InvoiceLineIDContains":"String","InvoiceLineIDLike":"String","InvoiceLineIDBetween":["String"],"InvoiceLineIDIn":["String"],"InvoiceNo":"String","InvoiceNoStartsWith":"String","InvoiceNoEndsWith":"String","InvoiceNoContains":"String","InvoiceNoLike":"String","InvoiceNoBetween":["String"],"InvoiceNoIn":["String"],"StaffID":"String","StaffIDStartsWith":"String","StaffIDEndsWith":"String","StaffIDContains":"String","StaffIDLike":"String","StaffIDBetween":["String"],"StaffIDIn":["String"],"IN_LogicalID":"String","IN_LogicalIDStartsWith":"String","IN_LogicalIDEndsWith":"String","IN_LogicalIDContains":"String","IN_LogicalIDLike":"String","IN_LogicalIDBetween":["String"],"IN_LogicalIDIn":["String"],"IN_PhysicalID":"String","IN_PhysicalIDStartsWith":"String","IN_PhysicalIDEndsWith":"String","IN_PhysicalIDContains":"String","IN_PhysicalIDLike":"String","IN_PhysicalIDBetween":["String"],"IN_PhysicalIDIn":["String"],"BranchID":"String","BranchIDStartsWith":"String","BranchIDEndsWith":"String","BranchIDContains":"String","BranchIDLike":"String","BranchIDBetween":["String"],"BranchIDIn":["String"],"PartNo":"String","PartNoStartsWith":"String","PartNoEndsWith":"String","PartNoContains":"String","PartNoLike":"String","PartNoBetween":["String"],"PartNoIn":["String"],"PartDescription":"String","PartDescriptionStartsWith":"String","PartDescriptionEndsWith":"String","PartDescriptionContains":"String","PartDescriptionLike":"String","PartDescriptionBetween":["String"],"PartDescriptionIn":["String"],"Quantity":0,"QuantityGreaterThanOrEqualTo":0,"QuantityGreaterThan":0,"QuantityLessThan":0,"QuantityLessThanOrEqualTo":0,"QuantityNotEqualTo":0,"QuantityBetween":[0],"QuantityIn":[0],"LineTotalIncGST":0,"LineTotalIncGSTGreaterThanOrEqualTo":0,"LineTotalIncGSTGreaterThan":0,"LineTotalIncGSTLessThan":0,"LineTotalIncGSTLessThanOrEqualTo":0,"LineTotalIncGSTNotEqualTo":0,"LineTotalIncGSTBetween":[0],"LineTotalIncGSTIn":[0],"LineTaxTotal":0,"LineTaxTotalGreaterThanOrEqualTo":0,"LineTaxTotalGreaterThan":0,"LineTaxTotalLessThan":0,"LineTaxTotalLessThanOrEqualTo":0,"LineTaxTotalNotEqualTo":0,"LineTaxTotalBetween":[0],"LineTaxTotalIn":[0],"LineTotalExGST":0,"LineTotalExGSTGreaterThanOrEqualTo":0,"LineTotalExGSTGreaterThan":0,"LineTotalExGSTLessThan":0,"LineTotalExGSTLessThanOrEqualTo":0,"LineTotalExGSTNotEqualTo":0,"LineTotalExGSTBetween":[0],"LineTotalExGSTIn":[0],"LineCost":0,"LineCostGreaterThanOrEqualTo":0,"LineCostGreaterThan":0,"LineCostLessThan":0,"LineCostLessThanOrEqualTo":0,"LineCostNotEqualTo":0,"LineCostBetween":[0],"LineCostIn":[0],"LineProfit":0,"LineProfitGreaterThanOrEqualTo":0,"LineProfitGreaterThan":0,"LineProfitLessThan":0,"LineProfitLessThanOrEqualTo":0,"LineProfitNotEqualTo":0,"LineProfitBetween":[0],"LineProfitIn":[0],"ClassificationDescription":"String","ClassificationDescriptionStartsWith":"String","ClassificationDescriptionEndsWith":"String","ClassificationDescriptionContains":"String","ClassificationDescriptionLike":"String","ClassificationDescriptionBetween":["String"],"ClassificationDescriptionIn":["String"],"Category1DescriptionAtTimeOfSale":"String","Category1DescriptionAtTimeOfSaleStartsWith":"String","Category1DescriptionAtTimeOfSaleEndsWith":"String","Category1DescriptionAtTimeOfSaleContains":"String","Category1DescriptionAtTimeOfSaleLike":"String","Category1DescriptionAtTimeOfSaleBetween":["String"],"Category1DescriptionAtTimeOfSaleIn":["String"],"Category2DescriptionAtTimeOfSale":"String","Category2DescriptionAtTimeOfSaleStartsWith":"String","Category2DescriptionAtTimeOfSaleEndsWith":"String","Category2DescriptionAtTimeOfSaleContains":"String","Category2DescriptionAtTimeOfSaleLike":"String","Category2DescriptionAtTimeOfSaleBetween":["String"],"Category2DescriptionAtTimeOfSaleIn":["String"],"Category3DescriptionAtTimeOfSale":"String","Category3DescriptionAtTimeOfSaleStartsWith":"String","Category3DescriptionAtTimeOfSaleEndsWith":"String","Category3DescriptionAtTimeOfSaleContains":"String","Category3DescriptionAtTimeOfSaleLike":"String","Category3DescriptionAtTimeOfSaleBetween":["String"],"Category3DescriptionAtTimeOfSaleIn":["String"],"DebtorID":"String","DebtorIDStartsWith":"String","DebtorIDEndsWith":"String","DebtorIDContains":"String","DebtorIDLike":"String","DebtorIDBetween":["String"],"DebtorIDIn":["String"],"DebtorClassificationID":"String","DebtorClassificationIDStartsWith":"String","DebtorClassificationIDEndsWith":"String","DebtorClassificationIDContains":"String","DebtorClassificationIDLike":"String","DebtorClassificationIDBetween":["String"],"DebtorClassificationIDIn":["String"],"ProcessDate":"0001-01-01T00:00:00.0000000","ProcessDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","ProcessDateGreaterThan":"0001-01-01T00:00:00.0000000","ProcessDateLessThan":"0001-01-01T00:00:00.0000000","ProcessDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","ProcessDateNotEqualTo":"0001-01-01T00:00:00.0000000","ProcessDateBetween":["0001-01-01T00:00:00.0000000"],"ProcessDateIn":["0001-01-01T00:00:00.0000000"],"InventoryID":"String","InventoryIDStartsWith":"String","InventoryIDEndsWith":"String","InventoryIDContains":"String","InventoryIDLike":"String","InventoryIDBetween":["String"],"InventoryIDIn":["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":[{"InvoiceLineID":"String","InvoiceNo":"String","StaffID":"String","IN_LogicalID":"String","IN_PhysicalID":"String","BranchID":"String","PartNo":"String","PartDescription":"String","Quantity":0,"LineTotalIncGST":0,"LineTaxTotal":0,"LineTotalExGST":0,"LineCost":0,"LineProfit":0,"ClassificationDescription":"String","Category1DescriptionAtTimeOfSale":"String","Category2DescriptionAtTimeOfSale":"String","Category3DescriptionAtTimeOfSale":"String","DebtorID":"String","DebtorClassificationID":"String","ProcessDate":"0001-01-01T00:00:00.0000000","InventoryID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}