Items uit het domein “orders” stellen een bestelbon voor.


Opbouw URL’s:

https://eenvoudigfactureren.be/api/v1/orders: Bestelbongegevens

https://eenvoudigfactureren.be/api/v1/orders/4004: Bestelbon met ID 4004

https://eenvoudigfactureren.be/api/v1/orders/4004/items: Items van bestelbon met ID 4004

https://eenvoudigfactureren.be/api/v1/orders/4004/items/5004: Item met ID 5004 van bestelbon met ID 4004

https://eenvoudigfactureren.be/api/v1/orders/4004/remarks: Opmerkingen van bestelbon met ID 4004

https://eenvoudigfactureren.be/api/v1/orders/4004/remarks/5010: Opmerking met ID 5010 van bestelbon met ID 4004

https://eenvoudigfactureren.be/api/v1/orders/4004/events: Gebeurtenissen van bestelbon met ID 4004

https://eenvoudigfactureren.be/api/v1/orders/4004/events/5030: Gebeurtenis met ID 5030 van bestelbon met ID 4004


Domein : orders

VeldnaamTypeOmschrijvingVoorbeeld
order_idintUnieke ID van de bestelbon. Gegenereerd door het systeem. Verplicht op te geven in URL (behalve bij creatie).4004
uritextURL naar de bestelbon. Gegenereerd door het systeem. Te gebruiken bij aanspreken bestelbon langs de API.
external_order_idtext(Unieke) ID van de bestelbon dat kan worden ingesteld door een externe partij. Maximum 50 karakters lang. Uniekheid van de waarde wordt niet afgedwongen.Order-548984
client_idintUnieke ID van de klant. Verplicht op te geven.1001
client_uritextURL naar de klant. Gegenereerd door het systeem. Te gebruiken bij aanspreken klant langs de API.
client_nametextNaam van de klant. Wordt automatisch overgenomen uit de klantgegevens indien niet opgegeven.IT Services BVBA
client_attentiontextT.a.v. van de klant. Wordt automatisch overgenomen uit de klantgegevens indien niet opgegeven.Dienst administratie
typetextType van het document. Bevat steeds de waarde: ‘order’. Wordt bepaald door het systeem en kan niet zelf worden doorgegeven.order
numbertextUniek nummer van de bestelbon zoals getoond op de bestelbon. Wordt gegenereerd indien niet meegegeven. Maximum 255 karakters lang.00000001
layout_idintUnieke 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
referencetextZelf opgegeven referentie van de bestelbon. Niet verplicht. Maximum 250 karakters lang.REF123456789
datedateDatum creatie van de bestelbon. Wordt gegenereerd indien niet meegegeven. Formaat YYYY-MM-DD.2018-02-15
days_deliveryintAantal dagen levering na datum bestelbon. Indien niet opgegeven worden de standaard volgens instellingen genomen. Maximumwaarde 999 dagen. Indien 0 is er geen leveringsdatum.14
date_deliverydateDatum levering van de bestelbon. Wordt gegenereerd op basis van ‘date’ en ‘days_delivery’. Formaat YYYY-MM-DD.2018-02-29
days_lateintAantal dagen dat leveringsdatum reeds werd overschreden t.o.v. de huidige datum. Wordt enkel getoond indien status ‘late’. Wordt gegenereerd door het systeem en kan niet zelf worden opgegeven.0
deposit_paidfloatVoorschot-bedrag van de bestelbon. Kan tot op 2 decimalen nauwkeurig opgegeven worden. Indien niet opgegeven is wordt standaard 0.00 gebruikt.10.00
statustextStatus van de bestelbon. Mogelijke waarden: ‘open’, ‘late’, ‘create_invoice’, ‘completed’. Status ‘late’ wordt automatisch bepaald door het systeem en kan niet zelf worden opgegeven. De waarden ‘open’ (=Openstaand), ‘create_invoice’ (=Te factureren), ‘completed’ (=Opgeleverd) kunnen worden opgegeven. Standaard status is ‘open’.open
billing_addressAddressFacturatieadres van de klant. Wordt automatisch overgenomen uit de klantgegevens indien niet opgegeven.
delivery_addressAddressVerzendadres van de klant. Wordt automatisch overgenomen uit de klantgegevens indien niet opgegeven.
site_addressAddressWerfadres van de klant. Wordt automatisch overgenomen uit de klantgegevens indien niet opgegeven.
discount_percentagefloatKortingspercentage die geld voor de hele bestelbon. Bedrag moet tussen 0 en 100 liggen. Getallen tot 2 cijfers na de komma zijn toegestaan. Indien niet opgegeven is deze waarde 0.5
currencytextDe munteenheid waarin de bestelbon wordt opgemaakt. Deze waarde moet deel uitmaken van een limitatieve lijst van de ondersteunde munteenheden. De waarde is 3 tekens lang en steeds in hoofdletters. Indien niet opgegeven wordt EUR gebruikt.EUR
exchange_ratenumberDe omwisselingskoers om de bedragen op de bestelbon om te zetten naar EUR.1
show_tax_for_exchange_ratetextToon de BTW omgerekend naar EURO op de bestelbon indien er een andere munt wordt gebruikt (wettelijk verplicht op een factuur). Kan waarde ‘yes’ of ‘no’ hebben. Indien leeg is de standaard waarde ‘yes’.yes
languagetextDe taal waarin de bestelbon 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
tax_calculationtextDe berekeningswijze BTW van de bestelbon. Mogelijke waardes: ‘total’, ‘item’. Standaard wordt ‘total’ gebruikt. Bij berekeningswijze ‘total’ wordt de BTW berekend op het totaalbedrag van de bestelbon, bij berekeningswijze ‘item’ wordt de BTW berekend per bestelbonlijn. Wisselen tussen de berekeningswijze kan afrondingsverschillen geven. Indien ‘tax_included’=’yes’ is enkel ‘item’ een geldige waarde.total
tax_includedtextDuidt aan of de bedragen van de bestelbon al dan niet inclusief BTW werden opgegeven en dus inclusief BTW worden afgedrukt. Kan waarde ‘yes’ of ‘no’ hebben. Indien leeg wordt de standaard waarde bepaald zoals ingesteld voor de account (standaard ‘no’).no
tax_country_codetextISO landcode van het OSS land (One Stop Shop) waar de BTW van toepassing is. Leeg bij gewone BTW berekening.
NL
itemslistLijst met bestelbon-items.
discount_total_without_taxfloatTotaal bedrag van de toegekende korting op het totaal bestelbon zonder rekening te houden met BTW. Wordt automatisch berekend en kan niet zelf worden opgegeven.10.00
total_refundable_depositfloatTotaal bedrag van factuurlijnen met terugbetaalbare verpakking (tax_rate_special_status = DR). Wordt automatisch berekend en kan niet zelf worden opgegeven.5.00
total_without_taxfloatTotaal bedrag over alle factuur-items heen zonder rekening te houden met BTW. Eventuele kortingen (discount_total_without_tax) en terugbetaalbare verpakking (total_refundable_deposit) zijn reeds opgenomen in dit totaal. Wordt automatisch berekend en kan niet zelf worden opgegeven.200.00
tax_rate_1float1e BTW-percentage die kan gebruikt worden op de bestelbon. Wordt tijdens creatie overgenomen uit de instellingen en kan niet zelf worden opgegeven.21
total_tax_1floatTotaal bedrag BTW volgens 1e BTW-percentage over alle items heen. Wordt automatisch berekend en kan niet zelf worden opgegeven.42.00
tax_rate_2float2e BTW-percentage die kan gebruikt worden op de bestelbon. Wordt tijdens creatie overgenomen uit de instellingen en kan niet zelf worden opgegeven.12
total_tax_2floatTotaal bedrag BTW volgens 2e BTW-percentage over alle items heen. Wordt automatisch berekend en kan niet zelf worden opgegeven.0.00
tax_rate_3float3e BTW-percentage die kan gebruikt worden op de bestelbon. Wordt tijdens creatie overgenomen uit de instellingen en kan niet zelf worden opgegeven.6
total_tax_3floatTotaal bedrag BTW volgens 3e BTW-percentage over alle items heen. Wordt automatisch berekend en kan niet zelf worden opgegeven.0.00
discount_total_with_taxfloatTotaal bedrag van de toegekende korting op het totaal van de bestelbon inclusief BTW. Wordt automatisch berekend en kan niet zelf worden opgegeven.12.10
total_with_taxfloatTotaal bedrag over alle items heen inclusief BTW. Wordt automatisch berekend en kan niet zelf worden opgegeven.242.00
notetextNota die onderaan de bestelbon wordt getoond. Optioneel mee te geven. Maximum 2000 karakters lang.Garantievoorwaarden van toepassing
note_htmlhtmlNota die onderaan de bestelbon wordt getoond in HTML formaat. Optioneel mee te geven. Maximum 2000 karakters lang.
<p>Garantievoorwaarden van toepassing</p>
last_activitydatetimeTijdstip met de laatste activiteit van de bestelbon. Kan niet worden opgegeven, wordt automatisch bepaald door het systeem.2018-05-03 11:33:45
custom_valueslistLijst met extra velden die kunnen worden toegevoegd aan de bestelbon. De beschikbare extra velden kunnen worden ingesteld via “Instellingen” > “Geavanceerd”.
tagslistLijst met tags die aanduiden welke acties reeds werden uitgevoerd voor de bestelbon.
remarkslistLijst met persoonlijke opmerkingen op de bestelbon.
eventslistLijst met gebeurtenissen van de bestelbon.



