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

Attachment

Operations

Create a new attachment

Request

Creates a new attachment record.

Security
X-Api-Key
Bodyapplication/jsonrequired
accountIdstring

Account ID associated with the attachment.

Example: "507f1f77bcf86cd799439011"
namestringrequired

Name of the attachment.

Example: "receipt.pdf"
mimeTypestringrequired

MIME type of the attachment.

Example: "application/pdf"
originalUrlstringrequired

Original URL of the attachment.

Example: "https://example.com/original/receipt.pdf"
urlstringrequired

CDN URL of the attachment.

Example: "https://cdn.example.com/receipt.pdf"
pathstringrequired

Storage path of the attachment.

Example: "/attachments/2025/01/receipt.pdf"
curl -i -X POST \
  https://docs.finalpos.com/_mock/openapi/v1/api/attachment \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "accountId": "507f1f77bcf86cd799439011",
    "name": "receipt.pdf",
    "mimeType": "application/pdf",
    "originalUrl": "https://example.com/original/receipt.pdf",
    "url": "https://cdn.example.com/receipt.pdf",
    "path": "/attachments/2025/01/receipt.pdf"
  }'

Responses

The attachment has been successfully created.

Bodyapplication/json
idstring

Unique identifier for the Attachment.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
createdAtstring(date-time)

Timestamp when the Attachment was created.

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

Timestamp when the Attachment was last updated.

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

Company ID associated with the Attachment.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
accountIdstring

Account ID associated with the attachment.

Example: "507f1f77bcf86cd799439011"
namestring

Name of the attachment.

Example: "receipt.pdf"
mimeTypestring

MIME type of the attachment.

Example: "application/pdf"
originalUrlstring

Original URL of the attachment.

Example: "https://example.com/original/receipt.pdf"
urlstring

CDN URL of the attachment.

Example: "https://cdn.example.com/receipt.pdf"
pathstring

Storage path of the attachment.

Example: "/attachments/2025/01/receipt.pdf"
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",
  "accountId": "507f1f77bcf86cd799439011",
  "name": "receipt.pdf",
  "mimeType": "application/pdf",
  "originalUrl": "https://example.com/original/receipt.pdf",
  "url": "https://cdn.example.com/receipt.pdf",
  "path": "/attachments/2025/01/receipt.pdf"
}

Get a attachment by ID

Request

Retrieves a single attachment by its unique identifier.

Security
X-Api-Key
Path
idstringrequired

Attachment ID

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

Responses

The attachment has been successfully retrieved.

Bodyapplication/json
idstring

Unique identifier for the Attachment.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
createdAtstring(date-time)

Timestamp when the Attachment was created.

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

Timestamp when the Attachment was last updated.

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

Company ID associated with the Attachment.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
accountIdstring

Account ID associated with the attachment.

Example: "507f1f77bcf86cd799439011"
namestring

Name of the attachment.

Example: "receipt.pdf"
mimeTypestring

MIME type of the attachment.

Example: "application/pdf"
originalUrlstring

Original URL of the attachment.

Example: "https://example.com/original/receipt.pdf"
urlstring

CDN URL of the attachment.

Example: "https://cdn.example.com/receipt.pdf"
pathstring

Storage path of the attachment.

Example: "/attachments/2025/01/receipt.pdf"
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",
  "accountId": "507f1f77bcf86cd799439011",
  "name": "receipt.pdf",
  "mimeType": "application/pdf",
  "originalUrl": "https://example.com/original/receipt.pdf",
  "url": "https://cdn.example.com/receipt.pdf",
  "path": "/attachments/2025/01/receipt.pdf"
}

Update a attachment by ID

Request

Updates an existing attachment record.

Security
X-Api-Key
Path
idstringrequired

Attachment ID

Bodyapplication/jsonrequired
accountIdstring

Account ID associated with the attachment.

Example: "507f1f77bcf86cd799439011"
namestring

Name of the attachment.

Example: "receipt.pdf"
mimeTypestring

MIME type of the attachment.

Example: "application/pdf"
originalUrlstring

Original URL of the attachment.

Example: "https://example.com/original/receipt.pdf"
urlstring

CDN URL of the attachment.

Example: "https://cdn.example.com/receipt.pdf"
pathstring

Storage path of the attachment.

Example: "/attachments/2025/01/receipt.pdf"
curl -i -X PUT \
  'https://docs.finalpos.com/_mock/openapi/v1/api/attachment/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "accountId": "507f1f77bcf86cd799439011",
    "name": "receipt.pdf",
    "mimeType": "application/pdf",
    "originalUrl": "https://example.com/original/receipt.pdf",
    "url": "https://cdn.example.com/receipt.pdf",
    "path": "/attachments/2025/01/receipt.pdf"
  }'

Responses

The attachment has been successfully updated.

Bodyapplication/json
idstring

Unique identifier for the Attachment.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
createdAtstring(date-time)

Timestamp when the Attachment was created.

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

Timestamp when the Attachment was last updated.

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

Company ID associated with the Attachment.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
accountIdstring

Account ID associated with the attachment.

Example: "507f1f77bcf86cd799439011"
namestring

Name of the attachment.

Example: "receipt.pdf"
mimeTypestring

MIME type of the attachment.

Example: "application/pdf"
originalUrlstring

Original URL of the attachment.

Example: "https://example.com/original/receipt.pdf"
urlstring

CDN URL of the attachment.

Example: "https://cdn.example.com/receipt.pdf"
pathstring

Storage path of the attachment.

Example: "/attachments/2025/01/receipt.pdf"
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",
  "accountId": "507f1f77bcf86cd799439011",
  "name": "receipt.pdf",
  "mimeType": "application/pdf",
  "originalUrl": "https://example.com/original/receipt.pdf",
  "url": "https://cdn.example.com/receipt.pdf",
  "path": "/attachments/2025/01/receipt.pdf"
}

Delete a attachment by ID

Request

Deletes a attachment by its unique identifier.

Security
X-Api-Key
Path
idstringrequired

Attachment ID

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

Responses

The attachment 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"
}

Account

Operations

Refunds

Operations

Session

Operations

ZapierTriggers

Operations