CensusInputRequest

Used as an inbound DTO for eligibility/benefits evaluation and for payroll and employee profile processing.

  • eligibleForBenefits
    Type: boolean
    required

    Indicates whether the employee is eligible for benefits.

  • employeeRegistration
    Type: string
    required

    Unique employee identifier / registration number in the source system.

  • employeeStatus
    Type: string
    required

    Employee current status.

  • firstName
    Type: string
    required

    Employee first name (given name).

  • hireDate
    Type: null | stringFormat: date-time
    required

    Employee hire date.

  • lastName
    Type: string
    required

    Employee last name (surname / family name).

  • grossAnnualSalary
    Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double

    Gross annual salary amount.

  • hourlyRate
    Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double

    Hourly rate when applicable.

  • payCycle
    Type: null | string

    Payroll cycle / frequency for the employee.

  • payrollArea
    Type: null | string

    Payroll area identifier.

  • payrollGroup
    Type: null | string

    Payroll group identifier.

  • periodsPerYear
    Type: null | integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32

    Number of pay periods per year.

  • personnelSubArea
    Type: null | string

    Personnel subarea identifier.

  • salaryPerPeriod
    Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double

    Salary amount per pay period.

  • standardHours
    Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double

    Standard scheduled hours.

  • timeType
    Type: null | string

    Time type (pay basis).