bimetricsEntwickler
Vorlagen und Dauerbuchungen

Löschen einer Dauerbuchung prüfen

Als Markdown ansehen

Benötigte Berechtigung:read(Daten lesen)

GET
/api/document/collection/contract/{id}/delete-preview

Zählt, was das Löschen mit den Belegen täte, und ändert nichts. Künftige Belege gehen immer mit, Belege bis heute nur mit pastDocuments. Zugeordnete, bezahlte und festgeschriebene bleiben in jedem Fall. Solange assigned größer als 0 ist, lehnt das Löschen ab.

Benötigt einen Schlüssel mit der Berechtigung read.

Authentifizierung

headerAuthentifizierungBearer <bm_…>

Empfohlen: Authorization: Bearer bm_…. Der Schlüssel wird nur einmal angezeigt; nie in URLs, Logs oder Frontend-Code ablegen.

Pfadparameter

id*string

ID des Objekts in dieser Firma (UUID).

Formatuuid

Antworten

Erfolg.

application/json
  1. response

Was das Löschen mit den Belegen täte.

assigned?integer

Zugeordnete Belege; solange es welche gibt, lehnt das Löschen ab.

contractStays?boolean

Ohne pastDocuments bleiben Belege und damit die Dauerbuchung als gelöscht vermerkt.

deletable?integer

Belege bis heute, die mit pastDocuments mitgehen.

kept?integer

Belege bis heute, die in jedem Fall bleiben.

upcoming?integer

Künftige Belege, die in jedem Fall mitgehen.

Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/document/collection/contract/497f6eca-6276-4993-bfeb-53cbbbba6f08/delete-preview" \  -H "Authorization: Bearer $BIMETRICS_API_KEY"
Beispielantwort
{  "assigned": 0,  "contractStays": true,  "deletable": 2,  "kept": 1,  "upcoming": 1}