POS

A Point of Sale represents a physical device for selling tickets at a venue.

Endpoints

The POS object

Attributes

_id

Required

string

The ID of the POS

active

Required

boolean

Whether the POS is active or not

name

Required

string

The name of the POS

posNo

Required

string

The number of the POS

printingType

Required

string

The printing type of the POS. DIRECT = direct printing. EXTERNAL = extenral printing.

EXTERNALDIRECT

Optional Attributes

Collapse all

sellerId

Optional

string

The ID of the seller owning this POS

restrictions

Optional

object

Restrictions of the POS

Optional Attributes

Collapse all

restrictions.restrictXReportAccess

Optional

boolean

Whether the code must be inserted in order to see the x reports

restrictions.restrictZReportAccess

Optional

boolean

Whether the code must be inserted in order to generate a z report and to finish the session

restrictions.restrictDashboardAccess

Optional

boolean

Whether the POS user can see the dashboard

restrictions.restrictInstantCancellation

Optional

boolean

Whether POS user can cancel a transaction immediately

restrictions.code

Optional

string

Code to unlock x and z reports if restricted

restrictions.restrictEventAccess

Optional

boolean

Whether the POS user can only choose specific events and/or specific secret shops

restrictions.restrictPurchaseIntents

Optional

boolean

Whether the POS user can manage purchase intents

restrictions.allowedEvents

Optional

array<string>

An array of IDs of allowed events

signature

Optional

object

POS signature settings

Optional Attributes

Collapse all

signature.fiskaly

Optional

object

Fiskaly settings

Optional Attributes

Collapse all

signature.fiskaly.tssId

Optional

string

The ID of the TSS

signature.fiskaly.clientId

Optional

string

The ID of the client

signature.fiskaly.state

Optional

string

The state of the TSS

UNINITIALIZEDINITIALIZEDDISABLED

state

Optional

string

The state of the POS

disabledactive

createdAt

Optional

string date-time

An ISO timestamp indicating when the POS was created

updatedAt

Optional

string date-time

An ISO timestamp indicating when the POS was updated

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "active": true,
  "name": "string",
  "posNo": "string",
  "printingType": "EXTERNAL",
  "restrictions": {
    "restrictXReportAccess": true,
    "restrictZReportAccess": true,
    "restrictDashboardAccess": true,
    "restrictInstantCancellation": true,
    "code": "string",
    "restrictEventAccess": true,
    "restrictPurchaseIntents": true,
    "allowedEvents": [
      "string"
    ]
  },
  "signature": {
    "fiskaly": {
      "tssId": "string",
      "clientId": "string",
      "state": "UNINITIALIZED"
    }
  },
  "state": "disabled",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Create a POS

Payload

name

Required

string

printingType

Required

string

Optional Attributes

Collapse all

posNo

Optional

string

201

Created

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "name": "string",
  "posNo": "string",
  "printingType": "string"
}

{
  "_id": "string",
  "sellerId": "string",
  "active": true,
  "name": "string",
  "posNo": "string",
  "printingType": "EXTERNAL",
  "restrictions": {
    "restrictXReportAccess": true,
    "restrictZReportAccess": true,
    "restrictDashboardAccess": true,
    "restrictInstantCancellation": true,
    "code": "string",
    "restrictEventAccess": true,
    "restrictPurchaseIntents": true,
    "allowedEvents": [
      "string"
    ]
  },
  "signature": {
    "fiskaly": {
      "tssId": "string",
      "clientId": "string",
      "state": "UNINITIALIZED"
    }
  },
  "state": "disabled",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Update POS

Payload

name

Required

string

posNo

Required

string

active

Required

boolean

printingType

Required

string

Optional Attributes

Collapse all

restrictions

Optional

object

Optional Attributes

Collapse all

restrictions.restrictXReportAccess

Optional

boolean

restrictions.restrictZReportAccess

Optional

boolean

restrictions.code

Optional

string

restrictions.restrictDashboardAccess

Optional

boolean

restrictions.restrictInstantCancellation

Optional

boolean

restrictions.restrictEventAccess

Optional

boolean

restrictions.restrictPurchaseIntents

Optional

boolean

restrictions.allowedEvents

Optional

array

One of

Only one of the following types

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "name": "string",
  "posNo": "string",
  "active": true,
  "printingType": "string",
  "restrictions": {
    "restrictXReportAccess": true,
    "restrictZReportAccess": true,
    "code": "string",
    "restrictDashboardAccess": true,
    "restrictInstantCancellation": true,
    "restrictEventAccess": true,
    "restrictPurchaseIntents": true,
    "allowedEvents": [
      "string"
    ]
  }
}

