API docs by Redocly

Swoppen Soferu REST API (1.0)

Download OpenAPI specification:

API Support: service@swoppen.com URL: https://developer.swoppen.com License: GNU Lesser General Public License v3.0

Tickets

Tickets erstellen

Tickets

Authorizations:
(bearerAuthbasicAuth)
Request Body schema: application/json
required
cms_address_id
integer
cms_facility_id
integer
cl_checklist_id
integer
st_article_id
integer
st_cost_centre_id
integer
pms_project_id
integer
cms_contacting_id
integer
auf_task_id
integer
rm_item_id
integer
rm_booking_id
integer
pze_shift_id
integer
task
string
azn_time
string
st_customer_id
string

Kunden-Nr.

to_clear
boolean

Abrechnen

date
required
string <date-time>

Fällig

estimated_time
string

Erwartete Dauer Min.

subject
required
string

Titel

content
string

Beschreibung

remark
string

Notiz

priority
required
number

Priorität

Mögliche Werte: 1 = Blocker 2 = Kritisch 6 = Hoch 3 = Normal 4 = Geringfügig 5 = Trivial

status
number

Status

Mögliche Werte: 0 = Neu 1 = Offen 2 = In Bearbeitung 7 = Warte auf Freigabe 8 = Freigabe 6 = Klärung 3 = Wiedervorlage 4 = Erledigt 5 = Archiviert 9 = Abgelehnt default = Neu

sp_type_id
number

Typ

Mögliche Werte: 1 = Beispieltyp

sp_ticket_category_id
number

Kategorie

Mögliche Werte: 3 = adsf 2 = Housekeeping 1 = Rezepzion

per_activity_id
number

Bereich

Mögliche Werte: 2 = Entwicklung 4 = Marketing 3 = Service 1 = Anmeldung

bv_usergroup_id
number

Benutzergruppe

Mögliche Werte: 9 = restaurant 4 = Rezeption 5 = Stempeluhr

bv_user_id
integer
creator
string

Ersteller

tags
string

Tags

Responses

Request samples

Content type
application/json
{
  • "priority": 3,
  • "date": "2026-08-13 12:20:00",
  • "status": 0,
  • "subject": "Heizung defekt",
  • "content": "Die Heizung in Raum 2 fällt ständig aus."
}

Liste aller Tickets

Tickets

Authorizations:
(bearerAuthbasicAuth)
query Parameters
limit
integer <= 250
Default: 25
Example: limit=25

Anzahl der Elemente, die pro Seite zurückgegeben werden

page
integer
Default: 0

Auflistung der Elemente ab Seite

to_clear
string
sp_ticket_id
string

ID

title
string

Titel

subject
string

Titel

content
string

Beschreibung

category
integer
Enum: 3 2 1

Kategorie

Mögliche Werte: 3 = adsf 2 = Housekeeping 1 = Rezepzion

type
integer
Value: 1

Typ

Mögliche Werte: 1 = Beispieltyp

project
string

Projekt

st_customer_id
string

Kunden-Nr.

detector
string

Melder

usergroup
string

Gruppe

creator
string

Erstellt von

editor
string

Bearbeiter

date
string

Fällig

date_time
string

Uhrzeit

estimated_time
string

Soll

actual_time
string

Ist

created_date
string

Erstellt am

modified_date
string

Geändert am

closed_date
string

Geschlossen am

status
integer
Enum: 1 2 9 4 5 7 8 6 3

Status

Mögliche Werte: 1 = Offen 2 = In Bearbeitung 9 = Abgelehnt 4 = Erledigt 5 = Archiviert 7 = Warte auf Freigabe 8 = Freigabe 6 = Klärung 3 = Wiedervorlage

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    },
  • "code": 0,
  • "message": "string",
  • "date": "2019-08-24T14:15:22Z"
}

Tickets bearbeiten

Tickets

Authorizations:
(bearerAuthbasicAuth)
path Parameters
sp_ticket_id
required
integer
Request Body schema: application/json
required
cms_address_id
integer
cms_facility_id
integer
cl_checklist_id
integer
st_article_id
integer
st_cost_centre_id
integer
pms_project_id
integer
cms_contacting_id
integer
auf_task_id
integer
rm_item_id
integer
rm_booking_id
integer
pze_shift_id
integer
task
string
azn_time
string
st_customer_id
string

Kunden-Nr.

to_clear
boolean

Abrechnen

date
required
string <date-time>

Fällig

estimated_time
string

Erwartete Dauer Min.

subject
required
string

Titel

content
string

Beschreibung

remark
string

Notiz

priority
required
number

Priorität

Mögliche Werte: 1 = Blocker 2 = Kritisch 6 = Hoch 3 = Normal 4 = Geringfügig 5 = Trivial

status
number

Status

Mögliche Werte: 0 = Neu 1 = Offen 2 = In Bearbeitung 7 = Warte auf Freigabe 8 = Freigabe 6 = Klärung 3 = Wiedervorlage 4 = Erledigt 5 = Archiviert 9 = Abgelehnt default = Neu

sp_type_id
number

Typ

Mögliche Werte: 1 = Beispieltyp

sp_ticket_category_id
number

Kategorie

Mögliche Werte: 3 = adsf 2 = Housekeeping 1 = Rezepzion

per_activity_id
number

Bereich

Mögliche Werte: 2 = Entwicklung 4 = Marketing 3 = Service 1 = Anmeldung

bv_usergroup_id
number

Benutzergruppe

Mögliche Werte: 9 = restaurant 4 = Rezeption 5 = Stempeluhr

bv_user_id
integer
creator
string

Ersteller

tags
string

Tags

Responses

Request samples

Content type
application/json
""

Tickets löschen

Tickets

Authorizations:
(bearerAuthbasicAuth)
path Parameters
sp_ticket_id
required
integer

Responses

Tickets abfragen

Tickets

Authorizations:
(bearerAuthbasicAuth)
path Parameters
sp_ticket_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "cms_address_id": 0,
  • "cms_facility_id": 0,
  • "cl_checklist_id": 0,
  • "st_article_id": 0,
  • "st_cost_centre_id": 0,
  • "pms_project_id": 0,
  • "cms_contacting_id": 0,
  • "auf_task_id": 0,
  • "rm_item_id": 0,
  • "rm_booking_id": 0,
  • "pze_shift_id": 0,
  • "task": "string",
  • "azn_time": "string",
  • "st_customer_id": "string",
  • "to_clear": true,
  • "date": "2019-08-24T14:15:22Z",
  • "estimated_time": "string",
  • "subject": "string",
  • "content": "string",
  • "remark": "string",
  • "priority": 0,
  • "status": 0,
  • "sp_type_id": 0,
  • "sp_ticket_category_id": 0,
  • "per_activity_id": 0,
  • "bv_usergroup_id": 0,
  • "bv_user_id": 0,
  • "creator": "string",
  • "tags": "string"
}

