@springtree/eva-core/EVA.Payroll.d.ts

The EVA core typings

declare module EVA.Payroll {

  /**
   * Get an Employment by ID.
   * 
   * An Employment defines if and/or when an Employee is employed and should have Roles and/or Functionalities.
   */
  export interface GetEmploymentByID {
    ID: number;
  }

  export interface GetEmploymentByIDResponse {
    ID: number;
    BackendID: string;
    UserID: number;
    UserFullName: string;
    UserEmailAddress: string;
    StartDate?: string;
    EndDate?: string;
    EmploymentType: string;
    Employer: string;
    DefaultReplacementID: number;
    DefaultReplacementFullName: string;
    DefaultReplacementEmailAddress: string;
    Error: EVA.Core.ServiceError;
  }

  /**
   * Create an new Employment for an User.
   * 
   * An Employment defines if and/or when an Employee is employed and should have Roles and/or Functionalities.
   */
  export interface CreateEmployment {
    BackendID?: string;
    UserID: number;
    StartDate?: string;
    EndDate?: string;
    EmploymentType?: string;
    Employer?: string;
    DefaultReplacementID: number;
  }

  export interface CreateEmploymentResponse {
    ID: number;
    Error: EVA.Core.ServiceError;
  }

  /**
   * Updates an existing Employment.
   * 
   * An Employment defines if and/or when an Employee is employed and should have Roles and/or Functionalities.
   */
  export interface UpdateEmployment {
    ID: number;
    BackendID?: string;
    UserID: number;
    StartDate?: string;
    EndDate?: string;
    EmploymentType?: string;
    Employer?: string;
    DefaultReplacementID: number;
  }

  /**
   * Deletes an existing Employment.
   * 
   * An Employment defines if and/or when an Employee is employed and should have Roles and/or Functionalities.
   */
  export interface DeleteEmployment {
    ID: number;
  }

  /**
   * Lists Employments.
   * 
   * An Employment defines if and/or when an Employee is employed and should have Roles and/or Functionalities.
   */
  export interface ListEmployments {
    PageConfig?: EVA.Core.PageConfig<ListEmploymentsFilter>;
  }

  export interface ListEmploymentsFilter {
    UserID: number;
    DefaultReplacementID: number;
    BackendID: string;
    EmploymentType: string;
    Employer: string;
  }

  export interface ListEmploymentsResponse {
    Result: EVA.Core.PagedResult<EmploymentDto>;
    Error: EVA.Core.ServiceError;
  }

  export interface EmploymentDto {
    ID: number;
    BackendID: string;
    UserID: number;
    UserFullName: string;
    UserEmailAddress: string;
    StartDate?: string;
    EndDate?: string;
    EmploymentType: string;
    Employer: string;
    DefaultReplacementID: number;
    DefaultReplacementFullName: string;
    DefaultReplacementEmailAddress: string;
  }

}