PUT api/quote/{id}/payment/{guid}
Update an existing quote payment record
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Guid identifier of Quote Header record |
globally unique identifier |
Required |
guid |
Guid identifier of Quote Payment record |
globally unique identifier |
Required |
Body Parameters
Quote Payment detail to update
QuotePaymentName | Description | Type | Additional information |
---|---|---|---|
ID | integer |
None. |
|
Identifier | Collection of byte |
None. |
|
IdentifierGuid | globally unique identifier |
None. |
|
SaleHeaderID | integer |
None. |
|
PaymentType | PaymentType |
None. |
|
Amount | integer |
None. |
|
Account | string |
String length: inclusive between 0 and 40 |
|
AccountID | Collection of byte |
None. |
|
AccountIDGuid | globally unique identifier |
None. |
|
AccountType | AccountType |
None. |
|
CardName | string |
String length: inclusive between 0 and 16 |
|
AuthorisationNumber | string |
String length: inclusive between 0 and 16 |
|
BankReference | string |
String length: inclusive between 0 and 40 |
|
MerchantID | string |
String length: inclusive between 0 and 32 |
|
TerminalID | string |
String length: inclusive between 0 and 32 |
|
CardNumber |
Can be: CardNumber of Gift Card, Barcode of issued/redeemed voucher, etc |
string |
String length: inclusive between 0 and 32 |
PaymentDate | date |
None. |
|
PaymentDateString | string |
None. |
|
InvRocNo | string |
String length: inclusive between 0 and 16 |
|
ResponseCode | string |
String length: inclusive between 0 and 4 |
|
Cashout | integer |
None. |
|
IdempotentVoid | Collection of byte |
None. |
|
IdempotentVoidGuid | globally unique identifier |
None. |
|
Offline | boolean |
None. |
|
Processed | Processed |
None. |
|
STAN | string |
String length: inclusive between 0 and 10 |
|
ResponseText | string |
None. |
|
SaleHeaderGuid | Collection of byte |
Relation. This field may not always be loaded or used for updates. |
|
SaleHeaderIdentifierGuid | globally unique identifier |
Relation. This field may not always be loaded or used for updates. |
Request Formats
application/json, text/json
{ "id": 1, "identifier": "LnQocOWhQE+UkLlv/mlofQ==", "identifierGuid": "7028742e-a1e5-4f40-9490-b96ffe69687d", "saleHeaderID": 2, "paymentType": 3, "amount": 4, "account": "sample string 5", "accountID": "STKzUWr1QU2asbjeRJIAFA==", "accountIDGuid": "51b33249-f56a-4d41-9ab1-b8de44920014", "accountType": 1, "cardName": "sample string 6", "authorisationNumber": "sample string 7", "bankReference": "sample string 8", "merchantID": "sample string 9", "terminalID": "sample string 10", "cardNumber": "sample string 11", "paymentDate": "2025-06-14T07:12:49.7055039", "paymentDateString": "sample string 12", "invRocNo": "sample string 13", "responseCode": "sample string 14", "cashout": 1, "idempotentVoid": "jH9DeGB5I0OXE9yUYkOCkw==", "idempotentVoidGuid": "78437f8c-7960-4323-9713-dc9462438293", "offline": true, "processed": 1, "stan": "sample string 15", "responseText": "sample string 16", "saleHeaderGuid": "PG16gs+vQ0GsLkgDKUSh8A==", "saleHeaderIdentifierGuid": "827a6d3c-afcf-4143-ac2e-48032944a1f0" }
application/xml, text/xml
<QuotePayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://gapsolutions.com.au/schema/ezimanager"> <Account>sample string 5</Account> <AccountID>STKzUWr1QU2asbjeRJIAFA==</AccountID> <AccountIDGuid>51b33249-f56a-4d41-9ab1-b8de44920014</AccountIDGuid> <AccountType>1</AccountType> <Amount>4</Amount> <AuthorisationNumber>sample string 7</AuthorisationNumber> <BankReference>sample string 8</BankReference> <CardName>sample string 6</CardName> <CardNumber>sample string 11</CardNumber> <Cashout>1</Cashout> <ID>1</ID> <IdempotentVoid>jH9DeGB5I0OXE9yUYkOCkw==</IdempotentVoid> <IdempotentVoidGuid>78437f8c-7960-4323-9713-dc9462438293</IdempotentVoidGuid> <Identifier>LnQocOWhQE+UkLlv/mlofQ==</Identifier> <IdentifierGuid>7028742e-a1e5-4f40-9490-b96ffe69687d</IdentifierGuid> <InvRocNo>sample string 13</InvRocNo> <MerchantID>sample string 9</MerchantID> <Offline>true</Offline> <PaymentDate>2025-06-14T07:12:49.7055039+00:00</PaymentDate> <PaymentDateString>sample string 12</PaymentDateString> <PaymentType>3</PaymentType> <Processed>1</Processed> <ResponseCode>sample string 14</ResponseCode> <ResponseText>sample string 16</ResponseText> <STAN>sample string 15</STAN> <SaleHeaderGuid>PG16gs+vQ0GsLkgDKUSh8A==</SaleHeaderGuid> <SaleHeaderID>2</SaleHeaderID> <SaleHeaderIdentifierGuid>827a6d3c-afcf-4143-ac2e-48032944a1f0</SaleHeaderIdentifierGuid> <TerminalID>sample string 10</TerminalID> </QuotePayment>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Returns an updated payment record
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-excel
Sample not available.