Create a new electronic receipt
The new Receipt resource
Receipt resource created
Invalid input
Resource not found
{- "fiscal_id": "string",
- "lottery_code": "string",
- "items": [
- {
- "quantity": 0,
- "description": "string",
- "unit_price": 0,
- "vat_rate_code": "4",
- "discount": 0,
- "complimentary": true
}
], - "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",
- "email": "string"
}
{- "return_receipts": [
- {
- "uuid": "string",
- "type": "sale",
- "status": "new",
- "fiscal_id": "string",
- "created_at": "2024-10-08 16:19:42",
- "total_amount": 11.42,
- "transaction_id": "string",
- "document_number": "string",
- "document_date": "2024-10-08 16:19:42"
}
], - "voiding_receipt": {
- "uuid": "string",
- "type": "sale",
- "status": "new",
- "fiscal_id": "string",
- "created_at": "2024-10-08 16:19:42",
- "total_amount": 11.42,
- "transaction_id": "string",
- "document_number": "string",
- "document_date": "2024-10-08 16:19:42"
}, - "returned_receipt": {
- "uuid": "string",
- "type": "sale",
- "status": "new",
- "fiscal_id": "string",
- "created_at": "2024-10-08 16:19:42",
- "total_amount": 11.42,
- "transaction_id": "string",
- "document_number": "string",
- "document_date": "2024-10-08 16:19:42"
}, - "voided_receipt": {
- "uuid": "string",
- "type": "sale",
- "status": "new",
- "fiscal_id": "string",
- "created_at": "2024-10-08 16:19:42",
- "total_amount": 11.42,
- "transaction_id": "string",
- "document_number": "string",
- "document_date": "2024-10-08 16:19:42"
}, - "error_message": "string",
- "error_code": "string",
- "uuid": "string",
- "type": "sale",
- "status": "new",
- "fiscal_id": "string",
- "created_at": "2024-10-08 16:19:42",
- "total_amount": 11.42,
- "transaction_id": "string",
- "document_number": "string",
- "document_date": "2024-10-08 16:19:42"
}
Get a list of electronic receipts. Notes on fields. return_receipts
can contain a list of receipts that retrurn items from the current one, i.e. this is a 'parent' receipt and return_receipts
are its 'children' that return items from it. returned_receipt
could be the 'parent' receipt the current one is returning item from; in this case the type of the current receipt will be return
. The same holds for voiding_receipt
that is the receipt that voids the current one and voided_receipt
that is the receipt voided by the current one; in this case the type of the current receipt will be void
.
ReceiptOutput collection response
[- {
- "return_receipts": [
- {
- "uuid": "string",
- "type": "sale",
- "status": "new",
- "fiscal_id": "string",
- "created_at": "2024-10-08 16:19:42",
- "total_amount": 11.42,
- "transaction_id": "string",
- "document_number": "string",
- "document_date": "2024-10-08 16:19:42"
}
], - "voiding_receipt": {
- "uuid": "string",
- "type": "sale",
- "status": "new",
- "fiscal_id": "string",
- "created_at": "2024-10-08 16:19:42",
- "total_amount": 11.42,
- "transaction_id": "string",
- "document_number": "string",
- "document_date": "2024-10-08 16:19:42"
}, - "returned_receipt": {
- "uuid": "string",
- "type": "sale",
- "status": "new",
- "fiscal_id": "string",
- "created_at": "2024-10-08 16:19:42",
- "total_amount": 11.42,
- "transaction_id": "string",
- "document_number": "string",
- "document_date": "2024-10-08 16:19:42"
}, - "voided_receipt": {
- "uuid": "string",
- "type": "sale",
- "status": "new",
- "fiscal_id": "string",
- "created_at": "2024-10-08 16:19:42",
- "total_amount": 11.42,
- "transaction_id": "string",
- "document_number": "string",
- "document_date": "2024-10-08 16:19:42"
}, - "error_message": "string",
- "error_code": "string",
- "uuid": "string",
- "type": "sale",
- "status": "new",
- "fiscal_id": "string",
- "created_at": "2024-10-08 16:19:42",
- "total_amount": 11.42,
- "transaction_id": "string",
- "document_number": "string",
- "document_date": "2024-10-08 16:19:42"
}
]
Get an electronic receipt. See notes above related to the API for getting a list of electronic receipts for more details on the results.
ReceiptOutput resource response
Resource not found
{- "return_receipts": [
- {
- "uuid": "string",
- "type": "sale",
- "status": "new",
- "fiscal_id": "string",
- "created_at": "2024-10-08 16:19:42",
- "total_amount": 11.42,
- "transaction_id": "string",
- "document_number": "string",
- "document_date": "2024-10-08 16:19:42"
}
], - "voiding_receipt": {
- "uuid": "string",
- "type": "sale",
- "status": "new",
- "fiscal_id": "string",
- "created_at": "2024-10-08 16:19:42",
- "total_amount": 11.42,
- "transaction_id": "string",
- "document_number": "string",
- "document_date": "2024-10-08 16:19:42"
}, - "returned_receipt": {
- "uuid": "string",
- "type": "sale",
- "status": "new",
- "fiscal_id": "string",
- "created_at": "2024-10-08 16:19:42",
- "total_amount": 11.42,
- "transaction_id": "string",
- "document_number": "string",
- "document_date": "2024-10-08 16:19:42"
}, - "voided_receipt": {
- "uuid": "string",
- "type": "sale",
- "status": "new",
- "fiscal_id": "string",
- "created_at": "2024-10-08 16:19:42",
- "total_amount": 11.42,
- "transaction_id": "string",
- "document_number": "string",
- "document_date": "2024-10-08 16:19:42"
}, - "error_message": "string",
- "error_code": "string",
- "uuid": "string",
- "type": "sale",
- "status": "new",
- "fiscal_id": "string",
- "created_at": "2024-10-08 16:19:42",
- "total_amount": 11.42,
- "transaction_id": "string",
- "document_number": "string",
- "document_date": "2024-10-08 16:19:42"
}
Get the details of an electronic receipt, or the receipt PDF itself if the Accept: application/pdf
header is sent
ReceiptDetailsOutput resource response
Resource not found
Document still being processed, please retry later
{- "total_taxable_amount": 7.23,
- "total_uncollected_amount": 7.23,
- "deductible_amount": 7.23,
- "total_vat_amount": 7.23,
- "total_discount": 7.23,
- "total_gross_discount": 7.23,
- "discount": 7.23,
- "items": [
- {
- "id": "string",
- "quantity": 7.23,
- "description": "string",
- "gross_price": 7.23,
- "vat_rate": "22",
- "gross_discount": 7.23,
- "complimentary": true,
- "unit_price": 7.23,
- "return": 7.23,
- "taxable_amount": 7.23,
- "net_taxable_amount": 7.23,
- "vat_amount": 7.23,
- "total_amount": 7.23,
- "unit_discount": 7.23
}
], - "uuid": "string",
- "type": "sale",
- "status": "new",
- "fiscal_id": "string",
- "created_at": "2024-10-08 16:19:42",
- "total_amount": 11.42,
- "transaction_id": "string",
- "document_number": "string",
- "document_date": "2024-10-08 16:19:42"
}
Return items an electronic receipt
Receipt resource created
Invalid input
Resource not found
{- "items": [
- {
- "id": "string",
- "quantity": 0
}
]
}
{- "return_receipts": [
- {
- "uuid": "string",
- "type": "sale",
- "status": "new",
- "fiscal_id": "string",
- "created_at": "2024-10-08 16:19:42",
- "total_amount": 11.42,
- "transaction_id": "string",
- "document_number": "string",
- "document_date": "2024-10-08 16:19:42"
}
], - "voiding_receipt": {
- "uuid": "string",
- "type": "sale",
- "status": "new",
- "fiscal_id": "string",
- "created_at": "2024-10-08 16:19:42",
- "total_amount": 11.42,
- "transaction_id": "string",
- "document_number": "string",
- "document_date": "2024-10-08 16:19:42"
}, - "returned_receipt": {
- "uuid": "string",
- "type": "sale",
- "status": "new",
- "fiscal_id": "string",
- "created_at": "2024-10-08 16:19:42",
- "total_amount": 11.42,
- "transaction_id": "string",
- "document_number": "string",
- "document_date": "2024-10-08 16:19:42"
}, - "voided_receipt": {
- "uuid": "string",
- "type": "sale",
- "status": "new",
- "fiscal_id": "string",
- "created_at": "2024-10-08 16:19:42",
- "total_amount": 11.42,
- "transaction_id": "string",
- "document_number": "string",
- "document_date": "2024-10-08 16:19:42"
}, - "error_message": "string",
- "error_code": "string",
- "uuid": "string",
- "type": "sale",
- "status": "new",
- "fiscal_id": "string",
- "created_at": "2024-10-08 16:19:42",
- "total_amount": 11.42,
- "transaction_id": "string",
- "document_number": "string",
- "document_date": "2024-10-08 16:19:42"
}