| GET | /SalesOrders/{InvoiceID}/Payments/{PaymentID} | Retrieves a payment for a sales order |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InvoiceID | path | string | No | |
| PaymentID | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LedgerID | form | string | No | |
| AccountNo | form | string | No | |
| Description | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /SalesOrders/{InvoiceID}/Payments/{PaymentID} HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
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"}