Projekte

Projekte erstellen

Projekte

Authorizations:
(bearerAuthbasicAuth)
Request Body schema: application/json
required
pms_type_id
required
number

Typ

Mögliche Werte: Intern = Intern Kundenauftrag = Kundenauftrag

pms_project_no
required
string

Projekt-Nr.

name
required
string

Titel

description
string

Beschreibung

status_description
string

Status

st_customer_id
string

Kunden-Nr.

per_personnel_id
integer
status
number

Status

Mögliche Werte: 1 = Aktiv 0 = Inaktiv

progress
integer

Fortschritt Prozent

scheduled_start
string <date>

Beginn

scheduled_end
string <date>

Ende

cms_address_id
integer

Responses

Request samples

Content type
application/json
[ ]

Liste aller Projekte

Projekte

Authorizations:
(bearerAuthbasicAuth)
query Parameters
limit
integer <= 250
Default: 25
Example: limit=25

Anzahl der Elemente, die pro Seite zurückgegeben werden

page
integer
Default: 0

Auflistung der Elemente ab Seite

progress
string

Fortschritt

pms_project_no
string

Projekt-Nr.

name
string

Name

pms_type_id
string
Enum: "Intern" "Kundenauftrag"

Typ

Mögliche Werte: Intern = Intern Kundenauftrag = Kundenauftrag

st_customer_id
string

Kunden-Nr.

key_name
string

Suchname

responsible_person
string

Verantwortlicher

scheduled_start
string

Beginn

scheduled_end
string

Ende

status
integer
Enum: 1 2

Status

Mögliche Werte: 1 = Aktiv 2 = Inaktiv

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    },
  • "code": 0,
  • "message": "string",
  • "date": "2019-08-24T14:15:22Z"
}

Projekte bearbeiten

Projekte

Authorizations:
(bearerAuthbasicAuth)
path Parameters
pms_project_id
required
integer
Request Body schema: application/json
required
pms_type_id
required
number

Typ

Mögliche Werte: Intern = Intern Kundenauftrag = Kundenauftrag

pms_project_no
required
string

Projekt-Nr.

name
required
string

Titel

description
string

Beschreibung

status_description
string

Status

st_customer_id
string

Kunden-Nr.

per_personnel_id
integer
status
number

Status

Mögliche Werte: 1 = Aktiv 0 = Inaktiv

progress
integer

Fortschritt Prozent

scheduled_start
string <date>

Beginn

scheduled_end
string <date>

Ende

cms_address_id
integer

Responses

Request samples

Content type
application/json
""

Projekte löschen

Projekte

Authorizations:
(bearerAuthbasicAuth)
path Parameters
pms_project_id
required
integer

Responses

Projekte abfragen

Projekte

Authorizations:
(bearerAuthbasicAuth)
path Parameters
pms_project_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "pms_type_id": 0,
  • "pms_project_no": "string",
  • "name": "string",
  • "description": "string",
  • "status_description": "string",
  • "st_customer_id": "string",
  • "per_personnel_id": 0,
  • "status": 0,
  • "progress": 0,
  • "scheduled_start": "2019-08-24",
  • "scheduled_end": "2019-08-24",
  • "cms_address_id": 0
}

Artikel

Artikel erstellen

Artikel

Authorizations:
(bearerAuthbasicAuth)
Request Body schema: application/json
required
st_article_group_id
integer
st_article_id
required
string

Artikel-Nr.

name1
required
string

Bezeichnung 1

name2
string

Bezeichnung 2

name3
string

Bezeichnung 3

settings[color]
string

Farbe

st_article_model_id
string

Artikelmodell

ean
string

GTIN

ean2
string

GTIN (VE)

alternative_article
string

Ersatzartikel

draft
string

Zeichnung

manufacturer_article_no
string

Hersteller Artikel-Nr.

manufacturer
string
min_quantity_stored
string

min. Lagermenge

max_quantity_stored
string

max. Lagermenge

inventory_price
string

Ø EK-Preis

short_description
string

Kurzbeschreibung

sales_unit
string
article_factor
string

Inhalt/Menge

article_factor_unit
number

Mögliche Werte: s = pauschal Stück = Stück Person = pro Person 2second = pro Stk./Sek. 2minute = pro Stk./Min. 2hour = pro Stk./Std. 2night = pro Stk./Nacht 2day = pro Stk./Tag 2week = pro Stk./Woche 2month = pro Stk./Monat 2year = pro Stk./Jahr 1second = pro Person/Sek. 1minute = pro Person/Min. 1hour = pro Person/Std. 1night = pro Person/Nacht 1day = pro Person/Tag 1week = pro Person/Woche 1month = pro Person/Monat 1year = pro Person/Jahr second = pro Sekunde minute = pro Minute hour = pro Stunde night = pro Nacht day = pro Tag week = pro Woche month = pro Monat year = pro Jahr Packung = Packung St. = Stück Pers. = Person(en)

settings[show_basic_charge]
boolean

Grundpreis auszeichnen

settings[disable_price_group]
boolean

Preisgruppierung deaktivieren

purchase_unit
string
article_mass_unit
string
stocking_unit
string
weight
string

Brutto-Gewicht kg

weight_net
string

Netto-Gewicht kg

length
string

Länge cm

height
string

Höhe cm

width
string

Breite cm

volume
string

Volumen l

settings[capacity]
integer

Kapazität

st_cost_centre_id
integer
st_account_id
string

FiBu-Konto

settings[pms_project_id]
integer
valid_from
string <date>

gültig von

valid_until
string <date>

gültig bis

settings[email]
string

E-Mail

settings[ver_rate_id]
integer
settings[per_activity_id]
integer
copy_st_article_id
integer
type
string
description
string

Beschreibung

settings[note2]
string

Notiz 2

settings[note3]
string

Notiz 3

locked
boolean

Sperrvermerk

purchase_article
boolean

Einkaufsartikel

sales_article
boolean

Verkaufsartikel

shop_article
boolean

Shopartikel

