The Fakturia API is an open OpenAPI based interface using the REST standard.
It allows developers to directly interact with our application via HTTPS exchanging data in the JSON format.
Info | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Endpoint for all API calls:
Timestamps are handled in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss in Java) |
Table of Contents |
---|
Prerequisites
...
Include the following HTTP -Header variables headers in every request to authorize against our service:
Header variable name | value |
---|---|
api-key | {your api key - see project settings in the backoffice} |
Resources Overview
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 | ||||
Errors
The API returns standard HTTP status codes to indicate that something went wrong.