Items uit het domein “deliveries” stellen een leveringsbon voor.
Opbouw URL’s:
https://eenvoudigfactureren.be/api/v1/deliveries: Leveringsbongegevens
https://eenvoudigfactureren.be/api/v1/deliveries/4004: Leveringsbon met ID 4004
https://eenvoudigfactureren.be/api/v1/deliveries/4004/items: Items van leveringsbon met ID 4004
https://eenvoudigfactureren.be/api/v1/deliveries/4004/items/5004: Item met ID 5004 van leveringsbon met ID 4004
https://eenvoudigfactureren.be/api/v1/deliveries/4004/remarks: Opmerkingen van leveringsbon met ID 4004
https://eenvoudigfactureren.be/api/v1/deliveries/4004/remarks/5010: Opmerking met ID 5010 van leveringsbon met ID 4004
https://eenvoudigfactureren.be/api/v1/deliveries/4004/events: Gebeurtenissen van leveringsbon met ID 4004
https://eenvoudigfactureren.be/api/v1/deliveries/4004/events/5030: Gebeurtenis met ID 5030 van leveringsbon met ID 4004
Domein : deliveries
| Veldnaam | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
| delivery_id | int | Unieke ID van de leveringsbon. Gegenereerd door het systeem. Verplicht op te geven in URL (behalve bij creatie). | 4004 |
| uri | text | URL naar de leveringsbon. Gegenereerd door het systeem. Te gebruiken bij aanspreken leveringsbon langs de API. | – |
| external_delivery_id | text | (Unieke) ID van de leveringsbon dat kan worden ingesteld door een externe partij. Maximum 50 karakters lang. Uniekheid van de waarde wordt niet afgedwongen. | delivery-548984 |
| client_id | int | Unieke ID van de klant. Verplicht op te geven. | 1001 |
| client_uri | text | URL naar de klant. Gegenereerd door het systeem. Te gebruiken bij aanspreken klant langs de API. | – |
| client_name | text | Naam van de klant. Wordt automatisch overgenomen uit de klantgegevens indien niet opgegeven. | IT Services BVBA |
| client_attention | text | T.a.v. van de klant. Wordt automatisch overgenomen uit de klantgegevens indien niet opgegeven. | Dienst administratie |
| type | text | Type van het document. Bevat steeds de waarde: ‘delivery’. Wordt bepaald door het systeem en kan niet zelf worden doorgegeven. | delivery |
| number | text | Uniek nummer van de leveringsbon zoals getoond op de leveringsbon. Wordt gegenereerd indien niet meegegeven. Maximum 255 karakters lang. | 00000001 |
| layout_id | int | Unieke ID van de layout. Indien niet opgegeven wordt de standaard layout automatisch bepaald. Kan leeg zijn indien er geen layout voor de account werd ingesteld. | 8001 |
| reference | text | Zelf opgegeven referentie van de leveringsbon. Niet verplicht. Maximum 250 karakters lang. | REF123456789 |
| date | date | Datum creatie van de leveringsbon. Wordt gegenereerd indien niet meegegeven. Formaat YYYY-MM-DD. | 2018-02-15 |
| status | text | Status van de leveringsbon. Mogelijke waarden: ‘open’ (=Openstaand), ‘completed’ (=Opgeleverd). Standaard status is ‘open’. | open |
| billing_address | Address | Facturatieadres van de klant. Wordt automatisch overgenomen uit de klantgegevens indien niet opgegeven. | – |
| delivery_address | Address | Verzendadres van de klant. Wordt automatisch overgenomen uit de klantgegevens indien niet opgegeven. | – |
| site_address | Address | Werfadres van de klant. Wordt automatisch overgenomen uit de klantgegevens indien niet opgegeven. | – |
| language | text | De taal waarin de leveringsbon wordt opgemaakt. Deze waarde kan ‘dutch’, ‘french’, ‘english’ of ‘german’ bevatten maar kan ook leeg zijn. Indien leeg (= standaard waarde) wordt de standaard taal (dutch) gebruikt. | dutch |
| items | list | Lijst met leveringsbon-items. | – |
| note | text | Nota die onderaan de leveringsbon wordt getoond. Optioneel mee te geven. Maximum 2000 karakters lang. | Garantievoorwaarden van toepassing |
| note_html | html | Nota die onderaan de leveringsbon wordt getoond in HTML formaat. Optioneel mee te geven. Maximum 2000 karakters lang. | <p>Garantievoorwaarden van toepassing</p> |
| last_activity | datetime | Tijdstip met de laatste activiteit van de leveringsbon. Kan niet worden opgegeven, wordt automatisch bepaald door het systeem. | 2018-05-03 11:33:45 |
| custom_values | list | Lijst met extra velden die kunnen worden toegevoegd aan de leveringsbon. De beschikbare extra velden kunnen worden ingesteld via “Instellingen” > “Geavanceerd”. | – |
| tags | list | Lijst met tags die aanduiden welke acties reeds werden uitgevoerd voor de leveringsbon. | – |
| remarks | list | Lijst met persoonlijke opmerkingen op de leveringsbon. | – |
| events | list | Lijst met gebeurtenissen van de leveringsbon. | – |
Subdomein : items ( < deliveries )
| Veldnaam | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
| item_id | int | Unieke ID van het leveringsbon-item. Gegenereerd door het systeem. Verplicht op te geven in URL (behalve bij creatie). | 4004 |
| delivery_id | int | Unieke ID van de leveringsbon. Gegenereerd door het systeem. Verplicht op te geven in URL. | 3003 |
| uri | text | URL naar leveringsbon-item. Gegenereerd door het systeem. Te gebruiken bij aanspreken leveringsbon-item langs de API. | – |
| type | text | Type van het leveringsbon-item. Standaard is 'item'. Kan ook 'text' (=informatieve lijn) bevatten. | item |
| quantity | float | Aantal eenheden van het leveringsbon-item. Kan tot op 2 decimalen nauwkeurig opgegeven worden. Indien niet opgegeven wordt standaard ‘1’ gebruikt. Het maximumbedrag is 99.999,99. | 2 |
| unit | text | Eenheid van het item. Niet verplicht. Maximum 10 karakters lang en moet beginnen met een letter. Mag geen spaties bevatten. | stuk |
| stockitem_code | text | Artikelcode gekoppeld aan het item. Niet verplicht. Maximum 20 karakters lang. Toevoegen van een artikelcode heeft geen invloed op het aantal items in voorraad op de artikelenlijst. | A0000001 |
| stockitem_id | int | Unieke ID van het artikel. Niet verplicht. Kan enkel gebruikt worden tijdens aanmaken of bewerken. Door deze ID door te geven worden niet opgegeven velden zoals “description” en “stockitem_code” automatisch aangevuld. | 2002 |
| quantity_with_unit | text | Aantal en eenheid van het item gescheiden door een spatie. Kan enkel gebruikt worden tijdens aanmaken of bewerken. Kan niet gebruikt worden in combinatie met veld ‘quantity’ of ‘unit’. Dezelfde beperkingen als velden ‘quantity’ en ‘unit’ zijn van toepassing. | 2 stuk |
| description | text | Omschrijving van het leveringsbon-item. Verplicht op te geven bij creatie (alternatief kan veld description_html worden gebruikt). | product omschrijving |
| description_html | html | Omschrijving van het leveringsbon-item in HTML formaat. Verplicht op te geven bij creatie (alternatief kan veld description worden gebruikt). | <p>product omschrijving</p> |
| custom_values | list | Lijst met extra velden. De beschikbare velden worden toegevoegd via “Instellingen” > “Geavanceerd”. | – |
Subdomein : custom_values ( < deliveries + items < deliveries )
| Veldnaam | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
| name | text | Interne naam van het extra veld. Wordt bepaald bij aanmaak van het standaard veld en kan worden gebruikt als unieke identificatie van het standaard veld. Verplicht op te geven bij toevoegen of wijzigen van de waarde van dit veld. | myreference |
| description | text | Naam of omschrijving van het extra veld zoals het wordt weergegeven bij gebruik. Wordt enkel informatief teruggegeven en kan niet worden aangepast via de API. | Onze referentie |
| value | text | Waarde van het extra veld. Maximum 75 karakters lang. | 123456 |
Subdomein : tags ( < deliveries )
| Veldnaam | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
| tag_id | number | Unieke ID van de tag | 3 |
| name | text | Naam of code van de tag. Mogelijke waardes: ‘printed’ (tag_id=3), ‘sent’ (tag_id=6), ‘accountant’ (tag_id=9). | printed |
Opmerking: Het subdomein ‘tags’ is geen volwaardige subdomein en kan niet los van domein ‘deliveries’ worden aangesproken. Het is niet mogelijk om waardes in tags aan te passen langs de API. Deze gegevens worden automatisch toegevoegd op basis van uitgevoerde acties.
Subdomein : remarks ( < deliveries )
| Veldnaam | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
| remark_id | int | Unieke ID van de opmerking. Gegenereerd door het systeem. Verplicht op te geven in URL (behalve bij creatie). | 5020 |
| delivery_id | int | Unieke ID van de leveringsbon. Gegenereerd door het systeem. Verplicht op te geven in URL. | 3003 |
| uri | text | URL naar opmerking. Gegenereerd door het systeem. Te gebruiken bij aanspreken opmerking langs de API. | – |
| date | date | Datum waarop de opmerking werd toegevoegd. Indien niet opgegeven wordt de huidige datum gebruikt. Formaat is YYYY-MM-DD. | 2012-02-15 |
| description | text | Omschrijving van de opmerking. Verplicht op te geven bij creatie of wijziging (alternatief kan veld description_html worden gebruikt). | Klant dringt aan op spoedige levering |
| description_html | html | Omschrijving van de opmerking in HTML formaat. Verplicht op te geven bij creatie of wijziging (alternatief kan veld description worden gebruikt). | <p>Klant dringt aan op spoedige levering</p> |
Subdomein : events ( < deliveries )
| Veldnaam | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
| event_id | int | Unieke ID van de gebeurtenis. Gegenereerd door het systeem. Verplicht op te geven in URL. | 5030 |
| delivery_id | int | Unieke ID van de leveringsbon. Gegenereerd door het systeem. Verplicht op te geven in URL. | 3003 |
| uri | text | URL naar gebeurtenis. Gegenereerd door het systeem. Te gebruiken bij aanspreken gebeurtenis langs de API. | – |
| date | date | Datum waarop de gebeurtenis heeft plaatsgevonden. Formaat YYYY-MM-DD. | 2012-02-15 |
| type | text | Type van de gebeurtenis. Momenteel enkel ’email sent’ mogelijk. | email sent |
| content | text | Inhoud of omschrijving van de gebeurtenis. Bij type ’email sent’ komt hierin de inhoud van de email terecht. | In bijlage uw leveringsbon |
| recipients | list | Lijst met ontvangers van de gebeurtenis. | – |
Opmerking: Een element van het subdomein ‘events’ kan niet worden gewijzigd of zelf worden aangemaakt. Enkel het systeem kan een ‘event’ aanmaken.
Subdomein : recipients ( < events < deliveries )
| Veldnaam | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
| name | text | Naam (voornaam + familienaam) van de ontvanger. | Bart Decouster |
| email_address | text | Email adres van de ontvanger. | bart.decouster@hisdomain.com |
| external_event_recipient_id | text | Externe unieke referentie naar dit record. | 17ad5dfc-b03e-4fd3-b66b-05b264cfa0c6 |
| status | text | Status die teruggeeft of de event reeds toegekomen is bij ontvanger. Mogelijke statussen zijn: sending, sent, open, failed. | sending |
| information | text | Bijkomende informatie rond de status. Hier komt een foutmelding terecht indien status in ‘failed’ staat. | – |
Opmerking: Het subdomein ‘recipients’ is geen volwaardige subdomein en kan niet los van subdomein ‘events’ worden aangesproken.
Voorbeeld in XML van een leveringsbon:
<delivery>
<delivery_id>5005</delivery_id>
<uri>https://eenvoudigfactureren.be/api/v1/deliveries/5005</uri>
<external_delivery_id>delivery-0983984</external_delivery_id>
<client_id>1001</client_id>
<client_uri>https://eenvoudigfactureren/api/v1/clients/1001</client_uri>
<client_name>IT Services BVBA</client_name>
<client_attention>Dienst administratie</client_attention>
<type>delivery</type>
<number>00000001</number>
<layout_id>8001</layout_id>
<reference>ID123456789</reference>
<date>2018-02-15</date>
<status>open</status>
<billing_address>
<street>Olifantstraat 200</street>
<street2></street2>
<postal_code>9000</postal_code>
<city>Gent</city>
<country_code>BE</country_code>
<country>België</country>
</billing_address>
<delivery_address>
<street>Olifantstraat 200</street>
<street2></street2>
<postal_code>9000</postal_code>
<city>Gent</city>
<country_code>BE</country_code>
<country>België</country>
</delivery_address>
<site_address>
<street>Olifantstraat 200</street>
<street2></street2>
<postal_code>9000</postal_code>
<city>Gent</city>
<country_code>BE</country_code>
<country>België</country>
</site_address>
<language>dutch</language>
<items>
<item>
<item_id>4004</item_id>
<uri>https://eenvoudigfactureren.be/api/v1/deliveries/5005/items/4004</uri>
<type>item</type>
<description>product omschrijving</description>
<description_html><![CDATA[<p>product omschrijving</p>]]></description_html>
<quantity>2</quantity>
<unit>stuk</unit>
<stockitem_code>A000001</stockitem_code>
<custom_values>
<custom_value>
<name>ean</name>
<description>EAN</description>
<value>100000000000001</value>
</custom_value>
</custom_values>
</item>
</items>
<note>Garantievoorwaarden zijn van toepassing.</note>
<note_html><![CDATA[<p>Garantievoorwaarden zijn van toepassing.</p>]]></note_html>
<last_activity>2018-05-03 11:33:45</last_activity>
<custom_values>
<custom_value>
<name>myreference</name>
<description>Onze referentie</description>
<value>123456</value>
</custom_value>
</custom_values>
<tags>
<tag>
<tag_id>3</tag_id>
<name>printed</name>
</tag>
</tags>
<remarks>
<remark>
<remark_id>5020</remark_id>
<uri>https://eenvoudigfactureren.be/api/v1/deliveries/5005/remarks/5020</uri>
<date>2012-02-15</date>
<description>Klant dringt aan op spoedige levering</description>
<description_html><![CDATA[<p>Klant dringt aan op spoedige levering</p>]]></description_html>
</remark>
</remarks>
<events>
<event>
<event_id>5030</event_id>
<uri>https://eenvoudigfactureren.be/api/v1/deliveries/5005/events/5030</uri>
<date>2012-02-16</date>
<type>email sent</type>
<content>In bijlage uw leveringsbon</content>
<recipients>
<recipient>
<name>Bart Decouster</name>
<email_address>bart.decouster@hisdomain.com</email_address>
<external_event_recipient_id>17ad5dfc-b03e-4fd3-b66b-05b264cfa0c6</external_event_recipient_id>
<status>sending</status>
<information>-</information>
</recipient>
</recipients>
</event>
</events>
</delivery> Meer info over de API? Lees onderstaande nuttige artikels