API Documentation

Request parameters:

• long organisationId - organisation id
• long employeeId -

Request parameters:

• Int64 organisationId - organisation id
• Int64 employeeId -

Request parameters:

• Long organisationId - organisation id
• Long employeeId -

This method returns result of type 'SAOP.API.Models.Employee.Employee'.

    /// Employee details.
    public class Employee
    {
        // Employee id.
        // Mandatory field. Ignored on create request.
        public long EmployeeId { get; set; }
        // Employee code.
        // Max length: 10
        public string Code { get; set; }
        // Employee Tax number.
        // Max length: 12
        public string TaxNumber { get; set; }
        // Employee first name.
        // Mandatory field. Max length: 30
        public string FirstName { get; set; }
        // Employee last name.
        // Mandatory field. Max length: 250
        public string LastName { get; set; }
        // Employee address.
        // Max length: 250
        public string Address { get; set; }
        // Employee postal code.
        // Max length: 30
        public string PostalCode { get; set; }
        // Employee city.
        // Max length: 250
        public string City { get; set; }
        // Employee country.
        public mMApiFkField Country { get; set; }
        // Employee residence country.
        public mMApiFkField CountryOfResidence { get; set; }
        // Employee date of birth.
        public DateTime? DateOfBirth { get; set; }
        // Employee gender:
        // <ul>
        //     <li>M - Man</li>
        //     <li>Z - Woman</li>
        // </ul>
        //
        // Mandatory field. Max length: 1
        public string Gender { get; set; }
        // Date of employment.
        public DateTime? EmploymentStartDate { get; set; }
        // Employment end date.
        public DateTime? EmploymentEndDate { get; set; }
        // Notes.
        public string Notes { get; set; }
        // Employment type:
        // <ul>
        //     <li>ZD - Employed worker</li>
        //     <li>ZL - Employed owner</li>
        //     <li>ZAP - Employed elsewhere</li>
        //     <li>DSP - Pupil or student on compulsory practical training</li>
        //     <li>DD - Seconded worker</li>
        //     <li>ZJD - Employee - community work</li>
        // </ul>
        //
        // Mandatory field. Max length: 30
        public string EmploymentType { get; set; }
        // Employee Personal identification number.
        // Max length: 30
        public string PersonalIdenficationNumber { get; set; }
        // Employee Insurance base for employment type ZL and organisation type »Zasebnik«:
        // <ul>
        //     <li>005 - Basis 005,</li>
        //     <li>104 - Basis 104,</li>
        // </ul>
        // EmploymentType ZL and organisation type »Gospodarska družba«:
        // <ul>
        //     <li>040in112 - Basis 040 + 112,</li>
        //     <li>040 - Basis 040,</li>
        //     <li>103 - Basis 103.</li>
        // </ul>
        // Max length: 30
        public string InsuranceBasis { get; set; }
        public DateTime RecordDtModified { get; set; }
        // Row version is used for concurrency check.
        // Mandatory field. Ignored on create request.
        public string RowVersion { get; set; }
    
    }

        /// Link with id, name and url to related data.
        public class mMApiFkField
        {
            // Record id.
            public long? ID { get; set; }
            // Record name.
            public string Name { get; private set; }
            // Url to full record details.
            public string ResourceUrl { get; private set; }
        
        }

