Receipt

Create a new electronic receipt

Create a new electronic receipt

SecurityBearer
Request
Request Body schema:

The new Receipt resource

fiscal_id
required
string

The VAT number of the company that issued the receipt.

lottery_code
string

"Codice Lotteria del cliente".

required
Array of objects (ReceiptItem)

"Elementi contabili".

invoice_issuing
boolean

"Flag Emissione Fattura".

services_uncollected_amount
number

"Credito Non Riscosso - Prestazioni Servizi".

goods_uncollected_amount
number

"Credito Non Riscosso - Bene Consegnato".

cash_payment_amount
number

"Pagamento In Contanti".

electronic_payment_amount
number

"Pagamento Elettronico".

ticket_restaurant_payment_amount
number

"Pagamento Ticket Restaurant".

ticket_restaurant_quantity
integer

"Numero Ticket Restaurant".

discount
number

"Sconto A Pagare".

linked_receipt
string

"Documento Commerciale Collegato".

Responses
201

Receipt resource created

400

Invalid input

404

Resource not found

post/receipts
Request samples
{
  • "fiscal_id": "string",
  • "lottery_code": "string",
  • "items": [
    ],
  • "invoice_issuing": true,
  • "services_uncollected_amount": 0,
  • "goods_uncollected_amount": 0,
  • "cash_payment_amount": 0,
  • "electronic_payment_amount": 0,
  • "ticket_restaurant_payment_amount": 0,
  • "ticket_restaurant_quantity": 0,
  • "discount": 0,
  • "linked_receipt": "string"
}
Response samples
{
  • "return_receipts": [
    ],
  • "voiding_receipt": {
    },
  • "returned_receipt": {
    },
  • "voided_receipt": {
    },
  • "error_message": "string",
  • "error_code": "string",
  • "uuid": "string",
  • "type": "sale",
  • "status": "new",
  • "fiscal_id": "string",
  • "created_at": "string",
  • "total_amount": 0,
  • "transaction_id": "string",
  • "document_number": "string",
  • "document_date": "string"
}

Get a list of electronic receipts

Get a list of electronic receipts

SecurityBearer
Request
query Parameters
business_registry_configuration.fiscal_id
string
business_registry_configuration.fiscal_id[]
Array of strings
document_number
string
document_number[]
Array of strings
status
string
status[]
Array of strings
type
string
type[]
Array of strings
created_at[before]
string
created_at[strictly_before]
string
created_at[after]
string
created_at[strictly_after]
string
document_date[before]
string
document_date[strictly_before]
string
document_date[after]
string
document_date[strictly_after]
string
page
integer

The collection page number

Responses
200

ReceiptOutput collection response

get/receipts
Request samples 
Response samples 
[
  • {
    }
]
Get an electronic receipt
Get an electronic receipt


SecurityBearer 
Request 
path Parameters
id
required
string
 
Responses 
200
ReceiptOutput resource response


404
Resource not found


get/receipts/{id}
Request samples 
Response samples 
{
  • "return_receipts": [
    ],
  • "voiding_receipt": {
    },
  • "returned_receipt": {
    },
  • "voided_receipt": {
    },
  • "error_message": "string",
  • "error_code": "string",
  • "uuid": "string",
  • "type": "sale",
  • "status": "new",
  • "fiscal_id": "string",
  • "created_at": "string",
  • "total_amount": 0,
  • "transaction_id": "string",
  • "document_number": "string",
  • "document_date": "string"
}
Void an electronic receipt
Void an electronic receipt


SecurityBearer 
Request 
path Parameters
id
required
string
 
Responses 
204
Receipt resource deleted


404
Resource not found


delete/receipts/{id}
Request samples 
Get the details or the PDF of an electronic receipt
Get the details of an electronic receipt, or the receipt PDF itself if the 'Accept: application/pdf' header is sent


SecurityBearer 
Request 
path Parameters
id
required
string
 
Responses 
200
ReceiptDetailsOutput resource response


404
Resource not found


409
Document still being processed, please retry later


get/receipts/{id}/details
Request samples 
Response samples 
{
  • "total_taxable_amount": 0,
  • "total_uncollected_amount": 0,
  • "deductible_amount": 0,
  • "total_vat_amount": 0,
  • "total_discount": 0,
  • "total_gross_discount": 0,
  • "discount": 0,
  • "items": [
    ],
  • "uuid": "string",
  • "type": "sale",
  • "status": "new",
  • "fiscal_id": "string",
  • "created_at": "string",
  • "total_amount": 0,
  • "transaction_id": "string",
  • "document_number": "string",
  • "document_date": "string"
}
Return items an electronic receipt
Return items an electronic receipt


SecurityBearer 
Request 
path Parameters
id
required
string
 
Request Body schema: 
The new Receipt resource


required
Array of objects (ReceiptReturnItem) 
"Elementi contabili".


 
Responses 
201
Receipt resource created


400
Invalid input


404
Resource not found


post/receipts/{id}/return
Request samples 
{
  • "items": [
    ]
}
Response samples 
{
  • "return_receipts": [
    ],
  • "voiding_receipt": {
    },
  • "returned_receipt": {
    },
  • "voided_receipt": {
    },
  • "error_message": "string",
  • "error_code": "string",
  • "uuid": "string",
  • "type": "sale",
  • "status": "new",
  • "fiscal_id": "string",
  • "created_at": "string",
  • "total_amount": 0,
  • "transaction_id": "string",
  • "document_number": "string",
  • "document_date": "string"
}