API - Domein "quotes"

Offertes

Items uit het domein “quotes” stellen een offerte voor.

Opbouw URL’s:

• https://eenvoudigfactureren.be/api/v1/quotes: Offertegegevens
• https://eenvoudigfactureren.be/api/v1/quotes/4004: Offerte met ID 4004
• https://eenvoudigfactureren.be/api/v1/quotes/4004/items: Items van offerte met ID 4004
• https://eenvoudigfactureren.be/api/v1/quotes/4004/items/5004: Item met ID 5004 van offerte met ID 4004
• https://eenvoudigfactureren.be/api/v1/quotes/4004/remarks: Opmerkingen van offerte met ID 4004
• https://eenvoudigfactureren.be/api/v1/quotes/4004/remarks/5010: Opmerking met ID 5010 van offerte met ID 4004
• https://eenvoudigfactureren.be/api/v1/quotes/4004/events: Gebeurtenissen van offerte met ID 4004
• https://eenvoudigfactureren.be/api/v1/quotes/4004/events/5030: Gebeurtenis met ID 5030 van offerte met ID 4004

Domein : quotes

Subdomein : items ( < quotes )

Subdomein : custom_values ( < quotes + items < quotes )

Subdomein : tags ( < quotes )

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

Subdomein : events ( < quotes )

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 < quotes )

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

Type : Address

Voorbeeld in XML van een offerte:

<quote>
  <quote_id>4004</quote_id>
  <uri>https://eenvoudigfactureren.be/api/v1/quotes/4004</uri>
  <external_quote_id>Offerte-151098587</external_quote_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>quote</type>
  <number>EST2012-001</number>
  <layout_id>8001</layout_id>
  <reference>ID123456789</reference>
  <date>2012-02-15</date>
  <deposit_paid>10.00</deposit_paid>
  <status>open</status>
  <days_valid>10</days_valid>
  <date_expired>2012-02-25</date_expired>
  <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>
  <language>dutch</language>
  <tax_calculation>total</tax_calculation>
  <tax_included>no</tax_included>
  <items>
    <item>
      <item_id>5005</item_id>
      <uri>https://eenvoudigfactureren.be/api/v1/quotes/4004/items/5005</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>
  <note>Schriftelijk te bevestigen bij goedkeuring.</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>
  <remarks>
  	<remark>
  		<remark_id>5020</remark_id>
  		<uri>https://eenvoudigfactureren.be/api/v1/quotes/3003/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/quotes/3003/events/5030</uri>
      <date>2012-02-16</date>
      <type>email sent</type>
      <content>In bijlage uw factuur</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>
</quote>