Employees models

Models of the employee endpoints.

Generated by python -m codegen from the iikoCloud OpenAPI specification. Do not edit by hand.

AttendanceCreateRequest

Bases: IikoModel

AttendanceCreateRequest.

attendance_type_id class-attribute instance-attribute

attendance_type_id: str | None = None

Attendance type UUID

comment class-attribute instance-attribute

comment: str | None = None

Comment

employee_id instance-attribute

employee_id: str

Employee UUID

end_at instance-attribute

end_at: str

Date and time of the confirmed attendance end. If the value is null, the attendance is considered open. Existing attendances may be open.

is_confirmed_manually class-attribute instance-attribute

is_confirmed_manually: bool | None = None

Manually confirmed flag; may be absent for legacy data.

organization_id instance-attribute

organization_id: str

Organization UUID

personal_end_at class-attribute instance-attribute

personal_end_at: str | None = None

Date and time of the registered attendance end from POS

personal_start_at class-attribute instance-attribute

personal_start_at: str | None = None

Date and time of the registered attendance start from POS

role_id instance-attribute

role_id: str

Role UUID; may be absent for legacy attendances

start_at instance-attribute

start_at: str

Date and time of the confirmed attendance start

AttendanceCreateResponse

Bases: IikoModel

AttendanceCreateResponse.

attendance class-attribute instance-attribute

attendance: AttendanceResponse | None = None

Attendance

AttendanceDeleteRequest

Bases: IikoModel

AttendanceDeleteRequest.

id instance-attribute

id: str

Attendance UUID

organization_id instance-attribute

organization_id: str

Organization UUID

AttendanceDeleteResponse

Bases: IikoModel

AttendanceDeleteResponse.

id class-attribute instance-attribute

id: str | None = None

Attendance UUID

AttendanceListRequest

Bases: IikoModel

AttendanceListRequest.

attendance_type_ids class-attribute instance-attribute

attendance_type_ids: list[str] | None = None

Non-empty unique array of attendance type UUIDs to filter by

employee_ids class-attribute instance-attribute

employee_ids: list[str] | None = None

Non-empty unique array of employee UUIDs to filter by

end_at instance-attribute

end_at: str

Date and time of the confirmed attendance end. If the value is null, the attendance is considered open. Existing attendances may be open.

is_closed class-attribute instance-attribute

is_closed: bool | None = None

Attendance closed flag. If absent in the request body - both closed and open attendances will be returned. If the value is true - only closed attendances will be returned (endAt != null). If the value is false - only open attendances will be returned (endAt = null)

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response (1..1000)

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning

organization_id instance-attribute

organization_id: str

Organization UUID

should_include_payment_details class-attribute instance-attribute

should_include_payment_details: bool | None = None

Flag to display payment details

start_at instance-attribute

start_at: str

Date and time of the confirmed attendance start

AttendanceListResponse

Bases: IikoModel

AttendanceListResponse.

items class-attribute instance-attribute

items: list[AttendanceResponse] | None = None

Attendances

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response (1..1000)

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of records matching the selected filter rules

AttendanceResponse

Bases: IikoModel

AttendanceResponse.

attendance_type_code class-attribute instance-attribute

attendance_type_code: str | None = None

Attendance type code

attendance_type_id class-attribute instance-attribute

attendance_type_id: str | None = None

Attendance type UUID

comment class-attribute instance-attribute

comment: str | None = None

Comment

created_at class-attribute instance-attribute

created_at: str | None = None

Date and time of creation

employee_id class-attribute instance-attribute

employee_id: str | None = None

Employee UUID

end_at class-attribute instance-attribute

end_at: str | None = None

Date and time of the confirmed attendance end. If the value is null, the attendance is considered open. Existing attendances may be open.

id class-attribute instance-attribute

id: str | None = None

Attendance UUID

is_closed class-attribute instance-attribute

is_closed: bool | None = None

Attendance closed flag. Computed as endAt != null

is_confirmed_manually class-attribute instance-attribute

is_confirmed_manually: bool | None = None

Manually confirmed flag; may be absent for legacy data

modified_by_user_id class-attribute instance-attribute

modified_by_user_id: str | None = None

UUID of the user who made the last changes

organization_id class-attribute instance-attribute

organization_id: str | None = None

Organization UUID

organization_name class-attribute instance-attribute

organization_name: str | None = None

Organization name

payment_details class-attribute instance-attribute

payment_details: PaymentDetails | None = None

