Documentation Index

Fetch the complete documentation index at: https://docs.restaurant365.com/llms.txt

Use this file to discover all available pages before exploring further.

/public/v1/pos/sales/import

Prev Next
Post
/public/v1/pos/sales/import

Submits sales data for a location and business date for end-of-day or intraday processing

Security
HTTP
Type Bearer

Put ONLY your JWT Bearer token on textbox below!

Body parameters
Expand All
object

Submits sales data for a location and business date for end-of-day or intraday processing

locationId
string (uuid)

Unique identifier (GUID) of the R365 location the import applies to.

businessDate
string (date)

Business date the submitted data represents.

importMode
string | null

Processing mode for the import. Values are "EOD", "Intraday".

sales
Array of object (R365.Pos.Public.Contracts.Sales.Models.SaleRecord) | null

Collection of sales transactions to import.

object

A single sales transaction submitted for import.

salesId
string | null

Provider-assigned identifier of the sales transaction.

transactionDate
string (date-time)

Date and time the transaction occurred.

checkNumber
string | null

Check or ticket number associated with the transaction.

guestCount
integer (int32)

Number of guests on the transaction.

salesAmount
number (double)

Net sales amount before tax and tip.

taxAmount
number (double)

Total tax amount applied to the transaction.

tipAmount
number (double)

Tip amount on the transaction.

totalAmount
number (double)

Total transaction amount including sales, tax, and tip.

autoGratuity
number (double)

Automatic gratuity amount applied to the transaction.

isVoid
boolean

Indicates whether the transaction has been voided.

server
string | null

Identifier or name of the server associated with the transaction.

serviceType
string | null

Service type of the transaction, such as dine-in or takeout.

revenueCenter
string | null

Revenue center the transaction was recorded under.

comment
string | null

Optional comment associated with the transaction.

openDate
string (date-time) | null

Date and time the check was opened, if available.

pickupTime
string (date-time) | null

Scheduled pickup time for the order, if applicable.

payments
Array of object (R365.Pos.Public.Contracts.Sales.Models.SalePaymentRecord) | null

Collection of payment records associated with this transaction.

object

A single payment record associated with a sales transaction.

paymentType
string | null

Type of payment tender used.

server
string | null

Identifier or name of the server who processed the payment.

comment
string | null

Optional comment associated with the payment.

company
string | null

Company or brand associated with the payment, if applicable.

customerText
string | null

Customer-facing display text for the payment.

tillId
string | null

Identifier of the till the payment was processed on.

amount
number (double)

Monetary amount of the payment.

salesDetails
Array of object (R365.Pos.Public.Contracts.Sales.Models.SaleDetailRecord) | null

Collection of line-item details for this transaction.

object

A single line-item detail within a sales transaction.

menuItemName
string | null

Name of the menu item.

categoryName
string | null

Category the menu item belongs to.

company
string | null

Company or brand associated with the item, if applicable.

customerText
string | null

Customer-facing display text for the item.

pluCode
string | null

Price look-up code for the item.

sku
string | null

Stock-keeping unit identifier for the item.

menuItemId
string | null

Provider-assigned identifier of the menu item.

barcode
string | null

Barcode value associated with the item, if applicable.

modifierGroupId
string | null

Identifier of the modifier group this item belongs to, if applicable.

modifierGroupName
string | null

Name of the modifier group this item belongs to, if applicable.

uniqueMenuItemId
string | null

Unique identifier for the menu item within this transaction.

amount
number (double)

Net amount for this line item after discounts.

quantity
number (double)

Quantity of the item sold.

taxAmount
number (double)

Tax amount applied to this line item.

grossAmount
number (double)

Gross amount for this line item before discounts.

discountAmount
number (double)

Total discount amount applied to this line item.

isVoid
boolean

Indicates whether this line item has been voided.

isModifier
boolean

Indicates whether this item is a modifier of another line item.

parentItemId
integer (int32)

Identifier of the parent line item, when this item is a modifier.

itemId
integer (int32)

Sequential identifier of this line item within the transaction.

appliedSalesTaxes
Array of object (R365.Pos.Public.Contracts.Sales.Models.AppliedTaxRecord) | null

Collection of applied tax entries for this transaction.

object

A single applied tax entry associated with a sales transaction.

taxRateId
string | null

Provider-assigned identifier of the tax rate.

taxName
string | null

Name of the tax rate.

taxRate
number (double)

Tax rate as a decimal value.

totalAmount
number (double)

Total tax amount applied.

taxableAmount
number (double)

Portion of the transaction amount subject to this tax.

isInclusive
boolean

Indicates whether the tax is included in the item price rather than added on top.

taxTypeId
integer (int32)

Numeric identifier for the tax type.

idempotencyKey
string | null

Optional client-supplied key to prevent duplicate submissions. Requests with the same key within 24 hours return a 409.

correlationId
string | null

Optional identifier for correlating this request with the caller's system.

clientTimestampUtc
string (date-time) | null

Optional UTC timestamp from the client, used to resolve which request is latest when multiple exist for the same import type.

Responses
200

OK

object

Response returned after submitting an import request.

importId
integer (int64)

Unique numeric identifier of the import session.

requestId
integer (int64)

Unique numeric identifier of the individual import request within the session.

isNewSession
boolean

Indicates whether a new import session was created. Returns false when submitting to an existing session.

correlationId
string | null

Correlation identifier echoed from the request, if provided.

422

Unprocessable Content

Expand All
object
errorCode
string | null
innerError
object (R365.Pos.Public.Models.R365Error)
errorCode
string | null
innerError
object (R365.Pos.Public.Models.R365Error) Recursive