API - Domein "deliveries"

Leveringsbonnen

Items uit het domein “deliveries” stellen een leveringsbon voor.

Opbouw URL’s:

• https://eenvoudigfactureren.be/api/v1/deliveries: Leveringsbongegevens
• https://eenvoudigfactureren.be/api/v1/deliveries/4004: Leveringsbon met ID 4004
• https://eenvoudigfactureren.be/api/v1/deliveries/4004/items: Items van leveringsbon met ID 4004
• https://eenvoudigfactureren.be/api/v1/deliveries/4004/items/5004: Item met ID 5004 van leveringsbon met ID 4004
• https://eenvoudigfactureren.be/api/v1/deliveries/4004/remarks: Opmerkingen van leveringsbon met ID 4004
• https://eenvoudigfactureren.be/api/v1/deliveries/4004/remarks/5010: Opmerking met ID 5010 van leveringsbon met ID 4004
• https://eenvoudigfactureren.be/api/v1/deliveries/4004/events: Gebeurtenissen van leveringsbon met ID 4004
• https://eenvoudigfactureren.be/api/v1/deliveries/4004/events/5030: Gebeurtenis met ID 5030 van leveringsbon met ID 4004

Domein : deliveries

Subdomein : items ( < deliveries )

Subdomein : tags ( < deliveries )

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

Subdomein : events ( < deliveries )

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

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

Voorbeeld in XML van een leveringsbon:

<delivery>
  <delivery_id>5005</delivery_id>
  <uri>https://eenvoudigfactureren.be/api/v1/deliveries/5005</uri>
  <external_delivery_id>delivery-0983984</external_delivery_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>delivery</type>
  <number>00000001</number>
  <layout_id>8001</layout_id>
  <reference>ID123456789</reference>
  <date>2018-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>
  <language>dutch</language>
  <items>
    <item>
      <item_id>4004</item_id>
      <uri>https://eenvoudigfactureren.be/api/v1/deliveries/5005/items/4004</uri>
      <description>product omschrijving</description>
      <quantity>2</quantity>
	  <unit>stuk</unit>
	  <stockitem_code>A000001</stockitem_code>
	  <custom_values>
		  <custom_value>
			  <name>ean</name>
			  <description>EAN</description>
			  <value>100000000000001</value>
		  </custom_value>
  	  </custom_values>
    </item>
  </items>
  <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>
  <remarks>
  	<remark>
  		<remark_id>5020</remark_id>
  		<uri>https://eenvoudigfactureren.be/api/v1/deliveries/5005/remarks/5020</uri>
  		<date>2012-02-15</date>
  		<description>Klant dringt aan op spoedige levering</description>
  	</remark>
  </remarks>
  <events>
    <event>
      <event_id>5030</event_id>
      <uri>https://eenvoudigfactureren.be/api/v1/deliveries/5005/events/5030</uri>
      <date>2012-02-16</date>
      <type>email sent</type>
      <content>In bijlage uw leveringsbon</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>
</delivery>