KleanApp

Holt eine einzelne CRM-Aktion mit allen Details und Kommentaren Geliefert werden nur Aktionen, die der Benutzer sehen darf: mit Objektbezug nur zu erlaubten Objekten, mit Auftraggeberbezug nur zu sichtbaren Auftraggebern, ohne beides nur die eigenen.

Liefert die DB1-Auswertung (Deckungsbeitrag 1): Rechnungserlös gegen Soll-/Iststunden, Lohnkosten, kalkulatorische Lohnnebenkosten, Aufwände und Subunternehmerkosten je Einzelposten, Objekt oder Auftrag. Parameter: optional monat ('MM.JJJJ' für einen Monat oder 'JJJJ' für ein Gesamtjahr, Default aktueller Monat), optional gruppierung ('einzelposten', 'objekt' oder 'auftrag', Default 'objekt'), optional status (Rechnungsstatus; leer = alle außer storniert und gelöscht). Setzt das Fibu-Modul und das Recht für die Finanzauswertungen voraus; ist der Parameter für das DB1-Recht aktiv, zusätzlich das Recht 'Auswertungen DB1'.

Liefert die geplanten Dienstplan-Einsätze eines Zeitraums mit aufgelösten Serienterminen (jeder Termin einzeln, keine RRULE) und mit Namen von Mitarbeiter und Objekt. Parameter: von, bis (Format TT.MM.JJJJ), optional mitarbeiterId, optional objektId. Antwort: {anzahl, anzahlGekuerzt, einsaetze:[{mitarbeiterId, mitarbeiter, personalnummer, objektId, objekt, objektNummer, datum, von, bis, dauerStunden, pauseMinuten, istVertretung, bemerkung}]}. Für Summen je Mitarbeiter/Objekt/Tag/Woche stattdessen get_dienstplan_summe verwenden.

Liefert gebuchte Leistungen aus laufenden Aufträgen, die im Dienstplan nicht verplant sind (Abrechnungsart 'Aufwand nach Arbeitsschein' ohne Dienstplan-Eintrag) — also Planungslücken. Parameter: von, bis (Format TT.MM.JJJJ, bezogen auf Belegdatum bzw. Leistungszeitraum des Auftrags), optional objektId. Antwort: {anzahl, leistungen:[{objekt, leistung, zeitraum, gesamtkontingentStunden, auftragNummer, auftragStatus, empfaenger, bemerkungIntern}]}. Setzt das Fibu-Modul und das Benutzerrecht 'Aufträge' voraus.

Liefert die geplanten Dienstplan-Stunden eines Zeitraums aggregiert (Serientermine sind aufgelöst, Pausen sind abgezogen). Parameter: von, bis (Format TT.MM.JJJJ), groupBy ('mitarbeiter', 'objekt', 'tag' oder 'woche'), optional mitarbeiterId, optional objektId. Antwort: {gruppierung, gesamtEinsaetze, gesamtStunden, zeilen:[{gruppe, anzahlEinsaetze, stunden, pauseStunden}]}, sortiert absteigend nach Stunden (bei 'tag'/'woche' chronologisch).

Liefert die geplanten Dienstplan-Einsätze für einen Zeitraum. Parameter: von(Beginn, Format TT.MM.JJJJ), bis(Ende, Format TT.MM.JJJJ), optional mitarbeiterId, optional objektId. Antwort: JSON-Liste {dienstplanId, mitarbeiterId, objektId, startLokal, endLokal, recurrenceInfo, recurrenceException, vertretungFuerDienstplanId}. Hinweis: Bei gesetztem recurrenceInfo handelt es sich um einen wiederkehrenden Einsatz (RRULE); startLokal/endLokal beschreiben dann den Serien-Ausgangstermin.

Liefert die Feiertage eines Zeitraums für das Bundesland des Mandanten (nationale Feiertage immer inklusive). Parameter: von, bis (Format TT.MM.JJJJ). Antwort: {anzahl, bundesland, feiertage:[{datum, wochentag, name, bundesland, hinweis}]}. Für Planungsfragen über Feiertage hinweg immer dieses Tool nutzen, nie selbst rechnen.

Liefert die Daten eines Intervalls mit der ID 'intervallId'

Liefert alle Intervalle in KleanApp

Sucht die erfassten Arbeitszeiten (Ist-Stunden) in KleanApp für ein bestimmtes Datum

Sucht die erfassten Arbeitszeiten (Ist-Stunden) der letzten 60 Tage in KleanApp für eine bestimmten Mitarbeiter.

