Skip to content

Final POS API (1.2.4)

Welcome to the Final POS Public API—your playground for crafting the checkout and kiosk flows you want. Create your API keys in Manage (Settings > API Keys) and send them as x-api-key on every request. Customer endpoints use dynamic DTO generation so they adapt to your custom tables in real time, while the rest of the controllers follow a stable, static contract for predictable integrations.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
UNLICENSED
Languages
Servers
Mock server
https://docs.finalpos.com/_mock/openapi
Official API
https://api.finalpos.com

Data Transfer Objects (DTOs)

Schemas

Customer

Operations

Customers

Operations

Custom Tables: structure

Operations

Custom Table: content

Operations

Custom Tables: content

Operations

Product

Operations

Products

Operations

Outlet

Operations

Outlets

Operations

Category

Operations

Categories

Operations

Station

Operations

Stations

Operations

Variant

Operations

Variants

Operations

Order

Operations

Orders

Operations

Transactions

Operations

Roles

Operations

Create a new role

Request

Creates a new role record.

Security
X-Api-Key
Bodyapplication/jsonrequired
namestringrequired

Name of the role.

Example: "Manager"
permissionsArray of objects(RolePermissionDto)required

Permissions assigned to the role.

Example: [{"name":"create_order","permissionId":"507f1f77bcf86cd799439011","category":"orders","subCategory":"management","value":true}]
permissions[].​namestringrequired

Name of the permission.

Example: "create_order"
permissions[].​permissionIdstringrequired

Permission ID reference.

Example: "507f1f77bcf86cd799439011"
permissions[].​categorystringrequired

Category of the permission.

Example: "orders"
permissions[].​subCategorystringrequired

Sub-category of the permission.

Example: "management"
permissions[].​valuebooleanrequired

Whether the permission is enabled.

Example: true
curl -i -X POST \
  https://docs.finalpos.com/_mock/openapi/v1/api/roles \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Manager",
    "permissions": [
      {
        "name": "create_order",
        "permissionId": "507f1f77bcf86cd799439011",
        "category": "orders",
        "subCategory": "management",
        "value": true
      }
    ]
  }'

Responses

The role has been successfully created.

Bodyapplication/json
idstring

Unique identifier for the Roles.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
createdAtstring(date-time)

Timestamp when the Roles was created.

Example: "2025-12-07T19:31:48.436+00:00"
updatedAtstring(date-time)

Timestamp when the Roles was last updated.

Example: "2025-12-07T19:35:48.436+00:00"
companyIdstring

Company ID associated with the Roles.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
namestring

Name of the role.

Example: "Manager"
permissionsArray of objects(RolePermissionDto)

Permissions assigned to the role.

Example: [{"name":"create_order","permissionId":"507f1f77bcf86cd799439011","category":"orders","subCategory":"management","value":true}]
Response
application/json
{
  "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "createdAt": "2025-12-07T19:31:48.436+00:00",
  "updatedAt": "2025-12-07T19:35:48.436+00:00",
  "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "name": "Manager",
  "permissions": [
    { … }
  ]
}

Get a role by ID

Request

Retrieves a single role by its unique identifier.

Security
X-Api-Key
Path
idstringrequired

Roles ID

curl -i -X GET \
  'https://docs.finalpos.com/_mock/openapi/v1/api/roles/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

The role has been successfully retrieved.

Bodyapplication/json
idstring

Unique identifier for the Roles.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
createdAtstring(date-time)

Timestamp when the Roles was created.

Example: "2025-12-07T19:31:48.436+00:00"
updatedAtstring(date-time)

Timestamp when the Roles was last updated.

Example: "2025-12-07T19:35:48.436+00:00"
companyIdstring

Company ID associated with the Roles.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
namestring

Name of the role.

Example: "Manager"
permissionsArray of objects(RolePermissionDto)

Permissions assigned to the role.

Example: [{"name":"create_order","permissionId":"507f1f77bcf86cd799439011","category":"orders","subCategory":"management","value":true}]
Response
application/json
{
  "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "createdAt": "2025-12-07T19:31:48.436+00:00",
  "updatedAt": "2025-12-07T19:35:48.436+00:00",
  "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "name": "Manager",
  "permissions": [
    { … }
  ]
}

Update a role by ID

Request

Updates an existing role record.

Security
X-Api-Key
Path
idstringrequired

Roles ID

Bodyapplication/jsonrequired
namestring

Name of the role.

Example: "Manager"
permissionsArray of objects(RolePermissionDto)

Permissions assigned to the role.

Example: [{"name":"create_order","permissionId":"507f1f77bcf86cd799439011","category":"orders","subCategory":"management","value":true}]
curl -i -X PUT \
  'https://docs.finalpos.com/_mock/openapi/v1/api/roles/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Manager",
    "permissions": [
      {
        "name": "create_order",
        "permissionId": "507f1f77bcf86cd799439011",
        "category": "orders",
        "subCategory": "management",
        "value": true
      }
    ]
  }'

Responses

The role has been successfully updated.

Bodyapplication/json
idstring

Unique identifier for the Roles.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
createdAtstring(date-time)

Timestamp when the Roles was created.

Example: "2025-12-07T19:31:48.436+00:00"
updatedAtstring(date-time)

Timestamp when the Roles was last updated.

Example: "2025-12-07T19:35:48.436+00:00"
companyIdstring

Company ID associated with the Roles.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
namestring

Name of the role.

Example: "Manager"
permissionsArray of objects(RolePermissionDto)

Permissions assigned to the role.

Example: [{"name":"create_order","permissionId":"507f1f77bcf86cd799439011","category":"orders","subCategory":"management","value":true}]
Response
application/json
{
  "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "createdAt": "2025-12-07T19:31:48.436+00:00",
  "updatedAt": "2025-12-07T19:35:48.436+00:00",
  "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "name": "Manager",
  "permissions": [
    { … }
  ]
}

Delete a role by ID

Request

Deletes a role by its unique identifier.

Security
X-Api-Key
Path
idstringrequired

Roles ID

curl -i -X DELETE \
  'https://docs.finalpos.com/_mock/openapi/v1/api/roles/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

The role has been successfully deleted.

Bodyapplication/json
statusCodenumberrequired

HTTP status code

Example: 200
messagestringrequired

Message describing the result of the operation

Example: "Resource with Id 123 deleted successfully"
Response
application/json
{
  "statusCode": 200,
  "message": "Resource with Id 123 deleted successfully"
}

Attachment

Operations

Account

Operations

Refunds

Operations

Session

Operations

ZapierTriggers

Operations