allowance_possible
boolean

Rabattfähig

time_dependent
boolean

Zeitabhängig

disable_proposal
boolean

Kein Bestellvorschlag

disable_statistic
boolean

nicht umsatzrelevant

settings[is_dropshipping]
boolean

Dropshipping-Artikel

settings[is_coupon]
boolean

als Gutschein bestellbar

settings[is_included]
boolean

Enthaltene Leistung

settings[is_minibar]
boolean

Minibar

settings[is_self_checkout]
boolean

Self-Checkout

inventory_maintenance
boolean

Bestandsführung

is_serial_no
boolean

Seriennummer-Artikel

is_mhd
boolean

Mindesthaltbarkeitsdatum

is_charge
boolean

Charge

is_bill_of_material
boolean

Stücklistenartikel

inventory_maintenance2
boolean

Bestandsführung

inventory_maintenance_ek
boolean

Bestandsführung (Einkauf)

shop_article2
boolean

Preise aus Stückliste

settings[view_template]
string

Template

settings[shift_time]
integer

Rüstzeit Min

Responses

Request samples

Content type
application/json
[ ]

Liste aller Artikel

Artikel

Authorizations:
(bearerAuthbasicAuth)
query Parameters
limit
integer <= 250
Default: 25
Example: limit=25

Anzahl der Elemente, die pro Seite zurückgegeben werden

page
integer
Default: 0

Auflistung der Elemente ab Seite

st_article_id
string

Artikel-Nr.

group
string

Artikelgruppe

name1
string

Bezeichnung 1

name2
string

Bezeichnung 2

name3
string

Bezeichnung 3

st_article_model_id
string

Artikelmodell

ean
string

GTIN

ean2
string

GTIN 2

is_bill_of_material
string

Stückliste

alternative_article
string

Ersatzartikel

draft
string

Zeichnung

manufacturer_article_no
string

Hersteller Artikel-Nr.

manufacturer_key_name
string

Hersteller

article_number
string

Lief. Artikel-Nr.

supplier_key_name
string

Lieferant

ek_price
string

EK-Preis

inventory_price
string

Ø EK-Preis

sales_unit
string

Verkaufspreis pro

purchase_unit
string

Einkaufspreis pro

article_mass_unit
string

Artikelmasse pro

stocking_unit
string

Lagermenge in

st_account_id
string

FiBu-Konto

weight
string

Nettogewicht

weight_net
string

Bruttogewicht

article_length
string

Länge

height
string

Höhe

width
string

Breite

volume
string

Volumen

valid_from
string

gültig von

valid_until
string

gültig bis

locked
string

Sperrvermerk

purchase_article
string

Einkaufsartikel

sales_article
string

Verkaufsartikel

inventory_maintenance
string

Bestandsführung

shop_article
string

Shopartikel

allowance_possible
string

Rabattfähig

is_part_of_variant
string

Variantenartikel

st_cost_centre_no
string

Kostenstellen-Nr.

cost_centre
string

Kostenstelle

bf_current
string

Bestand

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    },
  • "code": 0,
  • "message": "string",
  • "date": "2019-08-24T14:15:22Z"
}

Artikel bearbeiten

Artikel

Authorizations:
(bearerAuthbasicAuth)
path Parameters
st_article_id
required
integer
Request Body schema: application/json
required
st_article_group_id
integer
st_article_id
required
string

Artikel-Nr.

name1
required
string

Bezeichnung 1

name2
string

Bezeichnung 2

name3
string

Bezeichnung 3

settings[color]
string

Farbe

st_article_model_id
string

Artikelmodell

ean
string

GTIN

ean2
string

GTIN (VE)

alternative_article
string

Ersatzartikel

draft
string

Zeichnung

manufacturer_article_no
string

Hersteller Artikel-Nr.

manufacturer
string
min_quantity_stored
string

min. Lagermenge

max_quantity_stored
string

max. Lagermenge

inventory_price
string

Ø EK-Preis

short_description
string

Kurzbeschreibung

sales_unit
string
article_factor
string

Inhalt/Menge

article_factor_unit
number

Mögliche Werte: s = pauschal Stück = Stück Person = pro Person 2second = pro Stk./Sek. 2minute = pro Stk./Min. 2hour = pro Stk./Std. 2night = pro Stk./Nacht 2day = pro Stk./Tag 2week = pro Stk./Woche 2month = pro Stk./Monat 2year = pro Stk./Jahr 1second = pro Person/Sek. 1minute = pro Person/Min. 1hour = pro Person/Std. 1night = pro Person/Nacht 1day = pro Person/Tag 1week = pro Person/Woche 1month = pro Person/Monat 1year = pro Person/Jahr second = pro Sekunde minute = pro Minute hour = pro Stunde night = pro Nacht day = pro Tag week = pro Woche month = pro Monat year = pro Jahr Packung = Packung St. = Stück Pers. = Person(en)

settings[show_basic_charge]
boolean

Grundpreis auszeichnen

settings[disable_price_group]
boolean

Preisgruppierung deaktivieren

purchase_unit
string
article_mass_unit
string
stocking_unit
string
weight
string

Brutto-Gewicht kg

weight_net
string

Netto-Gewicht kg

length
string

Länge cm

height
string

Höhe cm

width
string

Breite cm

volume
string

Volumen l

settings[capacity]
integer

Kapazität

st_cost_centre_id
integer
st_account_id
string

FiBu-Konto

settings[pms_project_id]
integer
valid_from
string <date>

gültig von

valid_until
string <date>

gültig bis

settings[email]
string

E-Mail

settings[ver_rate_id]
integer
settings[per_activity_id]
integer
copy_st_article_id
integer
type
string
description
string

Beschreibung

settings[note2]
string

Notiz 2

settings[note3]
string

Notiz 3

locked
boolean

Sperrvermerk

purchase_article
boolean

Einkaufsartikel

sales_article
boolean

Verkaufsartikel

shop_article
boolean

Shopartikel

allowance_possible
boolean

Rabattfähig

time_dependent
boolean

Zeitabhängig

disable_proposal
boolean

Kein Bestellvorschlag

disable_statistic
boolean

nicht umsatzrelevant

settings[is_dropshipping]
boolean

Dropshipping-Artikel

settings[is_coupon]
boolean

als Gutschein bestellbar

settings[is_included]
boolean

Enthaltene Leistung

settings[is_minibar]
boolean

Minibar

settings[is_self_checkout]
boolean

Self-Checkout