Erfasste Arbeitsstunden (Iststunden) für einen Zeitraum. Parameter: von(Beginn, Format TT.MM.JJJJ), bis(Ende, Format TT.MM.JJJJ), optional mitarbeiterId, optional objektId.Antwort: JSON-Liste aggregiert nach Objekt oder Datum, absteigend nach Stunden sortiert.

Liefert alle Kunden in KleanApp

Liefert die laufenden Aufträge mit Belegnummer, Empfänger, Objekt, Leistungszeitraum und Netto-/Bruttosumme — dieselbe Auswertung wie das Portlet 'Laufende Aufträge' im Web. Setzt das Fibu-Modul und das Recht für die Finanzauswertungen voraus.

Liefert die Berechtigungen des abfragenden Benutzers: Name, Personalnummer, Admin-Kennzeichen, die Anzahl der für ihn sichtbaren Objekte, die aktiven Module des Mandanten, seine Benutzerrechte und je Themenbereich, ob die zugehörigen Tools Daten liefern werden. Vor Fragen zu Finanzen, Dienstplan, Zeiterfassung, Tickets, CRM oder Mitarbeiterdaten kann damit vorab geklärt werden, was beantwortbar ist.

Liefert alle Mitarbeiter in KleanApp, auf die der abfragende Benutzer Zugriff hat (Mitarbeiter seiner Objekte). Personaldaten (Anschrift, Kontaktdaten, Ein-/Austritt, benutzerdefinierte Felder) kommen nur mit dem Recht 'Benutzerverwaltung', die Einsatzdaten (Arbeitszeiten, Urlaub) nur mit einem der Einsatzdaten-Rechte — sonst stehen diese Felder auf null.

Liefert die Daten eines Mitarbeiters. Der Mitarbeiter wird über 'mitarbeiterId', 'uniqueId' oder 'personalnummer' identifiziert; sind mehrere Angaben gesetzt, gilt die Reihenfolge mitarbeiterId, uniqueId, personalnummer. Personaldaten und Einsatzdaten sind rechteabhängig und stehen ohne das jeweilige Recht auf null.

Liefert die Daten einer Nutzungsart mit der ID 'nutzungsartId'

Liefert alle Nutzungsarten in KleanApp

Holt die die Daten des Objekts mit der ID 'objektId'

Liefert alle Objekte in KleanApp

Liefert die Daten einer Objektgruppe mit der ID 'objektgruppeId'

Liefert alle Objektgruppen in KleanApp

Liefert Objektpausen (Zeiträume in denen ein Objekt nicht eingeplant wird). Parameter: optional objektId, optional von/bis (Format TT.MM.JJJJ). Bei gesetztem Zeitraum werden nur überschneidende Pausen zurückgegeben. Antwort: JSON-Liste {objektpauseId, objektId, objekt, objektNummer, von, bis, kommentar}.

Sucht zu einer Mitarbeiter-ID alle Objekt-IDs in denen der Mitarbeiter arbeiten darf

Liefert die offenen (noch nicht freigegebenen oder abgelehnten) Urlaubs- und Krankmeldungsanträge. Parameter: optional von, bis (Format TT.MM.JJJJ, Überschneidung mit dem Antragszeitraum; ohne Angabe alle offenen), optional art ('Urlaub' oder 'Krank'). Antwort: {anzahl, antraege:[{antragId, mitarbeiter, personalnummer, art, von, bis, tage, gestelltAm, vertretung, bemerkung}]}, sortiert nach Antragsdatum. Setzt eines der Abwesenheitsrechte voraus.

Liefert die offenen Angebote mit Belegnummer, Empfänger, Objekt, Belegdatum und Netto-/Bruttosumme. Setzt das Fibu-Modul und das Recht für die Finanzauswertungen voraus.

Liefert die noch nicht abgerechneten Leistungen je Monat (offene Beträge aus laufenden Aufträgen). Parameter: von, bis (Format TT.MM.JJJJ). Setzt das Fibu-Modul und das Recht für die Finanzauswertungen voraus.

Liefert die offenen Rechnungen: überfällige (Fälligkeit überschritten) und in den nächsten Tagen fällige, jeweils mit Empfänger, Belegnummer, Fälligkeit, offenem Betrag und Mahnstufe. Parameter: optional tageZukunft (Vorschau für 'fällig', Default 14). Antwort: {ueberfaellig:{anzahl, summeOffen, rechnungen:[…]}, faellig:{…}}. Setzt das Fibu-Modul und das Recht für die Finanzauswertungen voraus.

