Firmenübersichten
3 endpoints
Änderungsströme über den Firmenbestand — nach Zeitraum, pro Tag oder pro Stunde.
Für den laufenden Abgleich sind Webhooks der bessere Weg: sie melden früher und mit weniger Aufrufen. Diese Endpunkte sind für den Erstabgleich gedacht und für die Wiederherstellung nach einer Störung.
Firmenänderungen pro Tag
GET /customers/changes/{date}
Dieser Endpunkt gibt die Änderungen der Firmen pro Tag zurück.
Änderungen sind:
neue Firmen (new)
geänderte Firmen (modified)
gelöschte Firmen (deleted)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
date |
path | string | yes | Stichtag im Format YYYY-MM-DD |
Responses
200 — OK
| Property | Type | Required | Description |
|---|---|---|---|
customerId |
integer (int32) | no | Identifikation der Firma |
name |
string | null | no |
createdAtUtc |
string (date-time) | no | Datum und Uhrzeit zu welcher die Firma angelegt wurde |
modifiedAtUtc |
string (date-time) | no | Datum und Uhrzeit zu welcher die Firma das letzte Mal geändert wurde |
404 — Firma nicht gefunden
| Property | Type | Required | Description |
|---|---|---|---|
messageGuid |
string (uuid) | null | no |
message |
string | null | no |
validationErrors |
ValidationError[] | no | Liste der Validierungsfehler |
Firmenänderungen pro Tag und Stunde
GET /customers/changes/{date}/{hour}
Dieser Endpunkt gibt die Änderungen der Firmen pro Tag und Stunde zurück.
Änderungen sind:
neue Firmen (new)
geänderte Firmen (modified)
gelöschte Firmen (deleted)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
date |
path | string | yes | Stichtag im Format YYYY-MM-DD |
hour |
path | integer | yes | Stunde des Tages (0–23) |
Responses
200 — OK
| Property | Type | Required | Description |
|---|---|---|---|
customerId |
integer (int32) | no | Identifikation der Firma |
name |
string | null | no |
createdAtUtc |
string (date-time) | no | Datum und Uhrzeit zu welcher die Firma angelegt wurde |
modifiedAtUtc |
string (date-time) | no | Datum und Uhrzeit zu welcher die Firma das letzte Mal geändert wurde |
404 — Firma nicht gefunden
| Property | Type | Required | Description |
|---|---|---|---|
messageGuid |
string (uuid) | null | no |
message |
string | null | no |
validationErrors |
ValidationError[] | no | Liste der Validierungsfehler |
Firmenänderungen nach Zeitraum und Niederlassung
GET /customers/changes
Dieser Endpunkt gibt die Änderungen der Firmen in einem Datumsbereich zurück.
Änderungen sind:
neue Firmen (new)
geänderte Firmen (modified)
gelöschte Firmen (deleted)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
endDate |
query | string | no | Ende des Zeitraums im Format YYYY-MM-DD |
officeId |
query | integer | no | Identifikation der Niederlassung |
startDate |
query | string | no | Beginn des Zeitraums im Format YYYY-MM-DD |
Responses
200 — OK
| Property | Type | Required | Description |
|---|---|---|---|
customerId |
integer (int32) | no | Identifikation der Firma |
name |
string | null | no |
createdAtUtc |
string (date-time) | no | Datum und Uhrzeit zu welcher die Firma angelegt wurde |
modifiedAtUtc |
string (date-time) | no | Datum und Uhrzeit zu welcher die Firma das letzte Mal geändert wurde |