inventory_maintenance
boolean

Bestandsführung

is_serial_no
boolean

Seriennummer-Artikel

is_mhd
boolean

Mindesthaltbarkeitsdatum

is_charge
boolean

Charge

is_bill_of_material
boolean

Stücklistenartikel

inventory_maintenance2
boolean

Bestandsführung

inventory_maintenance_ek
boolean

Bestandsführung (Einkauf)

shop_article2
boolean

Preise aus Stückliste

settings[view_template]
string

Template

settings[shift_time]
integer

Rüstzeit Min

Responses

Request samples

Content type
application/json
""

Artikel löschen

Artikel

Authorizations:
(bearerAuthbasicAuth)
path Parameters
st_article_id
required
integer

Responses

Artikel abfragen

Artikel

Authorizations:
(bearerAuthbasicAuth)
path Parameters
st_article_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "st_article_group_id": 0,
  • "st_article_id": "string",
  • "name1": "string",
  • "name2": "string",
  • "name3": "string",
  • "settings[color]": "string",
  • "st_article_model_id": "string",
  • "ean": "string",
  • "ean2": "string",
  • "alternative_article": "string",
  • "draft": "string",
  • "manufacturer_article_no": "string",
  • "manufacturer": "string",
  • "min_quantity_stored": "string",
  • "max_quantity_stored": "string",
  • "inventory_price": "string",
  • "short_description": "string",
  • "sales_unit": "string",
  • "article_factor": "string",
  • "article_factor_unit": 0,
  • "settings[show_basic_charge]": true,
  • "settings[disable_price_group]": true,
  • "purchase_unit": "string",
  • "article_mass_unit": "string",
  • "stocking_unit": "string",
  • "weight": "string",
  • "weight_net": "string",
  • "length": "string",
  • "height": "string",
  • "width": "string",
  • "volume": "string",
  • "settings[capacity]": 0,
  • "st_cost_centre_id": 0,
  • "st_account_id": "string",
  • "settings[pms_project_id]": 0,
  • "valid_from": "2019-08-24",
  • "valid_until": "2019-08-24",
  • "settings[email]": "string",
  • "settings[ver_rate_id]": 0,
  • "settings[per_activity_id]": 0,
  • "copy_st_article_id": 0,
  • "type": "string",
  • "description": "string",
  • "settings[note2]": "string",
  • "settings[note3]": "string",
  • "locked": true,
  • "purchase_article": true,
  • "sales_article": true,
  • "shop_article": true,
  • "allowance_possible": true,
  • "time_dependent": true,
  • "disable_proposal": true,
  • "disable_statistic": true,
  • "settings[is_dropshipping]": true,
  • "settings[is_coupon]": true,
  • "settings[is_included]": true,
  • "settings[is_minibar]": true,
  • "settings[is_self_checkout]": true,
  • "inventory_maintenance": true,
  • "is_serial_no": true,
  • "is_mhd": true,
  • "is_charge": true,
  • "is_bill_of_material": true,
  • "inventory_maintenance2": true,
  • "inventory_maintenance_ek": true,
  • "shop_article2": true,
  • "settings[view_template]": "string",
  • "settings[shift_time]": 0
}

Revenue Management

Vorberechnete und Live-Daten für Revenue Management Systeme. Cache-Strategie: occupancy/bookings/forecast via Cache (TTL 1h), rates live.

Belegung & KPIs

Tägliche oder monatliche Belegungs-KPIs je Zimmerkategorie. Cache TTL 1h.

Authorizations:
(bearerAuthbasicAuth)
query Parameters
date_from
required
string <date>
Example: date_from=2024-06-01

Startdatum Y-m-d

date_until
required
string <date>
Example: date_until=2024-06-30

Enddatum Y-m-d

cms_client_id
integer

Mandant-ID (Standard: aktiver Client)

granularity
string
Default: "daily"
Enum: "daily" "monthly"

Aggregierungsebene

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2026-08-13 12:20:04",
  • "source": "cache",
  • "data": [
    ]
}

Preise & Raten lesen

Raten je Zimmerkategorie und Tag. Tagespreis aus swo_rm_article_contingents, sonst Listenpreis aus swo_st_prices. Immer live (kein Cache).

Authorizations:
(bearerAuthbasicAuth)
query Parameters
date_from
required
string <date>
Example: date_from=2024-06-01

Startdatum Y-m-d

date_until
required
string <date>
Example: date_until=2024-06-30

Enddatum Y-m-d

cms_client_id
integer

Mandant-ID (Standard: aktiver Client)

st_price_list_id
string

Preisliste (Standard: Mandanten-Preisliste)

st_article_id
string

Nur diese Zimmerkategorie

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2019-08-24T14:15:22Z",
  • "data": [
    ]
}

Preise & Raten schreiben

Schreibt Raten in swo_rm_article_contingents. Existierende Einträge werden aktualisiert (is_rate_modified = 1), neue angelegt. Preisliste aus ClientSettings, überschreibbar per st_price_list_id.

Authorizations:
(bearerAuthbasicAuth)
query Parameters
cms_client_id
integer

Mandant-ID

Request Body schema: application/json
required
Array
st_article_id
required
integer

Zimmerkategorie-ID

date
required
string <date>

Datum Y-m-d

price
required
number <float>

Neuer Preis

st_price_list_id
integer

Preislisten-ID (optional, Standard aus ClientSettings)

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Ungültige oder fehlende Parameter",
  • "date": "2026-08-13 12:20:04"
}

Buchungen & Reservierungen

Aggregierte Buchungszahlen nach Anreisetag, Channel (b.source) und Zimmerkategorie. Cache TTL 1h.

Authorizations:
(bearerAuthbasicAuth)
query Parameters
date_from
required
string <date>
Example: date_from=2024-06-01

Startdatum Y-m-d

date_until
required
string <date>
Example: date_until=2024-06-30

Enddatum Y-m-d

cms_client_id
integer

Mandant-ID (Standard: aktiver Client)

granularity
string
Default: "daily"
Enum: "daily" "monthly"

Aggregierungsebene

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2026-08-13 12:20:04",
  • "source": "cache",
  • "data": [
    ]
}

On-The-Books Forecast

OTB-Stand je Tag: Belegung und Umsatz (Logis, F&B, Sonstiges) anteilig verteilt. Cache TTL 1h. budget_revenue / variance_pct sind null bis Budget-System angebunden.

