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
  • Creating and modifying ticket
  • Deleting ticket
  • Closing ticket
  • Evaluating the Default Fiscal Name
  • Printing preliminary ticket

Was this helpful?

  1. API reference
  2. Tickets

Ticket Operations and User Rights

Navigating Access for Ticket Actions

PreviousTicket Model StatesNextTicket Model Mathematics

Last updated 1 year ago

Was this helpful?

This section describes required when performing .

Creating and modifying ticket

When creating or modifying , specific are required, based on payload data and whether ticket with given identifier already exists.

  • TicketCreate: necessary when no existing ticket with given identifier is found.

  • TicketUpdate: necessary when attempting to modify an open ticket with a given identifier. This applies when the ticket is linked to an authorized user (determined through the employee.userName property).

  • TicketUpdateAny: necessary when attempting to modify an open ticket with a given identifier. This applies when the ticket is linked to a user other than the authorized user (determined through the employee.userName property).

  • TicketRename: necessary when attempting to modify name property of an existing open ticket.

  • TicketSetDiscount: necessary when attempting to set a non-zero value for the discountRate property of a new ticket or changing it from an existing ticket. If the ticket is associated with a (through the customer property), setting a value equal to the customer's discount rate (customer.discountRate) is allowed and doesn't require this right.

  • TicketSetCustomer: necessary when attempting to set non-null value for customer property of a new ticket or changing it for an existing ticket.

  • TicketHandover: necessary when attempting to associate ticket with user other than the authorized user (determined through the employee.userName property).

  • TicketTakeover: necessary when attempting to switch the association of a ticket from a user other than the authorized user (identified through the employee.userName property) to the authorized user. The execution of this operation also required TicketUpdateAny .

Deleting ticket

When deleting existing opened ticket, specific are required, based on properties of existing ticket.

  • TicketDelete: neccessary when deleting ticket associated with authorized user (determined through the employee.userName property).

  • TicketUpdateAny: necessary deleting ticket linked to a user other than the authorized user (determined through the employee.userName property).

  • Storno: necessary when deleting ticket containing at least one in items collection with a quantity greater than zero.

Closing ticket

  • TicketClose: necessary when closing ticket.

  • TicketCloseAny: necessary when closing ticket linked to a user other than the authorized user (determined through the employee.userName property).

  • TicketUpdate: necessary when ticket is linked to an authorized user (determined through the employee.userName property).

  • TicketUpdateAny: necessary when ticket is linked to a user other than the authorized user (determined through the employee.userName property).

Evaluating the Default Fiscal Name

Printing preliminary ticket

  • TicketPrintPreliminary

  • TicketUpdate: necessary when ticket is linked to an authorized user (determined through the employee.userName property).

  • TicketUpdateAny: necessary when ticket is linked to a user other than the authorized user (determined through the employee.userName property).

When closing ticket, following are required:

TicketCloseAs: necessary when closing ticket in behalf of user other than the authorized user (determined through the user.userName property of ).

TicketCloseToAnyFiscal: necessary when closing a ticket on a that is not the default fiscal device. For more details on how to evaluate the default fiscal device, please refer to the section.

This section outlines the procedure for determining the default for a

Using Zone's defaultFiscalName Property: The default fiscal name is extracted from the defaultFiscalName property of the linked to the through the 's location property. If the location property is empty (equal to null), move on to the next step.

Checking Device's Settings.DefaultFiscalName Property: The Settings.DefaultFiscalName property of the associated with the authorized user is checked. If the property value is equal to null, proceed to the next step.

No Default Fiscal Name Set: If none of the above steps yield a default fiscal name, it means that the default fiscal name is not configured. In such cases, the TicketCloseToAnyFiscal is not required.

When printing preliminary ticket, following are required:

๐Ÿงพ
user right
user rights
user rights
Ticket API methods
user rights
user right
user rights
user rights
Evaluating the Default Fiscal Name
ticket
customer
ticket item
TicketCloseContext
fiscal device
fiscal device
ticket
Zone
Ticket
Ticket
Device