The Fakturia API is an open interface using the REST standard. It allows developers to directly interact with our application exchanging data in the JSON format.
Endpoint for all API calls: https://api.fakturia.de/v1/
Prerequisites
The API can only be accessed if the following conditions are true:
- Your Fakturia plan includes API access
- The API is activated in the backend for at least one project
- An API-Key has been generated in the backend
- The IP address of your client has been added to the IP whitelist for the project
Authorization
Include the following HTTP-Header variables in every request to authorize against our service:
| Header variable name | value |
|---|---|
| api-key | {your api key - see project settings in the backoffice} |
Access Points
| URL | GET | POST | PUT | PATCH | DELETE |
|---|---|---|---|---|---|
| /Customers | Liste aller Kunden | Neuen Kunden anlegen | |||
| /Customers/:CustomerId | Bestimmten Kunden laden | Bestehenden Kunden aktualisieren | |||
| /Customers/:CustomerId/Contracts | Liefert alle Verträge eines Kunden | ||||
| /Contracts | Alle Verträge auflisten | (Neuen Vertrag anlegen) | |||
| /Contracts/:ContractId/Transactions | Alle Leistungen zum Vertrag auflisten | Neue Leistung zum Vertrag erfassen | |||
| /Invoices | Liste aller Rechnungen | ||||