Facturen Resource

GET: /leden/facturen | Paginated

Geeft een lijst terug met facturen. Alleen de facturen waarbij de details al geimporteerd zijn worden terug gegeven.

Since

Het is mogelijk om een lijst op te halen met veranderingen sinds een bepaalde tijd. Dit doe je door de volgende GET parameter mee te geven

Parameters:
Key Beschrijving Noodzaak
since De timestamp vanaf wanneer je de nieuwe facturen wilt terug krijgen optioneel
Response:
id Factuur id | Unique
debit_nr Debiteuren nummer van het lid waar de factuur bij hoort
file_name Bestandsnaam van de factuur
url Een link beveiligd met een security code waarmee de factuur bekeken kan worden
factuur_datum De datum waarop de factuur is aangemaakt
start_amount Begin saldo van debiteur
end_amount Eind saldo van debiteur
remark Optionele opmerkingen voor lid
created_at De timestamp wanneer het record is aangemaakt in de headless (Format Y-m-d H:i:s)
updated_at De timestamp wanneer het record voor het laatst is geüpdatet (Format: Y-m-d H:i:s)

GET: /leden/facturen/{factuur_id}

Geeft een specifieke factuur terug met de daaraan gekoppelde factuur regels.

Let op! De factuur regels krijg je alleen terug als de API key daar rechten tot heeft.
Response:
id Factuur id | Unique
debit_nr Debiteuren nummer van het lid waar de factuur bij hoort
file_name Bestandsnaam van de factuur
url Een link beveiligd met een security code waarmee de factuur bekeken kan worden
factuur_datum De datum waarop de factuur is aangemaakt
start_amount Begin saldo van debiteur
end_amount Eind saldo van debiteur
remark Optionele opmerkingen voor lid
details
Let op! Dit veld krijg je alleen terug als de API key daar rechten tot heeft

Een lijst met de factuur regels. Hierbij bevat een group factuur regel entry de volgende velden:

  • factuur_nummer - administratief factuurnummer bij Minerva
  • row - Het nummer dat de volgorde van de factuur details aangeeft op de factuur zelf
  • name - naam van factuur regel
  • description - inhoudelijke omschrijving van de factuur regel
  • amount - Hoe vaak de kosten gerekend worden
  • price - Hoe hoog de kosten per stuk zijn
  • total - Totaal van de kosten voor deze regel
  • is_detail - Boolean die aangeeft of het om een detail regel gaat
  • order_date - Datetime die aangeeft wanneer de bestelling geplaatst is
  • created_at
  • updated_at
created_at De timestamp wanneer het record is aangemaakt in de headless (Format Y-m-d H:i:s)
updated_at De timestamp wanneer het record voor het laatst is geüpdatet (Format: Y-m-d H:i:s)

POST: /leden/facturen

Maak een nieuwe factuur aan.

Key Beschrijving Noodzaak Type
debit_nr Debiteuren nummer van het lid die de factuur moet ontvangen. Verplicht integer
file_name De naam van het factuur bestand wat geupload wordt naar de server. Verplicht string
year Het jaar waar de factuur over gaat. Verplicht year(4)
month De maand waar de factuur over gaat. Verplicht integer
factuur_datum De datum dat de factuur uitgegeven wordt. Verplicht date("d-m-Y")
start_amount Begin saldo van debiteur Optioneel float
end_amount Eind saldo van debiteur Optioneel float
remark Optionele opmerkingen voor lid Optioneel string

PUT/PATCH: /leden/facturen/{factuur_id}

Update een specifieke factuur.
Parameters:
Key Beschrijving Noodzaak
debit_nr Debiteuren nummer van het lid die de factuur moet ontvangen. integer
file_name De naam van het factuur bestand wat geupload wordt naar de server. string
year Het jaar waar de factuur over gaat. year(4)
month De maand waar de factuur over gaat. integer
factuur_datum De datum dat de factuur uitgegeven wordt. date("d-m-Y")
start_amount Begin saldo van debiteur Optioneel float
end_amount Eind saldo van debiteur Optioneel float
remark Optionele opmerkingen voor lid Optioneel string

DELETE: /leden/facturen/{factuur_id}

Verwijderd een factuur, het fysieke bestand op de server en alle factuur details die bij deze factuur horen.