Zum Inhalt springen
Developer

BuchhaltungsButler

Einstellungen / BuchhaltungsButler

System und Einstellungen3 EndpunkteSettings / BuchhaltungsButler

Liefert den Status der BuchhaltungsButler-Anbindung

GET/api/settings/buchhaltungsbutler/status

Antworten

200Liefert den Status der BuchhaltungsButler-AnbindungBuchhaltungsButlerStatus

Felder anzeigen (11)
  • enabledboolean
  • configuredboolean

    Sind alle API-Zugangsdaten hinterlegt?

  • connectedboolean

    Ergebnis des Verbindungstests (null = nicht getestet)

  • messagestring

    Detail-Meldung (z.B. Fehlermeldung des Verbindungstests)

  • pull_incoming_invoices_enabledboolean
  • pull_transactions_enabledboolean
  • pull_days_backinteger
  • sync_last_runstring (date-time)

    Letzter Lauf des Sync-Cronjobs

  • sync_next_runstring (date-time)

    Nächster geplanter Lauf des Sync-Cronjobs

  • sync_runningboolean

    Läuft der Sync gerade?

  • sync_last_resultstring

    Ergebnis-Ausgabe des letzten Sync-Laufs

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/settings/buchhaltungsbutler/status \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "enabled": true,
  "configured": true,
  "connected": true,
  "message": "string",
  "pull_incoming_invoices_enabled": true,
  "pull_transactions_enabled": true,
  "pull_days_back": 1,
  "sync_last_run": "2026-10-15T09:30:00+02:00",
  "sync_next_run": "2026-10-15T09:30:00+02:00",
  "sync_running": true
}

Testet die Verbindung zur BuchhaltungsButler-API mit den gespeicherten Zugangsdaten

POST/api/settings/buchhaltungsbutler/test_connection

Antworten

200Testet die Verbindung zur BuchhaltungsButler-APIBuchhaltungsButlerStatus

Felder anzeigen (11)
  • enabledboolean
  • configuredboolean

    Sind alle API-Zugangsdaten hinterlegt?

  • connectedboolean

    Ergebnis des Verbindungstests (null = nicht getestet)

  • messagestring

    Detail-Meldung (z.B. Fehlermeldung des Verbindungstests)

  • pull_incoming_invoices_enabledboolean
  • pull_transactions_enabledboolean
  • pull_days_backinteger
  • sync_last_runstring (date-time)

    Letzter Lauf des Sync-Cronjobs

  • sync_next_runstring (date-time)

    Nächster geplanter Lauf des Sync-Cronjobs

  • sync_runningboolean

    Läuft der Sync gerade?

  • sync_last_resultstring

    Ergebnis-Ausgabe des letzten Sync-Laufs

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/settings/buchhaltungsbutler/test_connection \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "enabled": true,
  "configured": true,
  "connected": true,
  "message": "string",
  "pull_incoming_invoices_enabled": true,
  "pull_transactions_enabled": true,
  "pull_days_back": 1,
  "sync_last_run": "2026-10-15T09:30:00+02:00",
  "sync_next_run": "2026-10-15T09:30:00+02:00",
  "sync_running": true
}

Einmaligen BuchhaltungsButler-Pull-Sync auslösen ("Jetzt synchronisieren")

POST/api/settings/buchhaltungsbutler/sync

Antworten

200Einmaligen BuchhaltungsButler-Pull-Sync auslösenSuccess

Felder anzeigen (3)
  • successboolean
  • messagestring
  • error_codesarray<integer>
Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/settings/buchhaltungsbutler/sync \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "success": true,
  "message": "string",
  "error_codes": [
    1
  ]
}