Payment calculation; null if not requested or not applicable

personal_end_at class-attribute instance-attribute

personal_end_at: str | None = None

Date and time of the registered attendance end from POS

personal_start_at class-attribute instance-attribute

personal_start_at: str | None = None

Date and time of the registered attendance start from POS

role_id class-attribute instance-attribute

role_id: str | None = None

Role UUID; may be absent for legacy attendances

start_at class-attribute instance-attribute

start_at: str | None = None

Date and time of the confirmed attendance start

updated_at class-attribute instance-attribute

updated_at: str | None = None

Date and time of the last modification

AttendanceTypeItem

Bases: IikoModel

AttendanceTypeItem.

code class-attribute instance-attribute

code: str | None = None

Attendance type code

comment class-attribute instance-attribute

comment: str | None = None

Description

id class-attribute instance-attribute

id: str | None = None

Attendance type UUID

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Attendance type deleted flag

is_presence class-attribute instance-attribute

is_presence: bool | None = None

Presence flag: the value true means the employee is present, the value false means the employee is absent

name class-attribute instance-attribute

name: str | None = None

Localized name

pay_rate class-attribute instance-attribute

pay_rate: Decimal | None = None

Payment coefficient

AttendanceTypeListRequest

Bases: IikoModel

AttendanceTypeListRequest.

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

false — active, true — deleted, null — all

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response (1..1000)

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning

AttendanceTypeListResponse

Bases: IikoModel

AttendanceTypeListResponse.

items class-attribute instance-attribute

items: list[AttendanceTypeItem] | None = None

Attendance types

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response (1..1000)

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of records matching the selected filter rules

AttendanceUpdateRequest

Bases: IikoModel

AttendanceUpdateRequest.

attendance_type_id instance-attribute

attendance_type_id: str

Attendance type UUID

comment class-attribute instance-attribute

comment: str | None = None

Comment

employee_id instance-attribute

employee_id: str

Employee UUID

end_at instance-attribute

end_at: str

Date and time of the confirmed attendance end. If the value is null, the attendance is considered open. Existing attendances may be open.

id instance-attribute

id: str

Attendance UUID

is_confirmed_manually instance-attribute

is_confirmed_manually: bool

Manually confirmed flag; may be absent for legacy data

organization_id instance-attribute

organization_id: str

Organization UUID

personal_end_at class-attribute instance-attribute

personal_end_at: str | None = None

Date and time of the registered attendance end from POS. An already set value cannot be reset (set to null).

personal_start_at class-attribute instance-attribute

personal_start_at: str | None = None

Date and time of the registered attendance start from POS. An already set value cannot be reset (set to null).

role_id instance-attribute

role_id: str

Role UUID; may be absent for legacy attendances

start_at instance-attribute

start_at: str

Date and time of the confirmed attendance start

AttendanceUpdateResponse

Bases: IikoModel

AttendanceUpdateResponse.

attendance class-attribute instance-attribute

attendance: AttendanceResponse | None = None

Attendance

EmployeeCreateRequest

Bases: IikoModel

EmployeeCreateRequest.

card_number class-attribute instance-attribute

card_number: str | None = None

Card number

code instance-attribute

code: str

Code

email class-attribute instance-attribute

email: str | None = None

E-mail

first_name class-attribute instance-attribute

first_name: str | None = None

First name

hire_date class-attribute instance-attribute

hire_date: str | None = None

Employee hire date. Can be null

last_name class-attribute instance-attribute

last_name: str | None = None

Last name

main_organization_id instance-attribute

main_organization_id: str

Identifier (organizationId) of the employee's main organization

main_role_id class-attribute instance-attribute

main_role_id: str | None = None

Position identifier

middle_name class-attribute instance-attribute

middle_name: str | None = None

Middle name

name class-attribute instance-attribute

name: str | None = None

Employee name in the system

note class-attribute instance-attribute

note: str | None = None

Notes

organization_ids class-attribute instance-attribute

organization_ids: list[str] | None = None

Identifiers (organizationId) of the employee's organizations

phone class-attribute instance-attribute

phone: str | None = None

Phone

responsible_for_organization_ids class-attribute instance-attribute

responsible_for_organization_ids: list[str] | None = None

Identifiers (organizationId) of the organizations the employee is responsible for

EmployeeFilter

Bases: IikoModel

EmployeeFilter.

field class-attribute instance-attribute

field: str | None = None

Field name to filter by. Possible values: id, code, firstName, lastName, middleName, phone, email, mainRoleId, organizationId, isFired

