Persons

Queryable, Introduced in version 2.18

GET https://localhost:8001/sv/001.1/api/v1/Common/Persons

Represents a person.

GUID

50651357-4726-4877-A944-87820BED57BA

Required permission

Show person

Properties

Name Type Summary Introduced in
Id Int64 The business key identifier of the person.
BlockedContextType Int32 Specifies where the person block applies.

  • None: 0
  • RegisterCustomerOrder: 1

  • Bitmask
IsRecordingEmployee Boolean Specifies if the person has any type of employee recording enabled.
EmployeeNumber String The human readable employee number of the person.

  • Max length is 10
  • Not nullable
  • Unique
FirstName String The first name of the person.

  • Max length is 35
  • Not nullable
LastName String The last name of the person.

  • Max length is 35
  • Not nullable
PhoneNumber String The phone number of the person.

  • Max length is 80
PrivatePhoneNumber String The private phone number of the person.

  • Max length is 80
 Introduced in version 23.7
CellPhoneNumber String The cell phone number of the person.

  • Max length is 80
PrivateCellPhoneNumber String The private cell phone number of the person.

  • Max length is 80
 Introduced in version 23.7
InternalPhoneNumber String The internal phone number of the person.

  • Max length is 80
 Introduced in version 2.43
EmailAddress String The email address of the person.

  • Max length is 80
PrivateEmailAddress String The private email address of the person.

  • Max length is 80
 Introduced in version 23.7
SkypeId String The Skype identifier of the person.

  • Max length is 35
FaxNumber String The fax number of the person.
Position String The position of the person.

  • Max length is 80
IsReference Boolean Specifies if the person is a reference.
IsPurchaseManager Boolean Specifies if the person is a purchase manager.
IsPlanner Boolean Specififes if the person is a planner.
IsAccountManager Boolean Specifies if the person is an account manager.
Contact String The name of the person's contact.

  • Max length is 80
ContactPhoneNumber String The phone number of the person's contact.

  • Max length is 80
ContactCellPhoneNumber String The cell phone number of the person's contact.

  • Max length is 80
ContactEmailAddress String The email address of the person's contact.

  • Max length is 80
AddressId Int64? The business key identifier of the person's address.

References Addresses.
Address Addresses The address of the person.

  • Expandable
CommentId Int64? The business key identifier of the person's comment.

Reference Comments.
Comment Comments The comment of the person.

  • Expandable
BlockedFromDate DateTimeOffset? The date that the person starts being blocked from.
BlockedToDate DateTimeOffset? The date that the person stops being blocked.
IsPersonBlocked Boolean Specifies if the person is blocked.
PersonBlockedById Int64? Specifies the application user that blocked the person.
PersonBlockedDate DateTimeOffset? The date when the person was blocked.
CanAuthorize Boolean Specifies if the person can authorize invoices provided that EIM is not enabled for this MONITOR system.
ApplicationUserId Int64? The business key identifier of the application user that is coupled to the person.

References ApplicationUsers.
IsSeller Boolean Specifies if the person is a seller.
Initials String Max length5

  • Max length is 5
 Introduced in version 2.43
DepartmentId Int64 The business key identifier of the department that the person belongs to.

References Departments.
 Introduced in version 2.43
DistrictId Int64? The business key identifier of the district that the person belongs to.

References CustomerDistricts.
 Introduced in version 2.43
LanguageId Int64 The business key identifier of the person's preferred language.

References LanguageCodes.
WarehouseId Int64 The business key identifier of the person's default warehouse.

References Warehouses.
Category String The category of the person.

  • Max length is 15
IdentityNumber String The identity number of the person.

  • Max length is 16
 Introduced in version 2.43
GroupSettingsId Int64? The business key identifier of the person's attendance group settings.

References AttendanceGroupSettings.
UseWorkCenterManufacturingPrintSettings Boolean Specifies if manufacturing order document settings should come from the work center's settings or the person's settings.
 Introduced in version 2.28
ManufacturingPrintSettings PersonManufacturingPrintSettings[] The person's print settings for manufacturing order documents.

  • Expandable
 Introduced in version 2.28
