← API documentatie

Periodieke facturen API

Inhoud
GET /invoice-schedules

Periodieke facturen ophalen

Geeft uw periodieke facturen (terugkerende factuurschema's) terug, gesorteerd op de eerstvolgende factuurdatum.

Parameter Beschrijving
page, page_size Paginering, standaard 15 per pagina.
Verzoek
curl "https://financial.gyvex.com/api/invoice-schedules" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer UW_API_SLEUTEL"
GET /invoice-schedules/{id}

Periodieke factuur ophalen

Geeft een periodieke factuur terug met klanten en regels.

Verzoek
curl "https://financial.gyvex.com/api/invoice-schedules/3" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer UW_API_SLEUTEL"
POST /invoice-schedule/store

Periodieke factuur aanmaken

Maakt een periodieke factuur aan. Voor elke klant wordt per periode een factuur gemaakt met de opgegeven regels.

Veld Verplicht Beschrijving
name Ja Naam of referentie.
frequency Ja monthly (maandelijks), quarterly (per kwartaal) of yearly (jaarlijks).
next_billing_date Ja Datum van de eerstvolgende factuur.
customers Ja Lijst met klant-ID's die periodiek gefactureerd worden.
items Ja Lijst met regels (zie hieronder).
items[].description Ja Omschrijving van de regel.
items[].quantity Ja Aantal, geheel getal, minimaal 1.
items[].unit_price Ja Prijs per eenheid, excl. btw.
Verzoek
curl -X POST "https://financial.gyvex.com/api/invoice-schedule/store" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer UW_API_SLEUTEL" \
  -H "Content-Type: application/json" \
  -d '{"name": "Hosting", "frequency": "monthly", "next_billing_date": "2026-12-01", "customers": [7], "items": [{"description": "Hosting", "quantity": 1, "unit_price": 25}]}'
PUT /invoice-schedule/{id}/update

Periodieke factuur bijwerken

Werkt een periodieke factuur bij. Geef alle velden mee: de klanten en regels worden volledig vervangen.

Verzoek
curl -X PUT "https://financial.gyvex.com/api/invoice-schedule/3/update" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer UW_API_SLEUTEL" \
  -H "Content-Type: application/json" \
  -d '{"name": "Hosting", "frequency": "yearly", "next_billing_date": "2027-01-01", "customers": [7], "items": [{"description": "Hosting", "quantity": 1, "unit_price": 275}]}'
DELETE /invoice-schedule/{id}

Periodieke factuur verwijderen

Stopt het schema. Reeds aangemaakte facturen blijven bestaan. Bij succes volgt status 204.

Verzoek
curl -X DELETE "https://financial.gyvex.com/api/invoice-schedule/3" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer UW_API_SLEUTEL"

Hulp nodig bij uw koppeling?

Maak een ticket aan via "Mijn Gyvex" in uw dashboard. Met Premium krijgt u priority support, met reactie binnen 24 uur.