Authorizations:
(bearerAuthbasicAuth)
query Parameters
date_from
required
string <date>
Example: date_from=2024-06-01

Startdatum Y-m-d

date_until
required
string <date>
Example: date_until=2024-06-30

Enddatum Y-m-d

cms_client_id
integer

Mandant-ID (Standard: aktiver Client)

granularity
string
Default: "daily"
Enum: "daily" "monthly"

Aggregierungsebene

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2026-08-13 12:20:04",
  • "source": "cache",
  • "data": [
    ]
}

FiBu Export

Einheitlicher FiBu-Export-Endpoint. Unterstützt DATEV und Diamant. Format wird aus ClientSettings gelesen, kann per Parameter überschrieben werden.

FiBu-Export starten

Startet den FiBu-Export für den angegebenen Zeitraum.

Format-Auflösung: Parameter format > ClientSettings fibu_format > Fallback datev

Rückgabe: JSON mit download_url (TTL 1h) zur ZIP-Datei.

Positionen mit fehlenden FiBu-Konten werden in missing_fields zurückgegeben — der Export wird abgebrochen.

lock=true: Exportiert nur nicht-festgeschriebene Belege und schreibt diese nach erfolgreichem Export fest (GoBD-konform, is_transfered_fibu = 1). Verhindert Doppelexporte.

Hinweis: datev_xml exportiert nur Belegbilder (PDFs), keine Buchungssätze — missing_fields ist immer leer.

HTTP 422: Export hat keine Daten geliefert oder alle Positionen haben fehlende Konten.

Authorizations:
(bearerAuthbasicAuth)
query Parameters
from
required
string <date>
Example: from=2024-06-01

Startdatum Y-m-d

until
required
string <date>
Example: until=2024-06-30

Enddatum Y-m-d

cms_client_id
integer

Mandant-ID (Standard: aktiver Client)

lock
boolean
Default: false

Belege nach Export festschreiben (GoBD-konform). true = nur nicht-festgeschriebene Belege exportieren + nach Export festschreiben. false (Standard) = alle Belege exportieren, kein Festschreiben.

format
string
Enum: "datev" "datev_xml" "diamant"

Export-Format (Standard aus ClientSettings: fibu_format).

datev = DATEV Buchungsstapel CSV (Buchungsdaten)

datev_xml = DATEV XML mit Belegbildern (PDFs)

diamant = Diamant FiBu CSV

type[]
Array of strings
Items Enum: "VK" "FI" "KB"
Example: type[]=VK&type[]=FI

Export-Typen (mehrfach angeben möglich). Default: alle drei. VK = Rechnungen/Gutschriften, FI = Zahlungen & Anzahlungen, KB = Kassenbuch

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2024-06-01 10:00:00",
  • "download_url": "/API/fibu/download?path=L3Zhci93d3cv...&token=1781250413.08d0...",
  • "path": "L3Zhci93d3cvdml0YWxpc2VybWFubnRyYXV0...",
  • "token": "1781250413.08d0db7238c10b6da0888842ac7bb25b...",
  • "filename": "DATEV-2024-06-01-2024-06-30.zip",
  • "format": "datev",
  • "types": [
    ],
  • "locked": false,
  • "missing_fields": [ ],
  • "warnings": [ ]
}

ZIP-Datei herunterladen

Liefert die ZIP-Datei des FiBu-Exports als Binary-Download. Der path- und token-Parameter kommen aus der download_url der Export-Response. Token ist 1 Stunde gültig.

Authorizations:
(bearerAuthbasicAuth)
query Parameters
path
required
string

Base64-kodierter Dateipfad (aus download_url)

token
required
string

Signierter Download-Token (aus download_url)

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Ungültige oder fehlende Parameter",
  • "date": "2026-08-13 12:20:04"
}

Services

Leistungen auf Buchungen, Zimmer, Gäste oder beliebige Objekte buchen.

Leistung(en) buchen

Bucht eine oder mehrere Leistungen.

Einzelbuchung: Objekt direkt übergeben → HTTP 201.

Batch: Array von Objekten → HTTP 207 (Multi-Status). Jede Position hat ein eigenes success-Flag.

Zielobjekt: cms_object + id bestimmen worauf gebucht wird.

Authorizations:
(bearerAuthbasicAuth)
Request Body schema: application/json
required
One of
cms_object
required
string
Enum: "rm_booking_id" "rm_item_id" "cms_address_id" "sp_ticket_id"

Typ des Zielobjekts

id
required
integer

ID des Zielobjekts

rm_booking_id
integer

Buchungs-ID (wenn cms_object = rm_booking_id)

rm_item_id
integer

Zimmer-ID (wenn service_for = room)

cms_address_id
integer

Gast-Adress-ID (wenn service_for = guest)

cms_client_id
integer

Mandant-ID (Standard: aktiver Client)

st_article_id
required
string

Artikel-ID

price
required
number <float>

Preis (Brutto oder Netto je nach ClientSettings isNetPricing)

quantity
number <float>
Default: 1
time_quantity
number <float>
Default: 1

Zeitmenge (z.B. Anzahl Nächte)

st_quantity_unit_id
required
string

Mengeneinheit-ID

tax
integer or null

Steuersatz in % (z.B. 19, 7, 0). Optional — wird der passende Steuerschlüssel automatisch ermittelt. Ohne Angabe: Standard-Umsatzsteuerschlüssel des Mandanten.

pos_discount
number <float>
Default: 0

Rabatt in %

date
string <date>

Leistungsdatum (Einzeltag)

date_from
string <date>

Leistungszeitraum von

date_until
string <date>

Leistungszeitraum bis

text
string

Leistungstext

description
string

Beschreibung

is_hidden
integer
Default: 0
Enum: 0 1

Auf Belegen verstecken

is_included
integer
Default: 0
Enum: 0 1

Leistung ist im Paketpreis enthalten

Responses

Request samples

Content type
application/json
Example
{
  • "cms_object": "rm_booking_id",
  • "id": 42,
  • "cms_client_id": 1,
  • "st_article_id": "Fr",
  • "price": 12.5,
  • "quantity": 2,
  • "time_quantity": 1,
  • "st_quantity_unit_id": "St.",
  • "tax": 19,
  • "date": "2024-06-01",
  • "text": "Frühstück"
}

Response samples

Content type
application/json
{
  • "code": 201,
  • "message": "",
  • "date": "2024-06-01 10:00:00",
  • "results": [
    ]
}

Kunden

