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 | retrieve all customers | create a new customer | |||
| /Customers/:CustomerNumber | retrieve one customer | udpate existing customer | |||
| /Customers/:CustomerId/Contracts | get all contracts for a customer | ||||
| /Contracts | get all contracts | create a new contract | |||
| /Contracts/:ContractId/Transactions | get all transactions for a given contract | create a new transaction for a contract | |||
| /Invoices | retrieve all invoices | ||||