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 managementCore 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:
| Class | Action | Description |
|---|---|---|
WorkCard | - | Employee check-ins/check-outs |
DailyWorkTime | WTODaily | Daily work time declarations |
WeeklyWorkTime | WTOWeek | Weekly work time declarations |
WorkTimeOvertime | WTOOv | Overtime declarations (WorkTime model) |
WorkTimeOvertimeRetrospective | WTOOvA | Retrospective overtime declarations |
WorkTimeOvertimeDrivers | WTOOvD | Overtime declarations for drivers |
Hiring Documents (E3)
| Class | Action | Description |
|---|---|---|
HiringNew | WebE3N | New employee hiring |
HiringModification | WebE3M | Transfer from another company |
HiringDeletion | WebE3D | Employee lending FROM employer |
HiringWithLending | WebE3PD | Hiring TO indirect employer |
Termination Documents (E5)
| Class | Action | Description |
|---|---|---|
VoluntaryResignation | WebE5N | Standard resignation |
ResignationNotification | WebE5O | Notification of possible resignation |
ResignationAfterNotification | WebE5AO | Confirmed resignation after E5O |
TerminationByDeath | WebE5D | Termination due to death |
VoluntaryExitCompensation | WebE5E | Voluntary exit with severance |
RetirementVoluntary | WebE5S | Voluntary retirement |
RetirementMandatory | WebE5DS | Mandatory retirement |
Dismissal Documents (E6)
| Class | Action | Description |
|---|---|---|
DismissalWithoutNotice | WebE6NXP | Immediate dismissal |
DismissalWithNotice | WebE6NMP | Dismissal with notice |
RetirementDismissal | WebE6SXP | Retirement dismissal |
EndOfLoan | WebE6LD | End of loan arrangement |
TrialPeriodTermination | WebE6LT | Trial period termination |
Transfer | WebE6M | Employee transfer |
Fixed-Term Documents (E7)
| Class | Action | Description |
|---|---|---|
FixedTermTermination | WebE7N | Fixed-term contract termination |
Modification Documents (MA)
| Class | Action | Description |
|---|---|---|
EmploymentModification | WebMA | Modify regular employee |
BorrowedEmploymentModification | WebMAD | Modify borrowed employee |
Construction Documents (E12)
| Class | Action | Description |
|---|---|---|
ConstructionWorkDeclaration | WebE12 | Construction work personnel declaration |
ConstructionWorkCensus | WebE12Ap | Construction work census |
Community Program Documents (E3.1)
| Class | Action | Description |
|---|---|---|
CommunityProgramEmployment | WebE31 | Community-benefit program employment |
CommunityProgramEmploymentCorrection | WebE31C | E3.1 correction |
CommunityProgramExtension | WebE31E | E3.1 employment extension |
CommunityProgramInterruption | WebE31D | E3.1 employment interruption |
Training Documents (E3.2 / E3.3)
| Class | Action | Description |
|---|---|---|
TheoreticalTraining | WebE32 | Theoretical training start |
TheoreticalTrainingCorrection | WebE32C | E3.2 correction |
TheoreticalTrainingEmployerChange | WebE32T | E3.2 practical training employer change |
TheoreticalTrainingInterruption | WebE32D | E3.2 training interruption |
PracticalTraining | WebE33 | Practical training start (E3.3) |
PracticalTrainingCorrection | WebE33C | E3.3 correction |
Apprenticeship Documents (E3.4)
| Class | Action | Description |
|---|---|---|
Apprenticeship | WebE34 | Apprenticeship start |
ApprenticeshipCorrection | WebE34C | E3.4 correction |
Motorcycle Documents (E13)
| Class | Action | Description |
|---|---|---|
MotorcycleUse | WebE13 | Moped/motorcycle use declaration |
Parental Leave Documents (E14)
| Class | Action | Description |
|---|---|---|
ParentalLeave | WebE14 | Parental leave declaration |
ParentalLeaveCorrection | WebE14C | Parental leave correction / change |
Urgent Hiring Documents (FastAna)
| Class | Action | Description |
|---|---|---|
UrgentHiring | FastAna | Hiring to cover urgent needs |
UrgentHiringCorrection | FastAnaC | Urgent hiring correction / change |
Other Documents
| Class | Action | Description |
|---|---|---|
SixthDay | SixthDay | Sixth day / extra shift declaration |
PreAnnouncementExemption | ExProan | Pre-announcement exemption |
Internship | WebE35 | E3.5 internship declaration |
InternshipCorrection | WebE35C | E3.5 internship declaration correction |
InternshipTermination | WebE35D | E3.5 internship stop (early termination) |
InternshipScheduleChange | WebE35T | E3.5 internship schedule change |
Services
Services query ERGANI data:
| Class | Code | Description |
|---|---|---|
EmployerInfo | EX_BASE_01 | Employer details |
BranchInfo | EX_BASE_02 | Branch details |
ParameterLookup | EX_BASE_03 | Parameter lists |
MonthlyStatus | EX_BASE_04 | Monthly employee status |
WorkforceStatus | EX_BASE_05 | Workforce status |
AcceptanceStatus | EX_BASE_06 | Acceptance status |
RealWorkingDiary | EX_BASE_07 | Real employment diary |
DigitalWorkTimeStatus | EX_BASE_08 | Digital work time organization status |
API Reference Pages
- Ergani Facade - Main facade class methods
- Enums - Enumeration classes with values
- Responses - Response wrapper classes
- Exceptions - Exception classes