Kasticketten

Items uit het domein “receipts” stellen een kasticket voor.

Opbouw URL’s:

  • https://eenvoudigfactureren.be/api/v1/receipts: Kasticketgegevens
  • https://eenvoudigfactureren.be/api/v1/receipts/5005: Factuur met ID 5005
  • https://eenvoudigfactureren.be/api/v1/receipts/5005/items: Items van kasticket met ID 5005
  • https://eenvoudigfactureren.be/api/v1/receipts/5005/items/4005: Item met ID 4005 van kasticket met ID 5005
  • https://eenvoudigfactureren.be/api/v1/receipts/5005/remarks: Opmerkingen van kasticket met ID 5005
  • https://eenvoudigfactureren.be/api/v1/receipts/5005/remarks/5010: Opmerking met ID 5010 van kasticket met ID 5005
  • https://eenvoudigfactureren.be/api/v1/receipts/5005/payments: Betalingen van kasticket met ID 5005
  • https://eenvoudigfactureren.be/api/v1/receipts/5005/payments/5020: Betaling met ID 5020 van kasticket met ID 5005
  • https://eenvoudigfactureren.be/api/v1/receipts/5005/events: Gebeurtenissen van kasticket met ID 5005
  • https://eenvoudigfactureren.be/api/v1/receipts/5005/events/5030: Gebeurtenis met ID 5030 van kasticket met ID 5005

Domein : receipts

Veldnaam Type Omschrijving Voorbeeld
receipt_id int Unieke ID van het kasticket. Gegenereerd door het systeem. Verplicht op te geven in URL (behalve bij creatie). 5005
uri text URL naar het kasticket. Gegenereerd door het systeem. Te gebruiken bij aanspreken kasticket langs de API.
external_receipt_id text (Unieke) ID van het kasticket dat kan worden ingesteld door een externe partij. Maximum 50 karakters lang. Uniekheid van de waarde wordt niet afgedwongen. Receipt-0983984
client_id int Unieke ID van de klant. Optioneel op te geven. 1001
client_uri text URL naar de klant. Gegenereerd door het systeem. Te gebruiken bij aanspreken klant langs de API.
type text Type van het kasticket. Bevat steeds de waarde: ‘receipt’. Wordt bepaald door het systeem en kan niet zelf worden doorgegeven. invoice
number text Uniek nummer van het kasticket zoals getoond op het kasticket. 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 het kasticket. Niet verplicht. Maximum 250 karakters lang. ID123456789
date date Datum creatie van het kasticket. Wordt gegenereerd indien niet meegegeven. Formaat YYYY-MM-DD. 2012-02-15
status text Status van het kasticket. Mogelijke waarden: ‘open’, ‘closed’. Wordt bepaald door het systeem en kan niet zelf worden opgegeven. open
discount_percentage float Kortingspercentage die geld voor het hele kasticket. Bedrag moet tussen 0 en 100 liggen. Getallen tot 2 cijfers na de komma zijn toegestaan. Indien niet opgegeven is deze waarde 0. 5
language text De taal waarin het kasticket 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_calculation text De berekeningswijze BTW van het kasticket. Mogelijke waardes: ‘total’, ‘item’. Standaard wordt ‘total’ gebruikt. Bij berekeningswijze ‘total’ wordt de BTW berekend op het totaalbedrag van het kasticket, bij berekeningswijze ‘item’ wordt de BTW berekend per kasticketlijn. Wisselen tussen de berekeningswijze kan afrondingsverschillen geven. total
items list Lijst met kasticket-items.
discount_total_without_tax float Totaal bedrag van de toegekende korting op het totaal kasticket zonder rekening te houden met BTW. Wordt automatisch berekend en kan niet zelf worden opgegeven. 10.00
total_refundable_deposit float Totaal bedrag van factuurlijnen met terugbetaalbare verpakking (tax_rate_special_status = DR). Wordt automatisch berekend en kan niet zelf worden opgegeven. 5.00
total_without_tax float Totaal 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_1 float 1e BTW-percentage die kan gebruikt worden op het kasticket. Wordt tijdens creatie overgenomen uit de instellingen en kan niet zelf worden opgegeven. 21
total_tax_1 float Totaal bedrag BTW volgens 1e BTW-percentage over alle items heen. Wordt automatisch berekend en kan niet zelf worden opgegeven. 42.00
tax_rate_2 float 2e BTW-percentage die kan gebruikt worden op het kasticket. Wordt tijdens creatie overgenomen uit de instellingen en kan niet zelf worden opgegeven. 12
total_tax_2 float Totaal bedrag BTW volgens 2e BTW-percentage over alle items heen. Wordt automatisch berekend en kan niet zelf worden opgegeven. 0.00
tax_rate_3 float 3e BTW-percentage die kan gebruikt worden op het kasticket. Wordt tijdens creatie overgenomen uit de instellingen en kan niet zelf worden opgegeven. 6
total_tax_3 float Totaal bedrag BTW volgens 3e BTW-percentage over alle items heen. Wordt automatisch berekend en kan niet zelf worden opgegeven. 0.00
discount_total_with_tax float Totaal bedrag van de toegekende korting op het totaal van het kasticket inclusief BTW. Wordt automatisch berekend en kan niet zelf worden opgegeven. 12.10
total_with_tax float Totaal bedrag over alle items heen inclusief BTW. Wordt automatisch berekend en kan niet zelf worden opgegeven. 242.00
total_paid float Totaal bedrag dat reeds werd betaald door klant. Is de sommatie van alle bedragen in payments. Wordt automatisch berekend en kan niet zelf worden opgegeven. 25.00
note text Nota die onderaan het kasticket wordt getoond. Optioneel mee te geven. Maximum 2000 karakters lang. Garantievoorwaarden van toepassing
last_activity datetime Tijdstip met de laatste activiteit van het kasticket. Kan niet worden opgegeven, wordt automatisch bepaald door het systeem. 2018-05-03 11:33:45
tags list Lijst met tags die aanduiden welke acties reeds werden uitgevoerd voor het kasticket.
payments list Lijst met ontvangen betalingen van het kasticket.
remarks list Lijst met persoonlijke opmerkingen op het kasticket.
events list Lijst met gebeurtenissen van het kasticket.

