Items uit het domein “activities” stellen een gebeurtenis voor. Gebeurtenissen worden automatisch door het systeem gegenereerd en kunnen dus niet zelf worden ingegeven.
Opbouw URL’s:
https://eenvoudigfactureren.be/api/v1/activities: Activiteiten
https://eenvoudigfactureren.be/api/v1/activities/7001: Activiteit met ID 7001
Domein : activities
Veldnaam | Type | Omschrijving | Voorbeeld |
---|---|---|---|
activity_id | int | Unieke ID van de activiteit. Gegenereerd door het systeem. Op te geven in URL. | 7001 |
uri | text | URL naar de activiteit. Gegenereerd door het systeem. Te gebruiken bij aanspreken activiteit langs de API. | – |
type | text | Codering dat het type van de activiteit bepaald. | invoice_create |
date | datetime | Datum en tijd waarop de activiteit zich heeft voorgedaan. | 2012-10-01 18:28:35 |
user | text | Naam van de gebruiker die de aanpassing heeft doorgevoerd. Indien de naam niet beschikbaar wordt het e-mail adres teruggegeven. | John Doe |
description | text | Omschrijving van de zich voorgedane activiteit. | Factuur aangemaakt |
information | text | Bijkomende informatie over de zich voorgedane actiteit. | Factuur 2012-0001 aangemaakt (ID 2002) |
client_id | int | ID van de klant waar de activiteit naartoe verwijst. Optioneel veld, wordt enkel meegegeven indien van toepassing. | 1001 |
invoice_id | int | ID van de factuur waar de activiteit naartoe verwijst. Optioneel veld, wordt enkel meegegeven indien van toepassing. | 2002 |
receipt_id | int | ID van het kasticket waar de activiteit naartoe verwijst. Optioneel veld, wordt enkel meegegeven indien van toepassing. | 3003 |
quote_id | int | ID van de offerte waar de activiteit naartoe verwijst. Optioneel veld, wordt enkel meegegeven indien van toepassing. | 4004 |
order_id | int | ID van de bestelbon waar de activiteit naartoe verwijst. Optioneel veld, wordt enkel meegegeven indien van toepassing. | 5005 |
delivery_id | int | ID van de leveringsbon waar de activiteit naartoe verwijst. Optioneel veld, wordt enkel meegegeven indien van toepassing. | 6006 |
subscription_id | int | ID van het abonnement waar de activiteit naartoe verwijst. Optioneel veld, wordt enkel meegegeven indien van toepassing. | 7007 |
linked_invoice_id | int | ID van de bijkomende factuur waar de activiteit naartoe verwijst (bijv. de voorgaande factuur). Optioneel veld, wordt enkel meegegeven indien van toepassing. | 2002 |
linked_receipt_id | int | ID van het bijkomende kasticket waar de activiteit naartoe verwijst (bijv. het voorgaand kasticket). Optioneel veld, wordt enkel meegegeven indien van toepassing. | 3003 |
linked_quote_id | int | ID van de bijkomende offerte waar de activiteit naartoe verwijst (bijv. de voorgaande offerte). Optioneel veld, wordt enkel meegegeven indien van toepassing. | 4004 |
linked_order_id | int | ID van de bijkomende bestelbon waar de activiteit naartoe verwijst (bijv. de voorgaande bestelbon). Optioneel veld, wordt enkel meegegeven indien van toepassing. | 5005 |
linked_delivery_id | int | ID van de bijkomende leveringsbon waar de activiteit naartoe verwijst (bijv. de voorgaande leveringsbon). Optioneel veld, wordt enkel meegegeven indien van toepassing. | 6006 |
linked_subscription_id | int | ID van het bijkomend abonnement waar de activiteit naartoe verwijst (bijv. het originele abonnement). Optioneel veld, wordt enkel meegegeven indien van toepassing. | 7007 |
references | list | Lijst met referenties waar de activiteit toe hoort. | – |
Subdomein : reference ( < activities )
Veldnaam | Type | Omschrijving | Voorbeeld |
---|---|---|---|
reference_type | text | Codering dat het type van de referentie bepaald. | invoices |
reference_id | int | ID van het object waar naartoe wordt gerefereerd | 1001 |
reference_uri | text | URL van het object waar naartoe wordt gerefereerd. Gegenereerd door het systeem. | – |
Mogelijke activiteitstypes: login, settings_create, settings_update, settings_password_reset, settings_password_forgot,
client_create, client_update, client_delete, clientcontact_create, clientcontact_update, clientcontact_delete, clientcontact_delete_all, clientnote_update, invoice_create, invoice_update, invoice_create_copy, invoice_print, invoice_email, invoicepayment_create, invoicepayment_delete, invoicepayment_delete_all, invoicenote_create, invoicenote_delete, invoicenote_delete_all, backup_create, backup_restore, import_csv, import_other_account
Opmerking: Gegevens uit dit domein kunnen enkel worden opgevraagd (GET) en kunnen niet worden aangepast.
Voorbeeld in XML van een activiteit:
<activity> <activity_id>7001</activity_id> <uri>https://eenvoudigfactureren.be/api/v1/activities/7001</uri> <type>invoice_create</type> <date>2012-10-01 18:28:35</date> <user>John Doe</user> <description>Factuur aangemaakt</description> <information>Factuur 2012-0001 aangemaakt (ID 2002)</information> <client_id>1001</client_id> <invoice_id>2002</invoice_id> <receipt_id/> <quote_id/> <order_id/> <delivery_id/> <subscription_id/> <references> <reference> <reference_type>clients</reference_type> <reference_id>1001</reference_id> <reference_uri>https://eenvoudigfactureren.be/api/v1/clients/1001</reference_uri> </reference> <reference> <reference_type>invoices</reference_type> <reference_id>2002</reference_id> <reference_uri>https://eenvoudigfactureren.be/api/v1/invoices/2002</reference_uri> </reference> </references> </activity>