POST api/quotes

Create new quote header record

Request Information

URI Parameters

None.

Body Parameters

Quote header to add

Name	Description	Type	Additional information
SaleHeaderID		integer	None.
SaleIdentifier		string	String length: inclusive between 0 and 20
SaleHeaderGuid		Collection of byte	None.
SaleHeaderIdentifierGuid		globally unique identifier	None.
DeptNo		integer	None.
ZoneID		integer	None.
OperatorID		integer	None.
OperatorG_UID		Collection of byte	None.
OperatorGuid		globally unique identifier	None.
Created		date	None.
ItemCount		integer	None.
TotalAmount		integer	None.
CashTender		integer	Data type: Currency
CardTender		integer	Data type: Currency
CheqTender		integer	Data type: Currency
AcctTender		integer	Data type: Currency
VoucherTender		integer	Data type: Currency
VoucherForegone		integer	None.
Cashout		integer	Data type: Currency
ChangeAmount		integer	Data type: Currency
Rounding		integer	None.
GstAmount		integer	None.
CardName		string	String length: inclusive between 0 and 16
AccountType		integer	None.
AuthID		string	String length: inclusive between 0 and 16
BankRef		string	String length: inclusive between 0 and 16
InvRoc		string	String length: inclusive between 0 and 16
ResponseCode		string	String length: inclusive between 0 and 4
OrderNo		integer	None.
AccountNo		integer	None.
TranType		TransactionType	None.
Processed		Processed	None.
MachineID		integer	None.
StoreID		integer	None.
CustomerG_UID		Collection of byte	None.
CustomerGuid		globally unique identifier	None.
CommunityIdentifier		Collection of byte	None.
CommunityIdentifierGuid		globally unique identifier	None.
TimeInSale		time interval	None.
TimeInSubtotal		time interval	None.
NewID		integer	None.
TotalTaxInclusive		integer	None.
TotalTaxExempt		integer	None.
LoyaltyPoints		integer	None.
TaxTransactionDiscount		integer	None.
TransactionDiscountTender		integer	None.
TaxTransactionDiscountTender		integer	None.
TableNumber		integer	None.
Note		string	String length: inclusive between 0 and 140
ReceiptPrinted		boolean	None.
MasterRoamingID		integer	None.
IsLocal		boolean	None.
DrawerID		integer	None.
DemoID		string	None.
RetrievedBy		Collection of byte	None.
RetrievedByGuid		globally unique identifier	None.
RetrievedAt		date	None.
AgeVerified		boolean	None.
FiscalReference		string	String length: inclusive between 0 and 60
CustomerReference		string	String length: inclusive between 0 and 140
Locked		boolean	None.
Reversed		boolean	None.
SmartReceiptStatus		boolean	None.
RequiredExports		integer	None.
PickupDate		date	None.
LastQuoteSent		date	None.
AccountID		Collection of byte	None.
AccountIDGuid		globally unique identifier	None.
StoreName		string	Relation. This field may not always be loaded or used for updates.
CustomerName		string	Relation. This field may not always be loaded or used for updates.
CustomerEmail		string	Relation. This field may not always be loaded or used for updates.
SaleNumber	Finalised Sale Header ID	integer	Relation. This field may not always be loaded or used for updates.
Details		Collection of QuoteDetail	Relation. This field may not always be loaded or used for updates.
Payments		Collection of QuotePayment	Relation. This field may not always be loaded or used for updates.

Request Formats

application/json, text/json

Sample:

