API - Domein "invoices"

Facturen en creditnota’s

Items uit het domein “invoices” stellen een factuur of creditnota voor.
Bij een factuur is het totaalbedrag positief, bij een creditnota is het totaalbedrag negatief.

Opbouw URL’s:

• https://eenvoudigfactureren.be/api/v1/invoices: Factuurgegevens
• https://eenvoudigfactureren.be/api/v1/invoices/3003: Factuur met ID 3003
• https://eenvoudigfactureren.be/api/v1/invoices/3003/items: Items van factuur met ID 3003
• https://eenvoudigfactureren.be/api/v1/invoices/3003/items/4005: Item met ID 4005 van factuur met ID 3003
• https://eenvoudigfactureren.be/api/v1/invoices/3003/remarks: Opmerkingen van factuur met ID 3003
• https://eenvoudigfactureren.be/api/v1/invoices/3003/remarks/5010: Opmerking met ID 5010 van factuur met ID 3003
• https://eenvoudigfactureren.be/api/v1/invoices/3003/payments: Betalingen van factuur met ID 3003
• https://eenvoudigfactureren.be/api/v1/invoices/3003/payments/5020: Betaling met ID 5020 van factuur met ID 3003
• https://eenvoudigfactureren.be/api/v1/invoices/3003/costs: Herinneringskosten van factuur met ID 3003
• https://eenvoudigfactureren.be/api/v1/invoices/3003/costs/5030: Herinneringskost met ID 5030 van factuur met ID 3003
• https://eenvoudigfactureren.be/api/v1/invoices/3003/events: Gebeurtenissen van factuur met ID 3003
• https://eenvoudigfactureren.be/api/v1/invoices/3003/events/5030: Gebeurtenis met ID 5030 van factuur met ID 3003
• https://eenvoudigfactureren.be/api/v1/uploads: Bestand-uploads/Attachments

Domein : invoices

Subdomein : items ( < invoices )

Subdomein : custom_values ( < invoices + items < invoices )

Subdomein : tags ( < invoices )

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

Subdomein : costs ( < invoices )

Subdomein : remarks ( < invoices )

Subdomein : events ( < invoices )

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

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

Type : Address

Voorbeeld in XML van een factuur:

<invoice>
  <invoice_id>3003</invoice_id>
  <uri>https://eenvoudigfactureren.be/api/v1/invoices/3003</uri>
  <external_invoice_id>Invoice-0983984</external_invoice_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>invoice</type>
  <number>INV2012-001</number>
  <layout_id>8001</layout_id>
  <reference>ID123456789</reference>
  <date>2012-02-15</date>
  <date_delivery>2012-02-15</date_delivery>
  <status>open</status>
  <days_due>10</days_due>
  <days_overdue>0</days_overdue>
  <date_overdue>2012-02-25</date_overdue>
  <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>
  <cash_discount_percentage>2</cash_discount_percentage>
  <cash_discount_days_valid>8</cash_discount_days_valid>
  <cash_discount_date_valid>2012-02-23</cash_discount_date_valid>
  <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>4004</item_id>
      <uri>https://eenvoudigfactureren.be/api/v1/invoices/3003/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_refundable_discount>0.00</total_refundable_discount>
  <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_costs>5.00</total_costs>
  <total_paid>25.0</total_paid>
  <structured_message>278781035591</structured_message>
  <automatic_reminders>yes</automatic_reminders>
  <note>25 € kosten bij laattijdige betalingen.</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/invoices/3003/payments/5010</uri>
      <date>2012-02-15</date>
      <amount>25.00</amount>
	  <method>cash</method>
      <description>Voorschot</description>
    </payment>
  </payments>
  <costs>
    <cost>
		<cost_id>5030</cost_id>
		<amount>5.00</amount>
		<description>Herinneringskost</description>
	</cost>
  </costs>
  <remarks>
  	<remark>
  		<remark_id>5020</remark_id>
  		<uri>https://eenvoudigfactureren.be/api/v1/invoices/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/invoices/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>
</invoice>

Verstuur factuur via PEPPOL (POST)

Een factuur kan rechtstreeks worden doorgestuurd via PEPPOL naar uw klant.

Gebruik hiervoor de POST-methode met als URL bijvoorbeeld https://eenvoudigfactureren.be/api/v1/invoices/1001?send_peppol.

Een voorbeeld in PHP hoe u een factuur kunt versturen naar uw boekhouder:

$email = 'luc@mymail.com';
$password = '123456';

$p = curl_init('https://eenvoudigfactureren.be/api/v1/invoices/1001?send_peppol');
curl_setopt($p, CURLOPT_USERPWD, $email . ':' . $password);
curl_setopt($p, CURLOPT_POST, 1);
curl_setopt($p, CURLOPT_RETURNTRANSFER, TRUE);
		
$result_in_xml_string = curl_exec($p);

Verstuur factuur naar boekhouder (POST)

Een factuur kan rechtstreeks worden doorgestuurd naar het boekhoudpakket van uw boekhouder. Dit is enkel mogelijk indien een koppeling via CodaBox, ClearFacts of Yuki werd opgezet.

Een factuur kan slechts 1x worden doorgestuurd naar de boekhouder.

Gebruik hiervoor de POST-methode met als URL bijvoorbeeld https://eenvoudigfactureren.be/api/v1/invoices/1001?send_accountant.

Een voorbeeld in PHP hoe u een factuur kunt versturen naar uw boekhouder:

$email = 'luc@mymail.com';
$password = '123456';

$p = curl_init('https://eenvoudigfactureren.be/api/v1/invoices/1001?send_accountant');
curl_setopt($p, CURLOPT_USERPWD, $email . ':' . $password);
curl_setopt($p, CURLOPT_POST, 1);
curl_setopt($p, CURLOPT_RETURNTRANSFER, TRUE);
		
$result_in_xml_string = curl_exec($p);

Betaling via domiciliëring aanvragen (POST)

Door een domiciliëring kan een factuur rechtstreeks worden betaald zonder tussenkomst van de klant. Dit is enkel mogelijk indien een koppeling via Mollie werd opgezet.

Om een betaling via domiciliëring aan te vragen gebruikt u de POST-methode met als URL bijvoorbeeld https://eenvoudigfactureren.be/api/v1/invoices/1001?make_direct_collection.

Een voorbeeld in PHP hoe een betaling via domiciliëring kan worden aangevraagd:

$email = 'luc@mymail.com';
$password = '123456';

$p = curl_init('https://eenvoudigfactureren.be/api/v1/invoices/1001?make_direct_collection');
curl_setopt($p, CURLOPT_USERPWD, $email . ':' . $password);
curl_setopt($p, CURLOPT_POST, 1);
curl_setopt($p, CURLOPT_RETURNTRANSFER, TRUE);
		
$result_in_xml_string = curl_exec($p);