Artikelen

Items uit het domein “stockitems” stellen een artikel voor.

Opbouw URL’s:

  • https://eenvoudigfactureren.be/api/v1/stockitems: Artikelen
  • https://eenvoudigfactureren.be/api/v1/stockitems/5004: Artikel met ID 5004

Domein : stockitems

Veldnaam Type Omschrijving Voorbeeld
stockitem_id int Unieke ID van het artikel. Gegenereerd door het systeem. Op te geven in URL. 4004
uri text URL naar het artikel. Gegenereerd door het systeem. Te gebruiken bij aanspreken artikel langs de API. –
code text Unieke code van het artikel. Maximaal 20 karakters. Verplicht op te geven. A000001
description text Omschrijving het van artikel. Maximaal 10000 karakters. Verplicht op te geven. Product 1
type text Type van het artikel. Kan de waarde “single” (= artikel), “combined” (= verzamelartikel), “combined_fixed” (= verzamelartikel met vaste prijs) of “list” (= artikellijst) bevatten. Standaard waarde is “single”. single
comments text Bijkomende informatie bij het artikel. Maximaal 10000 karakters. Optioneel veld. Door leverancier X – nieuwe bestelling doorgegeven.
price float Prijs van het artikel. Optioneel veld. Kan enkel worden opgegeven bij type “single” en “combined_fixed”. 9.99
tax_category int BTW-categorie waartoe het artikel behoort. Kan waarde 1, 2, 3 of 0 hebben waarbij 0 = niet gespecifieerd, 1 = 1e BTW tarief (21%), 2 = 2e BTW tarief (12%) en 3 = 3e BTW tarief (6%) afhankelijk van de BTW-instellingen van uw account. Kan enkel worden opgegeven bij type “single” en “combined_fixed”. 1
tax_category_special_status text Code afwijkend BTW-tarief van het gebruikte BTW-percentage (tax_category) van het stock-item. Kan enkel gebruikt worden indien de BTW-categorie 0 is. Het veld is optioneel en kan maximum 20 karakters lang zijn. Kan enkel worden opgegeven bij type “single” en “combined_fixed”. MC
tax_included text Duidt aan of de opgegeven prijs inclusief of exclusief BTW werd opgegeven. Kan waarde ‘yes’ of ‘no’ hebben. Optioneel veld (standaard ‘no’). Kan enkel worden opgegeven bij type “single” en “combined_fixed”. yes
supply int/text Voorraad van het product. Kan een getal bevatten tussen -999999 en 999999 of de tekst “infinite” als voorraad niet van toepassing is. Kan enkel worden opgegeven bij type “single”. 10
unit text Eenheid van het product. Optioneel veld. Maximaal 10 karakters lang en mag geen spatie bevatten. Indien opgegeven wordt de eenheid automatisch toegevoegd aan de factuur bij selectie van het artikel. Kan enkel worden opgegeven bij type “single”, “combined” en “combined_fixed”. stuk
general_ledger_account text Code van de standaard grootboekrekening van het artikel. Niet verplicht. Tussen 6 en 8 karakters lang, uitsluitend cijfers zijn toegelaten. Kan enkel worden opgegeven bij type “single”, “combined” en “combined_fixed”. 700000
items list Lijst met verwijzing naar onderliggende artikelen. Enkel van toepassing bij type “combined”, “combined_fixed” en “list”. –
custom_values list Lijst met standaard velden. De beschikbare velden worden toegevoegd via “Instellingen” > “Geavanceerd”. –
active text Bepaald of het artikel actief is. Kan waarde ‘yes’ of ‘no’ hebben. yes
last_activity datetime Tijdstip met de laatste activiteit van het artikel. Kan niet worden opgegeven, wordt automatisch bepaald door het systeem. 2020-05-03 11:33:45

Subdomein : items ( < stockitems )

Veldnaam Type Omschrijving Voorbeeld
stockitem_id number Unieke ID van het onderliggende artikel 4001
quantity number Aantal van het artikel. Kan een getal bevatten tussen -999999 en 999999. 1

Subdomein : custom_values ( < stocktitems )

Veldnaam Type Omschrijving Voorbeeld
name text Interne naam van het standaard 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 standaard 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 standaard veld. Maximum 75 karakters lang. 123456

Voorbeeld in XML van een artikel:

<stockitem>
	<stockitem_id>4004</stockitem_id>
	<uri>https://eenvoudigfactureren.be/api/v1/stockitems/4004</uri>
	<code>A000001</code>
	<description>Product 1</description>
	<type>single</type>
	<comments>Door leverancier X - nieuwe bestelling doorgegeven.</comments>
	<price>9.99</price>
	<tax_category>1</tax_category>
	<tax_included>no</tax_included>
	<supply>10</supply>
	<unit>stuk</unit>
	<general_ledger_account>700000</general_ledger_account>
	<items/>
	<custom_values>
		<custom_value>
			<name>ean</name>
			<description>EAN</description>
			<value>100000000000001</value>
		</custom_value>
	</custom_values>
	<active>yes</active>
	<last_activity>2018-05-03 11:33:45</last_activity>
</stockitem>

Voorbeeld in XML van een verzamelartikel:

<stockitem>
	<stockitem_id>4004</stockitem_id>
	<uri>https://eenvoudigfactureren.be/api/v1/stockitems/4004</uri>
	<code>C000001</code>
	<description>Combinatie 1</description>
	<type>combined</type>
	<comments>Door leverancier X - nieuwe bestelling doorgegeven.</comments>
	<price>9.99</price>
	<tax_category>1</tax_category>
	<tax_included>no</tax_included>
	<supply>10</supply>
	<unit>stuk</unit>
	<general_ledger_account>700000</general_ledger_account>
	<items>
		<item>
			<stockitem_id>4001</stockitem_id>
			<quantity>1</quantity>
		</item>
		<item>
			<stockitem_id>4002</stockitem_id>
			<quantity>2</quantity>
		</item>
	</items>
	<custom_values/>
	<active>yes</active>
	<last_activity>2018-05-03 11:33:45</last_activity>
</stockitem>