Skip to content
API Reference/
/
Get transfers

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

POS-PMS Interface

Operations

Set inhouse guests

Request

Security
ApiKeyAuth
Bodyapplication/jsonrequiredArray [
reservationIdstring

Unique reservation id from the PMS System.

roomNrstring

Room number from the PMS System.

bedstring

Bed from the PMS System.

resTextstring

Reservation text from the PMS System.

guestNrstring

Guest number from the PMS System.

tableCodeinteger or null

Table code for mapping with the POS Table.

One of:

Table code for mapping with the POS Table.

integer
arrivalDatestring(date-time)

Date and time when the guest arrive.

departureDatestring(date-time)

Date and time when the guest depart.

]
curl -i -X POST \
  https://developer.lipp.cloud/_mock/apis/PMSInterface/SetInhouse \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '[
    {
      "reservationId": "string",
      "roomNr": "string",
      "bed": "string",
      "resText": "string",
      "guestNr": "string",
      "tableCode": 0,
      "arrivalDate": "2019-08-24T14:15:22Z",
      "departureDate": "2019-08-24T14:15:22Z"
    }
  ]'

Responses

Ok

Get transfers

Request

Security
ApiKeyAuth
Query
fromstring(date)required

Date for the transfers.

Example: from=2025-06-11
curl -i -X GET \
  'https://developer.lipp.cloud/_mock/apis/PMSInterface/GetTransfers?from=2025-06-11' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

A list of the transfers from the day

Bodyapplication/jsonArray [
_idstring(uuid)

Unique identifier

Example: "6c0df0b4-4a8a-4278-8b47-5e68f32b6658"
createdOnUTCstring(date-time)

Timestamp when the entity was created (UTC)

Example: "2025-01-23T12:34:56Z"
createdByUserNamestring

Username of the creator

Example: "Peter"
modifiedOnUTCstring or null

Timestamp when the entity was last modified (UTC)

One of:

Timestamp when the entity was last modified (UTC)

string(date-time)
modifiedByUserNamestring or null

Username of the last modifying user

One of:

Username of the last modifying user

string
numberstring

Pms transfer number.

roomNrstring

The room number.

bedstring

The bed.

resNrstring

The reservation number.

resTextstring

The reservation text.

guestNrinteger

The guest number

isTransferedboolean

Determense if the PMS Transfer is already transfered

invoiceIdstring(uuid)

The associated invoice id

invoiceobject(Invoice)

Represents an invoice in the POS system.

]
Response
application/json
[
  {
    "_id": "6c0df0b4-4a8a-4278-8b47-5e68f32b6658",
    "createdOnUTC": "2025-01-23T12:34:56Z",
    "createdByUserName": "Peter",
    "modifiedOnUTC": "2019-08-24T14:15:22Z",
    "modifiedByUserName": "string",
    "number": "string",
    "roomNr": "string",
    "bed": "string",
    "resNr": "string",
    "resText": "string",
    "guestNr": 0,
    "isTransfered": true,
    "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
    "invoice": { … }
  }
]

Get pending transfers

Request

Security
ApiKeyAuth
curl -i -X GET \
  https://developer.lipp.cloud/_mock/apis/PMSInterface/GetPendingTransfers \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

⚠️ Warning: Calling this endpoint marks all returned transfers as transferred.

Bodyapplication/jsonArray [
_idstring(uuid)

Unique identifier

Example: "6c0df0b4-4a8a-4278-8b47-5e68f32b6658"
createdOnUTCstring(date-time)

Timestamp when the entity was created (UTC)

Example: "2025-01-23T12:34:56Z"
createdByUserNamestring

Username of the creator

Example: "Peter"
modifiedOnUTCstring or null

Timestamp when the entity was last modified (UTC)

One of:

Timestamp when the entity was last modified (UTC)

string(date-time)
modifiedByUserNamestring or null

Username of the last modifying user

One of:

Username of the last modifying user

string
numberstring

Pms transfer number.

roomNrstring

The room number.

bedstring

The bed.

resNrstring

The reservation number.

resTextstring

The reservation text.

guestNrinteger

The guest number

isTransferedboolean

Determense if the PMS Transfer is already transfered

invoiceIdstring(uuid)

The associated invoice id

invoiceobject(Invoice)

Represents an invoice in the POS system.

]
Response
application/json
[
  {
    "_id": "6c0df0b4-4a8a-4278-8b47-5e68f32b6658",
    "createdOnUTC": "2025-01-23T12:34:56Z",
    "createdByUserName": "Peter",
    "modifiedOnUTC": "2019-08-24T14:15:22Z",
    "modifiedByUserName": "string",
    "number": "string",
    "roomNr": "string",
    "bed": "string",
    "resNr": "string",
    "resText": "string",
    "guestNr": 0,
    "isTransfered": true,
    "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
    "invoice": { … }
  }
]

Get daily revenues

Request

Security
ApiKeyAuth
Query
fromstring(date)required

Date for the transfers.

Example: from=2025-06-11
curl -i -X GET \
  'https://developer.lipp.cloud/_mock/apis/PMSInterface/GetDailyRevenues?from=2025-06-11' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Revenues from the day

Bodyapplication/json
datestring(date-time)
revenuesArray of objects(PMSRevenueDTO)
paymentsArray of objects(PMSPaymentDTO)
Response
application/json
{
  "date": "2019-08-24T14:15:22Z",
  "revenues": [
    { … }
  ],
  "payments": [
    { … }
  ]
}

Get transfer report

Request

Security
ApiKeyAuth
Query
transferIdstring(uuid)required

Id from the transfer.

Example: transferId=6BB44647-7AAC-452F-820F-FEDFFC8BA229
curl -i -X GET \
  'https://developer.lipp.cloud/_mock/apis/PMSInterface/GetTransferReport?transferId=6BB44647-7AAC-452F-820F-FEDFFC8BA229' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Get the PMS Transfer report in base64 as pdf

Bodyapplication/json
namestring
exportFormatinteger

0 = PDF

Default 0
contentBase64string(base64)
mdcInBase64string(base64)
Response
application/json
{
  "name": "string",
  "exportFormat": 0,
  "contentBase64": "string",
  "mdcInBase64": "string"
}
Terms
Copyright © Lipp Software GmbH. No rights reserved.