Click or drag to resize
ITimecardApi Interface
Time-card related XML-RPC methods. This interface also contains all other API methods. Either Basic or Cookie based authentication can be used to call all API methods.

Namespace: AMG.API
Assembly: AMG.API (in AMG.API.dll) Version: 2.0.0.0 (2.0.0.0)
Syntax
public interface ITimecardApi : IEmployeeApi, 
	IJobApi, IMiscEntryApi, ITransactionApi, IScheduleApi, IWageApi, 
	IDepartmentApi, ISettingsApi, IBenefitApi, IDivisionApi, IHeadquartersApi

The ITimecardApi type exposes the following members.

Methods
  NameDescription
Public methodAddBenefit
Adds a new benefit to given employee.
(Inherited from IBenefitApi.)
Public methodAddBenefitBalance
Balances the employee's benefit.
(Inherited from IBenefitApi.)
Public methodAddDepartment
Adds new department.
(Inherited from IDepartmentApi.)
Public methodAddDivision
Adds new division.
(Inherited from IDivisionApi.)
Public methodAddEmployee
Adds new employee.
(Inherited from IEmployeeApi.)
Public methodAddEmployeeStatus
Adds one or more statuses for given employee. All status start dates for each employee should be unique.
(Inherited from IEmployeeApi.)
Public methodAddHeadquarters
Adds new headquarters.
(Inherited from IHeadquartersApi.)
Public methodAddJob
Adds new job.
(Inherited from IJobApi.)
Public methodAddOrUpdateMiscEntry
Adds or updates a miscellaneous transaction. When there is already a transaction for given date/time, that transaction is updated. Otherwise new transaction is added.
(Inherited from IMiscEntryApi.)
Public methodAddOrUpdateTransaction
Adds or updates a punch transaction. When there is already a transaction for given employee at given date/time it is being updated otherwise new transaction is added.
(Inherited from ITransactionApi.)
Public methodAddOrUpdateWage
Adds or updates a wage definition. When there is already a wage for given employee at given date it is being updated otherwise new wage definition is added.
(Inherited from IWageApi.)
Public methodDeleteBenefit
Deletes a benefit by ID.
(Inherited from IBenefitApi.)
Public methodDeleteDepartment
Deletes a department by ID.
(Inherited from IDepartmentApi.)
Public methodDeleteDivision
Deletes a division by ID.
(Inherited from IDivisionApi.)
Public methodDeleteEmployee
Deletes an employee.
(Inherited from IEmployeeApi.)
Public methodDeleteEmployeeStatus
Deletes a status from employee.
(Inherited from IEmployeeApi.)
Public methodDeleteHeadquarters
Deletes a headquarters by ID.
(Inherited from IHeadquartersApi.)
Public methodDeleteJob
Deletes a job by ID.
(Inherited from IJobApi.)
Public methodDeleteMiscEntry
Deletes miscellaneous transaction by given employee and date.
(Inherited from IMiscEntryApi.)
Public methodDeleteSchedules
Deletes schedules for given employees in given time range.
(Inherited from IScheduleApi.)
Public methodDeleteTransaction
Deletes punch transaction by given employee and date.
(Inherited from ITransactionApi.)
Public methodDeleteWage
Deletes wage definition by given employee and date.
(Inherited from IWageApi.)
Public methodGetAllEmployeesShort
Returns all employees in short form.
(Inherited from IEmployeeApi.)
Public methodGetBenefits

Gets employee's benefits by category.

When categoryId is 0 all benefits will be retrieved.

(Inherited from IBenefitApi.)
Public methodGetCategories
Gets categories.
Public methodGetDepartments
Gets department by their IDs.
(Inherited from IDepartmentApi.)
Public methodGetDevices
Gets basic information of devices.
Public methodGetDivisions
Gets divisions by their IDs.
(Inherited from IDivisionApi.)
Public methodGetEmployee
Gets one employee information.
(Inherited from IEmployeeApi.)
Public methodGetEmployees
Gets Employee objects by their IDs.
(Inherited from IEmployeeApi.)
Public methodGetEmployeeStatuses
Gets employees' statuses.
(Inherited from IEmployeeApi.)
Public methodGetEmployeeWages
Gets all wages for given employees.
(Inherited from IWageApi.)
Public methodGetGroups
Gets groups.
Public methodGetHeadquarters
Gets headquarters by their IDs.
(Inherited from IHeadquartersApi.)
Public methodGetJobs
Gets jobs by their IDs.
(Inherited from IJobApi.)
Public methodGetMiscTransactions
Gets miscellaneous transactions for given employees in given time range.
(Inherited from IMiscEntryApi.)
Public methodGetPolicies
Gets pay policies.
Public methodGetPunchAnalysis
Gets Punch Analysis for given employees in a given time range.
Public methodGetSchedules
Gets schedules for given employees in given time range.
(Inherited from IScheduleApi.)
Public methodGetSetting
Gets settings.
(Inherited from ISettingsApi.)
Public methodGetShiftGroups
Gets shift groups.
Public methodGetTimecards
Gets time cards for given employees in a given time range.
Public methodGetTimecardsLite
Gets lightweight time cards for given employees in a given time range.
Public methodGetTimecardsWithWage
Gets time cards for given employees in a given time range including wage.
Public methodGetTransactions
Gets punch transactions for given employees in given time range.
(Inherited from ITransactionApi.)
Public methodGetWage
Gets employee's calculated wage according to all job costing rules.
(Inherited from IWageApi.)
Public methodLogin
When using cookie authentication this method should be called before calling any other API method. AMG XML-RPC API uses cookie based authentication, so all cookies returned by this method's response should be kept and sent with each request.
Public methodSetSchedules
Adds or updates schedules. When there is already a schedule for given date/time, that schedule is updated. Otherwise new schedule is added.
(Inherited from IScheduleApi.)
Public methodUpdateBenefit
Updates the given benefit.
(Inherited from IBenefitApi.)
Public methodUpdateDepartment
Updates the given department.
(Inherited from IDepartmentApi.)
Public methodUpdateDivision
Updates the given division.
(Inherited from IDivisionApi.)
Public methodUpdateEmployee
Updates employee's information.
(Inherited from IEmployeeApi.)
Public methodUpdateEmployeeStatus
Updates an employee's status.
(Inherited from IEmployeeApi.)
Public methodUpdateHeadquarters
Updates the given headquarters.
(Inherited from IHeadquartersApi.)
Public methodUpdateJob
Updates the given job.
(Inherited from IJobApi.)
Top
See Also