JiwaAPI

<back to all web services

sh_SalesOrderLineQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/sh_SalesOrderLinesRetrieves a list of sh sales order lines
sh_SalesOrderLineQuery Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDquerystringNo
InvoiceIDStartsWithquerystringNo
InvoiceIDEndsWithquerystringNo
InvoiceIDContainsquerystringNo
InvoiceIDLikequerystringNo
InvoiceIDBetweenquerystring[]No
InvoiceIDInquerystring[]No
UnitIncGSTqueryint?No
UnitIncGSTGreaterThanOrEqualToqueryint?No
UnitIncGSTGreaterThanqueryint?No
UnitIncGSTLessThanqueryint?No
UnitIncGSTLessThanOrEqualToqueryint?No
UnitIncGSTNotEqualToqueryint?No
UseSerialNoquerybool?No
PartNoquerystringNo
PartNoBetweenquerystring[]No
PartNoInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
sh_SalesOrderLine Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDformstringNo
InvoiceLineIDformstringNo
InvoiceHistoryIDformstringNo
LineNumformshort?No
CommentLineformbool?No
PartNoformstringNo
DescriptionformstringNo
PhysicalItemformshort?No
UnitCostformdecimal?No
UnitExGSTformdecimal?No
TotalTaxformdecimal?No
TotalIncGSTformdecimal?No
QuantityOrderedformdecimal?No
QuantityPrevDelformdecimal?No
QuantityThisDelformdecimal?No
QuantityBackOrdformdecimal?No
HistoryText_CommentformstringNo
NonStockformbool?No
InventoryIDformstringNo
UseSerialNoformbool?No
UnitTaxformdecimal?No
BOMObjectformint?No
KitStyleformshort?No
LineCostformdecimal?No
OrigInvoiceNoformstringNo
UnitIncGSTformdecimal?No
TotalExGSTformdecimal?No
DemandQuantityformdecimal?No
QuantityPrevDemandformdecimal?No
UserDefinedFloat1formdecimal?No
ETAToSHEffectiveformDateTime?No
ETAToSHOverrideformDateTime?No
ETAToSupplierformDateTime?No
ETAToSupplierOffsetInDaysformint?No
PurchaseOrderIdformstringNo
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Queries/sh_SalesOrderLines HTTP/1.1 
Host: localhost 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"InvoiceID":"String","InvoiceLineID":"String","InvoiceHistoryID":"String","LineNum":0,"CommentLine":false,"PartNo":"String","Description":"String","PhysicalItem":0,"UnitCost":0,"UnitExGST":0,"TotalTax":0,"TotalIncGST":0,"QuantityOrdered":0,"QuantityPrevDel":0,"QuantityThisDel":0,"QuantityBackOrd":0,"HistoryText_Comment":"String","NonStock":false,"InventoryID":"String","UseSerialNo":false,"UnitTax":0,"BOMObject":0,"KitStyle":0,"LineCost":0,"OrigInvoiceNo":"String","UnitIncGST":0,"TotalExGST":0,"DemandQuantity":0,"QuantityPrevDemand":0,"UserDefinedFloat1":0,"ETAToSHEffective":"0001-01-01T00:00:00.0000000","ETAToSHOverride":"0001-01-01T00:00:00.0000000","ETAToSupplier":"0001-01-01T00:00:00.0000000","ETAToSupplierOffsetInDays":0,"PurchaseOrderId":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}