{
  "_id": "string",
  "sellerId": "string",
  "active": true,
  "name": "string",
  "posNo": "string",
  "printingType": "EXTERNAL",
  "restrictions": {
    "restrictXReportAccess": true,
    "restrictZReportAccess": true,
    "restrictDashboardAccess": true,
    "restrictInstantCancellation": true,
    "code": "string",
    "restrictEventAccess": true,
    "restrictPurchaseIntents": true,
    "allowedEvents": [
      "string"
    ]
  },
  "signature": {
    "fiskaly": {
      "tssId": "string",
      "clientId": "string",
      "state": "UNINITIALIZED"
    }
  },
  "state": "disabled",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get POS

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "active": true,
  "name": "string",
  "posNo": "string",
  "printingType": "EXTERNAL",
  "restrictions": {
    "restrictXReportAccess": true,
    "restrictZReportAccess": true,
    "restrictDashboardAccess": true,
    "restrictInstantCancellation": true,
    "code": "string",
    "restrictEventAccess": true,
    "restrictPurchaseIntents": true,
    "allowedEvents": [
      "string"
    ]
  },
  "signature": {
    "fiskaly": {
      "tssId": "string",
      "clientId": "string",
      "state": "UNINITIALIZED"
    }
  },
  "state": "disabled",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get all POS

Query

top

Optional

number float

skip

Optional

number float

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

[
  {
    "_id": "string",
    "sellerId": "string",
    "active": true,
    "name": "string",
    "posNo": "string",
    "printingType": "EXTERNAL",
    "restrictions": {
      "restrictXReportAccess": true,
      "restrictZReportAccess": true,
      "restrictDashboardAccess": true,
      "restrictInstantCancellation": true,
      "code": "string",
      "restrictEventAccess": true,
      "restrictPurchaseIntents": true,
      "allowedEvents": [
        "string"
      ]
    },
    "signature": {
      "fiskaly": {
        "tssId": "string",
        "clientId": "string",
        "state": "UNINITIALIZED"
      }
    },
    "state": "disabled",
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z"
  }
]

Disable POS

This process cannot be undone. Once the POS has been disabled, it can no longer be activated again. After disabling the POS cannot be used and users of this POS cannot sign in anymore.

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "active": true,
  "name": "string",
  "posNo": "string",
  "printingType": "EXTERNAL",
  "restrictions": {
    "restrictXReportAccess": true,
    "restrictZReportAccess": true,
    "restrictDashboardAccess": true,
    "restrictInstantCancellation": true,
    "code": "string",
    "restrictEventAccess": true,
    "restrictPurchaseIntents": true,
    "allowedEvents": [
      "string"
    ]
  },
  "signature": {
    "fiskaly": {
      "tssId": "string",
      "clientId": "string",
      "state": "UNINITIALIZED"
    }
  },
  "state": "disabled",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get POS sessions

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

[
  {
    "_id": "string",
    "sessionNo": "string",
    "posId": "string",
    "opened": "2030-01-23T23:00:00.123Z",
    "closed": "2030-01-23T23:00:00.123Z",
    "cashAtOpen": 10.5,
    "totalAmount": 10.5,
    "includedTax": 10.5,
    "totalByPaymentMethod": {
      "creditcard": 10.5,
      "ec": 10.5,
      "cash": 10.5
    },
    "taxInfo": {
      "detailsPerRate": [
        {
          "taxRate": 10.5,
          "includedTax": 10.5,
          "reducedTax": 10.5
        }
      ]
    },
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z"
  }
]

Get POS journal logs

Query

top

Optional

number float

A limit on the number of objects to be returned. Can range between 1 and 1000.

skip

Optional

number float

The number of objects to skip for the requested result

type

Optional

string

Type of logs to filter

SALECANCELLATIONSESSION_CREATEDSESSION_CLOSED

referenceId

Optional

string

ID of the referenced object

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "rows": [
    {
      "_id": "string",
      "posId": "string",
      "referenceId": "string",
      "type": "SALE",
      "typeDescriptor": "cash",
      "fiscalization": {
        "_id": "string",
        "type": "RECEIPT",
        "transactionId": "string",
        "transactionNumber": 10.5,
        "timeStart": 10.5,
        "timeEnd": 10.5,
        "certificateSerial": "string",
        "timestampFormat": "string",
        "signatureValue": "string",
        "signatureCount": 10.5,
        "signatureAlgorithm": "string",
        "signaturePublicKey": "string",
        "clientSerialNumber": "string",
        "revision": 10.5,
        "tssId": "string",
        "clientId": "string",
        "qrCodeData": "string"
      },
      "createdAt": "2030-01-23T23:00:00.123Z",
      "updatedAt": "2030-01-23T23:00:00.123Z"
    }
  ],
  "total": 1
}

Export POS journal logs

Query

start

Required

string date-time

end

Required

string date-time

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

Export POS cancellations

Query

start

Required

string date-time

end

Required

string date-time

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

Export POS orders

Query

start

Required

string date-time

end

Required

string date-time

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

Export POS order items

Query

start

Required

string date-time

end

Required

string date-time

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

Export POS order discounts

Query

start

Required

string date-time

end

Required

string date-time

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No