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/accounting/pos-mapping

Prev Next
Get
/public/v1/accounting/pos-mapping

Retrieves POS Mappings grouped by type (Sales Account, Payment Type, Job, Paid Out) with enriched data including GL accounts, location, and legal entity.

Security
HTTP
Type Bearer

Put ONLY your JWT Bearer token on textbox below!

Query parameters
modifiedOn
string (date-time)

Modified date (returns records modified on or after this date). Format: 2022-06-02T09:13:00Z

posMappingId
string (uuid)

A specific POS Mapping identifier (GUID)

Responses
200

POS Mappings grouped by type with enriched data.

Expand All
object

Response grouping POS mappings by type for the enriched POS mapping endpoint.

posMappingSalesAccount
Array of object (PosMappingSalesAccount) | null

Sales account mappings.

object

POS mapping for a sales account.

id
string (uuid)

Unique identifier of the POS mapping.

name
string | null

POS account name.

glAccount
object (GlAccount)

GL Account summary for POS mapping response.

id
string (uuid)

GL Account identifier.

name
string | null

GL Account name.

number
string | null

GL Account number (e.g., "4010-100").

glType
string | null

GL Type name (e.g., "Sales", "Revenue", "Expense").

modifiedOn
string (date-time) | null

Timestamp of the most recent modification.

serviceType
string | null

Service type associated with this sales account.

category
object (Category)

POS category reference with identifier and name.

id
string (uuid)

Unique identifier of the category.

name
string | null

Category name.

type
string | null

Sales account type.

posMappingPaymentType
Array of object (PosMappingPaymentType) | null

Payment type mappings.

object

POS mapping for a payment type.

id
string (uuid)

Unique identifier of the POS mapping.

name
string | null

POS account name.

glAccount
object (GlAccount)

GL Account summary for POS mapping response.

id
string (uuid)

GL Account identifier.

name
string | null

GL Account name.

number
string | null

GL Account number (e.g., "4010-100").

glType
string | null

GL Type name (e.g., "Sales", "Revenue", "Expense").

modifiedOn
string (date-time) | null

Timestamp of the most recent modification.

exception
string | null

Exception rule applied to this payment type mapping.

paymentGroup
string | null

Payment group this payment type belongs to.

posMappingJob
Array of object (PosMappingJob) | null

Job title mappings.

object

POS mapping for a job title.

id
string (uuid)

Unique identifier of the POS mapping.

name
string | null

POS account name.

glAccount
object (GlAccount)

GL Account summary for POS mapping response.

id
string (uuid)

GL Account identifier.

name
string | null

GL Account name.

number
string | null

GL Account number (e.g., "4010-100").

glType
string | null

GL Type name (e.g., "Sales", "Revenue", "Expense").

modifiedOn
string (date-time) | null

Timestamp of the most recent modification.

jobCode
string | null

External job code.

department
string | null

Department the job belongs to.

location
object (Location)

Location reference for POS mapping responses.

id
string (uuid)

Unique identifier (GUID) of the location.

name
string | null

Display name of the location.

number
string | null

Location number.

legalEntityRef
object (LegalEntityRef)

Legal entity reference for POS mapping responses.

id
string (uuid)

Unique identifier (GUID) of the legal entity.

name
string | null

Display name of the legal entity.

number
string | null

Legal entity number.

posMappingPaidOut
Array of object (PosMappingPaidOut) | null

Paid-out type mappings.

object

POS mapping for a paid-out type.

id
string (uuid)

Unique identifier of the POS mapping.

name
string | null

POS account name.

glAccount
object (GlAccount)

GL Account summary for POS mapping response.

id
string (uuid)

GL Account identifier.

name
string | null

GL Account name.

number
string | null

GL Account number (e.g., "4010-100").

glType
string | null

GL Type name (e.g., "Sales", "Revenue", "Expense").

modifiedOn
string (date-time) | null

Timestamp of the most recent modification.

excludeFromPOSImport
boolean

Indicates whether this paid-out type is excluded from POS import processing.