Kundenstammdaten (Adresse, Person, Debitor). Resource-ID ist st_customer_id. Auth: API-Host + HostLimitation auf die Schnittstelle customers.

Kundenliste

Paginierte Liste aus dem Kundenadresskatalog.

Authorizations:
(bearerAuthbasicAuth)
query Parameters
limit
integer
Example: limit=25

Treffer pro Seite

page
integer
Example: page=1

Seite (ab 1)

cms_client_id
integer

Mandant-ID (Standard: aktiver Client)

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2026-08-13 12:20:04",
  • "source": "cache",
  • "data": [
    ]
}

Kunde anlegen

Legt Kunde, Adresse und Person an. Ohne st_customer_id wird die nächste freie Nummer vergeben.

Authorizations:
(bearerAuthbasicAuth)
Request Body schema: application/json
required
st_customer_id
string

Kunden-Nr.

cms_client_id
integer
cms_address_id
integer
cms_person_id
integer
cms_address_catalogue_id
integer
key_name
string

Suchname

company
string
name
string
first_name
string
title
string
sex
string
Enum: "m" "w" "d" ""
birthdate
string <date>
address
string

Anrede

street
string
zip
string
location
string
cms_country_iso_code
string
tel1
string
mobile
string
fax
string
email
string <email>
email2
string <email>
email_invoice
string <email>
www
string
vat_id
string
tax_id
string
st_account_id
string

Debitorenkonto

st_payment_method_id
string

Zahlungsweise

st_payment_target_id
string
st_payment_agreement_id
string
st_price_list_id
string
st_delivery_term_id
string
st_federation_id
string
credit_limit
number
discount_procent
number
customer_from
string <date>
customer_until
string <date>
remark
string

Responses

Request samples

Content type
application/json
{
  • "name": "Mustermann",
  • "first_name": "Max",
  • "street": "Musterstraße 1",
  • "zip": "10115",
  • "location": "Berlin",
  • "email": "max@example.com"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2026-08-13 12:20:04",
  • "data": {
    }
}

Kunde lesen

Authorizations:
(bearerAuthbasicAuth)
path Parameters
id
required
string
Example: 10001

Kunden-Nr. (st_customer_id)

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2026-08-13 12:20:04",
  • "data": {
    }
}

Kunde ändern

Teilupdate. PUT und PATCH sind ebenfalls erlaubt.

Authorizations:
(bearerAuthbasicAuth)
path Parameters
id
required
string
Example: 10001

Kunden-Nr. (st_customer_id)

Request Body schema: application/json
required
st_customer_id
string

Kunden-Nr.

cms_client_id
integer
cms_address_id
integer
cms_person_id
integer
cms_address_catalogue_id
integer
key_name
string

Suchname

company
string
name
string
first_name
string
title
string
sex
string
Enum: "m" "w" "d" ""
birthdate
string <date>
address
string

Anrede

street
string
zip
string
location
string
cms_country_iso_code
string
tel1
string
mobile
string
fax
string
email
string <email>
email2
string <email>
email_invoice
string <email>
www
string
vat_id
string
tax_id
string
st_account_id
string

Debitorenkonto

st_payment_method_id
string

Zahlungsweise

st_payment_target_id
string
st_payment_agreement_id
string
st_price_list_id
string
st_delivery_term_id
string
st_federation_id
string
credit_limit
number
discount_procent
number
customer_from
string <date>
customer_until
string <date>
remark
string

Responses

Request samples

Content type
application/json
{
  • "email": "neu@example.com",
  • "tel1": "+493012345"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2026-08-13 12:20:04",
  • "data": {
    }
}

Kunde ändern

Authorizations:
(bearerAuthbasicAuth)
path Parameters
id
required
string
Example: 10001

Kunden-Nr. (st_customer_id)

Request Body schema: application/json
required
st_customer_id
string

Kunden-Nr.

cms_client_id
integer
cms_address_id
integer
cms_person_id
integer
cms_address_catalogue_id
integer
key_name
string

Suchname

company
string
name
string
first_name
string
title
string
sex
string
Enum: "m" "w" "d" ""
birthdate
string <date>
address
string

Anrede

street
string
zip
string
location
string
cms_country_iso_code
string
tel1
string
mobile
string
fax
string
email
string <email>
email2
string <email>
email_invoice
string <email>
www
string
vat_id
string
tax_id
string
st_account_id
string

Debitorenkonto

st_payment_method_id
string

Zahlungsweise

st_payment_target_id
string
st_payment_agreement_id
string
st_price_list_id
string
st_delivery_term_id
string
st_federation_id
string
credit_limit
number
discount_procent
number
customer_from
string <date>
customer_until
string <date>
remark
string

Responses

Request samples

Content type
application/json
{
  • "st_customer_id": "10001",
  • "cms_client_id": 0,
  • "cms_address_id": 0,
  • "cms_person_id": 0,
  • "cms_address_catalogue_id": 0,
  • "key_name": "Mustermann, Max",
  • "company": "string",
  • "name": "Mustermann",
  • "first_name": "Max",
  • "title": "string",
  • "sex": "m",
  • "birthdate": "2019-08-24",
  • "address": "string",
  • "street": "string",
  • "zip": "string",
  • "location": "string",
  • "cms_country_iso_code": "DE",
  • "tel1": "string",
  • "mobile": "string",
  • "fax": "string",
  • "email": "user@example.com",
  • "email2": "user@example.com",
  • "email_invoice": "user@example.com",
  • "www": "string",
  • "vat_id": "string",
  • "tax_id": "string",
  • "st_account_id": "string",
  • "st_payment_method_id": "string",
  • "st_payment_target_id": "string",
  • "st_payment_agreement_id": "string",
  • "st_price_list_id": "string",
  • "st_delivery_term_id": "string",
  • "st_federation_id": "string",
  • "credit_limit": 0,
  • "discount_procent": 0,
  • "customer_from": "2019-08-24",
  • "customer_until": "2019-08-24",
  • "remark": "string"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2026-08-13 12:20:04",
  • "data": {
    }
}

Kunde löschen

Löscht Kunde, Adresse und Person. HTTP 409 wenn der Datensatz noch verwendet wird (Belege, Buchungen, Zuordnungen).

Authorizations:
(bearerAuthbasicAuth)
path Parameters
id
required
string
Example: 10001

Kunden-Nr. (st_customer_id)

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Ungültige oder fehlende Parameter",
  • "date": "2026-08-13 12:20:04"
}

Belegungen