This method returns result of type 'SAOP.API.Models.Employee.Employee'.

    /// Employee details.
    class Employee
    {
        // Employee id.
        // Mandatory field. Ignored on create request.
        public $EmployeeId;
        // Employee code.
        // Max length: 10
        public $Code;
        // Employee Tax number.
        // Max length: 12
        public $TaxNumber;
        // Employee first name.
        // Mandatory field. Max length: 30
        public $FirstName;
        // Employee last name.
        // Mandatory field. Max length: 250
        public $LastName;
        // Employee address.
        // Max length: 250
        public $Address;
        // Employee postal code.
        // Max length: 30
        public $PostalCode;
        // Employee city.
        // Max length: 250
        public $City;
        // Employee country.
        public $Country;
        // Employee residence country.
        public $CountryOfResidence;
        // Employee date of birth.
        public $DateOfBirth;
        // Employee gender:
        // <ul>
        //     <li>M - Man</li>
        //     <li>Z - Woman</li>
        // </ul>
        //
        // Mandatory field. Max length: 1
        public $Gender;
        // Date of employment.
        public $EmploymentStartDate;
        // Employment end date.
        public $EmploymentEndDate;
        // Notes.
        public $Notes;
        // Employment type:
        // <ul>
        //     <li>ZD - Employed worker</li>
        //     <li>ZL - Employed owner</li>
        //     <li>ZAP - Employed elsewhere</li>
        //     <li>DSP - Pupil or student on compulsory practical training</li>
        //     <li>DD - Seconded worker</li>
        //     <li>ZJD - Employee - community work</li>
        // </ul>
        //
        // Mandatory field. Max length: 30
        public $EmploymentType;
        // Employee Personal identification number.
        // Max length: 30
        public $PersonalIdenficationNumber;
        // Employee Insurance base for employment type ZL and organisation type »Zasebnik«:
        // <ul>
        //     <li>005 - Basis 005,</li>
        //     <li>104 - Basis 104,</li>
        // </ul>
        // EmploymentType ZL and organisation type »Gospodarska družba«:
        // <ul>
        //     <li>040in112 - Basis 040 + 112,</li>
        //     <li>040 - Basis 040,</li>
        //     <li>103 - Basis 103.</li>
        // </ul>
        // Max length: 30
        public $InsuranceBasis;
        public $RecordDtModified;
        // Row version is used for concurrency check.
        // Mandatory field. Ignored on create request.
        public $RowVersion;
    
    }

        /// Link with id, name and url to related data.
        class mMApiFkField
        {
            // Record id.
            public $ID;
            // Record name.
            public $Name;
            // Url to full record details.
            public $ResourceUrl;
        
        }

This method returns result of type 'SAOP.API.Models.Employee.Employee'.

    /// Employee details.
    public class Employee
    {
        // Employee id.
        // Mandatory field. Ignored on create request.
        public Long EmployeeId;
        // Employee code.
        // Max length: 10
        public String Code;
        // Employee Tax number.
        // Max length: 12
        public String TaxNumber;
        // Employee first name.
        // Mandatory field. Max length: 30
        public String FirstName;
        // Employee last name.
        // Mandatory field. Max length: 250
        public String LastName;
        // Employee address.
        // Max length: 250
        public String Address;
        // Employee postal code.
        // Max length: 30
        public String PostalCode;
        // Employee city.
        // Max length: 250
        public String City;
        // Employee country.
        public mMApiFkField Country;
        // Employee residence country.
        public mMApiFkField CountryOfResidence;
        // Employee date of birth.
        public Date DateOfBirth;
        // Employee gender:
        // <ul>
        //     <li>M - Man</li>
        //     <li>Z - Woman</li>
        // </ul>
        //
        // Mandatory field. Max length: 1
        public String Gender;
        // Date of employment.
        public Date EmploymentStartDate;
        // Employment end date.
        public Date EmploymentEndDate;
        // Notes.
        public String Notes;
        // Employment type:
        // <ul>
        //     <li>ZD - Employed worker</li>
        //     <li>ZL - Employed owner</li>
        //     <li>ZAP - Employed elsewhere</li>
        //     <li>DSP - Pupil or student on compulsory practical training</li>
        //     <li>DD - Seconded worker</li>
        //     <li>ZJD - Employee - community work</li>
        // </ul>
        //
        // Mandatory field. Max length: 30
        public String EmploymentType;
        // Employee Personal identification number.
        // Max length: 30
        public String PersonalIdenficationNumber;
        // Employee Insurance base for employment type ZL and organisation type »Zasebnik«:
        // <ul>
        //     <li>005 - Basis 005,</li>
        //     <li>104 - Basis 104,</li>
        // </ul>
        // EmploymentType ZL and organisation type »Gospodarska družba«:
        // <ul>
        //     <li>040in112 - Basis 040 + 112,</li>
        //     <li>040 - Basis 040,</li>
        //     <li>103 - Basis 103.</li>
        // </ul>
        // Max length: 30
        public String InsuranceBasis;
        public Date RecordDtModified;
        // Row version is used for concurrency check.
        // Mandatory field. Ignored on create request.
        public String RowVersion;
    
    }

        /// Link with id, name and url to related data.
        public class mMApiFkField
        {
            // Record id.
            public Long ID;
            // Record name.
            public String Name;
            // Url to full record details.
            public String ResourceUrl;
        
        }