POST api/quote/{id}/payments

Add quote payment

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Guid identifier of Quote Header record	globally unique identifier	Required

Body Parameters

Quote Payment detail to add

QuotePayment

Name	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

Sample:

{
  "id": 1,
  "identifier": "1AHd9IAvK0K5y1CJJMwyng==",
  "identifierGuid": "f4dd01d4-2f80-422b-b9cb-508924cc329e",
  "saleHeaderID": 2,
  "paymentType": 3,
  "amount": 4,
  "account": "sample string 5",
  "accountID": "b1fSahFlLEawoQL9km0ceg==",
  "accountIDGuid": "6ad2576f-6511-462c-b0a1-02fd926d1c7a",
  "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:18:43.8283404",
  "paymentDateString": "sample string 12",
  "invRocNo": "sample string 13",
  "responseCode": "sample string 14",
  "cashout": 1,
  "idempotentVoid": "TCwbi4ZDwUeSMI5a3qTOEg==",
  "idempotentVoidGuid": "8b1b2c4c-4386-47c1-9230-8e5adea4ce12",
  "offline": true,
  "processed": 1,
  "stan": "sample string 15",
  "responseText": "sample string 16",
  "saleHeaderGuid": "6GwzSno2W0yjzn+VHq1Vrg==",
  "saleHeaderIdentifierGuid": "4a336ce8-367a-4c5b-a3ce-7f951ead55ae"
}

application/xml, text/xml

Sample:

<QuotePayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://gapsolutions.com.au/schema/ezimanager">
  <Account>sample string 5</Account>
  <AccountID>b1fSahFlLEawoQL9km0ceg==</AccountID>
  <AccountIDGuid>6ad2576f-6511-462c-b0a1-02fd926d1c7a</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>TCwbi4ZDwUeSMI5a3qTOEg==</IdempotentVoid>
  <IdempotentVoidGuid>8b1b2c4c-4386-47c1-9230-8e5adea4ce12</IdempotentVoidGuid>
  <Identifier>1AHd9IAvK0K5y1CJJMwyng==</Identifier>
  <IdentifierGuid>f4dd01d4-2f80-422b-b9cb-508924cc329e</IdentifierGuid>
  <InvRocNo>sample string 13</InvRocNo>
  <MerchantID>sample string 9</MerchantID>
  <Offline>true</Offline>
  <PaymentDate>2025-06-14T07:18:43.8283404+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>6GwzSno2W0yjzn+VHq1Vrg==</SaleHeaderGuid>
  <SaleHeaderID>2</SaleHeaderID>
  <SaleHeaderIdentifierGuid>4a336ce8-367a-4c5b-a3ce-7f951ead55ae</SaleHeaderIdentifierGuid>
  <TerminalID>sample string 10</TerminalID>
</QuotePayment>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns a newly added payment record

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-excel

Sample:

Sample not available.