invantive documentation
Invantive Support ForumsLog In / Sign Up

EventNotificationConfigurationsByPayrollAdministrationId: Loket.nl REST itgen_loketnl_eventnotificationconfigurationsbypayrolladministrationid_plural

read only REST

  • Catalog: LoketNlRest
  • Schema: EventNotificationConfiguration
  • Label: itgen_loketnl_eventnotificationconfigurationsbypayrolladministrationid_plural

The event notification configuration (email addresses) for an payroll administration Activity name : GetEventNotificationConfigurationsByPayrollAdministrationId

Get a list of the notification configurations for certain events for an employer. Currently its only possible to configure email recipients for an event notification.

Note: Event notifications can be configured on payroll administration and provider level. This endpoint returns the provider level value if no value exists on the payroll administration level and if neither level has a value an empty event is returned.

Can only retrieve data.

API Source

  • Endpoint: /providers/employers/payrolladministrations/{payrollAdministrationId}/eventnotificationconfigurations
  • Operation: get /providers/employers/payrolladministrations/{payrollAdministrationId}/eventnotificationconfigurations

Parameters

Name Data Type Required Default Documentation
payrollAdministrationId `` The unique identifier of an administration

Table Columns

The columns of the table EventNotificationConfigurationsByPayrollAdministrationId are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
category_key int64 itgen_loketnl_category_key The id of the categorie to which the event belongs.
category_value varchar2 itgen_loketnl_category_value The name of the categorie to which the event belongs.
definedAtLevel varchar2 itgen_loketnl_definedatlevel The level at which the event is defined.
dependsOnModule_description varchar2 itgen_loketnl_dependsonmodule_description The name of the module to which the event belongs.
dependsOnModule_id guid itgen_loketnl_dependsonmodule_id The id of the module to which the event belongs.
emailAddress varchar2(6000) itgen_loketnl_emailaddress The e-mail address that will receive the notification. It is possible to configure multiple addresses by dividing them with a ;
type_description varchar2 itgen_loketnl_type_description The description of the event.
type_id guid itgen_loketnl_type_id The unique identifier of an object (GUID/UUID)
type_sortOrder int64 itgen_loketnl_type_sortorder A number used to sort the list.

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: