Zahlungseinstellungen
10 Endpunkte unter /api/rest/2.0
Customer billing settings - global tax and delivery preferences
Endpunkte
Alle Pfade sind relativ zur Basis /api/rest/2.0 Ihrer ameax-Installation. Die Antworten folgen dem JSON:API-Format mit data, links und meta.
| Methode | Pfad | Beschreibung |
|---|---|---|
GET |
/customers/{customer_id}/billing |
Get customer billing settings |
PATCH |
/customers/{customer_id}/billing |
Update customer billing settings |
GET |
/customers/{customer_id}/billing-businesses |
List billing business entries |
GET |
/customers/{customer_id}/billing-businesses/{business_id} |
Get billing business entry |
PUT |
/customers/{customer_id}/billing-businesses/{business_id} |
Create or update billing business entry |
PATCH |
/customers/{customer_id}/billing-businesses/{business_id} |
Partial update billing business entry |
DELETE |
/customers/{customer_id}/billing-businesses/{business_id} |
Delete billing business entry |
GET |
/customers/{customer_id}/billing-combined |
Get combined billing data |
POST |
/customers/{customer_id}/billing-combined |
Create combined billing data |
PATCH |
/customers/{customer_id}/billing-combined |
Update combined billing data |
Felder
Diese Felder liefert die API zu Zahlungseinstellungen. Dazu kommen die Zusatzfelder Ihrer eigenen Installation — sie werden nach denselben Regeln geprüft wie in der Oberfläche und erscheinen in der Spezifikation Ihres Mandanten.
| Feld | Typ | Beschreibung |
|---|---|---|
customer_id |
integer | Customer ID |
ustidnr |
string | VAT identification number (EU) |
ustidnr_validationdate |
date | VAT ID validation date |
taxnumber |
string | Tax number (national) |
taxtype |
string | Tax type: steuerpflichtig (taxable), steuerfreieg (incorrectly stored), steuerfrei (tax-free) |
taxdeductionjustified |
boolean | Entitled to VAT deduction (for commission payments) |
reversechargereceiver_constructionservices |
boolean | Reverse charge recipient for construction services (§13b UStG) |
accounting_email |
string | Email address(es) for direct receipt delivery (comma-separated) |
preferred_delivery |
string | Preferred delivery method for receipts |
dunning_deferral_dt |
date | Dunning deferral date (no dunning until this date) |
Zugriff
Jede Anfrage braucht ein API-Token im Kopf Authorization: Bearer <token>, wahlweise als Basic-Auth mit dem Benutzernamen api und dem Token als Passwort.
Das Token hängt an einem Benutzer und erbt dessen Rechte: Was dieser Benutzer in der Oberfläche nicht sehen darf, liefert die API auch nicht. Zusätzlich lassen sich je Token ein Ablaufdatum und eine IP-Beschränkung hinterlegen. Mehr dazu auf der API-Übersicht.
Anbindung besprechen.
Sie wollen ein System anbinden und wissen nicht, ob die Schnittstelle abdeckt, was Sie brauchen? Wir schauen es uns gemeinsam an — kostenlos und ohne Verpflichtung.