PlannedAbsences PlannedAbsences[] The planned absences for the person.

  • Expandable
 Introduced in version 2.47
TimeBanks PersonTimeBanks[] The time banks for the person.

  • Expandable
 Introduced in version 22.3
Relatives PersonRelatives[] The relatives of the person.

  • Expandable
 Introduced in version 22.3
EmploymentPeriods EmploymentPeriods[] The employment periods that belong to the personnel record.

  • Expandable
 Introduced in version 22.3
ExtraFields ExtraFields[] The extra fields of the personnel record.

  • Expandable
 Introduced in version 22.3
IsProjectManager Boolean Specifies if the person is a project manager.
 Introduced in version 23.3
AvailableWorkshopSchedules Schedules[] The workshop schedules of the personnel record.

  • Expandable
 Introduced in version 24.3
AvailableWorkCenters PersonWorkCenters[] Specifies which work centers (and thereby which report numbers) the person should be allowed to select among in the priority plan
and when starting work via report numbers.

  • Expandable
 Introduced in version 24.3
Signature BlobData The entity signature blob data

  • Expandable
 Introduced in version 24.5
EmployeeRecordingType Int32 The employee recording type of the person.

  • None: 0
  • AttendanceAndWork: 1
  • OnlyWork: 2

  • Bitmask
 Introduced in version 24.5
ScheduleManagementType Int32 The schedule management type of the person.

  • None: 0
  • ScheduleCycle: 1

  • Bitmask
 Introduced in version 24.5
PersonScheduleCycles PersonScheduleCycles[] The schedule cycles of the personnel record.

  • Expandable
 Introduced in version 24.5
AttendanceRecordingAuthorizers AttendanceRecordingAuthorizers[] The attendance recording authorizers of the personnel record.

  • Expandable
 Introduced in version 24.5
WorkMethod Int32 The work method of the person.

  • OnlyChange: 0
  • StartFinishAtWill: 1
 Introduced in version 24.9

Example

{
  "SignatureId": null,
  "Id": 0,
  "BlockedContextType": 0,
  "IsRecordingEmployee": false,
  "EmployeeNumber": null,
  "FirstName": null,
  "LastName": null,
  "PhoneNumber": null,
  "PrivatePhoneNumber": null,
  "CellPhoneNumber": null,
  "PrivateCellPhoneNumber": null,
  "InternalPhoneNumber": null,
  "EmailAddress": null,
  "PrivateEmailAddress": null,
  "SkypeId": null,
  "FaxNumber": null,
  "Position": null,
  "IsReference": false,
  "IsPurchaseManager": false,
  "IsPlanner": false,
  "IsAccountManager": false,
  "Contact": null,
  "ContactPhoneNumber": null,
  "ContactCellPhoneNumber": null,
  "ContactEmailAddress": null,
  "AddressId": null,
  "Address": null,
  "CommentId": null,
  "Comment": null,
  "BlockedFromDate": null,
  "BlockedToDate": null,
  "IsPersonBlocked": false,
  "PersonBlockedById": null,
  "PersonBlockedDate": null,
  "CanAuthorize": false,
  "ApplicationUserId": null,
  "IsSeller": false,
  "Initials": null,
  "DepartmentId": 0,
  "DistrictId": null,
  "LanguageId": 0,
  "WarehouseId": 0,
  "Category": null,
  "IdentityNumber": null,
  "GroupSettingsId": null,
  "UseWorkCenterManufacturingPrintSettings": false,
  "ManufacturingPrintSettings": null,
  "PlannedAbsences": null,
  "TimeBanks": null,
  "Relatives": null,
  "EmploymentPeriods": null,
  "ExtraFields": null,
  "IsProjectManager": false,
  "AvailableWorkshopSchedules": null,
  "AvailableWorkCenters": null,
  "Signature": null,
  "EmployeeRecordingType": 0,
  "ScheduleManagementType": 0,
  "PersonScheduleCycles": null,
  "AttendanceRecordingAuthorizers": null,
  "WorkMethod": 0
}