API Documentation

  • Home
  • ChangeLog
  • Terms of use
  • Swagger UI
  • Account
  • Address
  • Analytic
  • BankAccount
  • Contact
  • Country
  • Currency
  • Customer
  • Dashboard
  • Document
  • DocumentNumbering
  • Employee
  • ExchangeRate
  • Inbox
  • IssuedInvoice
  • IssuedInvoicePosting
  • Item
  • Journal
  • JournalType
  • Order
  • Organisation
  • Outbox
  • PaymentMethod
  • PayrollSettings
  • PostalCode
  • ProductGroup
  • PurposeCode
  • ReceivedInvoice
  • ReportTemplate
  • Stock
  • StockEntry
  • User
  • VatAccountingType
  • VatRate
  • Warehouse

Employee -> GetEmployee

Returns an employee.

Request

Relative request path: api/orgs/{organisationId}/employees/{employeeId}

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
organisationIdorganisation id
employeeId

Request parameters:

  • long organisationId - organisation id
  • long employeeId -

Request parameters:

  • Int64 organisationId - organisation id
  • Int64 employeeId -

Request parameters:

  • Long organisationId - organisation id
  • Long employeeId -

Response

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
EmployeeIdEmployee id.
CodeEmployee code.
TaxNumberEmployee Tax number.
FirstNameEmployee first name.
LastNameEmployee last name.
AddressEmployee address.
PostalCodeEmployee postal code.
CityEmployee city.
Countryclass Country. Employee country.
CountryOfResidenceclass Country. Employee residence country.
DateOfBirthEmployee date of birth.
GenderPossible values: (M, Z). Employee gender:
  • M - Man
  • Z - Woman
EmploymentStartDateDate of employment.
EmploymentEndDateEmployment end date.
NotesNotes.
EmploymentTypeEmployment type:
  • ZD - Employed worker
  • ZL - Employed owner
  • ZAP - Employed elsewhere
  • DSP - Pupil or student on compulsory practical training
  • DD - Seconded worker
  • ZJD - Employee - community work
PersonalIdenficationNumberEmployee Personal identification number.
InsuranceBasisEmployee Insurance base for employment type ZL and organisation type »Zasebnik«:
  • 005 - Basis 005,
  • 104 - Basis 104,
EmploymentType ZL and organisation type »Gospodarska družba«:
  • 040in112 - Basis 040 + 112,
  • 040 - Basis 040,
  • 103 - Basis 103.
RecordDtModified
RowVersionRow version is used for concurrency check.

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

    /// Employee details.
    public class Employee
    {
        // Employee id.
        // Ignored on create request.
        public long EmployeeId { get; set; }
        // Employee code.
        public string Code { get; set; }
        // Employee Tax number.
        public string TaxNumber { get; set; }
        // Employee first name.
        public string FirstName { get; set; }
        // Employee last name.
        public string LastName { get; set; }
        // Employee address.
        public string Address { get; set; }
        // Employee postal code.
        public string PostalCode { get; set; }
        // Employee city.
        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>
        //

        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>
        //

        public string EmploymentType { get; set; }
        // Employee Personal identification number.
        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>

        public string InsuranceBasis { get; set; }
        public DateTime RecordDtModified { get; set; }
        // Row version is used for concurrency check.
        // 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.
        // Ignored on create request.
        public $EmployeeId;
        // Employee code.
        public $Code;
        // Employee Tax number.
        public $TaxNumber;
        // Employee first name.
        public $FirstName;
        // Employee last name.
        public $LastName;
        // Employee address.
        public $Address;
        // Employee postal code.
        public $PostalCode;
        // Employee city.
        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>
        //

        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>
        //

        public $EmploymentType;
        // Employee Personal identification number.
        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>

        public $InsuranceBasis;
        public $RecordDtModified;
        // Row version is used for concurrency check.
        // 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.
        // Ignored on create request.
        public Long EmployeeId;
        // Employee code.
        public String Code;
        // Employee Tax number.
        public String TaxNumber;
        // Employee first name.
        public String FirstName;
        // Employee last name.
        public String LastName;
        // Employee address.
        public String Address;
        // Employee postal code.
        public String PostalCode;
        // Employee city.
        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>
        //

        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>
        //

        public String EmploymentType;
        // Employee Personal identification number.
        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>

        public String InsuranceBasis;
        public Date RecordDtModified;
        // Row version is used for concurrency check.
        // 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;
        
        }

 
Authorization endpoint : https://moj.minimax.si/SI/AUT/OAuth20
Token endpoint           : https://moj.minimax.si/SI/AUT/OAuth20/Token
Return url                   : https://moj.minimax.si/SI/API/Help/TestClientDialogsAuth
 
URI parameters
=
Headers | Add custom header
: Delete
Body
Samples:
Status
Headers
            
        
Body