Holt eine einzelne Rechnung mit allen Details: Einzelposten (mit Menge, Einzelpreis, Leistung/Artikel), Zahlungseingängen, Mahnungen, Korrekturrechnungen und Summen inkl. offenem Bruttobetrag. Setzt das Fibu-Modul und das Recht 'Rechnungen' (oder 'Rechnungen nur lesen') voraus.

Liefert Rechnungen eines Zeitraums (bezogen auf das Belegdatum) inkl. Status/Mahnstufe, Fälligkeit, Netto- und Bruttosumme sowie dem noch offenen Bruttobetrag (Rechnungssumme abzüglich Zahlungseingänge). Parameter: von, bis (Format TT.MM.JJJJ), optional status ('Offen', 'Bezahlt', 'Storniert', 'Mahnstufe1', 'Mahnstufe2', 'Mahnstufe3', 'InBearbeitung', …; leer = alle außer gelöschte), optional objektId, optional suchtext (Belegnummer/Empfänger), optional limit (Default 100, Max 500). Setzt das Fibu-Modul und das Recht 'Rechnungen' (oder 'Rechnungen nur lesen') voraus.

Liefert die Rendite je Objekt oder je Kunde und Monat: Rechnungen netto gegen Personalkosten und Aufwände, inklusive Personalstunden und der prozentualen Abweichung (= Rendite). Der Zeitraum ergibt sich aus den Mandanten-Parametern der Renditeauswertung (Standard: letzte 6 Monate). Parameter: optional proKunde (false = je Objekt, true = je Auftraggeber). Setzt das Fibu-Modul und das Recht für die Finanzauswertungen voraus.

Liefert die Rechnungsumsätze je Sachkonto (Erlöskonto), aggregiert über alle nicht stornierten/gelöschten Rechnungen. Parameter: optional von, bis (Format TT.MM.JJJJ, bezogen auf den Leistungsmonat der Position) — ohne Angabe werden alle Positionen berücksichtigt. Antwort: {zeilen:[{sachkonto, anzahlPositionen, summeNetto, summeBrutto}], summeNetto, summeBrutto}. Setzt das Fibu-Modul und das Recht für die Finanzauswertungen voraus.

Main source for planned working hours (Sollstunden). Parameters: datum(date DD.MM.YYYY).Response: JSON list {datum, sollstunden, mitarbeiterId, objektId, von, bis}.

Geplante Arbeitsstunden (Sollstunden) für einen Zeitraum. Parameter: von(Beginn, Format TT.MM.JJJJ), bis(Ende, Format TT.MM.JJJJ), optional mitarbeiterId, optional objektId.Antwort: JSON-Liste aggregiert nach Objekt oder Datum, absteigend nach Stunden sortiert.

Holt ein einzelnes Ticket mit allen Details, Aktionen und Kommentaren. Das Ticket wird entweder über ticketId oder über uniqueId identifiziert; sind beide angegeben, gilt ticketId. 'bilder' enthält die URLs der am Ticket hinterlegten Bilder/Dateien (leer, wenn keine vorhanden).

Liefert eine kompakte Statistik-Übersicht: Anzahl pro Status, offene pro Bearbeiter, Altersverteilung

Liefert die Gesamtliste der Ticketstatus: Id, Name, Aktionstext, die Flags istStart/istOffen/istInBearbeitung/istFertigFuerListe/istFertigFuerBenachrichtigungFaelligkeit/synchroApp/sendenNachL2, Schnellaktion, Hintergrundfarbe und den bei Statuswechsel automatisch zugewiesenen Benutzer. Mit ticketkategorieId werden nur die Status geliefert, die im Workflow dieser Kategorie vorkommen. Liefert die ticketstatusId für create_ticketaktion.

Liefert den Umsatz je Monat und Rechnungsstatus (offen, bezahlt, Mahnstufen) für die letzten Monate — dieselbe Auswertung wie das Verlaufs-Portlet im Web. Parameter: optional alterMonate (Anzahl Monate rückwirkend, Default 12). Antwort: {monate:[{monat, status, summe}], gesamt}. Setzt das Fibu-Modul und das Recht für die Finanzauswertungen voraus.

Liefert bereits erfasste Vertretungen (wer vertritt wen). Parameter: optional mitarbeiterId (matcht vertretenen ODER vertretenden Mitarbeiter), optional von/bis (Format TT.MM.JJJJ). Antwort: JSON-Liste {vertretungId, vertretenerMitarbeiterId, vertretenerMitarbeiter, vertreterMitarbeiterId, vertreterMitarbeiter, start, ende}.