POST api/quotes

Create new quote header record

Request Information

URI Parameters

None.

Body Parameters

Quote header to add

Name	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.
Details	Collection of QuoteDetail	Relation. This field may not always be loaded or used for updates.
StoreName	string	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.
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.

Request Formats

application/json, text/json

Sample:

{
  "saleHeaderID": 1,
  "saleIdentifier": "sample string 2",
  "saleHeaderGuid": "gpL1GWW6J0SdwCb7AfnuBQ==",
  "saleHeaderIdentifierGuid": "19f59282-ba65-4427-9dc0-26fb01f9ee05",
  "deptNo": 1,
  "zoneID": 1,
  "operatorID": 3,
  "operatorG_UID": "LBU8FKm7aUmK+xo6uziVzQ==",
  "operatorGuid": "143c152c-bba9-4969-8afb-1a3abb3895cd",
  "created": "2025-08-02T23:19:31.9940666",
  "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": "zPYAvTBsskasz0iwjUcFuw==",
  "customerGuid": "bd00f6cc-6c30-46b2-accf-48b08d4705bb",
  "communityIdentifier": "Y9DklUyoU028U4SZoT2JXQ==",
  "communityIdentifierGuid": "95e4d063-a84c-4d53-bc53-8499a13d895d",
  "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": "oUyKilLrEkqvuGFYProwgA==",
  "retrievedByGuid": "8a8a4ca1-eb52-4a12-afb8-61583eba3080",
  "retrievedAt": "2025-08-02T23:19:31.9940666",
  "ageVerified": true,
  "fiscalReference": "sample string 15",
  "customerReference": "sample string 16",
  "locked": true,
  "reversed": true,
  "smartReceiptStatus": true,
  "requiredExports": 1,
  "pickupDate": "2025-08-02T23:19:31.9940666",
  "lastQuoteSent": "2025-08-02T23:19:31.9940666",
  "accountID": "M1GNvry1OEug+2Cepkm9AA==",
  "accountIDGuid": "be8d5133-b5bc-4b38-a0fb-609ea649bd00",
  "details": [
    {
      "$id": "2",
      "saleItemID": 1,
      "saleHeaderID": 2,
      "identifier": "xnxJ8WJ1REidJe3Cw0wy7Q==",
      "identifierGuid": "f1497cc6-7562-4844-9d25-edc2c34c32ed",
      "plu": 1,
      "pluG_UID": "acQ2702Hv0WQYqVM5m2wNQ==",
      "pluGuid": "ef36c469-874d-45bf-9062-a54ce66db035",
      "accountId": "znRL6EYWKEKqVFpoKEFxgw==",
      "accountIdGuid": "e84b74ce-1646-4228-aa54-5a6828417183",
      "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": "2025-08-02T23:19:31.9940666",
      "bestOrExpireType": true,
      "refundG_UID": "t9g0+EFFZkiZG0109Ak02Q==",
      "refundGuid": "f834d8b7-4541-4866-991b-4d74f40934d9",
      "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": "+de7cLp4d0aH1fsZbSXYUg==",
      "operatorGuid": "70bbd7f9-78ba-4677-87d5-fb196d25d852",
      "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": "6J0iK3m1/EK+LVpPC/P2KQ==",
      "idempotentVoidGuid": "2b229de8-b579-42fc-be2d-5a4f0bf3f629",
      "saleHeaderGuid": "CV37MgJcS0eMz8NDJd8DlQ==",
      "saleHeaderIdentifierGuid": "32fb5d09-5c02-474b-8ccf-c34325df0395",
      "discounts": [
        {
          "$ref": "2"
        },
        {
          "$ref": "2"
        }
      ],
      "modifiers": [
        {
          "$ref": "2"
        },
        {
          "$ref": "2"
        }
      ]
    },
    {
      "$ref": "2"
    }
  ],
  "storeName": "sample string 17",
  "payments": [
    {
      "$id": "3",
      "id": 1,
      "identifier": "VmacBcjDk0OX6sNOJGZJUQ==",
      "identifierGuid": "059c6656-c3c8-4393-97ea-c34e24664951",
      "saleHeaderID": 2,
      "paymentType": 3,
      "amount": 4,
      "account": "sample string 5",
      "accountID": "AfzkrgKzME+9939EJUNisg==",
      "accountIDGuid": "aee4fc01-b302-4f30-bdf7-7f44254362b2",
      "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-08-02T23:19:31.9940666",
      "paymentDateString": "sample string 12",
      "invRocNo": "sample string 13",
      "responseCode": "sample string 14",
      "cashout": 1,
      "idempotentVoid": "WzGRQ8nCREqc8cJ1NDkn0A==",
      "idempotentVoidGuid": "4391315b-c2c9-4a44-9cf1-c275343927d0",
      "offline": true,
      "processed": 1,
      "stan": "sample string 15",
      "responseText": "sample string 16",
      "saleHeaderGuid": "5dkxSXKCxkuzRhhODKOiQA==",
      "saleHeaderIdentifierGuid": "4931d9e5-8272-4bc6-b346-184e0ca3a240"
    },
    {
      "$ref": "3"
    }
  ],
  "customerName": "sample string 18",
  "customerEmail": "sample string 19"
}

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.