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 currencies
  • Get currency by label
  • Create currency
  • Create or update currency
  • Delete currency by label

Was this helpful?

  1. API reference

Currencies

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

PreviousCompaniesNextCustomers

Last updated 1 year ago

Was this helpful?

Collection of currencies contains exactly one currency marked as domestic. All system transactions are conducted exclusively in the domestic currency.

Currency is represented by class.

API methods

Get currencies

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

Returns all currencies that matches query parameters. Result is of type .

Query Parameters

Name
Type
Description

label

string

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.

isDomestic

bool

Supports NData syntax.

Headers

Name
Type
Description

Authorization*

string

Authorization header with authorization token.

{
    "items":
    [
        {
            "IsDomestic": true,
            "Label": "EUR",
            "Sign": "€",
            "ExchangeRate": 1,
            "Description": "Euro",
            "_v": 1
        },
        {
            "IsDomestic": false,
            "Label": "USD",
            "Sign": "$",
            "ExchangeRate": 1.1214,
            "Description": "US Dollar",
            "_v": 1
        },
        {
            "IsDomestic": false,
            "Label": "CZK",
            "Sign": null,
            "ExchangeRate": 23.7529,
            "Description": "Czech Crown",
            "_v": 1
        }
    ],
    "count": 3,
    "totalCount": 3
}

Get currency by label

GET http://{server-address}/currencies/{label}

Path Parameters

Name
Type
Description

label*

string

Unique currency label.

Headers

Name
Type
Description

Authorization*

string

Authorization header with authorization token.

{
    "IsDomestic": true,
    "Label": "EUR",
    "Sign": "€",
    "ExchangeRate": 1,
    "Description": "Euro",
    "_v": 1
}
{
    "title": "Zdroj nebol nΓ‘jdenΓ½",
    "status": 404
}

Create currency

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

Required rights

Headers

Name
Type
Description

Authorization*

string

Authorization header with authorization token.

Request Body

Name
Type
Description

(body)*

Currency

Model to create.

{
    "IsDomestic": true,
    "Label": "EUR",
    "Sign": "€",
    "ExchangeRate": 1,
    "Description": "Euro",
    "_v": 1
}

Create or update currency

PUT http://{server-address}/currencies/{label}

Required rights

Path Parameters

Name
Type
Description

label*

string

Unique currency label.

Headers

Name
Type
Description

Authorization*

string

Authorization header with authorization token.

Request Body

Name
Type
Description

(body)*

Currency

Model to create or update.

{
    "IsDomestic": true,
    "Label": "EUR",
    "Sign": "€",
    "ExchangeRate": 1,
    "Description": "Euro",
    "_v": 2
}

Delete currency by label

DELETE http://{server-address}/currencies/{label}

Required rights

Path Parameters

Name
Type
Description

label*

string

Unique currency label.

Headers

Name
Type
Description

Authorization*

string

Authorization header with authorization token.

{
    "IsDomestic": true,
    "Label": "EUR",
    "Sign": "€",
    "ExchangeRate": 1,
    "Description": "Euro",
    "_v": 1
}
{
    "title": "Zdroj nebol nΓ‘jdenΓ½",
    "status": 404
}

Result is of type .

Creates new currency. Result is of type .

Authorized user must have CurrencyCreate assigned.

Creates new or updates existing currency. Result is of type .

Authorized user must have assigned CurrencyCreate or CurrencyUpdate .

Authorized user must have CurrencyDelete assigned.

πŸ’±
right
right
right
Currency
QueryResult<Currency>
Currency
Currency
Currency