JiwaAPI

<back to all web services

SalesOrderLineGETRequest

Requires Authentication
The following routes are available for this service:
GET/SalesOrders/{InvoiceID}/Historys/{InvoiceHistoryID}/Lines/{InvoiceLineID}Retrieves a sales order line.
SalesOrderLineGETRequest Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDpathstringNo
InvoiceHistoryIDpathstringNo
InvoiceLineIDpathstringNo
SalesOrderLine Parameters:
NameParameterData TypeRequiredDescription
ItemNoformint?No
CommentLineformbool?No
QuantityOrderedformdecimal?No
QuantityDemandformdecimal?No
QuantityThisDelformdecimal?No
QuantityBackOrdformdecimal?No
Pickedformbool?No
PriceExGstformdecimal?No
PriceIncGstformdecimal?No
DiscountedPriceformdecimal?No
TaxToChargeformdecimal?No
TaxRateformTaxRateNo
UnitCostformdecimal?No
FixSellPriceformbool?No
FixPriceformbool?No
UserDefinedFloat1formdecimal?No
UserDefinedFloat2formdecimal?No
UserDefinedFloat3formdecimal?No
ForwardOrderDateformDateTime?No
ScheduledDateformDateTime?No
LineTotalformdecimal?No
Weightformdecimal?No
Cubicformdecimal?No
QuotedDiscountedPriceformdecimal?No
QuotedDiscountPercentageformdecimal?No
DiscountedPercentageformdecimal?No
DiscountGivenformdecimal?No
QuantityDecimalPlacesformdecimal?No
QuantityOriginalOrderedformdecimal?No
SalesOrderSerialStockSelectionTypesformSalesOrderSerialStockSelectionTypesEnum?No
NonInventoryformbool?No
InvoiceLineIDformstringNo
InventoryIDformstringNo
PartNoformstringNo
DescriptionformstringNo
CommentTextformstringNo
Aux2formstringNo
LineLinkIDformstringNo
EDIStoreLocationCodeformstringNo
EDIDCLocationCodeformstringNo
CostCenterformstringNo
StageformstringNo
CustomFieldValuesformList<CustomFieldValue>No
LineDetailsformList<SalesOrderLineDetail>No
ShippingLabelsformList<SalesOrderShippingLabel>No
UnitOfMeasureformInventoryUnitOfMeasureNo
KitLineTypeformSalesOrderKitLineTypesEnum?No
KitUnitsformdecimal?No
KitHeaderLineIDformstringNo
TaxRate Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
TaxIDformstringNo
DescriptionformstringNo
GSTTaxGroupformTaxRateTypes?No
Rateformdecimal?No
IsDefaultRateformbool?No
BASCodeformdecimal?No
IsDefaultRateInGroupformbool?No
IsEnabledformbool?No
LedgerAccountformAccountNo
Account Parameters:
NameParameterData TypeRequiredDescription
LedgerIDformstringNo
AccountNoformstringNo
DescriptionformstringNo
CustomFieldValue Parameters:
NameParameterData TypeRequiredDescription
SettingIDformstringNo
SettingNameformstringNo
ContentsformstringNo
PluginIDformstringNo
PluginNameformstringNo
SalesOrderLineDetail Parameters:
NameParameterData TypeRequiredDescription
Costformdecimal?No
DateInformDateTime?No
ExpiryDateformDateTime?No
SpecialPriceformdecimal?No
Quantityformdecimal?No
LineDetailIDformstringNo
BinLocationformstringNo
SerialNoformstringNo
SOHIDformstringNo
IN_LogicalIDformstringNo
SalesOrderShippingLabel Parameters:
NameParameterData TypeRequiredDescription
Quantityformdecimal?No
UseByDateformDateTime?No
LabelNumberformint?No
SpareNumeric1formdecimal?No
SpareNumeric2formdecimal?No
SpareNumeric3formdecimal?No
SpareDate1formDateTime?No
SpareDate2formDateTime?No
SpareDate3formDateTime?No
ShippingLabelIDformstringNo
SSCCNumberformstringNo
BatchNoformstringNo
ReferenceformstringNo
SpareString1formstringNo
SpareString2formstringNo
SpareString3formstringNo
LastSavedDateTimeformDateTime?No
InventoryUnitOfMeasure Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
InnerUnitOfMeasureformInventoryUnitOfMeasureNo
QuantityInnersPerUnitOfMeasureformdecimal?No
IsSellformbool?No
IsPurchaseformbool?No
ItemNoformint?No
LastSavedDateTimeformDateTime?No
UnitOfMeasureIDformstringNo
NameformstringNo
PartNoformstringNo
BarcodeformstringNo

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 /SalesOrders/{InvoiceID}/Historys/{InvoiceHistoryID}/Lines/{InvoiceLineID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ItemNo":0,"CommentLine":false,"QuantityOrdered":0,"QuantityDemand":0,"QuantityThisDel":0,"QuantityBackOrd":0,"Picked":false,"PriceExGst":0,"PriceIncGst":0,"DiscountedPrice":0,"TaxToCharge":0,"TaxRate":{"RecID":"String","TaxID":"String","Description":"String","GSTTaxGroup":"WST","Rate":0,"IsDefaultRate":false,"BASCode":0,"IsDefaultRateInGroup":false,"IsEnabled":false,"LedgerAccount":{"LedgerID":"String","AccountNo":"String","Description":"String"}},"UnitCost":0,"FixSellPrice":false,"FixPrice":false,"UserDefinedFloat1":0,"UserDefinedFloat2":0,"UserDefinedFloat3":0,"ForwardOrderDate":"0001-01-01T00:00:00.0000000","ScheduledDate":"0001-01-01T00:00:00.0000000","LineTotal":0,"Weight":0,"Cubic":0,"QuotedDiscountedPrice":0,"QuotedDiscountPercentage":0,"DiscountedPercentage":0,"DiscountGiven":0,"QuantityDecimalPlaces":0,"QuantityOriginalOrdered":0,"SalesOrderSerialStockSelectionTypes":"e_SalesOrderSerialStockSelectionPrompted","NonInventory":false,"InvoiceLineID":"String","InventoryID":"String","PartNo":"String","Description":"String","CommentText":"String","Aux2":"String","LineLinkID":"String","EDIStoreLocationCode":"String","EDIDCLocationCode":"String","CostCenter":"String","Stage":"String","CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}],"LineDetails":[{"Cost":0,"DateIn":"0001-01-01T00:00:00.0000000","ExpiryDate":"0001-01-01T00:00:00.0000000","SpecialPrice":0,"Quantity":0,"LineDetailID":"String","BinLocation":"String","SerialNo":"String","SOHID":"String","IN_LogicalID":"String"}],"ShippingLabels":[{"Quantity":0,"UseByDate":"0001-01-01T00:00:00.0000000","LabelNumber":0,"SpareNumeric1":0,"SpareNumeric2":0,"SpareNumeric3":0,"SpareDate1":"0001-01-01T00:00:00.0000000","SpareDate2":"0001-01-01T00:00:00.0000000","SpareDate3":"0001-01-01T00:00:00.0000000","ShippingLabelID":"String","SSCCNumber":"String","BatchNo":"String","Reference":"String","SpareString1":"String","SpareString2":"String","SpareString3":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000"}],"UnitOfMeasure":{"RecID":"String","InnerUnitOfMeasure":{"RecID":"String","InnerUnitOfMeasure":{"RecID":"String","QuantityInnersPerUnitOfMeasure":0,"IsSell":false,"IsPurchase":false,"ItemNo":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","UnitOfMeasureID":"String","Name":"String","PartNo":"String","Barcode":"String"},"QuantityInnersPerUnitOfMeasure":0,"IsSell":false,"IsPurchase":false,"ItemNo":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","UnitOfMeasureID":"String","Name":"String","PartNo":"String","Barcode":"String"},"QuantityInnersPerUnitOfMeasure":0,"IsSell":false,"IsPurchase":false,"ItemNo":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","UnitOfMeasureID":"String","Name":"String","PartNo":"String","Barcode":"String"},"KitLineType":"e_SalesOrderNormalLine","KitUnits":0,"KitHeaderLineID":"String"}