{
  "saleHeaderID": 1,
  "saleIdentifier": "sample string 2",
  "saleHeaderGuid": "N6cZy7t9FUGJKjvLhUsbfw==",
  "saleHeaderIdentifierGuid": "cb19a737-7dbb-4115-892a-3bcb854b1b7f",
  "deptNo": 1,
  "zoneID": 1,
  "operatorID": 3,
  "operatorG_UID": "quzKYHXhU0uFTRW/e5U+lw==",
  "operatorGuid": "60caecaa-e175-4b53-854d-15bf7b953e97",
  "created": "2026-06-03T18:36:30.7323104",
  "itemCount": 5,
  "totalAmount": 6,
  "cashTender": 1,
  "cardTender": 1,
  "cheqTender": 1,
  "acctTender": 1,
  "voucherTender": 1,
  "voucherForegone": 1,
  "cashout": 1,
  "changeAmount": 1,
  "rounding": 1,
  "gstAmount": 1,
  "cardName": "sample string 7",
  "accountType": 1,
  "authID": "sample string 8",
  "bankRef": "sample string 9",
  "invRoc": "sample string 10",
  "responseCode": "sample string 11",
  "orderNo": 1,
  "accountNo": 1,
  "tranType": 1,
  "processed": 1,
  "machineID": 1,
  "storeID": 12,
  "customerG_UID": "Db8a+VuiCUqbnqVvWoX80w==",
  "customerGuid": "f91abf0d-a25b-4a09-9b9e-a56f5a85fcd3",
  "communityIdentifier": "NwoVettc+0ix0Nua7aVtiQ==",
  "communityIdentifierGuid": "7a150a37-5cdb-48fb-b1d0-db9aeda56d89",
  "timeInSale": "00:00:00.1234567",
  "timeInSubtotal": "00:00:00.1234567",
  "newID": 1,
  "totalTaxInclusive": 1,
  "totalTaxExempt": 1,
  "loyaltyPoints": 1,
  "taxTransactionDiscount": 1,
  "transactionDiscountTender": 1,
  "taxTransactionDiscountTender": 1,
  "tableNumber": 1,
  "note": "sample string 13",
  "receiptPrinted": true,
  "masterRoamingID": 1,
  "isLocal": true,
  "drawerID": 1,
  "demoID": "sample string 14",
  "retrievedBy": "wh9MKVEreUeEPP8EHMeZcQ==",
  "retrievedByGuid": "294c1fc2-2b51-4779-843c-ff041cc79971",
  "retrievedAt": "2026-06-03T18:36:30.7323104",
  "ageVerified": true,
  "fiscalReference": "sample string 15",
  "customerReference": "sample string 16",
  "locked": true,
  "reversed": true,
  "smartReceiptStatus": true,
  "requiredExports": 1,
  "pickupDate": "2026-06-03T18:36:30.7323104",
  "lastQuoteSent": "2026-06-03T18:36:30.7323104",
  "accountID": "O95qNtnBKkGlbZ1yBsm9WQ==",
  "accountIDGuid": "366ade3b-c1d9-412a-a56d-9d7206c9bd59",
  "storeName": "sample string 17",
  "customerName": "sample string 18",
  "customerEmail": "sample string 19",
  "saleNumber": 1,
  "details": [
    {
      "$id": "2",
      "saleItemID": 1,
      "saleHeaderID": 2,
      "identifier": "yFSx4clBT0id2cnVsPe1xQ==",
      "identifierGuid": "e1b154c8-41c9-484f-9dd9-c9d5b0f7b5c5",
      "plu": 1,
      "pluG_UID": "2qIJWrwmCUWA2WysS+dXOA==",
      "pluGuid": "5a09a2da-26bc-4509-80d9-6cac4be75738",
      "accountId": "NqVFdsPM902iLqCrGD08Ig==",
      "accountIdGuid": "7645a536-ccc3-4df7-a22e-a0ab183d3c22",
      "normalPrice": 3,
      "originalSellingPrice": 4,
      "discountPrice": 5,
      "unit": 1,
      "quantity": 6,
      "totalCents": 7,
      "fixedPrice": 1,
      "tranType": 1,
      "processed": true,
      "discountType": 1,
      "operatorDiscount": true,
      "cost": 1,
      "costDecimals": 8,
      "active": true,
      "markdown": true,
      "manualQuantity": true,
      "manualPrice": true,
      "manualMode": true,
      "offline": true,
      "refunded": true,
      "barcode": "sample string 9",
      "keyedSale": true,
      "discountedID": 1,
      "fuelID": 1,
      "serialNumber": "sample string 10",
      "bestOrExpire": "2026-06-03T18:36:30.7323104",
      "bestOrExpireType": true,
      "refundG_UID": "fnqcEwoCxky2cLjn14atFw==",
      "refundGuid": "139c7a7e-020a-4cc6-b670-b8e7d786ad17",
      "providerName": "sample string 11",
      "campaign": "sample string 12",
      "campaignType": 1,
      "modifiedID": 1,
      "omittedIngredient": true,
      "taxPercent": 1.1,
      "taxAmount": 1.1,
      "refundablePrice": 1.1,
      "showDiscounts": true,
      "orderPrinted": true,
      "note": "sample string 13",
      "operatorG_UID": "3MP7q6YLSEGnh2V6bAjhag==",
      "operatorGuid": "abfbc3dc-0ba6-4148-a787-657a6c08e16a",
      "modifierName": "sample string 14",
      "modifierSetName": "sample string 15",
      "totalValueWasScanned": true,
      "sold": true,
      "campaignPrice": true,
      "scannedValue": 1,
      "campaignName": "sample string 16",
      "comboDiscount": 1,
      "weightEmbedded": true,
      "departmentID": 1,
      "departmentCode": "sample string 17",
      "idempotentVoid": "VY2SSZlEdk+jPMHzYHf4Ow==",
      "idempotentVoidGuid": "49928d55-4499-4f76-a33c-c1f36077f83b",
      "saleHeaderGuid": "9c6UHFD2GUCqg2qMxY0c0A==",
      "saleHeaderIdentifierGuid": "1c94cef5-f650-4019-aa83-6a8cc58d1cd0",
      "discounts": [
        {
          "$ref": "2"
        },
        {
          "$ref": "2"
        }
      ],
      "modifiers": [
        {
          "$ref": "2"
        },
        {
          "$ref": "2"
        }
      ]
    },
    {
      "$ref": "2"
    }
  ],
  "payments": [
    {
      "$id": "3",
      "id": 1,
      "identifier": "o13CFgfolEWzPoj3We1BUQ==",
      "identifierGuid": "16c25da3-e807-4594-b33e-88f759ed4151",
      "saleHeaderID": 2,
      "paymentType": 3,
      "amount": 4,
      "account": "sample string 5",
      "accountID": "iSTVqHZdNUS7MwBpQvSlAQ==",
      "accountIDGuid": "a8d52489-5d76-4435-bb33-006942f4a501",
      "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": "2026-06-03T18:36:30.7323104",
      "paymentDateString": "sample string 12",
      "invRocNo": "sample string 13",
      "responseCode": "sample string 14",
      "cashout": 1,
      "idempotentVoid": "2JJmXorA8Eed9o65alQwbQ==",
      "idempotentVoidGuid": "5e6692d8-c08a-47f0-9df6-8eb96a54306d",
      "offline": true,
      "processed": 1,
      "stan": "sample string 15",
      "responseText": "sample string 16",
      "saleHeaderGuid": "Tz+lPmU/0US8rxmUWeyaAg==",
      "saleHeaderIdentifierGuid": "3ea53f4f-3f65-44d1-bcaf-199459ec9a02"
    },
    {
      "$ref": "3"
    }
  ]
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns a newly added header record(without details)

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.