Add an entry to the customer data processing log.
According to the General Data Protection Regulation (GDPR), all processing done with the information of natural persons – viewing, creating, changing, deleting, transferring etc. — must be logged. API automatically writes log entries when you create, update or delete customer information. However, when you retrieve customer information from API, API does not know which records are actually used and for what purpose — therefore you are responsible for logging these processing activities yourself. You can always keep the log in the system that actually does the processing; but if that option is not available, use this API call to write log entries into Erply.
This API call must be called whenever you fetch, transfer or synchronize customer information with any of the following API calls:
Parameter name | Description | Possible value | Required |
---|---|---|---|
employeeID | Employee doing the processing. If omitted, Erply assumes processing was done by the user who sent the API call. | integer | |
customerIDs | Multiple customer IDs, separated by commas, such as: 1,2,3,4,5. | string | yes |
activityType | Data processing type, can be "create", "read", "update" or "delete". | string | yes |
description | Data processing reason or purpose. Maximum 255 characters. | string | yes |
fields | A comma-separated list of fields that were affected by processing, or were used in processing. Possible field names are:
List all the fields that were used in processing — for example, |
string | |
partnerKey | Set this field if you have a partner key. The partner key helps to clarify the log entry, by indicating which application did the processing. | string |