Ergani Rust SDK

ergani is a Rust SDK for interacting with the API of Ergani.

Attributions

Ergani Rust SDK is a Rust flavour of the relevant Ergani Python SDK built by LOGIC.

Requirements

Rust 1.76.0 or later

Installation

The ergani package is available on crates.io and you can install it through your favorite package manager:

cargo install ergani

Usage

Create a client

To create a new Ergani client you have to set your Ergani username, password and optionally the Ergani API base URL, that defaults to https://trialeservices.yeka.gr/WebServicesAPI/api.

let ergani_username = env::var("ERGANI_USERNAME") ?;
let ergani_password = env::var("ERGANI_PASSWORD") ?;
let ergani_base_url = env::var("ERGANI_BASE_URL")
.unwrap_or("https://trialeservices.yeka.gr/WebServicesAPI/api".to_string());

let client = ErganiClient::new(ergani_username, ergani_password, Some(ergani_base_url)).await?;

If you intend to use this package for multiple company entities, it is necessary to create separate client instances for each entity with the appropriate credentials.

We are going to use the aforementioned ergani_client for the following usage examples.

Work card

Submit work card records to Ergani in order to declare an employee's movement (arrival, departure).

async fn submit_work_card(company_work_cards: Vec<CompanyWorkCard>) -> Result<Vec<SubmissionResponse>>

Example

let work_card_movement_datetime =
    NaiveDateTime::parse_from_str("2024-03-20 10:00", "%Y-%m-%d %H:%M")
    .unwrap()
    .and_utc();

let work_card_submission_date = NaiveDate::parse_from_str("2022-05-04", "%Y-%m-%d").unwrap();

let work_card = vec![CompanyWorkCardBuilder::builder()
    .set_employer_tax_identification_number("123456789")
    .set_business_branch_number(0)
    .set_comments(Some("Σχόλια"))
    .set_card_details(vec![WorkCardBuilder::builder()
        .set_employee_tax_identification_number("123456789")
        .set_employee_last_name("Last")
        .set_employee_first_name("First")
        .set_work_card_movement_type(WorkCardMovementType::Arrival)
        .set_work_card_submission_date(work_card_submission_date)
        .set_work_card_movement_datetime(work_card_movement_datetime)
        .set_late_declaration_justification(Some(LateDeclarationJustificationType::PowerOutage))
        .build()?])
    .build()];

let response = ergani_client.submit_work_card(work_card).await?;

response.iter().for_each(|r| {
    println!("{:?}", r);
});

Note: You can submit work cards for various employees across multiple company branches simultaneously as shown above.

Overtime

Submit overtime records to Ergani in order to declare employees overtimes.

async fn submit_overtime(company_overtimes: Vec<CompanyOvertime>) -> Result<Vec<SubmissionResponse>>

Example

let start_time = "2024-03-01T12:00:00Z".parse::<DateTime<Utc>>().unwrap();
let end_time = "2024-03-01T20:00:00Z".parse::<DateTime<Utc>>().unwrap();
let related_protocol_date = NaiveDate::from_ymd_opt(2024, 3, 1).unwrap();

let company_overtimes = vec![CompanyOvertimeBuilder::builder()
    .set_business_branch_number(0)
    .set_sepe_service_code("10000")
    .set_business_primary_activity_code("1000")
    .set_business_branch_activity_code("1010")
    .set_kallikratis_municipal_code("10000000")
    .set_legal_representative_tax_identification_number("123456789")
    .set_employee_overtimes(vec![OvertimeBuilder::builder()
        .set_employee_tax_identification_number("123456789")
        .set_employee_social_security_number("00000000000")
        .set_employee_last_name("Last")
        .set_employee_first_name("First")
        .set_overtime_date(NaiveDate::from_ymd_opt(2024, 3, 1).unwrap())
        .set_overtime_start_time(start_time)
        .set_overtime_end_time(end_time)
        .set_overtime_cancellation(false)
        .set_employee_profession_code("1234")
        .set_overtime_justification(
            OvertimeJustificationType::AccidentPreventionOrDamageRestoration,
        )
        .set_weekly_workdays_number(WeeklyWorkDays::Five)
        .set_asee_approval(Some("ΑΣΕΕ"))
        .build()
        .unwrap()])
    .set_related_protocol_id(Some("Αρ. Πρωτ. Σχετ."))
    .set_related_protocol_date(Some(related_protocol_date))
    .set_employer_organization(Some("Εργοδότης"))
    .set_business_secondary_activity_code_1(Some("1011"))
    .set_business_secondary_activity_code_2(Some("1012"))
    .set_business_secondary_activity_code_3(Some("1013"))
    .set_business_secondary_activity_code_4(Some("1014"))
    .set_comments(Some("Σχόλια"))
    .build()];

