POS Mappings

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

Retrieves POS Mappings. Returns all POS mappings with their associated GL Account (null if unmapped).

Security

The requesting user must have the following permission to retrieve POS mappings:

  • Administration → POS Management → View/Edit POS Mapping Tool
Security
HTTP
Type Bearer
Header parameters
x-r365-context-tenant-id
stringRequired

Identifies the R365 tenant the request applies to. Required on every request.

Query parameters
modifiedOnStart
string (date-time)

Modified date start (inclusive). Format: 2022-06-02T09:13:00Z. If not provided but modifiedOnEnd is provided, defaults to modifiedOnEnd date

modifiedOnEnd
string (date-time)

Modified date end (inclusive). Format: 2022-06-02T09:13:00Z

type
string

Mapping type. Allowed values: 'Sales Account', 'Payment Type', 'Job Title', 'Paid Out Type' (matched case-insensitively). Any other value returns 422.

Valid values[ "Sales Account", "Payment Type", "Job Title", "Paid Out Type" ]
pageSize
integer (int32)

Maximum number of top-level objects to return in one page.

Minimum1.0
Maximum250.0
Default250
continuationToken
string

Continuation token for pagination. Use the nextLink from a previous response to get the next page of results

Responses
200

POS Mappings with their associated GL Accounts and pagination support.

Expand All
object

Response containing POS mappings with pagination support.

posMappings
Array of object | null

The collection of POS mappings for the current page.

object

POS mapping with associated GL accounts.

id
string (uuid)

POS Account identifier.

type
string | null

POS mapping type (e.g., "Sales Account", "Job Title", "Payment Type", "Paid Out Type").

name
string | null

POS account name.

modifiedOn
string (date-time) | null

Last modified date.

glAccount
object (PosMappingGlAccount)

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").

nextLink
string | null

URL to retrieve the next page of results, or null if this is the last page.

400

Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range.

401

Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant.

403

Forbidden — the caller lacks the permission required for this operation.

404

Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired.

409

Conflict — the request conflicts with the current state of the resource and cannot be applied.

422

Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid.

429

Too Many Requests — the caller has exceeded the rate limit; retry after a short delay.

500

Internal Server Error — an unexpected error occurred while processing the request.