JiwaAPI

<back to all web services

SalesQuoteHistorysPATCHRequest

Requires Authentication
The following routes are available for this service:
PATCH/SalesQuotes/{QuoteID}/Historys/{QuoteHistoryID}Updates a sales Quote history.
SalesQuoteHistorysPATCHRequest Parameters:
NameParameterData TypeRequiredDescription
QuoteIDpathstringNo
QuoteHistoryIDpathstringNo
SalesQuoteHistory Parameters:
NameParameterData TypeRequiredDescription
QuoteHistoryIDformstringNo
HistoryNoformint?No
SalesStageformSalesStageNo
CartageCharge1formCartageChargeNo
CartageCharge2formCartageChargeNo
CartageCharge3formCartageChargeNo
OpportunityStatusReasonformOpportunityStatusReasonNo
RefformstringNo
LastModifiedByformstringNo
HistoryTotalformdecimal?No
RecordDateformDateTime?No
ExpiryDateformDateTime?No
ExpiryDaysformint?No
DocketPrintedformbool?No
DelAddress1formstringNo
DelAddress2formstringNo
DelAddress3formstringNo
DelAddress4formstringNo
PostCodeformstringNo
DeliveryAddressCountryformstringNo
NotesformstringNo
CourierDetailsformstringNo
FreightForwardAddress1formstringNo
FreightForwardAddress2formstringNo
FreightForwardAddress3formstringNo
FreightForwardAddress4formstringNo
FreightForwardAddressCountryformstringNo
FreightForwardNotesformstringNo
InvoicePrintedformbool?No
DelContactNameformstringNo
ExpectedCloseDateformDateTime?No
OpportunityStatusformStatusTypes?No
OpportunityNoteformstringNo
InvoiceEmailedformbool?No
DropShipmentformbool?No
DeliveryAddresseeformstringNo
SalesStage Parameters:
NameParameterData TypeRequiredDescription
SalesStageIDformstringNo
LastSavedDateTimeformDateTime?No
ItemNoformint?No
DescriptionformstringNo
PercentCompleteformshort?No
IsDefaultformbool?No
IsEnabledformbool?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
OpportunityStatusReason Parameters:
NameParameterData TypeRequiredDescription
OpportunityStatusReasonIDformstringNo
DescriptionformstringNo
NoteformstringNo
StatusTypeformStatusTypes?No
SalesQuoteHistory Parameters:
NameParameterData TypeRequiredDescription
QuoteHistoryIDformstringNo
HistoryNoformint?No
SalesStageformSalesStageNo
CartageCharge1formCartageChargeNo
CartageCharge2formCartageChargeNo
CartageCharge3formCartageChargeNo
OpportunityStatusReasonformOpportunityStatusReasonNo
RefformstringNo
LastModifiedByformstringNo
HistoryTotalformdecimal?No
RecordDateformDateTime?No
ExpiryDateformDateTime?No
ExpiryDaysformint?No
DocketPrintedformbool?No
DelAddress1formstringNo
DelAddress2formstringNo
DelAddress3formstringNo
DelAddress4formstringNo
PostCodeformstringNo
DeliveryAddressCountryformstringNo
NotesformstringNo
CourierDetailsformstringNo
FreightForwardAddress1formstringNo
FreightForwardAddress2formstringNo
FreightForwardAddress3formstringNo
FreightForwardAddress4formstringNo
FreightForwardAddressCountryformstringNo
FreightForwardNotesformstringNo
InvoicePrintedformbool?No
DelContactNameformstringNo
ExpectedCloseDateformDateTime?No
OpportunityStatusformStatusTypes?No
OpportunityNoteformstringNo
InvoiceEmailedformbool?No
DropShipmentformbool?No
DeliveryAddresseeformstringNo

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.

PATCH /SalesQuotes/{QuoteID}/Historys/{QuoteHistoryID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"QuoteID":"String","QuoteHistoryID":"String","HistoryNo":0,"SalesStage":{"SalesStageID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","ItemNo":0,"Description":"String","PercentComplete":0,"IsDefault":false,"IsEnabled":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"}}},"OpportunityStatusReason":{"OpportunityStatusReasonID":"String","Description":"String","Note":"String","StatusType":"OnGoing"},"Ref":"String","LastModifiedBy":"String","HistoryTotal":0,"RecordDate":"0001-01-01T00:00:00.0000000","ExpiryDate":"0001-01-01T00:00:00.0000000","ExpiryDays":0,"DocketPrinted":false,"DelAddress1":"String","DelAddress2":"String","DelAddress3":"String","DelAddress4":"String","PostCode":"String","DeliveryAddressCountry":"String","Notes":"String","CourierDetails":"String","FreightForwardAddress1":"String","FreightForwardAddress2":"String","FreightForwardAddress3":"String","FreightForwardAddress4":"String","FreightForwardAddressCountry":"String","FreightForwardNotes":"String","InvoicePrinted":false,"DelContactName":"String","ExpectedCloseDate":"0001-01-01T00:00:00.0000000","OpportunityStatus":"OnGoing","OpportunityNote":"String","InvoiceEmailed":false,"DropShipment":false,"DeliveryAddressee":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"QuoteHistoryID":"String","HistoryNo":0,"SalesStage":{"SalesStageID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","ItemNo":0,"Description":"String","PercentComplete":0,"IsDefault":false,"IsEnabled":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"}}},"OpportunityStatusReason":{"OpportunityStatusReasonID":"String","Description":"String","Note":"String","StatusType":"OnGoing"},"Ref":"String","LastModifiedBy":"String","HistoryTotal":0,"RecordDate":"0001-01-01T00:00:00.0000000","ExpiryDate":"0001-01-01T00:00:00.0000000","ExpiryDays":0,"DocketPrinted":false,"DelAddress1":"String","DelAddress2":"String","DelAddress3":"String","DelAddress4":"String","PostCode":"String","DeliveryAddressCountry":"String","Notes":"String","CourierDetails":"String","FreightForwardAddress1":"String","FreightForwardAddress2":"String","FreightForwardAddress3":"String","FreightForwardAddress4":"String","FreightForwardAddressCountry":"String","FreightForwardNotes":"String","InvoicePrinted":false,"DelContactName":"String","ExpectedCloseDate":"0001-01-01T00:00:00.0000000","OpportunityStatus":"OnGoing","OpportunityNote":"String","InvoiceEmailed":false,"DropShipment":false,"DeliveryAddressee":"String"}