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/imports/{importId}

Prev Next
Get
/public/v1/pos/imports/{importId}

Retrieves the current status of a POS import session by identifier

Security
HTTP
Type Bearer

Put ONLY your JWT Bearer token on textbox below!

Path parameters
importId
integer (int64) Required

Unique numeric identifier of the import session to retrieve

Responses
200

OK

Expand All
object

Current status of a POS import session, including per-section summaries and validation issues.

importId
integer (int64)

Unique numeric identifier of the import session.

status
string | null

Current processing status of the session. Values are "Pending", "Failed", "Processing", "ProcessingWithFailures", "Completed", "PartiallyCompleted".

triggerCount
integer (int32)

Number of times the session has been triggered.

requests
Array of object (R365.Pos.Public.Contracts.Imports.Models.Request) | null

Import requests submitted to this session, filtered to the latest trigger generation.

object

Summary of an individual import request within a session.

requestId
integer (int64)

Unique numeric identifier of the import request.

importType
string | null

Type of data submitted in this request. Values are "Sales", "Tills", "Deposits", "Paidouts", "LaborEmployees", "LaborPunches", "LaborJobTitles".

status
string | null

Current processing status of this request. Values are "Pending", "Sent", "Failed", "Superseded".

receivedAtUtc
string (date-time)

UTC timestamp when the request was received by the service.

correlationId
string | null

Correlation identifier provided by the caller at submission time, if any.

issues
Array of object (R365.Pos.Public.Contracts.Imports.Models.ValidationIssue) | null

Validation issues recorded during processing, filtered to the latest trigger generation.

object

A single validation issue recorded during import processing.

section
string | null

Import section where the issue was detected. Values are "Sales", "Tills", "Deposits", "Paidouts", "LaborEmployees", "LaborPunches", "LaborJobTitles".

severity
string | null

Severity level of the issue. Values are "Error", "Warning".

code
string | null

Machine-readable code identifying the type of validation issue.

recordKey
string | null

Identifier of the specific record that triggered the issue, if applicable.

path
string | null

Field path within the record where the issue was detected, if applicable.

message
string | null

Human-readable description of the validation issue.

requestId
integer (int64) | null

Identifier of the import request this issue belongs to, if applicable.

createdAtUtc
string (date-time)

UTC timestamp when this issue was recorded.

sectionSummaries
Array of object (R365.Pos.Public.Contracts.Imports.Models.SectionSummary) | null

Per-section record counts for the latest trigger generation.

object

Record counts for a single import section within a trigger generation.

section
string | null

Import section this summary applies to. Values are "Sales", "Tills", "Deposits", "Paidouts", "LaborEmployees", "LaborPunches", "LaborJobTitles".

received
integer (int32)

Total number of records received in the import request.

processed
integer (int32)

Number of records successfully processed.

failed
integer (int32)

Number of records that failed validation or processing.

warnings
integer (int32)

Number of records processed with non-fatal warnings.

requestId
integer (int64) | null

Identifier of the import request this summary belongs to, if applicable.

createdAtUtc
string (date-time)

UTC timestamp when this summary was recorded.

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