Skip to content
/POS Transaction

Lipp Connect API (1.1.0)

API for managing Lipp software.

Download OpenAPI description
index.json
index.yaml
Overview
Lipp Connect API Support
develop@linecker.at
Languages
Servers
Mock server
https://developer.lipp.cloud/_mock/apis/
Production server
https://connect.lipp.cloud/api/

POS Management

Operations

POS Transaction

Operations

Get invoice

Request

Security
ApiKeyAuth
Query
idstring(uuid)required
includeBookingsboolean
includePaymentsboolean
curl -i -X GET \
  'https://developer.lipp.cloud/_mock/apis/POSTransaction/GetInvoice?id=497f6eca-6276-4993-bfeb-53cbbbba6f08&includeBookings=true&includePayments=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

The invoice from the provided id

Bodyapplication/json
idstring(uuid)

Unique identifier of the invoice.

numberstring

Invoice number.

timestampstring(date-time)

Date and time when the invoice was created.

tableIdstring(uuid)

Identifier of the table related to this invoice.

tableInvoiceCarrierIdstring or null

Optional ID of the invoice carrier for the table.

One of:

Optional ID of the invoice carrier for the table.

string(uuid)
priceGrossTotalnumber(decimal)

Total gross price of the invoice.

customerSalutationIdstring or null

Optional salutation of the customer.

One of:

Optional salutation of the customer.

string(uuid)
customerName01string or null

First line of the customer name.

One of:

First line of the customer name.

string
customerName02string or null

Second line of the customer name.

One of:

Second line of the customer name.

string
customerStreetstring or null

Customer street.

One of:

Customer street.

string
customerZipstring or null

Customer ZIP code.

One of:

Customer ZIP code.

string
customerCitystring or null

Customer city.

One of:

Customer city.

string
customerCountryIdstring or null

Country ID of the customer.

One of:

Country ID of the customer.

string(uuid)
customerVatIdstring or null

Customer VAT ID.

One of:

Customer VAT ID.

string
customerIdstring or null

Reference to the customer.

One of:

Reference to the customer.

string(uuid)
headerTextstring or null

Optional header text printed on the invoice.

One of:

Optional header text printed on the invoice.

string
footerTextstring or null

Optional footer text printed on the invoice.

One of:

Optional footer text printed on the invoice.

string
isCancelledboolean

Indicates if the invoice is cancelled.

isRetrievedboolean

Indicates if the invoice was retrieved.

isCorrectedboolean

Indicates if the invoice was corrected.

correctedOnstring or null

Date and time when the invoice was corrected.

One of:

Date and time when the invoice was corrected.

string(date-time)
cancelledOnstring or null

Date and time when the invoice was cancelled.

One of:

Date and time when the invoice was cancelled.

string(date-time)
cancelledByUserIdstring or null

User who cancelled the invoice.

One of:

User who cancelled the invoice.

string(uuid)
cancelledInvoiceIdstring or null

Reference to the invoice that was cancelled.

One of:

Reference to the invoice that was cancelled.

string(uuid)
createdByUserIdstring(uuid)

User who created the invoice.

paymentMethodInfostring

Information about the payment method used.

dailyClosingIdstring or null

Reference to the related daily closing.

One of:

Reference to the related daily closing.

string(uuid)
statisticsValueDatestring(date)

Date used for statistical purposes.

invoiceTypeinteger

Type of the invoice (enum EnInvoiceType, e.g. 0 = Default, 10 = Effort, 20 = PMS Transfer).

customerNamestring or null

Full customer name (combined).

One of:

Full customer name (combined).

string
priceGrossTotalStringstring

Formatted string of total gross price.

wsNumberinteger

Workstation number where the invoice was generated.

bookingsArray of Booking (objects) or null
One of:

List of bookings that belong to this invoice.

invoicePaymentsArray of InvoicePayment (objects) or null
One of:

List of payments related to this invoice.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "number": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "tableId": "073fbfcb-cd05-4203-be18-a1ce6f8e4d2d",
  "tableInvoiceCarrierId": "f9e23206-19e9-41ee-8a1b-68b7b309475a",
  "priceGrossTotal": 0,
  "customerSalutationId": "1ba5ff7d-4edc-4741-b493-555d025422ca",
  "customerName01": "string",
  "customerName02": "string",
  "customerStreet": "string",
  "customerZip": "string",
  "customerCity": "string",
  "customerCountryId": "833fffc1-e3e6-4476-8b13-f07d365fbc21",
  "customerVatId": "string",
  "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  "headerText": "string",
  "footerText": "string",
  "isCancelled": true,
  "isRetrieved": true,
  "isCorrected": true,
  "correctedOn": "2019-08-24T14:15:22Z",
  "cancelledOn": "2019-08-24T14:15:22Z",
  "cancelledByUserId": "a450d7d4-5d4b-404b-bf98-d40f03e765e6",
  "cancelledInvoiceId": "1e0fc3b1-48c6-4bfb-99bf-b8436b8fd612",
  "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
  "paymentMethodInfo": "string",
  "dailyClosingId": "f4e63245-4f64-4c02-b2bc-16efb60900a7",
  "statisticsValueDate": "2019-08-24",
  "invoiceType": 0,
  "customerName": "string",
  "priceGrossTotalString": "string",
  "wsNumber": 0,
  "bookings": [
    { … }
  ],
  "invoicePayments": [
    { … }
  ]
}

