API documentation

Automate invoices with the e-invoicing API

Create invoices, quotes and customers and retrieve them from your own webshop, CRM or ERP. A simple REST API with JSON, included with Premium at no extra cost.

Do you work with Laravel? Then use our Laravel package.

Easy to connect

REST en JSON. Elke ontwikkelaar begrijpt het binnen enkele minuten.

Veilig

Connection via HTTPS and a personal API key that you can renew yourself.

Included with Premium

No extra costs or credits for using the API.

Content

Introduction

With the Gyvex Financial API you manage your invoices, quotes and customers from your own software. All endpoints work with JSON and are available via HTTPS.

Base URL
https://financial.gyvex.com/api
Premium required. The API is free to use, but only available with an active Premium account. View the prices.

Quick start

  1. Get a Premium account.
  2. Copy your API key under Settings → API.
  3. Send your key as a Bearer token, as below.
Example: retrieve invoices
curl "https://financial.gyvex.com/api/invoices" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer UW_API_SLEUTEL"

Authentication

Every request must include your personal API key in the Authorization header. Only data from your own account is accessible.

Headers
Accept: application/json
Authorization: Bearer UW_API_SLEUTEL
Content-Type: application/json
  • Treat your key like a password: store it server-side and never use it in browser code or a public repository.
  • Has your key leaked? Generate a new one under Settings → API. The old one will then stop working.
  • The key can also be sent as the query parameter api_token. We advise against this, because URLs end up in log files.

Requests and responses

  • For POST and PUT, send a JSON body with Content-Type: application/json.
  • Dates use the format JJJJ-MM-DD. Amounts are numbers with a dot as the decimal separator (12.50).
  • You specify the VAT percentage of a line (vat_percentage) as 21 or 0.21. Both mean 21%.
  • The system calculates the total amount and the line totals itself, including VAT.

Pagination

Lists are paginated. Use page for the page and page_size for the number of results per page (default 15). The response contains the results in data, plus metadata such as current_page, last_page, per_page and total.

Paginated response (shortened)
{
  "current_page": 1,
  "data": [ { "id": 42, "invoice_number": "2026-0042" } ],
  "last_page": 3,
  "per_page": 15,
  "total": 38
}

Error codes and limits

StatusMeaning
200Success.
201Created. The new invoice, quote or customer is in the response.
202Accepted. The action is queued, for example sending an email.
204Deleted. The response has no content.
401API key is missing or invalid.
403No Premium account, or you are not allowed to use this invoice, quote or customer.
404The requested data does not exist.
409Conflict. The action cannot be done, for example deleting a customer that still has invoices or quotes.
422Validation error. The input is incomplete or invalid, see errors in the response.
429Too many requests. Try again in a minute.
Example: validation error (422)
{
  "code": 422,
  "message": "Validation failed",
  "errors": {
    "invoice_number": ["The invoice number field is required."]
  }
}

Limit: a maximum of 60 requests per minute per account. If exceeded, you will receive status 429.

Need help with your integration?

Create a ticket via "My Gyvex" in your dashboard. With Premium you get priority support, with a reply within 24 hours.