Hotel-Belegungen anlegen, lesen und Check-In/Check-Out. Resource-ID ist rm_booking_id. Auth: API-Host + HostLimitation auf die Schnittstelle bookings.

Belegungsliste

Paginierte Liste der Belegungen (zimmerbasiert, wie im Hotel-Manager).

Authorizations:
(bearerAuthbasicAuth)
query Parameters
limit
integer
Example: limit=25

Treffer pro Seite

page
integer
Example: page=1

Seite (ab 1)

cms_client_id
integer

Mandant-ID (Standard: aktiver Client)

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2026-08-13 12:20:04",
  • "source": "cache",
  • "data": [
    ]
}

Belegung anlegen

Legt Belegungskopf und mindestens ein Zimmer an. Ohne rm_resource_id wird anhand st_article_id ein freies Zimmer im Zeitraum zugeordnet. HTTP 409 wenn keines frei ist. Belegungsnummer kommt aus dem Nummernkreis HM. Preis wird aus der Preisliste berechnet, sofern price nicht gesetzt ist.

Authorizations:
(bearerAuthbasicAuth)
Request Body schema: application/json
required
rm_booking_id
integer

Interne Belegungs-ID (Resource-ID, nur lesend)

rm_booking_no
string

Belegungsnummer (Nummernkreis HM, nur lesend)

rm_catalogue_id
string

Katalog. Immer HM bei diesem Endpoint.

cms_client_id
integer

Mandant-ID

st_customer_id
string

Kunden-Nr. Pflicht beim Anlegen, sofern cms_address_id fehlt. cms_address_id wird dann vom Kunden übernommen.

cms_address_id
integer

Adress-ID. Nur nötig ohne st_customer_id. Mit st_customer_id wird sie vom Kunden genommen.

name
string

Anzeigename. Leer = Nachname des Kunden.

from
required
string <date>

Anreise. Auf Root-Ebene wenn nur ein Zimmer, sonst in items[].

until
required
string <date>

Abreise.

rm_resource_id
integer

Zimmer-ID. Optional. Ohne Angabe wird ein freies Zimmer zur st_article_id zugeordnet.

room_number
string

Zimmernummer bei einem Zimmer ohne items[].

token
string

Zimmerkürzel bei einem Zimmer ohne items[].

st_article_id
string

Logis-Artikel / Zimmerkategorie. Pflicht ohne rm_resource_id.

st_price_list_id
string

Preisliste für alle Zimmer, sofern nicht in items[] gesetzt.

quantity
integer
Default: 1

Personen / Erwachsene (ein Zimmer).

children
integer
Default: 0

Kinder (ein Zimmer).

status
integer
Enum: 0 1 2 3 4 5 13 15 16 30

Zimmerstatus: 0 = Reservierung, 1 = Check-In, 2 = Check-Out, 3 = Storniert, 4 = Anfrage/Option, 13 = bestätigt (Channel), 30 = No-Show. Standard beim Anlegen: 0.

price
number <float>

Optionaler Festpreis (Brutto, pro Nacht/Preiszeile). Weglassen = Preisliste.

price_gross
number <float>

Alias für price.

remark
string

Bemerkung zur Belegung

source
string

Herkunft. Standard: api.

source_no
string

Externe Vorgangsnummer der Quelle

send_notification
integer
Default: 0
Enum: 0 1

1 = Reservierungsbestätigung versenden. Standard: 0.

reserved_date
string <date-time>

Reservierungsdatum (nur lesend)

access_token
string

Zugangstoken (nur lesend)

Array of objects

Zimmer. Beim Anlegen optional: ohne items[] gelten from/until/Zimmerfelder auf Root-Ebene als ein Zimmer.

Responses

Request samples

Content type
application/json
{
  • "st_customer_id": "10001",
  • "from": "2026-08-20",
  • "until": "2026-08-22",
  • "st_article_id": "DZ",
  • "quantity": 2,
  • "children": 0,
  • "price": 129,
  • "status": 0,
  • "remark": "",
  • "source": "api"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2026-08-13 12:20:04",
  • "data": {
    }
}

Belegung lesen

Authorizations:
(bearerAuthbasicAuth)
path Parameters
id
required
integer
Example: 12345

Immer rm_booking_id. Einzelnes Zimmer nur über rm_item_id im Body/Query (IDs können identisch sein).

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2026-08-13 12:20:04",
  • "data": {
    }
}

Status ändern (Check-In / Check-Out)

URL-{id} ist immer rm_booking_id. Einzelnes Zimmer: rm_item_id im Body oder Query — nicht aus der URL raten, rm_item_id und rm_booking_id können denselben Wert haben.

Authorizations:
(bearerAuthbasicAuth)
path Parameters
id
required
integer
Example: 12345

Immer rm_booking_id. Einzelnes Zimmer nur über rm_item_id im Body/Query (IDs können identisch sein).

Request Body schema: application/json
required
required
integer or string

1 / checkin = Check-In, 2 / checkout = Check-Out.

rm_item_id
integer

Zimmer-/Buchungs-ID (swo_rm_items). Nur dieses Zimmer ein- oder auschecken.

room_number
string

Alternative zu rm_item_id: Zimmernummer innerhalb der Belegung.

token
string

Alternative zu rm_item_id: Zimmerkürzel innerhalb der Belegung.

Responses

Request samples

Content type
application/json
{
  • "status": "checkin",
  • "rm_item_id": 9001
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2026-08-13 12:20:04",
  • "data": {
    }
}

Check-In

URL-{id} ist immer rm_booking_id. Nur ein Zimmer: rm_item_id oder room_number im Body/Query. Ohne Angabe: alle Zimmer der Belegung.

Authorizations:
(bearerAuthbasicAuth)
path Parameters
id
required
integer
Example: 12345

Immer rm_booking_id. Einzelnes Zimmer nur über rm_item_id im Body/Query (IDs können identisch sein).

Request Body schema: application/json
optional
rm_item_id
integer

Nur dieses Zimmer (rm_item_id)

room_number
string

Nur dieses Zimmer, per Zimmernummer

Responses

Request samples

Content type
application/json
{
  • "rm_item_id": 9001
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2026-08-13 12:20:04",
  • "data": {
    }
}

Check-Out

URL-{id} ist immer rm_booking_id. Nur ein Zimmer: rm_item_id oder room_number im Body/Query. Ohne Angabe: alle Zimmer der Belegung.