Subdomein : items ( < orders )

VeldnaamTypeOmschrijvingVoorbeeld
item_idintUnieke ID van het bestelbon-item. Gegenereerd door het systeem. Verplicht op te geven in URL (behalve bij creatie).4004
order_idintUnieke ID van de bestelbon. Gegenereerd door het systeem. Verplicht op te geven in URL.3003
uritextURL naar bestelbon-item. Gegenereerd door het systeem. Te gebruiken bij aanspreken bestelbon-item langs de API.
typetextType van het bestelbon-item. Standaard is 'item'. Kan ook 'text' (=informatieve lijn), 'header' (subtotaal bovenaan) of 'footer' (subtotaal onderaan) bevatten.
item
amountfloatBedrag per eenheid (1 quantity) van het bestelbon-item exclusief BTW. Verplicht te gebruiken indien veld tax_included=’no’. Kan tot op 4 decimalen nauwkeurig opgegeven worden. Het maximumbedrag is 9.999.999,9999. Wordt automatisch berekend indien bedrag werd opgegeven via ‘amount_with_tax’.100.00
amount_with_taxfloatBedrag per eenheid (1 quantity) van het bestelbon-item inclusief BTW. Verplicht te gebruiken indien veld tax_included=’yes’. Kan tot op 4 decimalen nauwkeurig opgegeven worden. Het maximumbedrag is 9.999.999,9999. Wordt automatisch berekend indien bedrag werd opgegeven via ‘amount’.121.00
quantityfloatAantal eenheden van het bestelbon-item. Kan tot op 2 decimalen nauwkeurig opgegeven worden. Indien niet opgegeven wordt standaard ‘1’ gebruikt. Het maximumbedrag is 999.999,99.2
unittextEenheid van het item. Niet verplicht. Maximum 10 karakters lang en moet beginnen met een letter. Mag geen spaties bevatten.stuk
stockitem_codetextArtikelcode 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_idintUnieke 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”, “amount”, “stockitem_code”, “tax_rate”, “tax_rate_special_status” en “general_ledger_account” automatisch aangevuld.2002
quantity_with_unittextAantal 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
descriptiontextOmschrijving van het bestelbon-item. Verplicht op te geven bij creatie.product omschrijving
description_htmlhtmlOmschrijving van het bestelbon-item in HTML formaat. Verplicht op te geven bij creatie (alternatief kan veld description worden gebruikt).
<p>product omschrijving</p>
total_without_taxfloatTotaal bedrag van het bestelbon-item zonder BTW. Wordt berekend a.d.h.v. veld ‘amount’ en ‘quantity’.200.00
tax_ratefloatBTW-percentage van het bestelbon-item. Moet overeenkomen met één van de BTW-percentages van de bestelbon of moet ‘0’ zijn. Indien niet opgegeven wordt ‘0’ verondersteld.21
tax_rate_special_statustextCode afwijkend BTW-tarief van het gebruikte BTW-percentage (tax_rate) van het bestelbon-item. Kan enkel gebruikt worden indien het BTW-percentage 0 is. Het veld is optioneel en kan maximum 20 karakters lang zijn.MC
total_with_taxfloatTotaal bedrag van het bestelbon-item inclusief BTW. Wordt berekend a.d.h.v. veld ‘amount’, ‘quantity’ en ‘tax_rate’.242.00
general_ledger_accounttextCode van de grootboekrekening gekoppeld aan het bestelbon-item. Niet verplicht. Tussen 6 en 8 karakters lang, uitsluitend cijfers zijn toegelaten.700000
custom_valueslistLijst met extra velden. De beschikbare velden worden toegevoegd via “Instellingen” > “Geavanceerd”.



