GetFutureDateOrders
This call is to retrieve Future Date Orders. Future Date Orders are classified if the Order has a PickUpTime one day or more in advance.
Note: Once the current Business Date is equal to the PickUpTime of the Future Date Order, the Future Date Order becomes an Order, which can be viewed via the call GetOrders.
Request Parameters
- FutureDateRange
DateRange— Specify a date range you would like to retrieve the FutureDateOrders for. - PriceRollUp
string— (optional) How to display pricing for combo items. Default is RollUp if not specified.RollUp- Child Items' prices roll up into the Combo (Child Items = 0, Parent/Combo has value)DetailsOnly- Combo Items = 0, Child Items have individual pricingRollUpAndDetails- Both Combo and Child Items display their pricing
Response Parameters
-
Message
string— Returns a PAR POS Error message if the request did not go through. Otherwise, this field will be null. -
ResultCode
int— Returns one of the following:- 0 — Success
- 1 — Unknown Error
- 2 — Invalid Request
- 3 — Server Unavailable
- 4 — Access Denied
-
FutureDateOrders
Array of Order— Future date orders for this location for the date range requested.Order Properties
-
BusinessDate
DateTime— Business date of this Order (the time component will always return as 00:00:00) -
ClosedTime
DateTimeOffset?— Date and time this Order was closed in UTC, null if not yet closed -
Count
int— Returns one of the following, depending on content of the Order: 0 = Reflects an empty Order (e.g. Entries deleted or voided, Total is 0), 1 = Reflects a full Order -
CustomerId
Guid?— Id of the Customer on this Order, or null if there was no assigned Customer -
Deposits
Array of OrderDeposit— Deposits paid for this Order, typically for future date ordersOrderDeposit Properties
- Amount
decimal— Amount of this OrderDeposit - BusinessDate
DateTime— Business date this OrderDeposit was taken - EmployeeId
int?— Maps to the Id of the Employee who applied this OrderDeposit - Id
int— Unique Id of this OrderDeposit - IsApplied
bool— True if this OrderDeposit has been applied to the Order, False if not - IsDeleted
bool— True if this OrderDeposit has been deleted, False if not - IsReversal
bool— True if this OrderDeposit is a reversal that offsets a deleted deposit, False if not - OriginalOrderDepositId
int?— Id of the original OrderDeposit being reversed, if this OrderDeposit is a reversal - PaymentId
int— Id of the OrderPayment that correlates to this OrderDeposit - TenderId
int— Maps to the Id of the Tender used for this OrderDeposit
- Amount
-
DestinationId
int?— Maps to the Id of the Destination of this Order -
Discounts
Array of OrderDiscount— Discounts applied to this OrderOrderDiscount Properties
- Amount
decimal— Amount of this OrderDiscount - ApproverEmployeeId
int?— Maps to the Id of the Employee who approved this OrderDiscount - DiscountId
int— Maps to the Id of the Discount for this OrderDiscount - EmployeeId
int?— Maps to the Id of the Employee who applied this OrderDiscount - ExternalLoyaltyAccount
string— Number of the external loyalty account through which this OrderDiscount is applied - Id
int— Unique Id of this OrderDiscount within the Order - LoyaltyRewardId
int?— Maps to the Id of the LoyaltyReward if this OrderDiscount is applied via a loyalty reward - Name
string— Name of this OrderDiscount - Source
int— 0 = Other, 1 = LoyaltyCard, 2 = LoyaltyReward
- Amount
-
DisplaySubtotal
decimal— Same as Subtotal unless this Order contains inclusive tax, then those taxes would be added to this DisplaySubtotal and subtracted from DisplayTax -
DisplayTax
decimal— Same as Tax unless this Order contains inclusive tax, then those taxes won't be counted in this DisplayTax -
EmployeeId
int?— Maps to the Id of the Employee who processed this Order -
Entries
Array of OrderEntry— Entries in this Order. An OrderEntry can either be of type OrderItem or an OrderGiftCard.OrderEntry — OrderItem Properties
-
CompositeOrderItemId
int?— Maps to the Id of the OrderItem within the Order that is the CompositeOrderItem, if this OrderItem is part of a combo -
DayPartId
int?— Maps to the Id of the DayPart of this OrderItem -
Denominator
byte— Denominator by which this OrderItem was split -
Description
string— Description of this OrderItem -
DestinationId
int?— Maps to the Id of the Destination of this OrderItem -
Discounts
Array of OrderItemDiscount— Discounts applied to this OrderItemOrderItemDiscount Properties
- Amount
decimal— Amount of discount applied to the OrderItem - Id
int— Unique Id of this OrderItemDiscount within the OrderItem - OrderDiscountId
int— Maps to the Id of the Discount for this OrderItemDiscount
- Amount
-
DisplayPrice
decimal— Price displayed for this OrderItem -
GrossSales
decimal— Gross sales for this OrderItem and its children -
Id
int— Unique Id of this OrderItem within the Order -
IsCleared
bool— True if this OrderItem was cleared, False if not -
IsDeleted
bool— True if this OrderItem was deleted, False if not -
IsVoided
bool— True if this OrderItem was voided, False if not -
ItemGrossSales
decimal— Gross sales for this OrderItem only -
ItemId
int— Maps to the Id of the Item of this OrderItem -
ItemNetSales
decimal— Net sales for this OrderItem only -
Modifiers
Array of OrderItemModifier— Modifiers applied to this OrderItemOrderItemModifier Properties
-
DisplayPrice
decimal— Price displayed for this OrderItemModifier -
GrossSales
decimal— Gross sales for this OrderItemModifier and its children -
Id
int— Unique Id of this OrderItemModifier within the OrderItem -
ItemGrossSales
decimal— Gross sales for this OrderItemModifier only -
ItemId
int— Maps to the Id of the Item for this OrderItemModifier -
ItemNetSales
decimal— Net sales for this OrderItemModifier only -
ModifierCodeId
int— Maps to the Id of the ModifierCode for this OrderItemModifier -
ModifierGroupId
int— Maps to the Id of the ModifierGroup for this OrderItemModifier -
Modifiers
Array of OrderItemModifier— Nested modifiers -
NetSales
decimal— Net sales for this OrderItemModifier and its children -
Price
decimal— Price of this OrderItemModifier -
Promotions
Array of OrderEntryPromotion— Promotions applied to this OrderItemModifier -
Taxes
Array of OrderEntryTax— Taxes applied to this OrderItemModifierOrderEntryTax Properties
- Amount
decimal— Amount of tax applied to the OrderEntry - Id
int— Unique Id of this OrderEntryTax within the OrderEntry - IsInclusive
bool— True if this OrderEntryTax is an inclusive tax, False if not - TaxId
int— Maps to the Id of the Tax of this OrderEntryTax
- Amount
-
-
NetSales
decimal— Net sales for this OrderItem and its children -
NonRevenueItem
bool— True if this OrderItem is a non-revenue Item, False if not -
Note
string— Note for this OrderItem -
Promotions
Array of OrderEntryPromotion— Promotions applied to this OrderItemOrderEntryPromotion Properties
- Amount
decimal— Amount of promotion applied to the OrderEntry - Id
int— Unique Id of this OrderItemPromotion within the OrderEntry - OrderPromotionId
int— Maps to the Id of the Promotion of this OrderEntryPromotion
- Amount
-
Price
decimal— Price of this OrderItem -
RevenueCenterId
int— Maps to the Id of the RevenueCenter of this OrderItem -
SplitItemId
short— Maps to the Id of the OrderItem within the Order that this OrderItem was split from -
Taxes
Array of OrderEntryTax— Taxes applied to this OrderItemOrderEntryTax Properties
- Amount
decimal— Amount of tax applied to the OrderEntry - Id
int— Unique Id of this OrderEntryTax within the OrderEntry - IsInclusive
bool— True if this OrderEntryTax is an inclusive tax, False if not - TaxId
int— Maps to the Id of the Tax of this OrderEntryTax
- Amount
-
Void
OrderItemVoid— Details about a void, if this OrderItem was voidedOrderItemVoid Properties
- ApproverEmployeeId
int— Maps to the Id of the Employee who approved this void - EmployeeId
int— Maps to the Id of the Employee who performed this void - Time
DateTimeOffset— Date and time this void was performed in UTC - VoidReasonId
int— Maps to the Id of the VoidReason for this void
- ApproverEmployeeId
OrderEntry — OrderGiftCard Properties
-
DayPartId
int?— Maps to the Id of the DayPart of this OrderItem -
Description
string— Description of this OrderGiftCard -
Id
int— Unique Id of this OrderGiftCard within the Order -
ItemId
int— Maps to the Id of the Item of this OrderGiftCard -
Price
decimal— Price of this OrderGiftCard -
Promotions
Array of OrderEntryPromotion— Promotions applied to this OrderGiftCardOrderEntryPromotion Properties
- Amount
decimal— Amount of promotion applied to the OrderEntry - Id
int— Unique Id of this OrderItemPromotion within the OrderEntry - OrderPromotionId
int— Maps to the Id of the Promotion of this OrderEntryPromotion
- Amount
-
-
FirstSendTime
DateTimeOffset?— Date and time this Order was first sent to the kitchen in UTC, null if not sent -
GrossSales
decimal— Gross sales for this Order -
GuestCount
int— Number of guests for this Order -
GuestCountFractional
decimal— Fractional number of guests for this Order -
Id
long— Unique Id of this Order -
IdEncoded
string— Unique encoded Id of this Order -
IdNoLocation
int— Unique Id of this order with location identifier removed. This is shorter and generally passed to integrations, including credit processors. -
IsClosed
bool— True if this Order is closed, False if not -
IsFutureOrder
bool— True if this Order is a future order, False if not -
IsRefund
bool— True if this Order is a refund, False if not -
IsTaxExempt
bool— True if this Order is exempt from taxes, False if not -
ModifiedTime
DateTimeOffset— Date and time this Order was last modified in the location's local time -
Name
string— Name of this Order -
NetSales
decimal— Net sales for this Order -
Number
short— Order, receipt, or call out number that cashiers use to call the customer for this Order -
OpenedTime
DateTimeOffset— Date and time this Order was opened in UTC -
OrderAdditionalDetails
string— Additional loyalty or payment information for this Order, depending on each individual processor. Note: This is a JSON-formatted string. -
Payments
Array of OrderPayment— Payments applied to this OrderOrderPayment Properties
-
Amount
decimal— Amount of this OrderPayment -
AdditionalData
List<NameValuePair>— Any additional information -
BusinessDate
DateTime— Business date this OrderPayment was applied (time component is 00:00:00) -
CardHolderName
string— Name of the cardholder of this OrderPayment, for card payments -
CardNumber
string— Card number of this OrderPayment, populated for credit card and gift card payments (typically only the last 4 digits) -
Change
decimal— Change given on this OrderPayment -
CreditCardTransactionInformation
CreditCardTransactionInformation— Additional credit card transaction information returned by VantivCreditCardTransactionInformation Properties
- AuthorizationCode
string— Authorization code returned from Vantiv - CardToken
string— Card token returned from Vantiv - ClientTransactionIdentifier
string— Client transaction identifier returned from Vantiv - Result
string— Result returned from Vantiv
- AuthorizationCode
-
Details
Array of OrderPaymentDetail— Transactional details for this OrderPaymentOrderPaymentDetail Properties
- Amount
decimal— Amount of this OrderPaymentDetail - EmployeeId
int?— Maps to the Id of the Employee who processed this OrderPaymentDetail - Id
int— Unique Id of this OrderPaymentDetail within the Order - TillNumber
int?— Maps to the Number of the Till that this OrderPaymentDetail was originally taken on - TipAmount
decimal— Tip amount for this OrderPaymentDetail - Type
int— 1 = Initial Payment, 2 = Adjustment, 3 = Change given, 4 = Transfer from, 5 = Transfer to
- Amount
-
EmployeeId
int?— Maps to the Id of the Employee who applied this OrderPayment -
Id
int— Unique Id of this OrderPayment within the Order -
IsDeleted
bool— True if this OrderPayment was deleted, False if not -
MerchantAccountType
int?— For credit card payments: 0 = Standard Merchant Account, 1 = eCommerce Merchant Account -
TenderId
int— Maps to the Id of the Tender of this OrderPayment -
TillNumber
int?— Maps to the Number of the Till that this OrderPayment was originally taken on -
TipAmount
decimal— Tip amount for this OrderPayment
-
-
PickupTime
DateTime?— Date and time this Order is scheduled for pick up in UTC, null if not applicable -
Promotions
Array of OrderPromotion— Promotions applied to this OrderOrderPromotion Properties
- Amount
decimal— Amount of promotion applied to the Order - ApproverEmployeeId
int?— Maps to the Id of the Employee who approved this OrderPromotion - EmployeeId
int?— Maps to the Id of the Employee who applied this OrderPromotion - Id
int— Unique Id of this OrderPromotion within the Order - Name
string— Name of this OrderPromotion - PromotionId
int— Maps to the Id of the Promotion of this OrderPromotion
- Amount
-
Rounding
decimal— Amount by which the Order was rounded to, reflecting the rounding settings -
RefundReasonId
int— Maps to the Id of the RefundReason used for this refund Order -
SectionId
int?— Maps to the Id of the Section of this Order -
Subtotal
decimal— Subtotal of this Order -
Surcharges
Array of OrderSurcharge— Surcharges applied to this OrderOrderSurcharge Properties
- Amount
decimal— Amount of surcharge applied to the Order - ApproverEmployeeId
int?— Maps to the Id of the Employee who approved this OrderSurcharge - EmployeeId
int?— Maps to the Id of the Employee who applied this OrderSurcharge - Id
int— Unique Id of this OrderSurcharge within the Order - IsSystemApplied
bool— True if this OrderSurcharge is automatically applied by the system, False if not - Name
string— Name of this OrderSurcharge - SurchargeId
int— Maps to the Id of the Surcharge of this OrderSurcharge - Taxes
Array of OrderEntryTax— Taxes on this OrderSurcharge
- Amount
-
Tax
decimal— Total tax for this Order -
Taxes
Array of OrderTax— Order taxes applied to this OrderOrderTax Properties
- Amount
decimal— Amount of tax applied to the Order - Id
int— Unique Id of this OrderTax within the Order - TaxId
int— Maps to the Id of the Tax of this OrderTax
- Amount
-
TaxExemptId
string— Tax identifier for the tax-exempt entity -
TerminalId
int— Id of the terminal this Order was placed on -
TillNumber
int?— Id of the till that owns this Order, null if not owned -
Total
decimal— Total for this Order
-
- Type: stringS
O A P Action required
SOAP envelope containing the GetFutureDateOrders request with FutureDateRange and optional PriceRollUp.
- text/xml; charset=utf-8
curl --request POST \
--url 'https://{server_name_goes_here}.parpos.com/Sales2.svc?GetFutureDateOrders' \
--header 'Content-Type: text/xml; charset=utf-8' \
--header 'AccessToken: your-access-token' \
--header 'LocationToken: your-location-token' \
--header 'SOAPAction: "http://www.brinksoftware.com/webservices/sales/v2/ISalesWebService2/GetFutureDateOrders"' \
--data '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v2="http://www.brinksoftware.com/webservices/sales/v2"
xmlns:brin="http://schemas.datacontract.org/2004/07/Brink.Foundation">
<soapenv:Header/>
<soapenv:Body>
<v2:GetFutureDateOrders>
<v2:request>
<v2:FutureDateRange>
<brin:_end>2026-05-26</brin:_end>
<brin:_start>2026-05-01</brin:_start>
</v2:FutureDateRange>
<v2:PriceRollUp>false</v2:PriceRollUp>
</v2:request>
</v2:GetFutureDateOrders>
</soapenv:Body>
</soapenv:Envelope>'
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<GetFutureDateOrdersResponse xmlns="http://www.brinksoftware.com/webservices/sales/v2">
<GetFutureDateOrdersResult>
<Message>Success</Message>
<ResultCode>0</ResultCode>
<FutureDateOrders>
<Order>
<BusinessDate>2024-01-20T00:00:00</BusinessDate>
<ClosedTime i:nil="true"/>
<Count>1</Count>
<CustomerId>a1b2c3d4-e5f6-7890-abcd-ef1234567890</CustomerId>
<Deposits>
<OrderDeposit>
<Amount>25.00</Amount>
<BusinessDate>2024-01-15T00:00:00</BusinessDate>
<EmployeeId>42</EmployeeId>
<Id>1</Id>
<IsApplied>false</IsApplied>
<IsDeleted>false</IsDeleted>
<IsReversal>false</IsReversal>
<OriginalOrderDepositId i:nil="true"/>
<PaymentId>1</PaymentId>
<TenderId>2</TenderId>
</OrderDeposit>
</Deposits>
<DestinationId>1</DestinationId>
<Discounts/>
<DisplaySubtotal>100.00</DisplaySubtotal>
<DisplayTax>8.00</DisplayTax>
<EmployeeId>42</EmployeeId>
<Entries>
<OrderEntry i:type="OrderItem">
<CompositeOrderItemId i:nil="true"/>
<DayPartId>1</DayPartId>
<Denominator>1</Denominator>
<Description>Party Platter</Description>
<DestinationId>1</DestinationId>
<Discounts/>
<DisplayPrice>100.00</DisplayPrice>
<GrossSales>100.00</GrossSales>
<Id>1</Id>
<IsCleared>false</IsCleared>
<IsDeleted>false</IsDeleted>
<IsVoided>false</IsVoided>
<ItemGrossSales>100.00</ItemGrossSales>
<ItemId>501</ItemId>
<ItemNetSales>100.00</ItemNetSales>
<Modifiers/>
<NetSales>100.00</NetSales>
<Note>Large event</Note>
<Price>100.00</Price>
<Promotions/>
<SplitItemId>0</SplitItemId>
<Taxes>
<OrderEntryTax>
<Amount>8.00</Amount>
<Id>1</Id>
<IsInclusive>false</IsInclusive>
<TaxId>1</TaxId>
</OrderEntryTax>
</Taxes>
<Void i:nil="true"/>
</OrderEntry>
</Entries>
<FirstSendTime i:nil="true"/>
<GrossSales>100.00</GrossSales>
<GuestCount>10</GuestCount>
<GuestCountFractional>10.0</GuestCountFractional>
<Id>99001</Id>
<IdEncoded>OTkwMDE=</IdEncoded>
<IdNoLocation>99001</IdNoLocation>
<IsClosed>false</IsClosed>
<IsFutureOrder>true</IsFutureOrder>
<IsRefund>false</IsRefund>
<IsTaxExempt>false</IsTaxExempt>
<ModifiedTime>2024-01-15T10:30:00-06:00</ModifiedTime>
<Name>Catering Order</Name>
<NetSales>100.00</NetSales>
<Number>5001</Number>
<OpenedTime>2024-01-15T10:00:00Z</OpenedTime>
<OrderAdditionalDetails i:nil="true"/>
<Payments>
<OrderPayment>
<AdditionalData/>
<Amount>25.00</Amount>
<BusinessDate>2024-01-15T00:00:00</BusinessDate>
<CardHolderName>Jane Doe</CardHolderName>
<CardNumber>************5678</CardNumber>
<Change>0.00</Change>
<CreditCardTransactionInformation>
<AuthorizationCode>DEF456</AuthorizationCode>
<CardToken>token456</CardToken>
<ClientTransactionIdentifier>txn002</ClientTransactionIdentifier>
<Result>Approved</Result>
</CreditCardTransactionInformation>
<Details>
<OrderPaymentDetail>
<Amount>25.00</Amount>
<EmployeeId>42</EmployeeId>
<Id>1</Id>
<TillNumber>1</TillNumber>
<TipAmount>0.00</TipAmount>
<Type>1</Type>
</OrderPaymentDetail>
</Details>
<EmployeeId>42</EmployeeId>
<Id>1</Id>
<IsDeleted>false</IsDeleted>
<MerchantAccountType>0</MerchantAccountType>
<TenderId>2</TenderId>
<TillNumber>1</TillNumber>
<TipAmount>0.00</TipAmount>
</OrderPayment>
</Payments>
<PickupTime>2024-01-20T12:00:00Z</PickupTime>
<Promotions/>
<RefundReasonId>0</RefundReasonId>
<Rounding>0.00</Rounding>
<SectionId>1</SectionId>
<Subtotal>100.00</Subtotal>
<Surcharges/>
<Tax>8.00</Tax>
<TaxExemptId i:nil="true"/>
<Taxes>
<OrderTax>
<Amount>8.00</Amount>
<Id>1</Id>
<TaxId>1</TaxId>
</OrderTax>
</Taxes>
<TerminalId>1</TerminalId>
<TillNumber>1</TillNumber>
<Total>108.00</Total>
</Order>
</FutureDateOrders>
</GetFutureDateOrdersResult>
</GetFutureDateOrdersResponse>
</s:Body>
</s:Envelope>