Subdomein : items ( < receipts )

Veldnaam Type Omschrijving Voorbeeld
item_id int Unieke ID van het kasticket-item. Gegenereerd door het systeem. Verplicht op te geven in URL (behalve bij creatie). 4004
receipt_id int Unieke ID van het kasticket. Gegenereerd door het systeem. Verplicht op te geven in URL. 3003
uri text URL naar kasticket-item. Gegenereerd door het systeem. Te gebruiken bij aanspreken kasticket-item langs de API.
amount float Bedrag per eenheid (1 quantity) van het kasticket-item zonder BTW. Verplicht op te geven bij creatie of als alternatief kan veld ‘amount_with_tax’ opgegeven worden. Kan tot op 6 decimalen nauwkeurig opgegeven worden, echter wordt het bedrag slechts tot op 2 decimalen nauwkeurig op het kasticket getoond. Het maximumbedrag is 9.999.999,99. 100.00
amount_with_tax float Bedrag per eenheid (1 quantity) van het kasticket-item inclusief BTW. Wordt automatisch berekend of kan opgegeven worden als alternatief voor het verplichte veld ‘amount’. Veld wordt enkel gebruikt bij opgave en wordt niet gebruikt bij weergave van het kasticket-item. 121.00
quantity float Aantal eenheden van het kasticket-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
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 kasticket-item. Verplicht op te geven bij creatie. product omschrijving
total_without_tax float Totaal bedrag van het kasticket-item zonder BTW. Wordt berekend a.d.h.v. veld ‘amount’ en ‘quantity’. 200.00
tax_rate float BTW-percentage van het kasticket-item. Moet overeenkomen met één van de BTW-percentages van het kasticket of moet ‘0’ zijn. Indien niet opgegeven wordt ‘0’ verondersteld. 21
tax_rate_special_status text Code afwijkend BTW-tarief van het gebruikte BTW-percentage (tax_rate) van het kasticket-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_tax float Totaal bedrag van het kasticket-item inclusief BTW. Wordt berekend a.d.h.v. veld ‘amount’, ‘quantity’ en ‘tax_rate’. 242.00

Subdomein : tags ( < receipts )

