GET | /SalesOrders/{InvoiceID}/Payments | Retrieves a list of payments for a sales order |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
InvoiceID | path | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /SalesOrders/{InvoiceID}/Payments HTTP/1.1 Host: api.jiwa.com.au Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ArrayOfSalesOrderPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.SalesOrders"> <SalesOrderPayment> <_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:d4p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.GeneralLedger"> <d4p1:_x003C_AccountNo_x003E_k__BackingField>String</d4p1:_x003C_AccountNo_x003E_k__BackingField> <d4p1:_x003C_Description_x003E_k__BackingField>String</d4p1:_x003C_Description_x003E_k__BackingField> <d4p1:_x003C_LedgerID_x003E_k__BackingField>String</d4p1:_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> </ArrayOfSalesOrderPayment>