value class-attribute instance-attribute

value: str | None = None

Filter value

EmployeeFireRequest

Bases: IikoModel

EmployeeFireRequest.

ids instance-attribute

ids: list[str]

List of employee identifiers to fire

EmployeeFireResponse

Bases: IikoModel

EmployeeFireResponse.

fired_ids class-attribute instance-attribute

fired_ids: list[str] | None = None

List of fired employee identifiers

EmployeeGetRequest

Bases: IikoModel

EmployeeGetRequest.

id instance-attribute

id: str

Employee identifier

EmployeeListRequest

Bases: IikoModel

EmployeeListRequest.

fields_ class-attribute instance-attribute

fields_: list[str] | None = Field(
    default=None, alias="fields"
)

Requested response fields: id, code, firstName, lastName, middleName, name, phone, email, cardNumber, mainRoleId, roleIds, isSystem, isFired, hireDate, fireDate, note, mainOrganizationId, organizationIds, responsibleForOrganizationIds.

If empty - returns 4 fields only: id, name, code, isFired.

filters instance-attribute

filters: list[EmployeeFilter]

Filter fields.

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response.

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning.

EmployeePositionDTO

Bases: IikoModel

EmployeePositionDTO.

can_work_by_substituted_card class-attribute instance-attribute

can_work_by_substituted_card: bool | None = None

Allowed to work with a substituted card

code class-attribute instance-attribute

code: str | None = None

Employee position code

id class-attribute instance-attribute

id: str | None = None

Employee position identifier (GUID)

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Flag indicating a deleted position

name class-attribute instance-attribute

name: str | None = None

Employee position name

payment_per_hour class-attribute instance-attribute

payment_per_hour: Decimal | None = None

Hourly payment rate

schedule_type class-attribute instance-attribute

schedule_type: str | None = None

Schedule type (HOURS, FIXED, SESSION, BYTIME)

steady_salary class-attribute instance-attribute

steady_salary: Decimal | None = None

Monthly salary amount

EmployeePositionFilterItem

Bases: IikoModel

EmployeePositionFilterItem.

field class-attribute instance-attribute

field: str | None = None

Field name for filtering

op class-attribute instance-attribute

op: str | None = None

Operation ("eq", "ne", "gt", "gte", "lt", "lte", "in", "nin", "like", "blank", "notblank")

value class-attribute instance-attribute

value: Any | None = None

Value for filtering by the field

values class-attribute instance-attribute

values: list[Any] | None = None

Values for multi-value filtering ("in", "nin")

EmployeePositionResponse

Bases: IikoModel

EmployeePositionResponse.

can_work_by_substituted_card class-attribute instance-attribute

can_work_by_substituted_card: bool | None = None

Allowed to work with a substituted card

code class-attribute instance-attribute

code: str | None = None

Employee position code

id class-attribute instance-attribute

id: str | None = None

Employee position identifier (GUID)

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Flag indicating a deleted position

name class-attribute instance-attribute

name: str | None = None

Employee position name

payment_per_hour class-attribute instance-attribute

payment_per_hour: Decimal | None = None

Hourly payment rate

schedule_type class-attribute instance-attribute

schedule_type: str | None = None

Schedule type (HOURS, FIXED, SESSION, BYTIME)

steady_salary class-attribute instance-attribute

steady_salary: Decimal | None = None

Monthly salary amount

EmployeeResponse

Bases: IikoModel

EmployeeResponse.

card_number class-attribute instance-attribute

card_number: str | None = None

Card number

code class-attribute instance-attribute

code: str | None = None

Code

email class-attribute instance-attribute

email: str | None = None

E-mail

fire_date class-attribute instance-attribute

fire_date: str | None = None

Employee fire date. If null, the employee is not fired

first_name class-attribute instance-attribute

first_name: str | None = None

First name

hire_date class-attribute instance-attribute

hire_date: str | None = None

Employee hire date. Can be null

id class-attribute instance-attribute

id: str | None = None

Employee identifier

is_fired class-attribute instance-attribute

is_fired: bool | None = None

Flag indicating that the employee is fired. If true — the employee is fired

is_system class-attribute instance-attribute

is_system: bool | None = None

Flag indicating that the employee is a system employee. If true — the employee is a system employee

last_name class-attribute instance-attribute

last_name: str | None = None

Last name

main_organization_id class-attribute instance-attribute

main_organization_id: str | None = None

