Fiscals
This page provides a description of the available API routes for managing fiscal devices.
Last updated
Was this helpful?
This page provides a description of the available API routes for managing fiscal devices.
Last updated
Was this helpful?
Fiscal device refers to receipt printer that prints cash register receipts (part of ticket closing procedure).
Fiscal device is represented by class.
These API methods allow for the management of fiscal resources, including creation, reading, updating, and deletion.
GET
http://{server-address}/fiscals
Returns all fiscals that matches query parameters. Result is of type .
name
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.
isActive
bool
Supports NData syntax.
type
string
Supports NData syntax.
dkp
string
Supports NData syntax.
Authorization*
string
Authorization header with authorization token.
GET
http://{server-address}/fiscals/{name}
name*
string
Unique fiscal name.
Authorization*
string
Authorization header with authorization token.
POST
http://{server-address}/fiscals
Required rights
Authorization*
string
Authorization header with authorization token.
(body)*
Fiscal
Model to create.
PUT
http://{server-address}/fiscals/{name}
Required rights
name*
string
Unique fiscal name.
Authorization*
string
Authorization header with authorization token.
(body)*
Fiscal
Model to create or update.
DELETE
http://{server-address}/fiscals/{name}
Required rights
name*
string
Unique fiscal name.
Authorization*
string
Authorization header with authorization token.
These API methods trigger specific actions on fiscal devices. However, it's important to note that depending on the type of fiscal device, some methods may not be supported. Additionally, attempting an action on a fiscal device that is marked as inactive will also result in failure. In both of these cases, making API calls will result in an HTTP status code of 403.
POST
http://{server-address}/fiscals/{name}/open_drawer
Opens cash drawer on specified device.
Required rights
name*
string
Unique fiscal name.
Authorization*
string
Authorization header with authorization token.
The response body contains no content.
POST
http://{server-address}/fiscals/{name}/cash_transfer
This method performs a cash transfer operation on a fiscal device specified by name. It updates the latest daily sales report for the device or creates a new report if none is currently opened. The updated daily sales report is then returned in the response body.
Required rights
name*
string
Unique fiscal name.
Authorization*
string
Authorization header with authorization token.
(body)*
CashTransfer
Cash transfer model.
POST
http://{server-address}/fiscals/{name}/print_record_copy
Required rights
name*
string
Unique fiscal name.
Authorization*
string
Authorization header with authorization token.
(body)*
RecordCopyContext
The record copy context.
The response body contains no content.
POST
http://{server-address}/fiscals/{name}/print_last_record_copy
Prints copy of last ticket printed on fiscal printer.
Required rights
name*
string
Unique fiscal name.
Authorization*
string
Authorization header with authorization token.
The response body contains no content.
POST
http://{server-address}/fiscals/{name}/print_overview_sales_report
Prints overview sales report on specified fiscal printer.
The overview sales report ("Priebežná uzávierka", "Prehľadová uzávierka" or "X uzávierka" in Slovak) includes financial information on sales from the last daily sales report.
Required rights
name*
string
Unique fiscal name.
Authorization*
string
Authorization header with authorization token.
The response body contains no content.
POST
http://{server-address}/fiscals/{name}/print_summary_interval_sales_report
Prints summary interval sales report on specified fiscal printer. The generated report consolidates financial information extracted from multiple daily sales reports.
Required rights
name*
string
Unique fiscal name.
Authorization*
string
Authorization header with authorization token.
(body)*
IntervalSalesReportContext
Model that specifies sales reports interval.
The response body contains no content.
POST
http://{server-address}/fiscals/{name}/print_detailed_interval_sales_report
Prints detailed interval sales report on specified fiscal printer. The generated report consolidates financial information extracted from multiple daily sales reports.
Required rights
name*
string
Unique fiscal name.
Authorization*
string
Authorization header with authorization token.
(body)*
IntervalSalesReportContext
Model that specifies sales reports interval.
The response body contains no content.
POST
http://{server-address}/fiscals/{name}/daily_sales_report
Required rights
name*
string
Unique fiscal name.
Authorization*
string
Authorization header with authorization token.
POST
http://{server-address}/fiscals/{name}/daily_sales_report_copy
Required rights
name*
string
Unique fiscal name.
Authorization*
string
Authorization header with authorization token.
(body)
DailySalesReportCopyContex
Context that specifies daily sales report to be printed.
The response body contains no content.
POST
http://{server-address}/fiscals/{name}/last_daily_sales_report_copy
Prints copy of last daily sales report associated with given fiscal printer.
Required rights
name*
string
Unique fiscal name.
Authorization*
string
Authorization header with authorization token.
The response body contains no content.
POST
http://{server-address}/fiscals/{name}/print_nonfiscal_record
Required rights
name*
string
Unique fiscal name.
Authorization*
string
Authorization header with authorization token.
(body)
NonfiscalRecordContext
Context that specifies text to be printed.
The response body contains no content.
Result is of type .
Creates new fiscal. Result is of type .
Authorized user must have FiscalCreate
assigned.
Creates new or updates existing fiscal. Result is of type .
Authorized user must have assigned FiscalCreate
or FiscalUpdate
.
Authorized user must have FiscalDelete
assigned.
Authorized user must have FiscalOpenDrawer
assigned.
The method accepts in request body.
Authorized user must have FiscalCashTransfer
assigned.
Prints copy of specified ticket on fiscal printer. Method accepts in request body.
Authorized user must have FiscalPrintRecordCopy
assigned.
Authorized user must have FiscalPrintRecordCopy
assigned.
Authorized user must have OverviewSalesReport
assigned.
The method accepts in request body.
Authorized user must have SummaryIntervalSalesReport
assigned.
The method accepts in request body.
Authorized user must have DetailedIntervalSalesReport
assigned.
Performs daily sales closure and prints daily sales report on specified fiscal printer. is returned in response body. It's important to note that certain fiscal devices only support one daily sales report per day, while other types of fiscal devices allow multiple closures to be performed within the same day.
Authorized user must have DoDailySalesReport
assigned.
Prints copy of daily sales report associated with given fiscal printer. Method accepts in request body.
Authorized user must have FiscalPrintDailySalesReportCopy
assigned.
Authorized user must have FiscalPrintDailySalesReportCopy
assigned.
Prints text (nonfiscal record) on selected fiscal device. Method accepts in request body.
Authorized user must have PrintNonfiscalRecord
assigned.