TimeTrex API Manual

Documentation

Packages

Core
GovernmentForms
Modules
API
Other
PayrollDeduction

Interfaces, Classes, Traits and Enums

GovernmentForms_CA
GovernmentForms_CA_ROE
GovernmentForms_CA_T4
GovernmentForms_CA_T4A
GovernmentForms_CA_T4ASum
GovernmentForms_CA_T4Sum
GovernmentForms_CA_T619
GovernmentForms_grid
GovernmentForms_US_1096
GovernmentForms_US_1099NEC
GovernmentForms_US_940
GovernmentForms_US_940SA
GovernmentForms_US_941
GovernmentForms_US_941SB
GovernmentForms_US_941WorkSheet1
GovernmentForms_US_941WorkSheet2
GovernmentForms_US_941WorkSheet3
GovernmentForms_US_941WorkSheet4
GovernmentForms_US_941WorkSheet5
GovernmentForms_US_CMS_PBJ
GovernmentForms_US_RETURN1040
GovernmentForms_US_RETURN940
GovernmentForms_US_RETURN941
GovernmentForms_US_State_UI
GovernmentForms_US
GovernmentForms_US_W2
GovernmentForms_US_W2C
GovernmentForms_US_W3
GovernmentForms_US_W3C
GovernmentForms
GovernmentForms_Base
AccrualBalanceFactory
AccrualBalanceListFactory
AccrualFactory
AccrualListFactory
APIAccrual
APIAccrualBalance
TimeTrexClientAPI
TimeTrexClientAPIReturnHandler
APIBranch
APICompany
APICompanyDeduction
APICompanyGenericTag
APICompanySetting
APILegalEntity
APIPayrollRemittanceAgency
APIPayrollRemittanceAgencyEvent
APIRemittanceSourceAccount
APISetupPresets
APIWageGroup
APIAbout
APIAuthorization
APICurrency
APICurrencyRate
APICustomField
APIDashboard
APIEnvironment
APIException
APIFactory
APIInstall
APILog
APIMisc
APIOtherField
APIPermission
APIPermissionControl
APIProgressBar
APIStation
APITest
APITimeSheet
APITTDate
APIUserDateTotal
APIDepartment
APIHierarchyControl
APIHierarchyLevel
APIHoliday
APIRecurringHoliday
APIImport
APIImportAccrual
APIImportBankAccount
APIImportBranch
APIImportDepartment
APIImportPayPeriod
APIImportPayStubAmendment
APIImportRemittanceDestinationAccount
APIImportUser
APIImportUserEducation
APIImportUserSkill
APIImportUserWage
APIKPI
APIKPIGroup
APIUserReview
APIUserReviewControl
APIMessageControl
APINotification
APINotificationDeviceToken
APIPayStub
APIPayStubEntry
APIPayStubEntryAccount
APIPayStubEntryAccountLink
APIPayStubTransaction
APIPayStubAmendment
APIRecurringPayStubAmendment
APIPayPeriod
APIPayPeriodSchedule
APIPayPeriodTimeSheetVerify
APIAbsencePolicy
APIAccrualPolicy
APIAccrualPolicyAccount
APIAccrualPolicyMilestone
APIBreakPolicy
APIContributingPayCodePolicy
APIContributingShiftPolicy
APIExceptionPolicy
APIExceptionPolicyControl
APIHolidayPolicy
APIMealPolicy
APIOverTimePolicy
APIPayCode
APIPayFormulaPolicy
APIPolicyGroup
APIPremiumPolicy
APIRegularTimePolicy
APIRoundIntervalPolicy
APISchedulePolicy
APIPunch
APIPunchControl
APIQualification
APIQualificationGroup
APIUserEducation
APIUserLanguage
APIUserLicense
APIUserMembership
APIUserSkill
APIAccrualBalanceSummaryReport
APIActiveShiftReport
APIAuditTrailReport
APIExceptionReport
APIForm1099NecReport
APIForm940Report
APIForm941Report
APIFormW2Report
APIGeneralLedgerSummaryReport
APIKPIReport
APIPayrollExportReport
APIPayStubSummaryReport
APIPayStubTransactionSummaryReport
APIPunchSummaryReport
APIRemittanceSummaryReport
APIReport
APIReportSchedule
APIROEReport
APIScheduleSummaryReport
APIT4ASummaryReport
APIT4SummaryReport
APITaxSummaryReport
APITimesheetDetailReport
APITimesheetSummaryReport
APIUserQualificationReport
APIUserSummaryReport
APIUSStateUnemploymentReport
APIRequest
APIROE
APIRecurringScheduleControl
APIRecurringScheduleTemplate
APIRecurringScheduleTemplateControl
APISchedule
APISystemJobQueue
APIUIKitChildSample
APIUIKitSample
APIAuthentication
APIBankAccount
APIEthnicGroup
APIRemittanceDestinationAccount
APIUser
APIUserContact
APIUserDeduction
APIUserDefault
APIUserDefaultPreferenceNotification
APIUserGenericData
APIUserGenericStatus
APIUserGroup
APIUserPreference
APIUserPreferenceNotification
APIUserReportData
APIUserSetting
APIUserTitle
APIUserWage
BranchFactory
BranchListFactory
CompanyDeductionFactory
CompanyDeductionListFactory
CompanyDeductionPayStubEntryAccountFactory
CompanyDeductionPayStubEntryAccountListFactory
CompanyFactory
CompanyGenericMapFactory
CompanyGenericMapListFactory
CompanyGenericTagFactory
CompanyGenericTagListFactory
CompanyGenericTagMapFactory
CompanyGenericTagMapListFactory
CompanyListFactory
CompanySettingFactory
CompanySettingListFactory
CompanyUserCountFactory
CompanyUserCountListFactory
LegalEntityFactory
LegalEntityListFactory
PayrollRemittanceAgencyEventFactory
PayrollRemittanceAgencyEventListFactory
PayrollRemittanceAgencyFactory
PayrollRemittanceAgencyListFactory
RemittanceSourceAccountFactory
RemittanceSourceAccountListFactory
SetupPresets
WageGroupFactory
WageGroupListFactory
Authentication
AuthorizationFactory
AuthorizationListFactory
BackgroundProcess
BreadCrumb
CalculatePayStub
CalculatePolicy
CurrencyFactory
CurrencyListFactory
CurrencyRateFactory
CurrencyRateListFactory
CustomFieldFactory
CustomFieldListFactory
Debug
DependencyTree
DependencyTreeNode
Environment
DBError
NestedRetryTransaction
Used by RetryTransaction() when a nested retry block fails, so we can detect it and trigger the outer most retry block to retry from the scratch.
GeneralError
ExceptionFactory
ExceptionListFactory
Factory
FactoryListIterator
FastTree
FormVariables
GeneralLedgerExport
GeneralLedgerExport_JournalEntry
GeneralLedgerExport_Record
GeneralLedgerExport_File_Format_Simply
GeneralLedgerExport_File_Format_CSV
GeneralLedgerExport_File_Format_CSVFlat
GeneralLedgerExport_File_Format_QuickBooks
GeneralLedgerExport_File_Format_Xero
GeneralLedgerExport_File_Format_Sage300
Group
IdempotentRequestFactory
IdempotentRequestListFactory
LockFile
LogDetailFactory
LogDetailListFactory
LogFactory
LogListFactory
LogRotate
Misc
Option
OtherFieldFactory
OtherFieldListFactory
Pager
Permission
PermissionControlFactory
PermissionControlListFactory
PermissionFactory
PermissionListFactory
PermissionUserFactory
PermissionUserListFactory
Profiler
ProgressBar
PurgeDatabase
Class PurgeDatabase
RateLimit
Redirect
Serializer
SharedMemory
Class SharedMemory
Sort
StationBranchFactory
StationBranchListFactory
StationDepartmentFactory
StationDepartmentListFactory
StationExcludeUserFactory
StationExcludeUserListFactory
StationFactory
StationIncludeUserFactory
StationIncludeUserListFactory
StationListFactory
StationUserFactory
StationUserGroupFactory
StationUserGroupListFactory
StationUserListFactory
SystemJobQueue
SystemJobQueueFactory
SystemJobQueueListFactory
SystemSettingFactory
SystemSettingListFactory
TTDate
TTi18n
TTLDAP
TTLog
TTMail
TTPassword
TTPDF
TTTree
TTUUID
UnitConvert
URLBuilder
UserDateFactory
UserDateListFactory
UserDateTotalFactory
UserDateTotalListFactory
Validator
Wage
Cron
CronJobFactory
CronJobListFactory
DepartmentFactory
DepartmentListFactory
HelpFactory
HelpGroupControlFactory
HelpGroupControlListFactory
HelpGroupFactory
HelpGroupListFactory
HelpListFactory
HierarchyControlFactory
HierarchyControlListFactory
HierarchyFactory
HierarchyLevelFactory
HierarchyLevelListFactory
HierarchyListFactory
HierarchyObjectTypeFactory
HierarchyObjectTypeListFactory
HierarchyShareFactory
HierarchyShareListFactory
HierarchyUserFactory
HierarchyUserListFactory
HolidayFactory
HolidayListFactory
RecurringHolidayFactory
RecurringHolidayListFactory
Import
ImportAccrual
ImportBranch
ImportDepartment
ImportPayPeriod
ImportPayStubAmendment
ImportRemittanceDestinationAccount
ImportUser
ImportUserEducation
ImportUserSkill
ImportUserWage
Install
KPIFactory
KPIGroupFactory
KPIGroupListFactory
KPIListFactory
UserReviewControlFactory
UserReviewControlListFactory
UserReviewFactory
UserReviewListFactory
MessageControlFactory
MessageControlListFactory
MessageFactory
MessageListFactory
MessageRecipientFactory
MessageRecipientListFactory
MessageSenderFactory
MessageSenderListFactory
Notification
NotificationDeviceTokenFactory
NotificationDeviceTokenListFactory
NotificationFactory
NotificationListFactory
DemoData
EFT
EFT_record
EFT_File_Format_1464
CPA005 Specification: https://www.payments.ca/sites/default/files/standard-005.pdf
EFT_File_Format_105
EFT_File_Format_ACH
EFT_File_Format_BEANSTREAM
EFT_File_Format_CIBC_EPAY
OSTicket
Class OSTicket
PaymentServicesClientAPI
Class PaymentServicesClientAPI
PaymentServicesClientAPIReturnHandler
Redis_Cache_Lite
Class Redis_Cache_Lite
ROEFactory
ROEListFactory
SugarCRM
Class SugarCRM
SugarCRMReturnHandler
Class SugarCRMReturnHandler
SystemDiagnostic
Telnet
Telnet class
TimeTrexPaymentServices
Class TimeTrexPaymentServices
PayStub
PayStubEntryAccountFactory
PayStubEntryAccountLinkFactory
PayStubEntryAccountLinkListFactory
PayStubEntryAccountListFactory
PayStubEntryFactory
PayStubEntryListFactory
PayStubFactory
PayStubListFactory
PayStubTransactionFactory
PayStubTransactionListFactory
PayStubAmendmentFactory
PayStubAmendmentListFactory
RecurringPayStubAmendmentFactory
RecurringPayStubAmendmentListFactory
RecurringPayStubAmendmentUserFactory
RecurringPayStubAmendmentUserListFactory
PayPeriodFactory
PayPeriodListFactory
PayPeriodScheduleFactory
PayPeriodScheduleListFactory
PayPeriodScheduleUserFactory
PayPeriodScheduleUserListFactory
PayPeriodTimeSheetVerifyFactory
PayPeriodTimeSheetVerifyListFactory
AbsencePolicyFactory
AbsencePolicyListFactory
AccrualPolicyAccountFactory
AccrualPolicyAccountListFactory
AccrualPolicyFactory
AccrualPolicyListFactory
AccrualPolicyMilestoneFactory
AccrualPolicyMilestoneListFactory
BreakPolicyFactory
BreakPolicyListFactory
ContributingPayCodePolicyFactory
ContributingPayCodePolicyListFactory
ContributingShiftPolicyFactory
ContributingShiftPolicyListFactory
ExceptionPolicyControlFactory
ExceptionPolicyControlListFactory
ExceptionPolicyFactory
ExceptionPolicyListFactory
HolidayPolicyFactory
HolidayPolicyListFactory
HolidayPolicyRecurringHolidayFactory
HolidayPolicyRecurringHolidayListFactory
MealPolicyFactory
MealPolicyListFactory
OverTimePolicyFactory
OverTimePolicyListFactory
PayCodeFactory
PayCodeListFactory
PayFormulaPolicyFactory
PayFormulaPolicyListFactory
PolicyGroupAccrualPolicyFactory
PolicyGroupAccrualPolicyListFactory
PolicyGroupFactory
PolicyGroupListFactory
PolicyGroupOverTimePolicyFactory
PolicyGroupOverTimePolicyListFactory
PolicyGroupPremiumPolicyFactory
PolicyGroupPremiumPolicyListFactory
PolicyGroupRoundIntervalPolicyFactory
PolicyGroupRoundIntervalPolicyListFactory
PolicyGroupUserFactory
PolicyGroupUserListFactory
PremiumPolicyBranchFactory
PremiumPolicyBranchListFactory
PremiumPolicyDepartmentFactory
PremiumPolicyDepartmentListFactory
PremiumPolicyFactory
PremiumPolicyListFactory
RegularTimePolicyFactory
RegularTimePolicyListFactory
RoundIntervalPolicyFactory
RoundIntervalPolicyListFactory
SchedulePolicyFactory
SchedulePolicyListFactory
PunchControlFactory
PunchControlListFactory
PunchFactory
PunchListFactory
QualificationFactory
QualificationGroupFactory
QualificationGroupListFactory
QualificationListFactory
UserEducationFactory
UserEducationListFactory
UserLanguageFactory
UserLanguageListFactory
UserLicenseFactory
UserLicenseListFactory
UserMembershipFactory
UserMembershipListFactory
UserSkillFactory
UserSkillListFactory
AccrualBalanceSummaryReport
ActiveShiftReport
AuditTrailReport
ExceptionReport
Form1099NecReport
Form940Report
Form941Report
FormW2Report
GeneralLedgerSummaryReport
KPIReport
PayrollExportReport
PayStubSummaryReport
PayStubTransactionSummaryReport
PunchSummaryReport
RemittanceSummaryReport
Report
ReportPDF
Class ReportPDF
ReportCell
Class ReportCell
ReportCellImage
Class ReportCellImage
ReportCellBarcode
Class ReportCellBarcode
ReportCellQRcode
Class ReportCellQRcode
ROEReport
ScheduleSummaryReport
T4ASummaryReport
T4SummaryReport
TaxSummaryReport
TimesheetDetailReport
TimesheetSummaryReport
UserQualificationReport
UserSummaryReport
USStateUnemploymentReport
RequestFactory
RequestListFactory
RecurringScheduleControlFactory
RecurringScheduleControlListFactory
RecurringScheduleFactory
RecurringScheduleListFactory
RecurringScheduleTemplateControlFactory
RecurringScheduleTemplateControlListFactory
RecurringScheduleTemplateFactory
RecurringScheduleTemplateListFactory
RecurringScheduleUserFactory
RecurringScheduleUserListFactory
ScheduleFactory
ScheduleListFactory
SoapClientTimeout
This class extends the built-in PHP SoapClient class to use CURL with proper timeout periods.
TTSoapClient
Add custom soap client that automatically retries calls on network errors like "Could not connect to host" Class TTSoapClient
TimeTrexSoapClient
UIKitChildSampleFactory
UIKitChildSampleListFactory
UIKitSampleFactory
UIKitSampleListFactory
BankAccountFactory
BankAccountListFactory
EthnicGroupFactory
EthnicGroupListFactory
RemittanceDestinationAccountFactory
RemittanceDestinationAccountListFactory
UserContactFactory
UserContactListFactory
UserDeductionFactory
UserDeductionListFactory
UserDefaultCompanyDeductionFactory
UserDefaultCompanyDeductionListFactory
UserDefaultFactory
UserDefaultListFactory
UserDefaultPreferenceNotificationFactory
UserDefaultPreferenceNotificationListFactory
UserFactory
UserGenericDataFactory
UserGenericDataListFactory
UserGenericStatusFactory
UserGenericStatusListFactory
UserGroupFactory
UserGroupListFactory
UserIdentificationFactory
UserIdentificationListFactory
UserListFactory
UserPreferenceFactory
UserPreferenceListFactory
UserPreferenceNotificationFactory
UserPreferenceNotificationListFactory
UserReportDataFactory
UserReportDataListFactory
UserSettingFactory
UserSettingListFactory
UserTitleFactory
UserTitleListFactory
UserWageFactory
UserWageListFactory
PayrollDeduction_CA_AB
PayrollDeduction_CA_BC
PayrollDeduction_CA_Data
PayrollDeduction_CA_MB
PayrollDeduction_CA_NB
PayrollDeduction_CA_NL
PayrollDeduction_CA_NS
PayrollDeduction_CA_NT
PayrollDeduction_CA_NU
PayrollDeduction_CA_ON
PayrollDeduction_CA_PE
PayrollDeduction_CA_QC
PayrollDeduction_CA_SK
PayrollDeduction_CA_YT
PayrollDeduction_CA
PayrollDeduction_CR_Data
PayrollDeduction_CR
PayrollDeduction
PayrollDeduction_Base
PayrollDeduction_US_AK
PayrollDeduction_US_AL
PayrollDeduction_US_AR
PayrollDeduction_US_AZ
PayrollDeduction_US_CA
PayrollDeduction_US_CO
PayrollDeduction_US_CT
PayrollDeduction_US_Data
PayrollDeduction_US_DC
PayrollDeduction_US_DE
PayrollDeduction_US_FL
PayrollDeduction_US_GA
PayrollDeduction_US_HI
PayrollDeduction_US_IA
PayrollDeduction_US_ID
PayrollDeduction_US_IL
PayrollDeduction_US_IN
PayrollDeduction_US_IN_ALL
PayrollDeduction_US_KS
PayrollDeduction_US_KY
PayrollDeduction_US_LA
PayrollDeduction_US_MA
PayrollDeduction_US_MD
PayrollDeduction_US_MD_ALL
PayrollDeduction_US_ME
PayrollDeduction_US_MI
PayrollDeduction_US_MN
PayrollDeduction_US_MO
PayrollDeduction_US_MS
PayrollDeduction_US_MT
PayrollDeduction_US_NC
PayrollDeduction_US_ND
PayrollDeduction_US_NE
PayrollDeduction_US_NH
PayrollDeduction_US_NJ
PayrollDeduction_US_NM
PayrollDeduction_US_NV
PayrollDeduction_US_NY
PayrollDeduction_US_NY_NYC
PayrollDeduction_US_NY_YONKERS
PayrollDeduction_US_OH
PayrollDeduction_US_OK
PayrollDeduction_US_OR
PayrollDeduction_US_PA
PayrollDeduction_US_RI
PayrollDeduction_US_SC
PayrollDeduction_US_SD
PayrollDeduction_US_TN
PayrollDeduction_US_TX
PayrollDeduction_US_UT
PayrollDeduction_US_VA
PayrollDeduction_US_VT
PayrollDeduction_US_WA
PayrollDeduction_US_WI
PayrollDeduction_US_WV
PayrollDeduction_US_WY
PayrollDeduction_US

Table of Contents

MAIL_MIMEPART_CRLF  = "\n"
profiler_start()  : mixed
profiler_stop()  : mixed

Constants

MAIL_MIMEPART_CRLF

public mixed MAIL_MIMEPART_CRLF = "\n"

Functions

profiler_start()

profiler_start( $name) : mixed
Parameters
$name :
Return values
mixed

profiler_stop()

profiler_stop( $name) : mixed
Parameters
$name :
Return values
mixed

Search results