JiwaAPI

<back to all web services

SalesOrderHistoryCustomFieldValuesPATCHRequest

Requires Authentication
The following routes are available for this service:
PATCH/SalesOrders/{InvoiceID}/Historys/{InvoiceHistoryID}/CustomFieldValues/{SettingID}Updates a sales order history custom field value.
SalesOrderHistoryCustomFieldValuesPATCHRequest Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDpathstringNo
InvoiceHistoryIDpathstringNo
SettingIDpathstringNo
CustomFieldValue Parameters:
NameParameterData TypeRequiredDescription
SettingIDformstringNo
SettingNameformstringNo
ContentsformstringNo
PluginIDformstringNo
PluginNameformstringNo
CustomFieldValue Parameters:
NameParameterData TypeRequiredDescription
SettingIDformstringNo
SettingNameformstringNo
ContentsformstringNo
PluginIDformstringNo
PluginNameformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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

PATCH /SalesOrders/{InvoiceID}/Historys/{InvoiceHistoryID}/CustomFieldValues/{SettingID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SalesOrderHistoryCustomFieldValuesPATCHRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel">
  <_x003C_Contents_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.CustomFields">String</_x003C_Contents_x003E_k__BackingField>
  <_x003C_PluginID_x003E_k__BackingField i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.CustomFields" />
  <_x003C_PluginName_x003E_k__BackingField i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.CustomFields" />
  <_x003C_SettingID_x003E_k__BackingField i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.CustomFields" />
  <_x003C_SettingName_x003E_k__BackingField i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.CustomFields" />
  <_x003C_InvoiceHistoryID_x003E_k__BackingField>String</_x003C_InvoiceHistoryID_x003E_k__BackingField>
  <_x003C_InvoiceID_x003E_k__BackingField>String</_x003C_InvoiceID_x003E_k__BackingField>
  <_x003C_PluginID_x003E_k__BackingField>String</_x003C_PluginID_x003E_k__BackingField>
  <_x003C_PluginName_x003E_k__BackingField>String</_x003C_PluginName_x003E_k__BackingField>
  <_x003C_SettingID_x003E_k__BackingField>String</_x003C_SettingID_x003E_k__BackingField>
  <_x003C_SettingName_x003E_k__BackingField>String</_x003C_SettingName_x003E_k__BackingField>
</SalesOrderHistoryCustomFieldValuesPATCHRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomFieldValue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.CustomFields">
  <_x003C_Contents_x003E_k__BackingField>String</_x003C_Contents_x003E_k__BackingField>
  <_x003C_PluginID_x003E_k__BackingField>String</_x003C_PluginID_x003E_k__BackingField>
  <_x003C_PluginName_x003E_k__BackingField>String</_x003C_PluginName_x003E_k__BackingField>
  <_x003C_SettingID_x003E_k__BackingField>String</_x003C_SettingID_x003E_k__BackingField>
  <_x003C_SettingName_x003E_k__BackingField>String</_x003C_SettingName_x003E_k__BackingField>
</CustomFieldValue>