# Automatische Zuordnung einer Buchungsvorlage lesen (https://developer.bimetrics.de/reference/templates-and-recurring-bookings/get-document-series-auto-assign)

`GET https://app.bimetrics.de/api/document/collection/series/{id}/auto-assign`

operationId: `getDocumentSeriesAutoAssign` · Berechtigung (Scope): `read` · Bereich: Vorlagen und Dauerbuchungen

Zeigt, ob die Vorlage passende Zahlungen von allein zugeordnet bekommt (`current`), und die neueste Zahlung, die ihr von Hand zugeordnet wurde (`pattern`). `needsFixedSplit` sagt, dass das Einschalten die feste Aufteilung und die letzte Rate verlangt. `problem` nennt, warum die Vorlage den Betrag nicht von allein buchen kann, mit den Gründen von `TemplateAutoAssignRefused`, oder `linesChanged`.

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

### Authentifizierung

`Authorization: Bearer bm_…` (alternativ `X-API-KEY: bm_…`, nie beide zugleich).

### Parameter

| Name | Ort | Pflicht | Typ | Beschreibung |
| --- | --- | --- | --- | --- |
| `id` | path | ja | string (uuid) | ID des Objekts in dieser Firma (UUID). |

### Beispiel

```sh
curl --fail-with-body "https://app.bimetrics.de/api/document/collection/series/{id}/auto-assign" \
  -H "Authorization: Bearer $BIMETRICS_API_KEY"
```

### Antworten

| Status | Beschreibung | Inhalt |
| --- | --- | --- |
| 200 | Erfolg. | `application/json`: AutoAssignState |
| 400 | Ungültige Anfrage, z. B. ein Parameter mit ungültigem Wert wie eine ID, die keine UUID ist; korrigieren statt wiederholen. Mehr unter [Fehler](https://developer.bimetrics.de/errors). | `application/json`: Error |
| 401 | Kein gültiger Schlüssel: fehlt (`Unauthorized`), ist unbekannt, abgelaufen oder widerrufen oder wurde nicht in genau einem Header gesendet (`InvalidAPIKey`). Schlüssel prüfen, nicht wiederholen. Auch eine ID, die zu einer anderen Firma gehört, ergibt `401 Unauthorized`. | `application/json`: Error |
| 403 | Dem Schlüssel fehlt die Berechtigung für diesen Endpunkt (`APIKeyPermissionDenied`, `context.scope` nennt sie; Berechtigungen sind fest: neuen Schlüssel anlegen, austauschen, alten widerrufen), der Endpunkt ist für API-Schlüssel nicht freigegeben (`APIKeyPermissionDenied` ohne `context.scope`), oder die Firma hat keinen API-Zugang (mehr), etwa nach Ende der Testphase oder des Abos (`APIUnavailable`). | `application/json`: Error |
| 404 | Nicht gefunden (`NotFound`). | `application/json`: Error |
| 413 | Die Anfrage ist zu groß (`APIRequestTooLarge`), siehe `x-bimetrics-limits`. | `application/json`: Error |
| 429 | Zu viele Anfragen; nach `Retry-After` Sekunden erneut senden. Mehr unter [Fehler](https://developer.bimetrics.de/errors). (Header: Retry-After) | `application/json`: Error |
| 500 | Serverfehler; die Anfrage später wiederholen. Mehr unter [Fehler](https://developer.bimetrics.de/errors). | `application/json`: Error |

#### Felder der Antwort 200 (`AutoAssignState`)

| Feld | Typ | Beschreibung |
| --- | --- | --- |
| `current` | SeriesAutoAssign | Was bestätigt ist; fehlt, solange die Automatik aus ist. |
| `fixedCostsMinor` | integer | Darlehenskosten, die die Vorlage aus jeder Rate bucht, in Cent; 0 ohne. |
| `needsContract` | boolean | `true`, wenn die Vorlage Vorsteuer bucht: Das Einschalten verlangt dann `contractConfirmed`. |
| `needsFixedSplit` | boolean | `true`, wenn die Vorlage Darlehenskosten von einer anderen Zeile abteilt: Das Einschalten verlangt dann `fixedSplitConfirmed` und `lastInstalmentOn`. |
| `pattern` | AutoAssignPattern | Neueste Zahlung, die der Vorlage von Hand zugeordnet wurde; fehlt ohne eine solche. |
| `problem` | string | Warum die Vorlage den Betrag nicht von allein buchen kann, ein Grund von `TemplateAutoAssignRefused`. Ist die Automatik an, auch `linesChanged` (bimetrics hat die Vorlage aktualisiert), `ended` (nach der letzten Rate), `returnDebitOpen` (eine offene Rücklastschrift pausiert sie) oder `assignedElsewhere` (eine gleiche Zahlung wurde seit dem Einschalten anders zugeordnet, auf welchem Weg auch immer). Leer, wenn sie bucht. |
| `problemTemplate` | string | Bei `taken` der Name der anderen Vorlage. |
| `taxMinor` | integer | Vorsteuer, die die Vorlage aus der Zahlung bucht, in Cent; 0 ohne. |

Verschachtelte Schemas stehen vollständig in der OpenAPI-Beschreibung: https://app.bimetrics.de/api/openapi.json
