JiwaAPI

SalesOrderPaymentsPOSTRequest

The following routes are available for this service:
POST	/SalesOrders/{InvoiceID}/Historys/{InvoiceHistoryID}/Payments	Adds a payment to a sales order

**SalesOrderPaymentsPOSTRequest** Parameters:
Name	Parameter	Data Type	Required	Description
InvoiceID	path	string	No
InvoiceHistoryID	path	string	No

**SalesOrderPayment** Parameters:
Name	Parameter	Data Type	Required
HistoryNo	form	int?	No
PaymentType	form	PaymentType	No
AmountPaid	form	decimal?	No
PaymentDate	form	DateTime?	No
ProcessPayment	form	bool?	No
AuthorisationStatus	form	PaymentAuthStatuses?	No
PaymentGatewayReturnCode	form	int?	No
Processed	form	bool?	No
CardExpiry	form	DateTime?	No
PaymentID	form	string	No
PaymentRef	form	string	No
AuthorisationNumber	form	string	No
PaymentGatewayReturnMessage	form	string	No
CardNumber	form	string	No
CardHolder	form	string	No
BankName	form	string	No
BSBN	form	string	No
BankAcc	form	string	No
AccountName	form	string	No

**PaymentType** Parameters:
Name	Parameter	Data Type	Required
PaymentTypeID	form	string	No
Name	form	string	No
Code	form	string	No
ItemNo	form	int?	No
IsEnabled	form	bool?	No
IsDefault	form	bool?	No
IsCreditCard	form	bool?	No
IsPOS	form	bool?	No
GeneralLedgerAccount	form	Account	No

**Account** Parameters:
Name	Parameter	Data Type	Required
LedgerID	form	string	No
AccountNo	form	string	No
Description	form	string	No

**SalesOrderPayment** Parameters:
Name	Parameter	Data Type	Required
HistoryNo	form	int?	No
PaymentType	form	PaymentType	No
AmountPaid	form	decimal?	No
PaymentDate	form	DateTime?	No
ProcessPayment	form	bool?	No
AuthorisationStatus	form	PaymentAuthStatuses?	No
PaymentGatewayReturnCode	form	int?	No
Processed	form	bool?	No
CardExpiry	form	DateTime?	No
PaymentID	form	string	No
PaymentRef	form	string	No
AuthorisationNumber	form	string	No
PaymentGatewayReturnMessage	form	string	No
CardNumber	form	string	No
CardHolder	form	string	No
BankName	form	string	No
BSBN	form	string	No
BankAcc	form	string	No
AccountName	form	string	No

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.

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

<SalesOrderPaymentsPOSTRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel">
  <_x003C_AccountName_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">String</_x003C_AccountName_x003E_k__BackingField>
  <_x003C_AmountPaid_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">0</_x003C_AmountPaid_x003E_k__BackingField>
  <_x003C_AuthorisationNumber_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">String</_x003C_AuthorisationNumber_x003E_k__BackingField>
  <_x003C_AuthorisationStatus_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">NoAuthorisationNeeded</_x003C_AuthorisationStatus_x003E_k__BackingField>
  <_x003C_BSBN_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">String</_x003C_BSBN_x003E_k__BackingField>
  <_x003C_BankAcc_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">String</_x003C_BankAcc_x003E_k__BackingField>
  <_x003C_BankName_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">String</_x003C_BankName_x003E_k__BackingField>
  <_x003C_CardExpiry_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">0001-01-01T00:00:00</_x003C_CardExpiry_x003E_k__BackingField>
  <_x003C_CardHolder_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">String</_x003C_CardHolder_x003E_k__BackingField>
  <_x003C_CardNumber_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">String</_x003C_CardNumber_x003E_k__BackingField>
  <_x003C_HistoryNo_x003E_k__BackingField i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders" />
  <_x003C_PaymentDate_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">0001-01-01T00:00:00</_x003C_PaymentDate_x003E_k__BackingField>
  <_x003C_PaymentGatewayReturnCode_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">0</_x003C_PaymentGatewayReturnCode_x003E_k__BackingField>
  <_x003C_PaymentGatewayReturnMessage_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">String</_x003C_PaymentGatewayReturnMessage_x003E_k__BackingField>
  <_x003C_PaymentID_x003E_k__BackingField i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders" />
  <_x003C_PaymentRef_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">String</_x003C_PaymentRef_x003E_k__BackingField>
  <_x003C_PaymentType_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">
    <_x003C_Code_x003E_k__BackingField>String</_x003C_Code_x003E_k__BackingField>
    <_x003C_GeneralLedgerAccount_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.GeneralLedger">
      <d3p1:_x003C_AccountNo_x003E_k__BackingField>String</d3p1:_x003C_AccountNo_x003E_k__BackingField>
      <d3p1:_x003C_Description_x003E_k__BackingField>String</d3p1:_x003C_Description_x003E_k__BackingField>
      <d3p1:_x003C_LedgerID_x003E_k__BackingField>String</d3p1:_x003C_LedgerID_x003E_k__BackingField>
    </_x003C_GeneralLedgerAccount_x003E_k__BackingField>
    <_x003C_IsCreditCard_x003E_k__BackingField>false</_x003C_IsCreditCard_x003E_k__BackingField>
    <_x003C_IsDefault_x003E_k__BackingField>false</_x003C_IsDefault_x003E_k__BackingField>
    <_x003C_IsEnabled_x003E_k__BackingField>false</_x003C_IsEnabled_x003E_k__BackingField>
    <_x003C_IsPOS_x003E_k__BackingField>false</_x003C_IsPOS_x003E_k__BackingField>
    <_x003C_ItemNo_x003E_k__BackingField>0</_x003C_ItemNo_x003E_k__BackingField>
    <_x003C_Name_x003E_k__BackingField>String</_x003C_Name_x003E_k__BackingField>
    <_x003C_PaymentTypeID_x003E_k__BackingField>String</_x003C_PaymentTypeID_x003E_k__BackingField>
  </_x003C_PaymentType_x003E_k__BackingField>
  <_x003C_ProcessPayment_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">false</_x003C_ProcessPayment_x003E_k__BackingField>
  <_x003C_Processed_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">false</_x003C_Processed_x003E_k__BackingField>
  <_x003C_HistoryNo_x003E_k__BackingField>0</_x003C_HistoryNo_x003E_k__BackingField>
  <_x003C_InvoiceHistoryID_x003E_k__BackingField>String</_x003C_InvoiceHistoryID_x003E_k__BackingField>
  <_x003C_InvoiceID_x003E_k__BackingField>String</_x003C_InvoiceID_x003E_k__BackingField>
  <_x003C_PaymentID_x003E_k__BackingField>String</_x003C_PaymentID_x003E_k__BackingField>
