/
IN
intect
/
Intect REST API
Search skmtc…
⌘K
Changes
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 18h ago · Updated 18h ago
Details
Filter operations
AbsenceInterval
6
Account
20
Audit
7
Auth
19
Backend
2
Balances
24
Companies
27
CompanyCars
5
CompanyUsers
15
get
Gets a list of all active users in the currently active company (i.e. CompanyUsers) along with their employment info (if any).
put
Updates an existing company user, including submitted Address and UserEmployment child objects (but not child objects of UserEmployments). Notice that other child objects cannot be added and removed this way, only modified. Provide null values (not empty lists) to leave child objects unmodified. Note that the convenience fields UserLanguageId and UserIdentityNumber, which really belong to the User object in the hiarchy, may be updated this way. Finally, notice that users with the Employee role can only update their own CompanyUsers, and NOT the attached UserEmployment objects.
post
Adds a user to the currently active company, optionally specifying EITHER a set of employment data OR a template to use for the employment. The user is created in the Intect database if he/she does not already exist, or mapped to the company if he/she does.
get
Gets a list of all users (including inactive ones) in the currently active company (i.e. CompanyUsers) along with their employment info (if any).
post
Gets a simplified list of users in the currently active company (i.e. CompanyUsers), exposing only a few key properties. This method is exposed as POST, allowing you to submit a set of filters and parameters in the request body.
get
Gets a simplified list of all active users in the currently active company (i.e. CompanyUsers), exposing only a few key properties.
get
Gets a simplified list of all users (including inactive ones) in the currently active company (i.e. CompanyUsers), exposing only a few key properties.
get
Gets a simplified list of all users (including inactive ones) in the currently active company (i.e. CompanyUsers), exposing only a few key properties.
post
Gets a simplified list of users in the currently active company (i.e. CompanyUsers), exposing only a few key properties. This method is exposed as POST, allowing you to submit a set of filters and parameters in the request body.
put
Updates existing CompanyUsers, including submitted Address and UserEmployment child objects (to be modified, not added or removed). Additionally you may optionally submit a list of UserEmployment.EmploymentBalanceConfiguration objects, which will then replace all existing records of that type. Provide null values (not empty lists) to leave child objects unmodified. Note also that the convenience fields UserLanguageId and UserIdentityNumber, which really belong to the User object in the hiarchy, may be updated this way. Finally, notice that users with the Employee role can only update their own CompanyUser object, and NOT the attached UserEmployment objects.
post
Adds users to the currently active company, optionally specifying either a set of employment data or a template to use for the employment. The users are created in the Intect database if they do not already exist, or mapped to the company if they do.
get
Retrieves detailed information about the specified company user.
delete
Deletes the specified company user. Only allowed if the user has no finalized payslips or other data that must be preserved.
post
Resends welcome e-mail to the specified CompanyUser. This includes resetting their password.
post
Resets the password for the specified user. <param name="companyUserId">The Id of the CompanyUser whose password should be reset.</param>
CustomValues
10
DimensionValues
5
Employments
25
EmploymentTemplates
30
Expense
13
Formulae
9
Holidays
6
Import
8
ImportMapping
15
Insights
22
Integrations
43
Miscellaneous
14
Modules
4
PaymentPlanRecipient
6
Preferences
4
Reports
10
SalaryBatches
30
SalaryCycles
14
SalaryLedgers
6
SalaryRecords
14
SalaryStatements
22
SalaryTypes
21
Startuptasks
4
StaticData
156
TimeEntry
19
TimeEntryTypes
19
Users
18
CompanyUsers
Gets a simplified list of all users (including inactive ones) in the currently active company (i.e. CompanyUsers), exposing only a few key properties.
get
/api/companyusers/simple/includehidden
Response
OK
IntectWebAPIControllersCompanyUsersControllerSimpleCompanyUser[]
required
Id
integer
IsActive
boolean
FirstName
string
MiddleName
string
LastName
string
FullName
string
RoleId
integer
UserId
integer
RecycleBin
string
IdentityNumber
string
ExternalReferences
string[]
UserEmploymentIds
integer[]
PersonalEmail
string
CompanyEmail
string
Changes