Subdomein : custom_values ( < orders + items < orders )

VeldnaamTypeOmschrijvingVoorbeeld
nametextInterne naam van het extra veld. Wordt bepaald bij aanmaak van het extra veld en kan worden gebruikt als unieke identificatie van het extra veld. Verplicht op te geven bij toevoegen of wijzigen van de waarde van dit veld.myreference
descriptiontextNaam 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
valuetextWaarde van het extra veld. Maximum 75 karakters lang.123456



Subdomein : tags ( < orders )

VeldnaamTypeOmschrijvingVoorbeeld
tag_idnumberUnieke ID van de tag3
nametextNaam 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 ‘orders’ 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 ( < orders )

VeldnaamTypeOmschrijvingVoorbeeld
remark_idintUnieke ID van de opmerking. Gegenereerd door het systeem. Verplicht op te geven in URL (behalve bij creatie).5020
order_idintUnieke ID van de bestelbon. Gegenereerd door het systeem. Verplicht op te geven in URL.3003
uritextURL naar opmerking. Gegenereerd door het systeem. Te gebruiken bij aanspreken opmerking langs de API.
datedateDatum waarop de opmerking werd toegevoegd. Indien niet opgegeven wordt de huidige datum gebruikt. Formaat is YYYY-MM-DD.2012-02-15
descriptiontextOmschrijving 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_htmlhtmlOmschrijving 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 ( < orders )