Veldnaam Type Omschrijving Voorbeeld
tag_id number Unieke ID van de tag 3
name text Naam of code van de tag. Mogelijke waardes: ‘@pdf’ (tag_id=3), ‘@email’ (tag_id=6), ‘@accountant’ (tag_id=9). @pdf

Opmerking: Het subdomein ‘tags’ is geen volwaardige subdomein en kan niet los van domein ‘receipts’ 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 : payments ( < receipts )

Veldnaam Type Omschrijving Voorbeeld
payment_id int Unieke ID van de betaling. Gegenereerd door het systeem. Verplicht op te geven in URL (behalve bij creatie). 5010
receipt_id int Unieke ID van het kasticket. Gegenereerd door het systeem. Verplicht op te geven in URL. 3003
uri text URL naar betaling. Gegenereerd door het systeem. Te gebruiken bij aanspreken betaling langs de API.
date date Datum waarop de betaling werd geregistreerd. Heeft het formaat YYYY-MM-DD. Indien niet opgegeven bij creatie wordt huidige datum gebruikt. 2012-02-15
amount float Bedrag van de betaling. Verplicht mee te geven bij creatie als alternatief kan veld ‘remaining_amount’ opgegeven worden. 25.00
method text Betaalwijze van de betaling. Optioneel mee te geven. Geldige waarden: transfer, cash, debitcard, creditcard, directcollection, online, bancontact, ideal. cash
description text Omschrijving van de betaling. Optioneel mee te geven. Maximum 255 karakters lang. Voorschot
remaining_amount text Enkel van toepassing bij toevoegen van een betaling (POST/PUT). Deze aanduiding zorgt ervoor dat het veld ‘amount’ het volledige resterende nog niet betaalde bedrag van het kasticket bevat. Niet verplicht veld, indien opgegeven heeft het steeds waarde ‘yes’. yes

Subdomein : remarks ( < receipts )

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
receipt_id int Unieke ID van het kasticket. 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. Klant heeft goederen reeds ontvangen

Subdomein : events ( < receipts )

Veldnaam Type Omschrijving Voorbeeld
event_id int Unieke ID van de gebeurtenis. Gegenereerd door het systeem. Verplicht op te geven in URL. 5030
receipt_id int Unieke ID van het kasticket. 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 kasticket
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 < receipts )

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 kasticket:

<receipt>
  <receipt_id>5005</receipt_id>
  <uri>https://eenvoudigfactureren.be/api/v1/receipts/5005</uri>
  <external_receipt_id>Receipt-0983984</external_receipt_id>
  <client_id>1001</client_id>
  <client_uri>https://eenvoudigfactureren/api/v1/clients/1001</client_uri>
  <type>receipt</type>
  <number>00000001</number>
  <layout_id>8001</layout_id>
  <reference>ID123456789</reference>
  <date>2012-02-15</date>
  <status>open</status>
  <discount_percentage>5</discount_percentage>
  <language>dutch</language>
  <tax_calculation>total</tax_calculation>
  <items>
    <item>
      <item_id>4004</item_id>
      <uri>https://eenvoudigfactureren.be/api/v1/receipts/5005/items/4004</uri>
      <description>product omschrijving</description>
      <amount>100.00</amount>
      <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>
    </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>
  <last_activity>2018-05-03 11:33:45</last_activity>
  <tags>
    <tag>
      <tag_id>3</tag_id>
      <name>@pdf</name>
    </tag>
  </tags>
  <payments>
    <payment>
      <payment_id>5010</payment_id>
      <uri>https://eenvoudigfactureren.be/api/v1/receipts/5005/payments/5010</uri>
      <date>2012-02-15</date>
      <amount>25.00</amount>
	  <method>cash</method>
      <description>Voorschot</description>
    </payment>
  </payments>
  <remarks>
  	<remark>
  		<remark_id>5020</remark_id>
  		<uri>https://eenvoudigfactureren.be/api/v1/receipts/5005/remarks/5020</uri>
  		<date>2012-02-15</date>
  		<description>Klant heeft goederen reeds ontvangen</description>
  	</remark>
  </remarks>
  <events>
    <event>
      <event_id>5030</event_id>
      <uri>https://eenvoudigfactureren.be/api/v1/receipts/5005/events/5030</uri>
      <date>2012-02-16</date>
      <type>email sent</type>
      <content>In bijlage uw kasticket</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>
</receipt>