Point of Sale

Read Point Of Sales

Retrieve PEMs.

SecurityE-Receipt_IT_API_OAuth2PasswordBearer
Request
query Parameters
PEMStatus (string) or Status (null) (Status)
page
integer (Page) >= 1
Default: 1

Page number

size
integer (Size)
Default: 30
Responses
200

Successful Response

401

Unauthorized

403

Forbidden

422

Validation Error

get/mf1/point-of-sales
Request samples 
Response samples 
application/json
{
  • "members": [
    ],
  • "total": 0,
  • "page": 1,
  • "size": 1,
  • "pages": 0
}
Read Point Of Sale
SecurityE-Receipt_IT_API_OAuth2PasswordBearer 
Request 
path Parameters
serial_number
required
string (Serial Number) 
The Point of Sale's serial number


 
Responses 
200
Successful Response


401
Unauthorized


403
Forbidden


404
Not Found


422
Validation Error


get/mf1/point-of-sales/{serial_number}
Request samples 
Response samples 
application/json
{
  • "serial_number": "string",
  • "status": "NEW",
  • "address": {
    },
  • "registration_key": "string"
}
Get Cash Registers
SecurityE-Receipt_IT_API_OAuth2PasswordBearer 
Request 
path Parameters
serial_number
required
string (Serial Number) 
The Point of Sale's serial number


 
query Parameters
page
integer (Page)   >= 1 
 Default:  1
Page number


 
size
integer (Size) 
 Default:  30
 
Responses 
200
Successful Response


401
Unauthorized


403
Forbidden


404
Not Found


422
Validation Error


get/mf1/point-of-sales/{serial_number}/cash-registers
Request samples 
Response samples 
application/json
{
  • "members": [
    ],
  • "total": 0,
  • "page": 1,
  • "size": 1,
  • "pages": 0
}
Close Journal
SecurityE-Receipt_IT_API_OAuth2PasswordBearer 
Request 
path Parameters
serial_number
required
string (Serial Number) 
The Point of Sale's serial number


 
Responses 
202
Successful Response


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


409
Conflict


422
Validation Error


500
Internal Server Error


post/mf1/point-of-sales/{serial_number}/close
Request samples 
Response samples 
application/json
null
Post Activation
Trigger the activation process of a Point of Sale by requesting a certificate to the Italian Tax Agency


SecurityE-Receipt_IT_API_OAuth2PasswordBearer 
Request 
path Parameters
serial_number
required
string (Serial Number) 
The Point of Sale's serial number


 
Request Body schema: application/json
required
registration_key
required
string (Registration Key) 
 
Responses 
202
Successful Response


401
Unauthorized


403
Forbidden


404
Not Found


409
Conflict


422
Validation Error


post/mf1/point-of-sales/{serial_number}/activation
Request samples 
application/json
{
  • "registration_key": "string"
}
Response samples 
application/json
null
Create Inactivity Period
Create a new inactivity period


SecurityE-Receipt_IT_API_OAuth2PasswordBearer 
Request 
path Parameters
serial_number
required
string (Serial Number) 
The Point of Sale serial number


 
Responses 
200
Successful Response


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


422
Validation Error


500
Internal Server Error


post/mf1/point-of-sales/{serial_number}/inactivity
Request samples 
Response samples 
application/json
null
Post Offline
Communicate to MF2 a period in which the Point of Sale was offline and the reason


SecurityE-Receipt_IT_API_OAuth2PasswordBearer 
Request 
path Parameters
serial_number
required
string (Serial Number) 
The Point of Sale serial number


 
Request Body schema: application/json
required
timestamp
required
string <date-time>  (Timestamp) 
 
reason
required
string (Reason) 
 
Responses 
202
Successful Response


400
Bad Request


401
Unauthorized


403
Forbidden


409
Conflict


422
Validation Error


post/mf1/point-of-sales/{serial_number}/communicate-offline
Request samples 
application/json
{
  • "timestamp": "2019-08-24T14:15:22Z",
  • "reason": "string"
}
Response samples 
application/json
null
Retrieves a list of Point of Sale resources.
Retrieves the collection of Pem resources.


Request 
path Parameters
merchant_uuid
required
string
The uuid of the Merchant.


 
query Parameters
page
integer
 Default:  1
The collection page number


 
itemsPerPage
integer  [ 0 .. 30 ] 
 Default:  30
The number of items per page


 
Responses 
200
Point of Sale resources


403
Forbidden


get/mf2/merchants/{merchant_uuid}/point-of-sales
Request samples 
Response samples 
[
  • {
    }
]
Creates a new Point of Sale.
Creates a Point of Sale resource


Request 
Request Body schema: 
required
The new Point of Sale resource


merchant_uuid
required
string <uuid> 
The merchant UUID.


 
https://schema.org/identifier
receipt_header
string or null
The receipt header. Leave empty to use the merchant name.


 
A-Cube_GOV-IT_PEL_Platform_Address (object) or null
 
A-Cube_GOV-IT_PEL_Platform_PemData (object) or null
 
Responses 
200
Point of Sale resource


201
Pem resource created


400
Invalid input


403
Forbidden


422
An error occurred


post/mf2/point-of-sales
Request samples 
{
  • "merchant_uuid": "ec27f24b-dbba-4c9a-aed0-9cec1c3b9e51",
  • "receipt_header": "string",
  • "address": {
    },
  • "external_pem_data": {
    }
}
Response samples 
{
  • "serial_number": "string",
  • "registration_key": "string"
}
Retrieves a Point of Sale resource.
Retrieves a Pem resource.


Request 
path Parameters
serial_number
required
string
The serial number of the Point of Sale


 
Responses 
200
Point of Sale resource


403
Forbidden


404
Not found


get/mf2/point-of-sales/{serial_number}
Request samples 
Response samples 
{
  • "serial_number": "string",
  • "type": "string",
  • "status": "string",
  • "address": {
    }
}