PORTOS Developers
  • πŸ‘‹Introduction
  • πŸ“–Glossary
  • HTTP Status codes
  • Error models
  • Error codes
  • Validation constraints
  • Resource names
  • πŸ”’User rights
  • Device environments
  • 🌍Localization
  • πŸ”NData query syntax
  • OpenAPI specification
  • Data models
  • Authentication
    • πŸ”Authentication schemes
      • JWT Bearer Authentication
      • HMAC Authentication
  • ⚑Notifications
    • SignalR
    • Webhooks
  • API reference
    • πŸ”‘API keys
    • πŸ›οΈArticle categories
    • πŸ’ΌCompanies
    • πŸ’±Currencies
    • πŸ‘«Customers
    • πŸ“ˆDaily sales reports
    • πŸ–₯️Devices
    • πŸ–¨οΈFiscals
    • ❀️Health check
    • πŸ“ƒLicense
    • 🎚️Modifiers
    • πŸ‘¨β€πŸ³Order endpoints
    • πŸ›ŽοΈOrders
    • πŸͺ™Payment types
    • β˜•Plus
    • πŸ”Roles
    • πŸ”Sessions
    • βš™οΈSettings
    • πŸ”ŽStock takings
    • πŸ”’Stock transfer numbering
    • 🚚Stock transfers
    • πŸ“¦Stocks
    • 🧾Tickets
      • Ticket Model States
      • Ticket Operations and User Rights
      • Ticket Model Mathematics
    • πŸ‘¨β€πŸ’ΌUsers
    • βš–οΈVats
    • πŸͺ‘Zones
  • 3rd Party Integrations
    • Introduction
    • Online orders API
    • Rewards API
    • PDA Files
  • Previous versions
    • Migration to V4.1
    • Migration to V4
    • Legacy documentation
Powered by GitBook
On this page
  • API methods
  • Get payment types
  • Get payment type by number
  • Create payment type
  • Create or update payment type
  • Delete payment type by number

Was this helpful?

  1. API reference

Payment types

This page provides a description of the available API routes for managing payment types.

PreviousOrdersNextPlus

Last updated 1 year ago

Was this helpful?

Each purchase has to be paid using various methods, including cash, payment cards, vouchers, and more. These payment methods are collectively referred to as "payment types" and are represented by the class.

API methods

Get payment types

GET http://{server-address}/paymenttypes

Returns all payment types that matches query parameters. Result is of type .

Query Parameters

Name
Type
Description

number

int

Supports NData syntax.

isActive

bool

Supports NData syntax.

$skip

int

Pagination property. Describing number of records to skip from beginning of result collection.

$take

int

Pagination property. Maximum count of items to be returned.

$sort

string[]

Comma separated list of property names. Please see NData syntax.

$count

bool

If set to true, response will not contain items collection. Use to get resource count, not the resources themselves.

category

PaymentTypeCategory

Supports NData syntax.

isChangeable

bool

Supports NData syntax.

Headers

Name
Type
Description

Authorization*

string

Authorization header with authorization token.

{
    "items":
    [
        {
            "number": 1,
            "category": "Cash",
            "isActive": true,
            "description": "HotovosΕ₯",
            "isChangeable": true,
            "_v": 1
        },
        {
            "number": 2,
            "category": "CreditCard",
            "isActive": true,
            "description": "PlatobnΓ‘ karta",
            "isChangeable": false,
            "_v": 2
        },
        {
            "number": 3,
            "category": "Other",
            "isActive": false,
            "description": "Ε ek",
            "isChangeable": false,
            "_v": 1
        },
        {
            "number": 4,
            "category": "Other",
            "isActive": false,
            "description": "GastrolΓ­stky",
            "isChangeable": false,
            "_v": 1
        },
        {
            "number": 5,
            "category": "Other",
            "isActive": false,
            "description": "InΓ©",
            "isChangeable": false,
            "_v": 1
        },
        {
            "number": 6,
            "category": "Other",
            "isActive": true,
            "description": "Wolt",
            "isChangeable": false,
            "_v": 2
        },
        {
            "number": 7,
            "category": "Other",
            "isActive": true,
            "description": "Bolt",
            "isChangeable": false,
            "_v": 1
        },
        {
            "number": 8,
            "category": "Other",
            "isActive": true,
            "description": "Foodora",
            "isChangeable": false,
            "_v": 2
        },
        {
            "number": 9,
            "category": "Other",
            "isActive": true,
            "description": "Bistro.sk",
            "isChangeable": false,
            "_v": 2
        },
        {
            "number": 10,
            "category": "Other",
            "isActive": false,
            "description": "Adaptee",
            "isChangeable": false,
            "_v": 1
        }
    ],
    "count": 10,
    "totalCount": 10
}

Get payment type by number

GET http://{server-address}/paymenttypes/{number}

Path Parameters

Name
Type
Description

number*

int

Unique payment type number.

Headers

Name
Type
Description

Authorization*

string

Authorization header with authorization token.

{
    "number": 1,
    "category": "Cash",
    "isActive": true,
    "description": "HotovosΕ₯",
    "isChangeable": true,
    "_v": 1
}
{
    "title": "Zdroj nebol nΓ‘jdenΓ½",
    "status": 404
}

Create payment type

POST http://{server-address}/paymenttypes

Required rights

Headers

Name
Type
Description

Authorization*

string

Authorization header with authorization token.

Request Body

Name
Type
Description

(body)*

PaymentType

Model to create

{
    "number": 1,
    "category": "Cash",
    "isActive": true,
    "description": "HotovosΕ₯",
    "isChangeable": true,
    "_v": 1
}

Create or update payment type

PUT http://{server-address}/paymenttypes/{number}

Required rights

Path Parameters

Name
Type
Description

number*

int

Unique payment type number.

Headers

Name
Type
Description

Authorization*

string

Authorization header with authorization token.

Request Body

Name
Type
Description

(body)*

PaymentType

The model to create or update.

{
    "number": 1,
    "category": "Cash",
    "isActive": true,
    "description": "HotovosΕ₯",
    "isChangeable": true,
    "_v": 2
}

Delete payment type by number

DELETE http://{server-address}/paymenttypes/{number}

Required rights

Path Parameters

Name
Type
Description

number*

int

Unique payment type number.

Headers

Name
Type
Description

Authorization*

string

Authorization header with authorization token.

{
    "number": 1,
    "category": "Cash",
    "isActive": true,
    "description": "HotovosΕ₯",
    "isChangeable": true,
    "_v": 1
}
{
    "title": "Zdroj nebol nΓ‘jdenΓ½",
    "status": 404
}

Result is of type .

Creates new payment type. Result is of type .

Authorized user must have PaymentTypeCreate assigned.

Updates existing or creates new payment type. Result is of type .

Authorized user must have assigned PaymentTypeCreate or PaymentTypeUpdate .

Authorized user must have PaymentTypeDelete assigned.

πŸͺ™
right
right
right
PaymentType
QueryResult<PaymentType>
PaymentType
PaymentType
PaymentType