Authorizations:
(bearerAuthbasicAuth)
path Parameters
id
required
integer
Example: 12345

Immer rm_booking_id. Einzelnes Zimmer nur über rm_item_id im Body/Query (IDs können identisch sein).

Request Body schema: application/json
optional
rm_item_id
integer

Nur dieses Zimmer (rm_item_id)

room_number
string

Nur dieses Zimmer, per Zimmernummer

Responses

Request samples

Content type
application/json
{
  • "rm_item_id": 9001
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2026-08-13 12:20:04",
  • "data": {
    }
}

Anzahlungen

Anzahlungen anlegen, lesen, ändern und Zahlungen/Teilrechnungen erzeugen. Resource-ID ist vk_deposit_id. Auth: API-Host + HostLimitation auf die Schnittstelle deposits.

Anzahlungsliste

Paginierte Liste der Anzahlungen.

Authorizations:
(bearerAuthbasicAuth)
query Parameters
limit
integer
Example: limit=25

Treffer pro Seite

page
integer
Example: page=1

Seite (ab 1)

cms_client_id
integer

Mandant-ID (Standard: aktiver Client)

rm_booking_id
integer

Nur Anzahlungen dieser Belegung

st_customer_id
string

Nur Anzahlungen dieses Kunden

__filter
integer
Enum: 1 2

1 = offen (unbezahlt), 2 = überfällig

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2019-08-24T14:15:22Z",
  • "data": [
    ]
}

Anzahlung anlegen

Legt eine Anzahlung an. Mit rm_booking_id wird der Kunde übernommen und die Anzahlung den Zimmern zugeordnet. create_invoice=1 erzeugt die Anzahlungsrechnung (nur mit Belegung). book_payment=1 verbucht die Zahlung (erzeugt bei Bedarf zuerst die Teilrechnung).

Authorizations:
(bearerAuthbasicAuth)
Request Body schema: application/json
required
st_customer_id
string
rm_booking_id
integer
rm_item_id
integer
amount
required
number <float>
currency
string
date
string <date-time>
due_date
string <date>
st_payment_method_id
string
st_tk_id
integer
tax
integer or null
remark
string
create_invoice
integer
Enum: 0 1
book_payment
integer
Enum: 0 1
reference
string
cms_client_id
integer

Responses

Request samples

Content type
application/json
{
  • "rm_booking_id": 12345,
  • "amount": 300,
  • "st_payment_method_id": "CC",
  • "create_invoice": 1,
  • "book_payment": 1,
  • "reference": "pi_123"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2019-08-24T14:15:22Z",
  • "data": {
    }
}

Anzahlung lesen

Authorizations:
(bearerAuthbasicAuth)
path Parameters
id
required
integer
Example: 42

vk_deposit_id

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2019-08-24T14:15:22Z",
  • "data": {
    }
}

Anzahlung ändern

Teilupdate. Nur solange keine Zahlung und keine Teilrechnung vorliegen. PUT und PATCH sind ebenfalls erlaubt.

Authorizations:
(bearerAuthbasicAuth)
path Parameters
id
required
integer
Example: 42

vk_deposit_id

Request Body schema: application/json
required
st_customer_id
string
rm_booking_id
integer
rm_item_id
integer
amount
required
number <float>
currency
string
date
string <date-time>
due_date
string <date>
st_payment_method_id
string
st_tk_id
integer
tax
integer or null
remark
string
create_invoice
integer
Enum: 0 1
book_payment
integer
Enum: 0 1
reference
string
cms_client_id
integer

Responses

Request samples

Content type
application/json
{
  • "amount": 350,
  • "remark": "Anzahlung angepasst"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2019-08-24T14:15:22Z",
  • "data": {
    }
}

Anzahlung ändern

Authorizations:
(bearerAuthbasicAuth)
path Parameters
id
required
integer
Example: 42

vk_deposit_id

Request Body schema: application/json
required
st_customer_id
string
rm_booking_id
integer
rm_item_id
integer
amount
required
number <float>
currency
string
date
string <date-time>
due_date
string <date>
st_payment_method_id
string
st_tk_id
integer
tax
integer or null
remark
string
create_invoice
integer
Enum: 0 1
book_payment
integer
Enum: 0 1
reference
string
cms_client_id
integer

Responses

Request samples

Content type
application/json
{
  • "st_customer_id": "string",
  • "rm_booking_id": 0,
  • "rm_item_id": 0,
  • "amount": 0.1,
  • "currency": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "due_date": "2019-08-24",
  • "st_payment_method_id": "string",
  • "st_tk_id": 0,
  • "tax": 0,
  • "remark": "string",
  • "create_invoice": 0,
  • "book_payment": 0,
  • "reference": "string",
  • "cms_client_id": 0
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2019-08-24T14:15:22Z",
  • "data": {
    }
}

Anzahlung löschen

Löscht die Anzahlung und storniert ggf. die zugehörige Zahlung. HTTP 409 wenn bereits mit einer Schlussrechnung verrechnet oder Kassenbuch abgeschlossen.

Authorizations:
(bearerAuthbasicAuth)
path Parameters
id
required
integer
Example: 42

vk_deposit_id

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2019-08-24T14:15:22Z"
}

Anzahlungsrechnung erzeugen

Erstellt die Teil-/Anzahlungsrechnung zur Belegung. Nur mit rm_booking_id. HTTP 409 wenn die Belegung bereits abgerechnet ist oder schon eine Teilrechnung existiert.

Authorizations:
(bearerAuthbasicAuth)
path Parameters
id
required
integer
Example: 42

vk_deposit_id

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2019-08-24T14:15:22Z",
  • "data": {
    }
}

Zahlung verbuchen

Verbucht den Zahlungseingang. Erzeugt bei Bedarf zuerst die Anzahlungsrechnung (nur mit Belegung).

Authorizations:
(bearerAuthbasicAuth)
path Parameters
id
required
integer
Example: 42

vk_deposit_id

Request Body schema: application/json
optional
st_payment_method_id
string

Zahlungsweise. Leer = Zahlungsweise der Anzahlung.

amount
number <float>

Betrag. Leer = Anzahlungsbetrag.

date
string <date>

Zahlungsdatum. Standard: heute.

reference
string

Zahlungsreferenz / Gateway-ID.

Responses

Request samples

Content type
application/json
{
  • "st_payment_method_id": "CC",
  • "reference": "pi_123"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "",
  • "date": "2019-08-24T14:15:22Z",
  • "data": {
    }
}