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-06-12 10:03: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-06-12 10:03:22",
  • "source": "cache",
  • "data": [
    ]
}

Preise & Raten lesen

Raten aus swo_rm_article_contingents je Kategorie und Tag. 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)

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-06-12 10:03:22"
}

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-06-12 10:03:22",
  • "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-06-12 10:03:22",
  • "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.

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)

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": [
    ],
  • "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-06-12 10:03:22"
}