Je kan, net zoals je dit op de website kan, ook een factuur, offerte, kasticket, bestelbon of leveringsbon per e-mail versturen naar de klant langs de API.
Gebruik hiervoor de POST-methode met als URL bijvoorbeeld https://eenvoudigfactureren.be/api/v1/invoices/1001?send_mail.
Je moet hierbij wel enkele bijkomende gegevens meegeven (in XML, JSON of form-encoding):
- recipient (text): E-mailadres of contact_id van de klant waarnaartoe de e-mail wordt verzonden. Kan ook worden opgegeven: ‘myself’ (uzelf in kopie), ‘main_contact’ (algemeen adres van de klant), ‘first_contact’ (algemeen adres of een ander beschikbaar e-mail adres), ‘all_contacts’ (alle beschikbare e-mailadressen). Het is ook mogelijk om een space separated lijst van voorgaande waarden op te geven.
- recipients (list): Lijst met recipient-waarden (zie voorgaande).
- subject (text): Het onderwerp van de email. Indien niet opgegeven wordt het standaard onderwerp gebruikt (zie Instellingen van uw account).
- message (text): De tekst-inhoud van de email. Indien niet opgegeven wordt de standaard email-inhoud gebruikt (zie Instellingen van uw account). Alternatief kan 'message_html' veld worden opgegeven.
- message_html (html): De tekst-inhoud van de email. Indien niet opgegeven wordt de standaard email-inhoud gebruikt (zie Instellingen van uw account). Alternatief kan 'message' veld worden opgegeven.
- document_type: Type van het document. Enkel van toepassing bij verzending van factuur. Kan volgende waardes bevatten: ‘pdf’, ‘ubl’, ‘both’ (= pdf + ubl), ‘duplicate’ (=duplicaat factuur in pdf), ‘reminder’ (=herinneringsdocument), ‘reminder_summary’ (=samenvattingsdocument herinnering). Indien niet opgegeven wordt ‘pdf’ gebruikt.
- attachments (list): Optioneel een lijst met attachments (zie verder).
Je moet bij een aanvraag tenminste 1 ontvanger meegeven. Jezelf als ontvanger opgeven is reeds voldoende. Een combinatie van verschillende velden ontvangers is mogelijk.
Een voorbeeld in XML om jouw gegevens door te geven:
<data> <recipients> <recipient>customer1@hisdomain.com</recipient> <recipient>123548</recipient> <recipient>myself</recipient> </recipients> <message>Beste, In bijlage vindt u uw factuur terug.</message> <attachments> <attachment> <upload_id>a9c4c541-33fc-4c34-894b-fcd091d45fc9</upload_id> <filename>Mijn Bijlage.docx</filename> </attachment> </attachments> </data>
of
<data> <recipient>customer1@hisdomain.com 123548 myself</recipient> <message>Beste, In bijlage vindt u uw factuur terug.</message> </data>
Een voorbeeld in PHP hoe je een factuur kan versturen langs email:
$params = [ 'recipient' => "customer@hisdomain.com myself", 'message' => "Beste,\\nIn bijlage vindt u uw factuur terug." ]; $p = curl_init('https://eenvoudigfactureren.be/api/v1/invoices/1001?send_mail'); curl_setopt($ch, CURLOPT_HTTPHEADER, [ "X-API-Key: your_api_key_here", "Content-Type: application/json", "Accept: application/json" ]); curl_setopt($p, CURLOPT_POSTFIELDS, $params); curl_setopt($p, CURLOPT_RETURNTRANSFER, true); $result_in_xml_string = curl_exec($p); curl_close($p);
Attachments toevoegen tijdens versturen e-mail (POST) via API
Tijdens het versturen van een factuur of offerte per e-mail kan je ook bijkomend attachments toevoegen.
Gebruik hiervoor de POST-methode met als URL https://eenvoudigfactureren.be/api/v1/uploads.
Verstuur het bestand als form-data met als key ‘file’. Het bestand mag niet groter zijn dan 5MB. Je kan meerdere bestanden in één keer toevoegen door ‘file[]’ te gebruiken. Optioneel kan je ook een bestandsnaam meegeven langs key ‘filename’.
Als antwoord krijg je een lijst terug met per opgeladen bestand:
- upload_id: Deze gebruik je bij het verzenden van de e-mail (argument attachments)
- filename: Doorgegeven bestandsnaam (deze wordt echter niet bijgehouden en dien je opnieuw door te geven tijdens doorsturen van de attachment per e-mail).
- available_until: Geldigheidsperiode waarin het bestand beschikbaar blijft (tot 1 uur na opladen van het bestand).