Get invoices

Request

Security
ApiKeyAuth
Query
fromstring(date)required

Start date (inclusive) for filtering invoices.

Example: from=2025-06-11
tostring(date)required

End date (inclusive) for filtering invoices.

Example: to=2025-06-11
includeBookingsboolean
includePaymentsboolean
curl -i -X GET \
  'https://developer.lipp.cloud/_mock/apis/POSTransaction/GetInvoices?from=2025-06-11&to=2025-06-11&includeBookings=true&includePayments=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

A list of the invoices from the time period

Bodyapplication/jsonArray [
idstring(uuid)

Unique identifier of the invoice.

numberstring

Invoice number.

timestampstring(date-time)

Date and time when the invoice was created.

tableIdstring(uuid)

Identifier of the table related to this invoice.

tableInvoiceCarrierIdstring or null

Optional ID of the invoice carrier for the table.

One of:

Optional ID of the invoice carrier for the table.

string(uuid)
priceGrossTotalnumber(decimal)

Total gross price of the invoice.

customerSalutationIdstring or null

Optional salutation of the customer.

One of:

Optional salutation of the customer.

string(uuid)
customerName01string or null

First line of the customer name.

One of:

First line of the customer name.

string
customerName02string or null

Second line of the customer name.

One of:

Second line of the customer name.

string
customerStreetstring or null

Customer street.

One of:

Customer street.

string
customerZipstring or null

Customer ZIP code.

One of:

Customer ZIP code.

string
customerCitystring or null

Customer city.

One of:

Customer city.

string
customerCountryIdstring or null

Country ID of the customer.

One of:

Country ID of the customer.

string(uuid)
customerVatIdstring or null

Customer VAT ID.

One of:

Customer VAT ID.

string
customerIdstring or null

Reference to the customer.

One of:

Reference to the customer.

string(uuid)
headerTextstring or null

Optional header text printed on the invoice.

One of:

Optional header text printed on the invoice.

string
footerTextstring or null

Optional footer text printed on the invoice.

One of:

Optional footer text printed on the invoice.

string
isCancelledboolean

Indicates if the invoice is cancelled.

isRetrievedboolean

Indicates if the invoice was retrieved.

isCorrectedboolean

Indicates if the invoice was corrected.

correctedOnstring or null

Date and time when the invoice was corrected.

One of:

Date and time when the invoice was corrected.

string(date-time)
cancelledOnstring or null

Date and time when the invoice was cancelled.

One of:

Date and time when the invoice was cancelled.

string(date-time)
cancelledByUserIdstring or null

User who cancelled the invoice.

One of:

User who cancelled the invoice.

string(uuid)
cancelledInvoiceIdstring or null

Reference to the invoice that was cancelled.

One of:

Reference to the invoice that was cancelled.

string(uuid)
createdByUserIdstring(uuid)

User who created the invoice.

paymentMethodInfostring

Information about the payment method used.

dailyClosingIdstring or null

Reference to the related daily closing.

One of:

Reference to the related daily closing.

string(uuid)
statisticsValueDatestring(date)

Date used for statistical purposes.

invoiceTypeinteger

Type of the invoice (enum EnInvoiceType, e.g. 0 = Default, 10 = Effort, 20 = PMS Transfer).

customerNamestring or null

Full customer name (combined).

One of:

Full customer name (combined).

string
priceGrossTotalStringstring

Formatted string of total gross price.

wsNumberinteger

Workstation number where the invoice was generated.

bookingsArray of Booking (objects) or null
One of:

List of bookings that belong to this invoice.

invoicePaymentsArray of InvoicePayment (objects) or null
One of:

List of payments related to this invoice.

]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "number": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "tableId": "073fbfcb-cd05-4203-be18-a1ce6f8e4d2d",
    "tableInvoiceCarrierId": "f9e23206-19e9-41ee-8a1b-68b7b309475a",
    "priceGrossTotal": 0,
    "customerSalutationId": "1ba5ff7d-4edc-4741-b493-555d025422ca",
    "customerName01": "string",
    "customerName02": "string",
    "customerStreet": "string",
    "customerZip": "string",
    "customerCity": "string",
    "customerCountryId": "833fffc1-e3e6-4476-8b13-f07d365fbc21",
    "customerVatId": "string",
    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
    "headerText": "string",
    "footerText": "string",
    "isCancelled": true,
    "isRetrieved": true,
    "isCorrected": true,
    "correctedOn": "2019-08-24T14:15:22Z",
    "cancelledOn": "2019-08-24T14:15:22Z",
    "cancelledByUserId": "a450d7d4-5d4b-404b-bf98-d40f03e765e6",
    "cancelledInvoiceId": "1e0fc3b1-48c6-4bfb-99bf-b8436b8fd612",
    "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
    "paymentMethodInfo": "string",
    "dailyClosingId": "f4e63245-4f64-4c02-b2bc-16efb60900a7",
    "statisticsValueDate": "2019-08-24",
    "invoiceType": 0,
    "customerName": "string",
    "priceGrossTotalString": "string",
    "wsNumber": 0,
    "bookings": [ … ],
    "invoicePayments": [ … ]
  }
]

POS-PMS Interface

Operations
Terms
Copyright © Lipp Software GmbH. No rights reserved.