HTTP Operation Type Object DTO Why-DTOs?
Mutation createEmployee EmployeeCreateGLDtoInput
Mutation updateEmployee EmployeeUpdateGLDtoInput
Mutation deleteEmployee EmployeeDeleteGLDtoInput
Query employees filtered by id Why?  
Query employees  

Description

Employee management.

Allows the identification of a third-party Employee within an organization.
It offers the option to add contacts within the Employee and their details.

Every Employee must have a code, which, depending on the organization’s settings, can be manually entered or automatically generated.
In the DE (German) legislation, automatic numbering is mandatory.

img

Explore Efficient Record Updates: For comprehensive insights into making precise modifications to records, check out our dedicated page on updates : Key concepts / Updating records

Key Value
Authorization Bearer Current access Token How to find?
X-TenantId Current tenant id How to find?
X-OrganizationId Current organization Id How to find?
x-api-key Primary or secondary subscription key of your app How to find?

employees

Fields Type Description Length
id UUID Id  
modificationDate Datetime Modification date  
creationDate Datetime Creation date  
       
code String Code employee 17
name String Employee Name 70
shortName String Short Name 70
disabled Boolean Inactive  
disabledDate Datetime Inactive date  
status
  • NONE
  • DISABLED
  • ENABLED
  • GDPR_APPLIED
Status  
defaultAccountingAccount AccountingAccount Fields of AccountingAccount  
defaultAccountingAccountId UUID Ledger General account  
comments String Comments 2000
gdprApplied Boolean GDPR action  
gdprAppliedDate Datetime GDPR date action  
businessArea BusinessArea Fields of BusinessArea  
businessAreaId UUID Business areas Id  
addresses[] Array List of addresses  
contacts[] Array List of contacts  
Info
  • defaultAccountingAccountId : Id of the general account in accountingAccount associated with the employee.
    The subAccountType of the account must be EMPLOYEE.

  • disabled : If TRUE the employee can no longer be used, but will remain in the existing information.

  • code : Code of the employee.
    During creation, it is automatically calculated if the option is active in Sequence Numbers, otherwise it is a mandatory value.
    In any cases, it is still possible to assign it to enforce a specific value.

    Forcing a value allows you to retrieve an alphanumeric code that can already identify the Employee, even if automatic numbering mode is active.

    Forcing a value allows you to retrieve an alphanumeric code that can already identify the Employee, even if automatic numbering mode is active.

    • If you force a value, it must be strictly numeric and adhere to the rule of a number being between 10000 and 69999 for customers, and between 70000 and 99999 for suppliers or employees.

img

employees/addresses

Attention, only one address is authorized, even if the representation is an array of addresses

Fields Type Description Length
id UUID Id  
       
countryId UUID Country Id  
country String Fields of Country  
countryIsoCodeAlpha2 String Country Code 2
countryName String CountryName  
name String Code 50
firstLine String First Line 35
secondLine String Second Line 35
city String Town 35
zipCode String Postal Code 9
province String Province 25
Info
  • countryIsoCodeAlpha2 : ISO2 country code.
    This field can be used for creation and serves as a simple alternative to assign the country of the address by using the ISO2 code directly, rather than the country ID in the Countries resource.

employees/contacts

Common to customers, suppliers, employees

Fields Type Description Length
id UUID Id  
       
courtesy
  • NONE
  • MR
  • MISS
Courtesy  
name String First name (John) 35
surname String Family name (Smith) 35
jobName String Job name 35
jobArea JobArea Fields of JobArea  
jobAreaId UUID Job areas Id  
isDefault Boolean Main contact  
emails[] Array List of emails  
phones[] Array List of phones  
socialMedias[] Array List Social Networking  

employees/contacts/emails

Fields Type Description Length
id UUID Id  
       
emailAddress String Email address 70
usage
  • NOT_SET
  • EMPTY
  • INVOICES
  • PAYMENTS
  • OTHERS
Type  
isDefault Boolean Main mail  

employees/contacts/phones

Fields Type Description Length
id UUID Id  
       
number String Phone 20
type
  • NOT_SET
  • EMPTY
  • LANDLINE
  • MOBILE
  • FAX
  • SKYPE
  • WHATS_APP
Type  
isDefault Boolean Main phone  

employees/contacts/socialMedias

Fields Type Description Length
id UUID UUID  
       
name String Name 30
link String Link 100