# Spiri.Bo

## Übersicht

* **Kategorien**: [Mieterkommunikation](https://connect-docs-de.locoia.com/kategorien/mieterkommunikation)
* **Use Cases**: [Stammdaten](#stammdaten), [Tickets](https://connect-docs-de.locoia.com/use-cases/crm/tickets), [Dokumente](https://connect-docs-de.locoia.com/use-cases/digitales-buro/dokumente)
* **Marketplace**: [Spiri.Bo](https://marketplace.aareon.com/de/listings/spiribo)
* **API Dokumentation**: [Link](https://api.spiri.bo/v1/docs/silo)

## Beschreibung

Spiri.Bo ist ein PropTech-Unternehmen der meravis Immobiliengruppe. Spiri.Bo digitalisiert die Wohnungswirtschaft für Mieterservice der begeistert. Spiri.Bo's Kern-Produkt ist die Spiri.Bo Mieterapp als All-In-One-Lösung. Bei weiteren Fragen zur Anbindung melden Sie sich direkt bei Spiri.Bo.

## Mit Spiri.Bo verbinden

1. Um einen Spiri.Bo-Use-Case zu nutzen benötigen Sie zur Aktivierung die **Spiri.Bo API Zugansdaten**. Diese erhalten Sie folgendermaßen:
   1. Fordern Sie per Email an <dev+api-key@spiri.bo> mit dem Betreff "API-Key Aareon Connect" den API Key an.
2. Nachdem Sie Aareon Connect Kunde geworden sind, können Sie die verfügbaren **Spiri.Bo Integrationen innerhalb Ihres ERP-Systems** auswählen und aktivieren.

## Use Cases

### 1. Stammdaten

#### Übersicht

* [Allgemeine Informationen](#stammdaten)
* [Feld Mapping](https://docs.google.com/spreadsheets/d/1fLwCGcttemtlDpznO3O00352cZZ5SPJXBPv6IRWQ6Bk/edit?gid=1022321755#gid=1022321755)

#### Entitäten

| ERP                                                                                        | Spiri.Bo      |
| ------------------------------------------------------------------------------------------ | ------------- |
| [Gebäude](https://connect-docs-de.locoia.com/entitaeten/gebaeude)                          | Gebäude       |
| [Verwaltungseinheiten](https://connect-docs-de.locoia.com/entitaeten/verwaltungseinheiten) | Wohnungen     |
| [Mietverträge](https://connect-docs-de.locoia.com/entitaeten/mietvertraege)                | Verträge      |
| [Mieter](https://connect-docs-de.locoia.com/entitaeten/mieter)                             | Mieterbestand |

#### Einstellungen

Im Zuge der Aktivierung des Stammdaten Use Cases, können Sie folgende Einstellungen nutzen:

<table><thead><tr><th width="151">Name</th><th width="487.33333333333326">Beschreibung</th><th>Optionen</th></tr></thead><tbody><tr><td>Separator für zusammengesetzte IDs</td><td>Dieser Separator wird genutzt um die IDs in dem Partner System aus den ERP Nummern zusammenzusetzen, sodass die IDs eindeutig sind.</td><td><code>-</code>, <code>_</code>, <code>.</code>, <code>/</code>, <code>|</code></td></tr><tr><td>Mandanten Nummern</td><td>Es werden nur Daten für die eingetragenen Mandanten synchronisiert.</td><td></td></tr><tr><td>Nur Hauptmieter übertragen</td><td>Es werden nur Hauptmieter übertragen</td><td></td></tr></tbody></table>

#### Voraussetzungen

* Es werden nur Mieter mit einem hinterlegten Nachnamen synchronisiert
* Es werden nur Stammdaten synchronisert, welche mit einem Mieter verknüpft sind
  * Beispiel: Ein Wohnung welche leer ist, wird nicht synchronisert

#### Wohnungstypen Mapping

Die im ERP hinterlegt Nutzungsart (des Mietvertrags) wird wie folgt auf die Wohnungstypen in Spiri.Bo gemappt:

| ERP                          | Spiri.Bo   |
| ---------------------------- | ---------- |
| Wohnraum                     | living     |
| Wohnung                      | living     |
| Praxis                       | commercial |
| Einzelhandel                 | commercial |
| Büro                         | commercial |
| Gastronomie                  | commercial |
| Pflegedienst                 | commercial |
| Werkstatt                    | commercial |
| Gewerbe                      | commercial |
| Produktion                   | commercial |
| Logistik                     | commercial |
| gewerbliche Nutzung          | commercial |
| Garagen                      | parking    |
| Stellplatz außen             | parking    |
| Carport                      | parking    |
| Tiefgarage                   | parking    |
| Fahrradraum                  | parking    |
| Hochgarage                   | parking    |
| Garage                       | parking    |
| Lager                        | storage    |
| *Alle anderen Nutzungsarten* | other      |

{% hint style="info" %}
Da die Nutzungsart im ERP System frei definierbar ist, wird das Mapping laufend erweitert.
{% endhint %}

### 2. Tickets

#### Übersicht

* [Allgemeine Informationen](https://connect-docs-de.locoia.com/use-cases/crm/tickets)
* [Feld Mapping](https://docs.google.com/spreadsheets/d/1fLwCGcttemtlDpznO3O00352cZZ5SPJXBPv6IRWQ6Bk/edit?gid=1996564035#gid=1996564035)

Die Aareon Connect Integration für das Übertragen von Meldungen aus Spiri.bo ins ERP besteht us 4 Komponenten:

1. **Meldungskategorien und -typen Synchronisation**

   Dieser Teil muss initial aktiviert werden, um die Kategorien und Typen von Meldungen aus dem ERP an Spiri.bo zu übergeben. Es werden die Kategorien und Typen aus dem ERP abgeholt und per Mail an Spiri.bo weitergeleitet. Dort werden sie anschließend hinterlegt.
2. **Claims/Meldungen Synchronisation**\
   Nachdem die Kategorien und Typen in Spiri.bo angelegt wurden, kann dieser und alle weiteren Teile (3 & 4) aktiviert werden. In diesem Teil der Integration werden die Schadensmeldungen an das ERP weitergeleitet und erscheinen dort als Meldung.
3. **Forms Synchronisation**\
   Dieser Teil der Integration synchronisiert neu angelegte Formulare (Anfragen, Lärmbeschwerden, etc.) aus Spiri.bo in das ERP.
4. **Update Kontakt Informationen**\
   Der letzte Teil der Integration leitet Änderungen von Kontaktinformationen (Telefonnummern) aus Spiri.bo an das ERP weiter.

**Einstellungen**

Sie müssen keine weiteren Einstellungen vornehmen.

**Voraussetzungen**

Damit die Synchronisation von Meldungen, Formularen und Kontaktänderungen im ERP ankommen, muss Teil 1 ("*Meldungskategorien und -typen Synchronisation*") aus der Übersicht erfüllt sein.

**Anhänge zu Schadensmeldungen hinzufügen**

Anhänge können nicht direkt an eine Schadensmeldung angefügt werden. Um Anhänge zu übertragen, wird von der Integration zunächst eine Aktivität erstellt. Der gewünschte Anhang wird dieser Aktivität hinzugefügt, die anschließend mit der Schadensmeldung verknüpft wird.

Dafür muss ein designierter Aktivitätentyp erstellt oder ausgewählt werden, der dann Aareon Connect mitgeteilt werden muss.

**Achtung**

Je nach Einstellung im ERP kann es vorkommen, dass Meldungen nicht direkt angezeigt werden. Fragen Sie hierzu Ihren ERP berater, wie häufig temporäre Meldungen temporäre Meldungen aus der Datenbank ins ERP übertragen werden.

### 3. Dokumente

#### Übersicht

* [Allgemeine Informationen](https://connect-docs-de.locoia.com/use-cases/digitales-buro/dokumente)
* [Feld Mapping](https://docs.google.com/spreadsheets/d/1fLwCGcttemtlDpznO3O00352cZZ5SPJXBPv6IRWQ6Bk/edit?gid=136836836#gid=136836836)

#### Entitäten

| ERP       | Spiri.Bo  |
| --------- | --------- |
| Archive   | N/A       |
| Ordner    | N/A       |
| Dokumente | Dokumente |

#### Einstellungen

Im Zuge der Aktivierung des Dokumenten Use Cases, können Sie folgende Einstellungen nutzen:

<table><thead><tr><th width="151">Name</th><th width="487.33333333333326">Beschreibung</th><th>Optionen</th></tr></thead><tbody><tr><td>Separator für zusammengesetzte IDs</td><td>Dieser Separator wird genutzt um die IDs in dem Partner System aus den ERP Nummern zusammenzusetzen, sodass die IDs eindeutig sind.</td><td><code>-</code>, <code>_</code>, <code>.</code>, <code>/</code>, <code>|</code></td></tr><tr><td>Relevante Archiv Namen</td><td>Namen der Archive von welchen Dokumente übertragen werden sollen.</td><td></td></tr><tr><td>Wirtschaftseinheits Index Name</td><td>Index Name der Wirtschaftseinheitsnummer.</td><td></td></tr><tr><td>Gebäude Index Name</td><td>Index Name der Gebäudenummer.</td><td></td></tr><tr><td>Verwaltungseinheits Index Name</td><td>Index Name der Verwaltungseinheitsnummer.</td><td></td></tr><tr><td>Mietvertrags Index Name</td><td>Index Name der Mietvertragsnummer.</td><td></td></tr></tbody></table>

#### Voraussetzungen

* Indexe für Stammdatennummern müssen gesetzt sein

#### Besonderheiten

* Der Use Case enthält 2 Integrationen die beide aktiviert werden müssen
