BuchhaltungsButler

System and settings3 EndpointsSettings / BuchhaltungsButler

Returns the BuchhaltungsButler integration status

GET/api/settings/buchhaltungsbutler/status

Responses

200Returns the BuchhaltungsButler integration statusBuchhaltungsButlerStatus

Show fields (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

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/settings/buchhaltungsbutler/status \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/settings/buchhaltungsbutler/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/settings/buchhaltungsbutler/status"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/settings/buchhaltungsbutler/status', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/settings/buchhaltungsbutler/status"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/settings/buchhaltungsbutler/status")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/settings/buchhaltungsbutler/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/buchhaltungsbutler_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await BuchhaltungsbutlerController.getStatus();
if (result.success) {
  print(result.data);
}

Response 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
}

Tests the BuchhaltungsButler API connection with the stored credentials

POST/api/settings/buchhaltungsbutler/test_connection

Responses

200Tests the BuchhaltungsButler API connectionBuchhaltungsButlerStatus

Show fields (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

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/settings/buchhaltungsbutler/test_connection \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/settings/buchhaltungsbutler/test_connection', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/settings/buchhaltungsbutler/test_connection"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.post(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/settings/buchhaltungsbutler/test_connection', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/settings/buchhaltungsbutler/test_connection"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/settings/buchhaltungsbutler/test_connection")
  .post(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/settings/buchhaltungsbutler/test_connection"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/buchhaltungsbutler_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await BuchhaltungsbutlerController.postTestConnection();
if (result.success) {
  print(result.data);
}

Response 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
}

Triggers a one-shot BuchhaltungsButler pull sync ("Sync now")

POST/api/settings/buchhaltungsbutler/sync

Responses

200Triggers a one-shot BuchhaltungsButler pull syncSuccess

Show fields (3)

successboolean
messagestring
error_codesarray<integer>

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/settings/buchhaltungsbutler/sync \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/settings/buchhaltungsbutler/sync', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/settings/buchhaltungsbutler/sync"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.post(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/settings/buchhaltungsbutler/sync', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/settings/buchhaltungsbutler/sync"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/settings/buchhaltungsbutler/sync")
  .post(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/settings/buchhaltungsbutler/sync"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/buchhaltungsbutler_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await BuchhaltungsbutlerController.postTriggerSync();
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "success": true,
  "message": "string",
  "error_codes": [
    1
  ]
}