Items from the "activities" domain represent an event. Events are automatically generated by the system and can therefore not be entered by itself.


Structure of URLs::

/api/v1/activities: Activities

/api/v1/activities/7001: Activity with ID 7001


Domain : activities

Field name
TypeDefinition
Example
activity_idintUnique ID of the activity? Generated by the system. To be specified in URL. 7001
uritextURL to the activity. Generated by the system. To be used when addressing activity along the API.
typetextEncoding that determines the type of activity.invoice_create
datedatetimeDate and time the activity occurred.2012-10-01 18:28:35
usertextName of the user who made the adjustment. If the name is not available, the e-mail address will be returned.John Doe
descriptiontextDescription of the activity envisaged.Invoice created
informationtextAdditional information about the activity that has occurred.Invoice 2012-0001 created (ID 2002)
client_idintID of the customer to which the activity refers. Optional field, is only given if applicable.1001
invoice_idintID of the invoice to which the activity refers. Optional field, is only given if applicable.2002
receipt_idintID of the receipt to which the activity refers. Optional field, is only given if applicable.3003
quote_idintID of the quotation to which the activity refers. Optional field, is only given if applicable.4004
order_idintID of the order form to which the activity refers. Optional field, is only given if applicable.5005
delivery_idintID of the delivery note to which the activity refers. Optional field, is only given if applicable.6006
subscription_idintID of the subscription to which the activity refers. Optional field, is only given if applicable.7007
linked_invoice_idintID of the additional invoice to which the activity refers (e.g. the previous invoice). Optional field, is only given if applicable.2002
linked_receipt_idintID of the additional receipt to which the activity refers (e.g. the previous receipt). Optional field, is only given if applicable.3003
linked_quote_idintID of the additional offer to which the activity refers (e.g. the previous quotation). Optional field, is only given if applicable.
4004
linked_order_idintID of the additional order form to which the activity refers (e.g. the previous order form). Optional field, is only given if applicable.5005
linked_delivery_idintID of the additional delivery note to which the activity refers (e.g. the previous delivery note). Optional field, is only given if applicable.6006
linked_subscription_idintID of the additional subscription to which the activity refers (e.g. the original subscription). Optional field, is only given if applicable.7007
referencesruseList of references to which the activity belongs.


Subdomain : reference ( < activities )

Field name
TypeDefinition
Example
reference_typetextEncoding that determines the type of the reference.
invoices
reference_idintID of the object being referenced to1001
reference_uritextURL of the object being referenced to. Generated by the system.


Possible activity types: 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

Note: Data from this domain can only be requested (GET) and cannot be modified.


Example in XML of an activity:

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