Skip to content

API Reference ​

This section provides detailed API documentation for the Oxygen Ergani package.

Package Structure ​

OxygenSuite\OxygenErgani
├── Ergani                          # Main facade class
├── Enums/                          # Enum definitions
├── Exceptions/                     # Exception classes
├── Http/
│   ├── Client                      # Base HTTP client
│   ├── Documents/                  # Document submission classes
│   │   ├── WorkCard/               # Work card submissions
│   │   ├── WorkTime/               # Work time declarations
│   │   ├── Hiring/                 # E3 hiring forms
│   │   ├── Termination/            # E5/E7 termination forms
│   │   ├── Dismissal/              # E6 dismissal forms
│   │   ├── Modification/           # MA modification forms
│   │   ├── Apprenticeship/         # E3.4 apprenticeship forms
│   │   ├── CommunityProgram/       # E3.1 community-benefit program forms
│   │   ├── Construction/           # E12 construction forms
│   │   ├── Motorcycle/             # E13 motorcycle use forms
│   │   ├── ParentalLeave/          # E14 parental leave forms
│   │   ├── Training/               # E3.2 theoretical / E3.3 practical training forms
│   │   ├── UrgentHiring/           # FastAna urgent hiring forms
│   │   ├── SixthDay/              # Sixth day declarations
│   │   ├── PreAnnouncement/       # Pre-announcement exemptions
│   │   └── Internship/            # E3.5 internship forms
│   └── Services/                   # Query services
├── Models/                         # Data models
├── Responses/                      # Response wrappers
└── Storage/                        # Token management

Core Classes ​

Ergani Facade ​

The Ergani class provides a simplified interface for common operations.

php
use OxygenSuite\OxygenErgani\Ergani;
use OxygenSuite\OxygenErgani\Enums\Environment;

$ergani = new Ergani($accessToken, Environment::PRODUCTION);

See Ergani Facade for full documentation.

Documents ​

Documents handle submissions to the ERGANI API:

ClassActionDescription
WorkCard-Employee check-ins/check-outs
DailyWorkTimeWTODailyDaily work time declarations
WeeklyWorkTimeWTOWeekWeekly work time declarations
WorkTimeOvertimeWTOOvOvertime declarations (WorkTime model)
WorkTimeOvertimeRetrospectiveWTOOvARetrospective overtime declarations
WorkTimeOvertimeDriversWTOOvDOvertime declarations for drivers

Hiring Documents (E3) ​

ClassActionDescription
HiringNewWebE3NNew employee hiring
HiringModificationWebE3MTransfer from another company
HiringDeletionWebE3DEmployee lending FROM employer
HiringWithLendingWebE3PDHiring TO indirect employer

Termination Documents (E5) ​

ClassActionDescription
VoluntaryResignationWebE5NStandard resignation
ResignationNotificationWebE5ONotification of possible resignation
ResignationAfterNotificationWebE5AOConfirmed resignation after E5O
TerminationByDeathWebE5DTermination due to death
VoluntaryExitCompensationWebE5EVoluntary exit with severance
RetirementVoluntaryWebE5SVoluntary retirement
RetirementMandatoryWebE5DSMandatory retirement

Dismissal Documents (E6) ​

ClassActionDescription
DismissalWithoutNoticeWebE6NXPImmediate dismissal
DismissalWithNoticeWebE6NMPDismissal with notice
RetirementDismissalWebE6SXPRetirement dismissal
EndOfLoanWebE6LDEnd of loan arrangement
TrialPeriodTerminationWebE6LTTrial period termination
TransferWebE6MEmployee transfer

Fixed-Term Documents (E7) ​

ClassActionDescription
FixedTermTerminationWebE7NFixed-term contract termination

Modification Documents (MA) ​

ClassActionDescription
EmploymentModificationWebMAModify regular employee
BorrowedEmploymentModificationWebMADModify borrowed employee

Construction Documents (E12) ​

ClassActionDescription
ConstructionWorkDeclarationWebE12Construction work personnel declaration
ConstructionWorkCensusWebE12ApConstruction work census

Community Program Documents (E3.1) ​

ClassActionDescription
CommunityProgramEmploymentWebE31Community-benefit program employment
CommunityProgramEmploymentCorrectionWebE31CE3.1 correction
CommunityProgramExtensionWebE31EE3.1 employment extension
CommunityProgramInterruptionWebE31DE3.1 employment interruption

Training Documents (E3.2 / E3.3) ​

ClassActionDescription
TheoreticalTrainingWebE32Theoretical training start
TheoreticalTrainingCorrectionWebE32CE3.2 correction
TheoreticalTrainingEmployerChangeWebE32TE3.2 practical training employer change
TheoreticalTrainingInterruptionWebE32DE3.2 training interruption
PracticalTrainingWebE33Practical training start (E3.3)
PracticalTrainingCorrectionWebE33CE3.3 correction

Apprenticeship Documents (E3.4) ​

ClassActionDescription
ApprenticeshipWebE34Apprenticeship start
ApprenticeshipCorrectionWebE34CE3.4 correction

Motorcycle Documents (E13) ​

ClassActionDescription
MotorcycleUseWebE13Moped/motorcycle use declaration

Parental Leave Documents (E14) ​

ClassActionDescription
ParentalLeaveWebE14Parental leave declaration
ParentalLeaveCorrectionWebE14CParental leave correction / change

Urgent Hiring Documents (FastAna) ​

ClassActionDescription
UrgentHiringFastAnaHiring to cover urgent needs
UrgentHiringCorrectionFastAnaCUrgent hiring correction / change

Other Documents ​

ClassActionDescription
SixthDaySixthDaySixth day / extra shift declaration
PreAnnouncementExemptionExProanPre-announcement exemption
InternshipWebE35E3.5 internship declaration
InternshipCorrectionWebE35CE3.5 internship declaration correction
InternshipTerminationWebE35DE3.5 internship stop (early termination)
InternshipScheduleChangeWebE35TE3.5 internship schedule change

Services ​

Services query ERGANI data:

ClassCodeDescription
EmployerInfoEX_BASE_01Employer details
BranchInfoEX_BASE_02Branch details
ParameterLookupEX_BASE_03Parameter lists
MonthlyStatusEX_BASE_04Monthly employee status
WorkforceStatusEX_BASE_05Workforce status
AcceptanceStatusEX_BASE_06Acceptance status
RealWorkingDiaryEX_BASE_07Real employment diary
DigitalWorkTimeStatusEX_BASE_08Digital work time organization status

API Reference Pages ​

Released under the MIT License.