agency-invoicing

PATCH /v1/agency-invoicing/tax-rates/{rateId}

Change a tax rate.

Alle agency-invoicing Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung agency.invoicing.manage verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Hier kommt Ihre Organisations-ID hin

Dieser Endpunkt akzeptiert org_id als Abfrageparameter. Lassen Sie ihn weg, erfasst der Aufruf Ihren gesamten Mandanten-Unterbaum; übergeben Sie ihn, um den Aufruf auf eine Organisation einzugrenzen.

Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

curl -X PATCH https://api.zinndigital.com/v1/agency-invoicing/tax-rates/{rateId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

⭐ Changing a rate does NOT restate any invoice that already carries it — the percentage and the name are copied onto each line when it is saved. That is what lets you move VAT from 20% to 17.5% next April without rewriting last month. Requires `agency.invoicing.manage`.

Parameter

NameTypErforderlichWas es ist
rateId (path)UuidJa
org_id (query)UuidNeinWhich of your organizations is invoicing. Required only when you belong to more than one — otherwise it is inferred from your DIRECT membership, never from the subtree-expanded…

Anfragekörper

NameTypErforderlichWas es ist
namestringNein
rate_bpsintegerNein
registration_numberstringNein
notestringNein
is_defaultbooleanNein

Antwort

NameTypErforderlichWas es ist
idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringJaWhat the document calls it. ⛔ Free text, not an enum: the line must read "VAT", "MwSt.", "TVA" or "Sales tax" depending on who is being invoiced.
rate_bpsintegerJa
registration_numberstringNein
notestringNein
is_defaultbooleanNein

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 422 · 429