Receipt Payments

The ReceiptPayments entity represents the payment details for a specific receipt, including the amount, payment method, and transaction status.

Fields

Field	Type	Description
id	Integer	Unique identifier (Primary Key).
date	DateTime	Date and time of the payment.
amount	Float	Payment amount.
type	Enum	Payment type (e.g., prepayment, payment, reversal).
canceled	Boolean	Flag indicating if the payment was reversed.
finalized	Boolean	Flag indicating if the payment transaction is finalized.
paymentService	Enum	The payment service provider used.
paymentEquipment	String	The hardware equipment used for the payment.
receipt	Relation	Link to the associated Receipt.
transactionData	JSON	Detailed technical data from the payment provider.
createdAt	DateTime	Metadata: Creation timestamp.
updatedAt	DateTime	Metadata: Last update timestamp.

---

Get List of Payments

Fetch a list of receipt payments.

Endpoint: POST /core/data/ReceiptPayments/select

Example Request:

{
  "fields": {
    "id": true,
    "date": true,
    "amount": true,
    "type": { "id": true, "value": true },
    "receipt": { "id": true, "number": 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 Payment

Retrieve details for a specific payment by ID.

Endpoint: POST /core/data/ReceiptPayments/select

Example Request:

{
  "fields": {
    "id": true,
    "amount": true,
    "finalized": true,
    "transactionData": true,
    "paymentService": true
  },
  "conditions": {
    "filters": [
      {
        "field": "id",
        "comparator": "=",
        "value": 5001
      }
    ]
  },
  "limit": 1
}