</SalesOrderPaymentsPOSTRequest>

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

<SalesOrderPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders">
  <_x003C_AccountName_x003E_k__BackingField>String</_x003C_AccountName_x003E_k__BackingField>
  <_x003C_AmountPaid_x003E_k__BackingField>0</_x003C_AmountPaid_x003E_k__BackingField>
  <_x003C_AuthorisationNumber_x003E_k__BackingField>String</_x003C_AuthorisationNumber_x003E_k__BackingField>
  <_x003C_AuthorisationStatus_x003E_k__BackingField>NoAuthorisationNeeded</_x003C_AuthorisationStatus_x003E_k__BackingField>
  <_x003C_BSBN_x003E_k__BackingField>String</_x003C_BSBN_x003E_k__BackingField>
  <_x003C_BankAcc_x003E_k__BackingField>String</_x003C_BankAcc_x003E_k__BackingField>
  <_x003C_BankName_x003E_k__BackingField>String</_x003C_BankName_x003E_k__BackingField>
  <_x003C_CardExpiry_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_CardExpiry_x003E_k__BackingField>
  <_x003C_CardHolder_x003E_k__BackingField>String</_x003C_CardHolder_x003E_k__BackingField>
  <_x003C_CardNumber_x003E_k__BackingField>String</_x003C_CardNumber_x003E_k__BackingField>
  <_x003C_HistoryNo_x003E_k__BackingField>0</_x003C_HistoryNo_x003E_k__BackingField>
  <_x003C_PaymentDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_PaymentDate_x003E_k__BackingField>
  <_x003C_PaymentGatewayReturnCode_x003E_k__BackingField>0</_x003C_PaymentGatewayReturnCode_x003E_k__BackingField>
  <_x003C_PaymentGatewayReturnMessage_x003E_k__BackingField>String</_x003C_PaymentGatewayReturnMessage_x003E_k__BackingField>
  <_x003C_PaymentID_x003E_k__BackingField>String</_x003C_PaymentID_x003E_k__BackingField>
  <_x003C_PaymentRef_x003E_k__BackingField>String</_x003C_PaymentRef_x003E_k__BackingField>
  <_x003C_PaymentType_x003E_k__BackingField>
    <_x003C_Code_x003E_k__BackingField>String</_x003C_Code_x003E_k__BackingField>
    <_x003C_GeneralLedgerAccount_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.GeneralLedger">
      <d3p1:_x003C_AccountNo_x003E_k__BackingField>String</d3p1:_x003C_AccountNo_x003E_k__BackingField>
      <d3p1:_x003C_Description_x003E_k__BackingField>String</d3p1:_x003C_Description_x003E_k__BackingField>
      <d3p1:_x003C_LedgerID_x003E_k__BackingField>String</d3p1:_x003C_LedgerID_x003E_k__BackingField>
    </_x003C_GeneralLedgerAccount_x003E_k__BackingField>
    <_x003C_IsCreditCard_x003E_k__BackingField>false</_x003C_IsCreditCard_x003E_k__BackingField>
    <_x003C_IsDefault_x003E_k__BackingField>false</_x003C_IsDefault_x003E_k__BackingField>
    <_x003C_IsEnabled_x003E_k__BackingField>false</_x003C_IsEnabled_x003E_k__BackingField>
    <_x003C_IsPOS_x003E_k__BackingField>false</_x003C_IsPOS_x003E_k__BackingField>
    <_x003C_ItemNo_x003E_k__BackingField>0</_x003C_ItemNo_x003E_k__BackingField>
    <_x003C_Name_x003E_k__BackingField>String</_x003C_Name_x003E_k__BackingField>
    <_x003C_PaymentTypeID_x003E_k__BackingField>String</_x003C_PaymentTypeID_x003E_k__BackingField>
  </_x003C_PaymentType_x003E_k__BackingField>
  <_x003C_ProcessPayment_x003E_k__BackingField>false</_x003C_ProcessPayment_x003E_k__BackingField>
  <_x003C_Processed_x003E_k__BackingField>false</_x003C_Processed_x003E_k__BackingField>
</SalesOrderPayment>