let response = ergani_client.submit_overtime(company_overtimes).await?;

Note: You can submit overtime records for various employees across multiple company branches simultaneously.

Daily schedule

Submit daily schedules to Ergani in order to declare schedules for employees that don't have a fixed schedule (e.g. shift workers).

async fn submit_daily_schedule(company_daily_schedules: Vec<CompanyDailySchedule>) -> Result<Vec<SubmissionResponse>>

Example

let start_time = "2024-03-01T12:00:00Z".parse::<DateTime<Utc>>().unwrap();
let end_time = "2024-03-01T20:00:00Z".parse::<DateTime<Utc>>().unwrap();
let related_protocol_date = NaiveDate::from_ymd_opt(2024, 3, 1).unwrap();

let company_daily_schedules = vec![CompanyDailyScheduleBuilder::builder()
    .set_business_branch_number(0)
    .set_start_date(NaiveDate::from_ymd_opt(2024, 3, 1).unwrap())
    .set_end_date(NaiveDate::from_ymd_opt(2024, 3, 2).unwrap())
    .set_employee_schedules(vec![EmployeeDailyScheduleBuilder::builder()
        .set_employee_tax_identification_number("123456789")
        .set_employee_last_name("Last")
        .set_employee_first_name("First")
        .set_schedule_date(NaiveDate::from_ymd_opt(2024, 3, 3).unwrap())
        .set_workday_details(vec![
            WorkDayDetailsBuilder::builder()
                .set_work_type(ScheduleWorkType::WorkFromHome)
                .set_start_time(start_time)
                .set_end_time(end_time)
                .build()?,
            WorkDayDetailsBuilder::builder()
                .set_work_type(ScheduleWorkType::WorkFromOffice)
                .set_start_time(start_time)
                .set_end_time(end_time)
                .build()?,
        ])
        .build()])
    .set_related_protocol_id(Some("1"))
    .set_related_protocol_date(Some(related_protocol_date))
    .set_comments(Some("Σχόλια"))
    .build()];

let response = ergani_client
    .submit_daily_schedule(company_daily_schedules)
    .await?;

Weekly schedule

Submit weekly schedules to Ergani in order to declare schedules for employees that have a fixed schedule.

async fn submit_weekly_schedule(company_weekly_schedules: Vec<CompanyWeeklySchedule>) -> Result<Vec<SubmissionResponse>>

Example

    let start_time = "2024-03-01T12:00:00Z".parse::<DateTime<Utc>>().unwrap();
let end_time = "2024-03-01T20:00:00Z".parse::<DateTime<Utc>>().unwrap();
let related_protocol_date = NaiveDate::from_ymd_opt(2024, 3, 1).unwrap();
let schedule_date = NaiveDate::from_ymd_opt(2024, 3, 3).unwrap();

let company_weekly_schedules = vec![CompanyWeeklyScheduleBuilder::builder()
    .set_business_branch_number(0)
    .set_start_date(NaiveDate::from_ymd_opt(2024, 3, 1).unwrap())
    .set_end_date(NaiveDate::from_ymd_opt(2024, 3, 2).unwrap())
    .set_employee_schedules(vec![EmployeeWeeklyScheduleBuilder::builder()
        .set_employee_tax_identification_number("123456789")
        .set_employee_last_name("Last")
        .set_employee_first_name("First")
        .set_schedule_date(schedule_date)
        .set_workday_details(vec![
            WorkDayDetailsBuilder::builder()
                .set_work_type(ScheduleWorkType::WorkFromHome)
                .set_start_time(start_time)
                .set_end_time(end_time)
                .build()?,
            WorkDayDetailsBuilder::builder()
                .set_work_type(ScheduleWorkType::WorkFromOffice)
                .set_start_time(start_time)
                .set_end_time(end_time)
                .build()?,
        ])
        .build()])
    .set_related_protocol_id(Some("1"))
    .set_related_protocol_date(Some(related_protocol_date))
    .build()];

let response = ergani_client
    .submit_weekly_schedule(company_weekly_schedules)
    .await?;

Note: You can submit weekly schedules for various employees across multiple company branches simultaneously.

Full reference documentation is available at https://docs.rs/ergani/latest/ergani/.

Glossary

The glossary might help you if you're taking a look at the official documentation of the Ergani API (https://eservices.yeka.gr/(S(ayldvlj35eukgvmzrr055oe5))/Announcements.aspx?id=257).

Work card

Work card movement types

Work card justifications

Overtime

Overtime justfications

Daily schedule

Weekly schedule

Schedule work types

License

This project is licensed under the MIT License