Identifier (organizationId) of the employee's main organization

main_role_id class-attribute instance-attribute

main_role_id: str | None = None

Position identifier

middle_name class-attribute instance-attribute

middle_name: str | None = None

Middle name

name class-attribute instance-attribute

name: str | None = None

Employee name in the system

note class-attribute instance-attribute

note: str | None = None

Notes

organization_ids class-attribute instance-attribute

organization_ids: list[str] | None = None

Identifiers (organizationId) of the employee's organizations

phone class-attribute instance-attribute

phone: str | None = None

Phone

responsible_for_organization_ids class-attribute instance-attribute

responsible_for_organization_ids: list[str] | None = None

Identifiers (organizationId) of the organizations the employee is responsible for

role_ids class-attribute instance-attribute

role_ids: list[str] | None = None

Employee position identifiers

EmployeeRestoreRequest

Bases: IikoModel

EmployeeRestoreRequest.

id instance-attribute

id: str

Employee identifier

EmployeeRestoreResponse

Bases: IikoModel

EmployeeRestoreResponse.

restored_ids class-attribute instance-attribute

restored_ids: list[str] | None = None

List of restored employee identifiers

EmployeeUpdateRequest

Bases: IikoModel

EmployeeUpdateRequest.

card_number class-attribute instance-attribute

card_number: str | None = None

Card number

code class-attribute instance-attribute

code: str | None = None

Code

email class-attribute instance-attribute

email: str | None = None

E-mail

first_name class-attribute instance-attribute

first_name: str | None = None

First name

hire_date class-attribute instance-attribute

hire_date: str | None = None

Employee hire date. Can be null

id instance-attribute

id: str

Employee identifier

last_name class-attribute instance-attribute

last_name: str | None = None

Last name

main_organization_id class-attribute instance-attribute

main_organization_id: str | None = None

Identifier (organizationId) of the employee's main organization

main_role_id class-attribute instance-attribute

main_role_id: str | None = None

Position identifier

middle_name class-attribute instance-attribute

middle_name: str | None = None

Middle name

name class-attribute instance-attribute

name: str | None = None

Employee name in the system

note class-attribute instance-attribute

note: str | None = None

Notes

organization_ids class-attribute instance-attribute

organization_ids: list[str] | None = None

Identifiers (organizationId) of the employee's organizations

phone class-attribute instance-attribute

phone: str | None = None

Phone

responsible_for_organization_ids class-attribute instance-attribute

responsible_for_organization_ids: list[str] | None = None

Identifiers (organizationId) of the organizations the employee is responsible for

GetPositionRequest

Bases: IikoModel

GetPositionRequest.

id class-attribute instance-attribute

id: str | None = None

Employee position identifier (GUID)

revision_from class-attribute instance-attribute

revision_from: int | None = None

Revision from which to return changed records (optional)

ListPositionsRequest

Bases: IikoModel

ListPositionsRequest.

filters class-attribute instance-attribute

filters: list[EmployeePositionFilterItem] | None = None

List of filters (fields: isDeleted, scheduleTypes)

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response (default: 50, max: 1000)

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning (0-based)

revision_from class-attribute instance-attribute

revision_from: int | None = None

Revision from which to return changed records (optional)

ListPositionsResponse

Bases: IikoModel

ListPositionsResponse.

items class-attribute instance-attribute

items: list[EmployeePositionDTO] | None = None

List of employee positions

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning (0-based)

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of records matching the filter

PaymentDetails

Bases: IikoModel

PaymentDetails.

other_payments_sum class-attribute instance-attribute

other_payments_sum: Decimal | None = None

Other payments/penalties

overtime_paid_minutes class-attribute instance-attribute

overtime_paid_minutes: int | None = None

Overtime paid minutes

overtime_payment_sum class-attribute instance-attribute

overtime_payment_sum: Decimal | None = None

Overtime payment sum

regular_paid_minutes class-attribute instance-attribute

regular_paid_minutes: int | None = None

Regular paid minutes

regular_payment_sum class-attribute instance-attribute

regular_payment_sum: Decimal | None = None

Regular payment sum

SwaggerEmployeeListResponse

Bases: IikoModel

SwaggerEmployeeListResponse.

items class-attribute instance-attribute

items: list[EmployeeResponse] | None = None

Employees

limit class-attribute instance-attribute

limit: int | None = None

Maximum number of records in the response.

offset class-attribute instance-attribute

offset: int | None = None

Number of records to skip from the beginning.

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of employees