VeldnaamTypeOmschrijvingVoorbeeld
event_idintUnieke ID van de gebeurtenis. Gegenereerd door het systeem. Verplicht op te geven in URL.5030
order_idintUnieke ID van de bestelbon. Gegenereerd door het systeem. Verplicht op te geven in URL.3003
uritextURL naar gebeurtenis. Gegenereerd door het systeem. Te gebruiken bij aanspreken gebeurtenis langs de API.
datedateDatum waarop de gebeurtenis heeft plaatsgevonden. Formaat YYYY-MM-DD.2012-02-15
typetextType van de gebeurtenis. Momenteel enkel ’email sent’ mogelijk.email sent
contenttextInhoud of omschrijving van de gebeurtenis. Bij type ’email sent’ komt hierin de inhoud van de email terecht.In bijlage uw bestelbon
recipientslistLijst 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 < orders )

VeldnaamTypeOmschrijvingVoorbeeld
nametextNaam (voornaam + familienaam) van de ontvanger.Bart Decouster
email_addresstextEmail adres van de ontvanger.bart.decouster@hisdomain.com
external_event_recipient_idtextExterne unieke referentie naar dit record.17ad5dfc-b03e-4fd3-b66b-05b264cfa0c6
statustextStatus die teruggeeft of de event reeds toegekomen is bij ontvanger. Mogelijke statussen zijn: sending, sent, open, failed.sending
informationtextBijkomende informatie rond de status. Hier komt een foutmelding terecht indien status in ‘failed’ staat.

