JiwaAPI

<back to all web services

SalesOrderPaymentsPOSTRequest

Requires Authentication
The following routes are available for this service:
POST/SalesOrders/{InvoiceID}/Historys/{InvoiceHistoryID}/PaymentsAdds a payment to a sales order
SalesOrderPaymentsPOSTRequest Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDpathstringNo
InvoiceHistoryIDpathstringNo
SalesOrderPayment Parameters:
NameParameterData TypeRequiredDescription
HistoryNoformint?No
PaymentTypeformPaymentTypeNo
AmountPaidformdecimal?No
PaymentDateformDateTime?No
ProcessPaymentformbool?No
AuthorisationStatusformPaymentAuthStatuses?No
PaymentGatewayReturnCodeformint?No
Processedformbool?No
CardExpiryformDateTime?No
PaymentIDformstringNo
PaymentRefformstringNo
AuthorisationNumberformstringNo
PaymentGatewayReturnMessageformstringNo
CardNumberformstringNo
CardHolderformstringNo
BankNameformstringNo
BSBNformstringNo
BankAccformstringNo
AccountNameformstringNo
PaymentType Parameters:
NameParameterData TypeRequiredDescription
PaymentTypeIDformstringNo
NameformstringNo
CodeformstringNo
ItemNoformint?No
IsEnabledformbool?No
IsDefaultformbool?No
IsCreditCardformbool?No
IsPOSformbool?No
GeneralLedgerAccountformAccountNo
Account Parameters:
NameParameterData TypeRequiredDescription
LedgerIDformstringNo
AccountNoformstringNo
DescriptionformstringNo
SalesOrderPayment Parameters:
NameParameterData TypeRequiredDescription
HistoryNoformint?No
PaymentTypeformPaymentTypeNo
AmountPaidformdecimal?No
PaymentDateformDateTime?No
ProcessPaymentformbool?No
AuthorisationStatusformPaymentAuthStatuses?No
PaymentGatewayReturnCodeformint?No
Processedformbool?No
CardExpiryformDateTime?No
PaymentIDformstringNo
PaymentRefformstringNo
AuthorisationNumberformstringNo
PaymentGatewayReturnMessageformstringNo
CardNumberformstringNo
CardHolderformstringNo
BankNameformstringNo
BSBNformstringNo
BankAccformstringNo
AccountNameformstringNo

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.

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

{"InvoiceID":"String","InvoiceHistoryID":"String","PaymentType":{"PaymentTypeID":"String","Name":"String","Code":"String","ItemNo":0,"IsEnabled":false,"IsDefault":false,"IsCreditCard":false,"IsPOS":false,"GeneralLedgerAccount":{"LedgerID":"String","AccountNo":"String","Description":"String"}},"AmountPaid":0,"PaymentDate":"0001-01-01T00:00:00.0000000","ProcessPayment":false,"AuthorisationStatus":"NoAuthorisationNeeded","PaymentGatewayReturnCode":0,"Processed":false,"CardExpiry":"0001-01-01T00:00:00.0000000","PaymentRef":"String","AuthorisationNumber":"String","PaymentGatewayReturnMessage":"String","CardNumber":"String","CardHolder":"String","BankName":"String","BSBN":"String","BankAcc":"String","AccountName":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"HistoryNo":0,"PaymentType":{"PaymentTypeID":"String","Name":"String","Code":"String","ItemNo":0,"IsEnabled":false,"IsDefault":false,"IsCreditCard":false,"IsPOS":false,"GeneralLedgerAccount":{"LedgerID":"String","AccountNo":"String","Description":"String"}},"AmountPaid":0,"PaymentDate":"0001-01-01T00:00:00.0000000","ProcessPayment":false,"AuthorisationStatus":"NoAuthorisationNeeded","PaymentGatewayReturnCode":0,"Processed":false,"CardExpiry":"0001-01-01T00:00:00.0000000","PaymentID":"String","PaymentRef":"String","AuthorisationNumber":"String","PaymentGatewayReturnMessage":"String","CardNumber":"String","CardHolder":"String","BankName":"String","BSBN":"String","BankAcc":"String","AccountName":"String"}