JiwaAPI

<back to all web services

SalesOrderHistorysGETRequest

Requires Authentication
The following routes are available for this service:
GET/SalesOrders/{InvoiceID}/Historys/{InvoiceHistoryID}Retrieves a sales order history.
SalesOrderHistorysGETRequest Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDpathstringNo
InvoiceHistoryIDpathstringNo
SalesOrderHistory Parameters:
NameParameterData TypeRequiredDescription
InvoiceHistoryIDformstringNo
HistoryNoformint?No
StatusformSalesOrderHistoryStatuses?No
EDIPickStatusformSalesOrderHistoryEDIPickStatuses?No
DBTransIDformstringNo
RefformstringNo
LastModifiedByformstringNo
HistoryTotalformdecimal?No
AmountPaidformdecimal?No
TotalQuantityDeliveredformdecimal?No
RunNoformstringNo
Deliveredformbool?No
DeliveredDateformDateTime?No
RecordDateformDateTime?No
DateCreatedformDateTime?No
DateLastSavedformDateTime?No
DatePostedformDateTime?No
DateProcessedformDateTime?No
InvoicePrintedformbool?No
DocketPrintedformbool?No
PackSlipPrintedformbool?No
PickSheetPrintedformbool?No
OtherPrintedformbool?No
InvoiceEmailedformbool?No
DocketEmailedformbool?No
PackSlipEmailedformbool?No
PickSheetEmailedformbool?No
OtherEmailedformbool?No
DeliveryAddressContactNameformstringNo
DeliveryAddresseeformstringNo
DeliveryAddressEmailAddressformstringNo
DeliveryAddress1formstringNo
DeliveryAddress2formstringNo
DeliveryAddress3formstringNo
DeliveryAddress4formstringNo
DeliveryAddressPostcodeformstringNo
DeliveryAddressCountryformstringNo
NotesformstringNo
CourierDetailsformstringNo
FreightForwardAddress1formstringNo
FreightForwardAddress2formstringNo
FreightForwardAddress3formstringNo
FreightForwardAddress4formstringNo
FreightForwardAddressCountryformstringNo
FreightForwardAddressNotesformstringNo
ConsignmentNoteformstringNo
EDIASNNumberformstringNo
DropShipmentformbool?No
CartageCharge1formCartageChargeNo
CartageCharge2formCartageChargeNo
CartageCharge3formCartageChargeNo
CarrierformSalesOrderCarrierNo
CustomFieldValuesformList<CustomFieldValue>No
CartageCharge Parameters:
NameParameterData TypeRequiredDescription
ExTaxAmountformdecimal?No
TaxAmountformdecimal?No
TaxRateformTaxRateNo
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
SalesOrderCarrier Parameters:
NameParameterData TypeRequiredDescription
CarrierIDformstringNo
CarrierNameformstringNo
AccountNoformstringNo
ServiceformSalesOrderCarrierServiceNo
UseLeastCostformbool?No
ChargeToformFreightChargeTos?No
StatusformFreightSystemStatuses?No
FreightItemCollectionformList<SalesOrderFreightItem>No
ConsignmentNoteCollectionformList<SalesOrderConsignmentNote>No
SalesOrderCarrierService Parameters:
NameParameterData TypeRequiredDescription
CarrierServiceIDformstringNo
NameformstringNo
SalesOrderFreightItem Parameters:
NameParameterData TypeRequiredDescription
FreightItemIDformstringNo
NumberItemsformint?No
ItemWeightformdecimal?No
ItemCubicformdecimal?No
ItemLengthformdecimal?No
ItemWidthformdecimal?No
ItemHeightformdecimal?No
ReferenceformstringNo
FreightDescriptionformSalesOrderCarrierFreightDescriptionNo
ConsignmentNoteformSalesOrderConsignmentNoteNo
SalesOrderCarrierFreightDescription Parameters:
NameParameterData TypeRequiredDescription
CarrierFreightDescriptionIDformstringNo
DescriptionformstringNo
SalesOrderConsignmentNote Parameters:
NameParameterData TypeRequiredDescription
ConsignmentNoteIDformstringNo
ConsignmentNoteDateformDateTime?No
ExGSTAmountformdecimal?No
GSTAmountformdecimal?No
ConsignmentNoteNoformstringNo
CustomFieldValue Parameters:
NameParameterData TypeRequiredDescription
SettingIDformstringNo
SettingNameformstringNo
ContentsformstringNo
PluginIDformstringNo
PluginNameformstringNo

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.

GET /SalesOrders/{InvoiceID}/Historys/{InvoiceHistoryID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"InvoiceHistoryID":"String","HistoryNo":0,"Status":"e_SalesOrderHistoryStatusEntering","EDIPickStatus":"e_SalesOrderHistoryEDIPickStatusNone","DBTransID":"String","Ref":"String","LastModifiedBy":"String","HistoryTotal":0,"AmountPaid":0,"TotalQuantityDelivered":0,"RunNo":"String","Delivered":false,"DeliveredDate":"0001-01-01T00:00:00.0000000","RecordDate":"0001-01-01T00:00:00.0000000","DateCreated":"0001-01-01T00:00:00.0000000","DateLastSaved":"0001-01-01T00:00:00.0000000","DatePosted":"0001-01-01T00:00:00.0000000","DateProcessed":"0001-01-01T00:00:00.0000000","InvoicePrinted":false,"DocketPrinted":false,"PackSlipPrinted":false,"PickSheetPrinted":false,"OtherPrinted":false,"InvoiceEmailed":false,"DocketEmailed":false,"PackSlipEmailed":false,"PickSheetEmailed":false,"OtherEmailed":false,"DeliveryAddressContactName":"String","DeliveryAddressee":"String","DeliveryAddressEmailAddress":"String","DeliveryAddress1":"String","DeliveryAddress2":"String","DeliveryAddress3":"String","DeliveryAddress4":"String","DeliveryAddressPostcode":"String","DeliveryAddressCountry":"String","Notes":"String","CourierDetails":"String","FreightForwardAddress1":"String","FreightForwardAddress2":"String","FreightForwardAddress3":"String","FreightForwardAddress4":"String","FreightForwardAddressCountry":"String","FreightForwardAddressNotes":"String","ConsignmentNote":"String","EDIASNNumber":"String","DropShipment":false,"CartageCharge1":{"ExTaxAmount":0,"TaxAmount":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"}}},"CartageCharge2":{"ExTaxAmount":0,"TaxAmount":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"}}},"CartageCharge3":{"ExTaxAmount":0,"TaxAmount":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"}}},"Carrier":{"CarrierID":"String","CarrierName":"String","AccountNo":"String","Service":{"CarrierServiceID":"String","Name":"String"},"UseLeastCost":false,"ChargeTo":"FreightChargeToSender","Status":"FreightSystemStatusNone","FreightItemCollection":[{"FreightItemID":"String","NumberItems":0,"ItemWeight":0,"ItemCubic":0,"ItemLength":0,"ItemWidth":0,"ItemHeight":0,"Reference":"String","FreightDescription":{"CarrierFreightDescriptionID":"String","Description":"String"},"ConsignmentNote":{"ConsignmentNoteID":"String","ConsignmentNoteDate":"0001-01-01T00:00:00.0000000","ExGSTAmount":0,"GSTAmount":0,"ConsignmentNoteNo":"String"}}],"ConsignmentNoteCollection":[{"ConsignmentNoteID":"String","ConsignmentNoteDate":"0001-01-01T00:00:00.0000000","ExGSTAmount":0,"GSTAmount":0,"ConsignmentNoteNo":"String"}]},"CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}]}