Opmerking: Het subdomein ‘recipients’ kan niet los van subdomein ‘events’ worden aangesproken.


Type : Address

VeldnaamTypeOmschrijvingVoorbeeld
streettextStraat + huisnummer van het adres. Niet verplicht, maximum 150 karakters lang.Langestraat 189
street2textTweede adreslijn van het adres. Niet verplicht, maximum 150 karakters lang.
citytextStad van het adres. Niet verplicht, maximum 50 karakters lang.Antwerpen
postal_codetextDe postcode van de stad van het adres. Niet verplicht, maximum 10 karakters lang.2000
countrytextLand van de klant. Kan niet worden opgegeven. Wordt automatisch bepaald a.d.h.v. country_code.België
country_codetextLandcode van de klant. Verplicht, 2 karakters lang, in hoofdletters.BE


Voorbeeld in XML van een bestelbon:

<order>
  <order_id>5005</order_id>
  <uri>https://eenvoudigfactureren.be/api/v1/orders/5005</uri>
  <external_order_id>Order-0983984</external_order_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>order</type>
  <number>00000001</number>
  <layout_id>8001</layout_id>
  <reference>ID123456789</reference>
  <date>2018-02-15</date>
  <days_delivery>14</days_delivery>
  <date_delivery>2018-02-29</date_delivery>
  <days_late>28</days_late>
  <deposit_paid>10.00</deposit_paid>
  <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>
  <discount_percentage>5</discount_percentage>
  <currency>EUR</currency>
  <exchange_rate>1</exchange_rate>
  <show_tax_for_exchange_rate>yes</show_tax_for_exchange_rate>
  <language>dutch</language>
  <tax_calculation>total</tax_calculation>
  <tax_included>no</tax_included>
  <items>
    <item>
      <item_id>4004</item_id>
      <uri>https://eenvoudigfactureren.be/api/v1/orders/5005/items/4004</uri>
      <type>item</type>
      <description>product omschrijving</description>
      <description_html><![CDATA[<p>product omschrijving</p>]]></description_html>
      <amount>100.00</amount>
      <amount_with_tax>121.00</amount_with_tax>
      <quantity>2</quantity>
      <unit>stuk</unit>
      <stockitem_code>A000001</stockitem_code>
      <total_without_tax>200.00</total_without_tax>
      <tax_rate>21</tax_rate>
      <total_with_tax>242.00</total_with_tax>
      <general_ledger_account>700000</general_ledger_account>
      <custom_values>
          <custom_value>
              <name>ean</name>
              <description>EAN</description>
              <value>100000000000001</value>
          </custom_value>
      </custom_values>
    </item>
  </items>
  <discount_total_without_tax>10.00</discount_total_without_tax>
  <total_without_tax>190.00</total_without_tax>
  <tax_rate_1>21</tax_rate_1>
  <total_tax_1>42.00</total_tax_1>
  <tax_rate_2>12</tax_rate_2>
  <total_tax_2>0.00</total_tax_2>
  <tax_rate_3>6</tax_rate_3>
  <total_tax_3>0.00</total_tax_3>
  <discount_total_with_tax>12.10</discount_total_with_tax>
  <total_with_tax>229.90</total_with_tax>
  <total_paid>25.0</total_paid>
  <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/orders/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/orders/5005/events/5030</uri>
      <date>2012-02-16</date>
      <type>email sent</type>
      <content>In bijlage uw bestelbon</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>
</order>
  Meer info over de API? Lees onderstaande nuttige artikels