HostFact API versie 3.1



Debiteuren

Debiteuren zijn te beheren via de controller 'debtor'.



sendemail

Middels deze functie kunt u een e-mail sturen naar een debiteur. U kunt een bestaande e-mail templates gebruiken en/of gegevens overschrijven. U kunt tevens factuur, domeinnaam, hosting etc. variabelen gebruiken in de e-mail. Gebruik de 'References' parameter om de factuur, domeinnaam, hosting etc. informatie mee te geven.
Voorbeeldbestand: /voorbeelden/debtor/debtor.sendemail.php


Invoerparameters:
Veldnaam Waarde Omschrijving
Identifier int De unieke ID van een debiteur
op te halen via de list functie
DebtorCode string Het debiteurnummer
TemplateID int De unieke ID van een e-mail template.
Recipient string Afwijkend e-mailadres ontvanger.
Standaard: e-mailadres debiteur
Subject string Afwijkend onderwerp
Message string Afwijkend bericht (in HTML)
SenderName string Afwijkende naam afzender
SenderEmail string Afwijkend e-mailadres afzender
CC string Afwijkende waarde voor CC-veld
BCC string Afwijkende waarde voor BCC-veld
References array Array met als key een object-type en value de ID.
Bijvoorbeeld:
array('hosting' => 1, 'domain' => 1, 'invoice' => 1);
SkipDefaultBCC 'yes' of 'no' Voorkom een BCC naar het standaard BCC adres. Standaard: 'no'
Verplichte velden: Identifier of DebtorCode, TemplateID

Voorbeeld invoer:
<?php

require_once("../hostfact_api.php");

$api = new HostFactAPI();

$debtorParams = array(
	'Identifier'	=> 1, // Debtor ID
	'Message' => 'test',
	//'Recipient' => '', // By default debtor e-mailaddress
	'TemplateID'	=> 5, // E-mailtemplate ID
	//'References' => array('invoice' => 1, 'domain' => 1), // Array with references, for filling variables
);

$response = $api->sendRequest('debtor', 'sendemail', $debtorParams);

print_r_pre($response);

?>

Voorbeeld uitvoer:
Array
(
    [controller] => debtor
    [action] => sendemail
    [status] => success
    [date] => 2022-11-24T12:00:00+02:00
    [debtors] => Array
        (
            [0] => E-mail met onderwerp 'Welkom bij HostFact' is succesvol verzonden naar info@company.com
        )

)