fineelik API
The fineelik API lets another system deliver invoices, read their state, follow what happens to them and report an approval that was made outside fineelik. A typical client is the ELO component of a customer.
Everything runs over HTTPS against the address of your fineelik instance, for example https://<your-instance>. All responses are JSON. Money amounts are decimal strings such as "1234.56", never floating point numbers.
What you can do
Section titled “What you can do”| Task | Endpoint | Guide |
|---|---|---|
| Deliver an invoice (PDF) | POST /api/invoices/upload |
Uploading invoices |
| Hand over a document from ELO | POST /api/ingest/handover |
Uploading invoices |
| List invoices and read one | GET /api/invoices, GET /api/invoices/{id} |
Uploading invoices |
| Follow changes | GET /api/integration/events |
Events and export |
| Read the export state of an invoice | GET /api/invoices/{id}/export |
Events and export |
| Report an approval made elsewhere | POST /api/invoices/{id}/external-decision |
External approval |
| Receive events by HTTPS call | webhooks | Webhooks |
The complete list with every field is in the reference: invoices, integration, webhooks, operations and schemas. The machine-readable description is the OpenAPI document (OpenAPI 3.0).
Quick start
Section titled “Quick start”- In fineelik, open Settings, Integrations (Schnittstellen) as an administrator and create an API key. Give it a name (up to 32 characters) and choose how long it is valid: 90, 180 or 365 days. Optionally bind it to one company; without a binding it works in the default company. The key is shown once. Copy it.
- Send it in the
x-api-keyheader with every call. - Deliver a first invoice:
curl -X POST https://<your-instance>/api/invoices/upload \ -H "x-api-key: <your-key>" \ -F "file=@invoice.pdf;type=application/pdf"- Read its state with the
invoiceIdfrom the answer:
curl https://<your-instance>/api/invoices/<invoiceId> \ -H "x-api-key: <your-key>"Next: Authentication.