API - Domein "receipts"

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

Subdomein : items ( < receipts )

Subdomein : custom_values ( < receipts + items < receipts )

Subdomein : tags ( < receipts )

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 )

Subdomein : remarks ( < receipts )

Subdomein : events ( < receipts )

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 )

Opmerking: Het subdomein ‘recipients’ is geen volwaardige subdomein en kan niet los van subdomein ‘events’ worden aangesproken.

Type : Address

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>
  <client_name>IT Services BVBA</client_name>
  <client_attention>Dienst administratie</client_attention>
  <type>receipt</type>
  <number>00000001</number>
  <layout_id>8001</layout_id>
  <reference>ID123456789</reference>
  <date>2012-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>
  <discount_percentage>5</discount_percentage>
  <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/receipts/5005/items/4004</uri>
      <description>product omschrijving</description>
      <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>
  <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>
  <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>