Receipts

The Receipts entity stores transaction data for sales, including totals, customer links, and related fiscal information.

Fields

Field	Type	Description
id	Integer	Unique identifier (Primary Key).
number	String	Receipt document number.
date	DateTime	Transaction date and time.
totalAmount	Float	Total amount.
paidAmount	Float	Amount paid.
fullAmount	Float	Full amount before discounts.
totalEntryPrice	Float	Total cost price of products.
customer	Relation	Relation to the Customers who made the purchase.
conveniq	Relation	Relation to the Conveniqs device.
fiscalService	String	Type of fiscal service used.
paymentService	String	Type of payment service used.
hasDebt	Boolean	Flag indicating if the receipt has unpaid debt.
isTesting	Boolean	Flag for test transactions.
frontalPhotos	File[]	Collection of photos related to the transaction.
createdAt	DateTime	Metadata: Creation timestamp.
updatedAt	DateTime	Metadata: Last update timestamp.

---

Get List of Receipts

Fetch a list of receipts with filters (e.g., by date or conveniq).

Endpoint: POST /core/data/Receipts/select

Example Request:

{
  "fields": {
    "id": true,
    "number": true,
    "totalAmount": true,
    "date": true,
    "customer": { "id": true, "name": true }
  },
  "conditions": {
    "operator": "and",
    "filters": [
      {
        "field": "date",
        "comparator": ">",
        "value": "2025-01-01T00:00:00Z"
      }
    ]
  },
  "orderBy": [
    {
      "field": "date",
      "order": "desc"
    }
  ],
  "limit": 50,
  "offset": 0
}

---

Get Single Receipt

Retrieve all details for a specific receipt by ID.

Endpoint: POST /core/data/Receipts/select

Example Request:

{
  "fields": {
    "id": true,
    "number": true,
    "fullAmount": true,
    "paidAmount": true,
    "date": true,
    "frontalPhotos": { "id": true, "fileName": true }
  },
  "conditions": {
    "filters": [
      {
        "field": "id",
        "comparator": "=",
        "value": 2001
      }
    ]
  },
  "limit": 1
}

---

Receipt Products (Table Part)

The ReceiptsProducts entity stores individual line items for a specific receipt.

Table Part Fields

Field	Type	Description
id	Integer	Unique identifier.
owner	Relation	Link to the parent Receipt.
product	Relation	Link to the Products entity.
quantity	Float	Quantity purchased.
price	Float	Price per unit.
amount	Float	Total line amount.
fullAmount	Float	Full amount before discount.
discount	Float	Applied discount.
fullDiscount	Float	Total discount for the line.
entryPrice	Float	Purchase price per unit.
totalEntryPrice	Float	Total cost price for the line.

---

Get Products for a Receipt

To fetch all products belonging to a specific receipt, filter by the owner.id field.

Endpoint: POST /core/data/ReceiptsProducts/select

Example Request:

{
  "fields": {
    "id": true,
    "product": { "id": true, "name": true, "barcode": true },
    "quantity": true,
    "price": true,
    "amount": true
  },
  "conditions": {
    "operator": "and",
    "filters": [
      {
        "field": "owner.id",
        "comparator": "=",
        "value": 2001 
      }
    ]
  },
  "limit": 500
}