Mogelijkheden 
Gebruikers Login

Facturen API


Met de API van DigitaleFactuur beheert u gemakkelijk uw facturen. Schrijf hiervoor uw eigen code of gebruik de voorbeeldcode op deze pagina. Kies hieronder de code die u wilt bekijken.


Actie URL Methode Import of export
Factuur aanmaken /factuur_aanmaken POST Import
Factuur betaling verwerken
- deelbetaling verwerken
- betaling ongedaan maken
/factuur_betaling_verwerken
/factuur_deelbetaling_verwerken
/factuur_betaling_ongedaan_maken

POST

Import
Factuur versturen /factuur_versturen POST Import
Factuur bijwerken /factuur_update POST Import
Factuur verwijderen /factuur_verwijderen POST Import
Facturen ophalen /factuur_ophalen GET Export
Factuur downloaden /factuur_downloaden GET Export

Factuur aanmaken


Bij het aanmaken van de factuur kunt u een bestaande klant van uw account gebruiken of een nieuwe klant laten aanmaken. Bij een nieuwe klant moet u de klantgegevens meesturen en bij een bestaande klant moet u het klant_id meegeven (zie voorbeelden hieronder). Wanneer CURL deze actie succesvol heeft uitgevoerd, krijgt u naast de resultaaat code ook het factuur_id terug.

Let op: deze actie kan slechts op één factuur per keer uitgevoerd worden!


XML-structuur
Voorbeeld PHP-script

Factuur betaling


U kunt een factuurbetaling verwerken, een deelbetaling van een factuur verwerken of een factuurbetaling ongedaan maken. Het verwerken van een deelbetaling is dezelfde actie als een volledige betaling, maar u stuurt ook het bedrag van de deelbetaling mee. Bij het ongedaan maken van een betaling is slechts het factuur_id nodig.

Let op: deze actie kan slechts op één factuur per keer uitgevoerd worden!


XML-structuur
Voorbeeld PHP-script

Factuur versturen


Een factuur kan per email of per post verstuurd worden. Kies hiervoor in het blok 'methode' in de XML de waarde 'email' of 'post'. Kiest u voor email, dan gebruikt DigitaleFactuur de klant, de emailtekst en het sjabloon dat u bij de factuur hebt opgegeven. Wanneer u één of meerdere van deze velden meegeeft, dan worden die gebruikt. Kiest u voor post, dan is alleen het veld post_type (kleur of zwartwit) verplicht, de velden klant_naam, klant_adres, klant_postcode en klant_plaats verplicht zijn optioneel.

Let op: deze actie kan slechts op één factuur per keer uitgevoerd worden!


XML-structuur
Voorbeeld PHP-script

Factuur bijwerken


Let op: deze actie kan slechts op één factuur per keer uitgevoerd worden!


XML-structuur
Voorbeeld PHP-script

Factuur verwijderen


Let op: deze actie kan slechts op één factuur per keer uitgevoerd worden!


Voorbeeld PHP-script

Facturen ophalen


Deze actie kan zowel op één factuur als op meerdere facturen uitgevoerd worden, tot een limiet van 50.

U kunt de volgende aanvullende parameters in de URL plaatsen:

  • facturen_id - alleen cijfers
  • betaalstatus - betaald of openstaand
  • factuurnummer - alleen cijfers

Voorbeeld PHP-script

Factuur downloaden


Let op: deze actie kan slechts op één factuur per keer uitgevoerd worden!


Voorbeeld PHP-script

Overige documentatie:    Algemene API info    Klanten API


slogan