Nieuwe gegevens worden steeds aangemaakt via de POST-methode.
Gebruik hierbij de juiste API-endpoint, bestaande uit het relevante domein (bijv. invoices, clients, payments) en eventueel een subdomein indien nodig.
Voorbeelden
Een nieuwe factuur aanmaken: POST /api/v1/invoices
- Een betaling toevoegen aan factuur met ID 1001: POST /api/v1/invoices/1001/payments
Ondersteunde formaten voor data-invoer
De data die je meestuurt kan in de volgende formaten worden aangeleverd:
JSON (aanbevolen)
XML
- Form-encoding (bijvoorbeeld application/x-www-form-urlencoded)
Belangrijk:
Bij JSON en XML kan je alle gegevens in één keer doorgeven (bijv. een factuur mét alle bijhorende factuurlijnen).
Bij form-encoding moet je elk onderdeel afzonderlijk verzenden (eerst de factuur, daarna elke factuurlijn apart).
Antwoord van de API
Na het verzenden van een POST-verzoek ontvang je een antwoord in het gevraagde formaat, met de status van de actie:
- Bij een fout: een error-object
- Bij succes: een success-melding inclusief de ID van het nieuw aangemaakte object en de bijhorende URI
Voorbeeld bij fout:
{
"error": "description is required"
}Voorbeeld bij succes:
{
"success": "invoice created",
"invoice_id": 1001,
"uri": "https://eenvoudigfactureren.be/api/v1/invoices/1001"
}Voorbeelden
Voorbeeld invoergegevens in JSON om een factuur aan te maken:
{
"client_id": 101,
"days_due": 14,
"items": [
{
"description": "Jouw bestelling",
"amount": 20.5
},
{
"description": "Levering",
"amount": 4
},
]
}Factuur aanmaken in curl:
curl -X POST "https://eenvoudigfactureren.be/api/v1/invoices" \ -H "X-API-Key: your_api_key_here" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ --data @invoiceData.json
Factuur aanmaken in JavaScript:
fetch("https://eenvoudigfactureren.be/api/v1/invoices", {
method: "POST",
headers: {
"X-API-Key": "your_api_key_here",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify(jsonData)
})
.then(response => {
if (!response.ok) {
return response.text().then(errorText => {
throw new Error(errorText);
});
}
return response.text();
})
.then(result => {
console.log("Response:", result);
})
.catch(error => {
console.error("Error:", error.message);
});Factuur aanmaken in PHP:
$p = curl_init('https://eenvoudigfactureren.be/api/v1/invoices');
curl_setopt($p, CURLOPT_HTTPHEADER, [
"X-API-Key: your_api_key_here",
'Content-Type: application/json',
'Accept: application/json'
]);
curl_setopt($p, CURLOPT_POSTFIELDS, $jsonData);
curl_setopt($p, CURLOPT_RETURNTRANSFER, TRUE);
$response = curl_exec($p);
if (curl_errno($p)) {
echo 'Error:' . curl_error($p);
} else {
echo $response;
}
curl_close($p);