TimeTrexPaymentServices
in package
Class TimeTrexPaymentServices
Table of Contents
- $password : mixed
- $url : mixed
- $user_name : mixed
- __construct() : mixed
- Constructor.
- convertClientPaymentObjectToBankAccountArray() : array<string|int, mixed>
- Converts a client payment object to a remittance bank account array for uploading.
- convertInvoiceTransactionObjectToTransactionArray() : array<string|int, mixed>
- Converts Invoice Transaction objects to a remittance transaction array for uploading.
- convertLegalEntityObjectToOrganizationArray() : array<string|int, mixed>
- Converts a legal entity object to a remittance organization array for uploading.
- convertPayStubTransactionObjectToTransactionArray() : array<string|int, mixed>
- Converts Pay Stub Transaction objects to a remittance transaction array for uploading.
- convertRemittanceAgencyEventObjectToAgencyAuthorizationArray() : array<string|int, mixed>|bool
- Converts a remittance agency object to a agency authorization array for uploading.
- convertRemittanceDestinationAccountObjectToBankAccountArray() : array<string|int, mixed>
- Converts a remittance destination account to a remittance bank account array for uploading.
- convertRemittanceSourceAccountObjectToBankAccountArray() : array<string|int, mixed>
- Converts a remittance source account object to a remittance bank account array for uploading.
- convertReportPaymentServicesDataToAgencyReportArray() : array<string|int, mixed>|bool
- Converts getPaymentServicesData() results to an AgencyReport array for uploading.
- convertROEToAgencyReportArray() : array<string|int, mixed>
- Converts ROE objects to a agency report array for uploading.
- convertT4ToAgencyReportArray() : array<string|int, mixed>
- Converts T4 objects to a agency report array for uploading.
- convertUserObjectToUserArray() : array<string|int, mixed>
- Converts a user object to a remittance user array for uploading.
- createNewOrganization() : bool
- Create organization from Legal Entity
- createNewUser() : bool
- generateBatchID() : false|string
- getAccountStatementReport() : bool
- getUser() : bool
- ping() : mixed
- setAgencyAuthorization() : bool
- Updates the remote remittance agency information.
- setAgencyReport() : bool
- Uploads Agency Report for processing through TimeTrex PaymentServices.
- setOrganization() : bool
- Uploads organization data to TimeTrex PaymentServices.
- setPayStubTransaction() : bool
- Uploads Pay Stub transactions for processing through TimeTrex PaymentServices.
- setRemittanceSourceAccount() : bool
- Updates the remote remittance bank account information.
- setUser() : bool
- Uploads user data to TimeTrex PaymentServices.
- validateBankAccount() : bool
- Deep validation of bank account.
Properties
$password
protected
mixed
$password
= \null
$url
protected
mixed
$url
= 'https://paymentservices.timetrex.com/api/soap/api.php'
$user_name
protected
mixed
$user_name
= \null
Methods
__construct()
Constructor.
public
__construct([string $user_name = null ][, string $password = null ]) : mixed
Parameters
- $user_name : string = null
- $password : string = null
Return values
mixed —convertClientPaymentObjectToBankAccountArray()
Converts a client payment object to a remittance bank account array for uploading.
public
convertClientPaymentObjectToBankAccountArray( $invoice_transaction_obj, $client_payment_obj, $client_obj, $client_contact_obj) : array<string|int, mixed>
Parameters
- $invoice_transaction_obj :
-
TransactionFactory
- $client_payment_obj :
-
ClientPaymentFactory
- $client_obj :
-
ClientFactory
- $client_contact_obj :
-
ClientContactFactory
Return values
array<string|int, mixed> —convertInvoiceTransactionObjectToTransactionArray()
Converts Invoice Transaction objects to a remittance transaction array for uploading.
public
convertInvoiceTransactionObjectToTransactionArray( $invoice_transaction_obj, $client_payment_obj, $client_obj, $client_contact_obj, $payment_gateway_obj, $confirmation_number) : array<string|int, mixed>
Parameters
- $invoice_transaction_obj :
-
TransactionFactory
- $client_payment_obj :
-
ClientPaymentFactory
- $client_obj :
-
ClientFactory
- $client_contact_obj :
-
ClientContactFactory
- $payment_gateway_obj :
-
PaymentGatewayFactory
- $confirmation_number :
Return values
array<string|int, mixed> —convertLegalEntityObjectToOrganizationArray()
Converts a legal entity object to a remittance organization array for uploading.
public
convertLegalEntityObjectToOrganizationArray( $le_obj) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —convertPayStubTransactionObjectToTransactionArray()
Converts Pay Stub Transaction objects to a remittance transaction array for uploading.
public
convertPayStubTransactionObjectToTransactionArray( $pst_obj, $ps_obj, $rs_obj, $uf_obj, $confirmation_number, $batch_id) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —convertRemittanceAgencyEventObjectToAgencyAuthorizationArray()
Converts a remittance agency object to a agency authorization array for uploading.
public
convertRemittanceAgencyEventObjectToAgencyAuthorizationArray( $rae_obj) : array<string|int, mixed>|bool
Parameters
Return values
array<string|int, mixed>|bool —convertRemittanceDestinationAccountObjectToBankAccountArray()
Converts a remittance destination account to a remittance bank account array for uploading.
public
convertRemittanceDestinationAccountObjectToBankAccountArray( $rd_obj, $rs_obj, $u_obj) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —convertRemittanceSourceAccountObjectToBankAccountArray()
Converts a remittance source account object to a remittance bank account array for uploading.
public
convertRemittanceSourceAccountObjectToBankAccountArray( $rs_obj) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —convertReportPaymentServicesDataToAgencyReportArray()
Converts getPaymentServicesData() results to an AgencyReport array for uploading.
public
convertReportPaymentServicesDataToAgencyReportArray(array<string|int, mixed> $report_data, object $prae_obj, object $pra_obj, object $rs_obj, object $pra_user_obj) : array<string|int, mixed>|bool
Parameters
- $report_data : array<string|int, mixed>
- $prae_obj : object
- $pra_obj : object
- $rs_obj : object
- $pra_user_obj : object
Return values
array<string|int, mixed>|bool —convertROEToAgencyReportArray()
Converts ROE objects to a agency report array for uploading.
public
convertROEToAgencyReportArray( $form_obj, $rae_obj, $ra_obj, $batch_id) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —convertT4ToAgencyReportArray()
Converts T4 objects to a agency report array for uploading.
public
convertT4ToAgencyReportArray( $form_obj, $report_data, $rae_obj, $ra_obj, $remote_id, $batch_id) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —convertUserObjectToUserArray()
Converts a user object to a remittance user array for uploading.
public
convertUserObjectToUserArray( $u_obj[, null $remote_organization_id = null ]) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —createNewOrganization()
Create organization from Legal Entity
public
createNewOrganization( $row) : bool
Parameters
Return values
bool —createNewUser()
public
createNewUser( $row) : bool
Parameters
Return values
bool —generateBatchID()
public
generateBatchID( $end_date[, null $run_id = null ]) : false|string
Parameters
Return values
false|string —getAccountStatementReport()
public
getAccountStatementReport([null $start_date = null ][, null $end_date = null ]) : bool
Parameters
- $start_date : null = null
- $end_date : null = null
Return values
bool —getUser()
public
getUser( $id) : bool
Parameters
Return values
bool —ping()
public
ping() : mixed
Return values
mixed —setAgencyAuthorization()
Updates the remote remittance agency information.
public
setAgencyAuthorization( $rows) : bool
Parameters
Return values
bool —setAgencyReport()
Uploads Agency Report for processing through TimeTrex PaymentServices.
public
setAgencyReport( $rows) : bool
Parameters
Return values
bool —setOrganization()
Uploads organization data to TimeTrex PaymentServices.
public
setOrganization( $rows) : bool
Parameters
Return values
bool —setPayStubTransaction()
Uploads Pay Stub transactions for processing through TimeTrex PaymentServices.
public
setPayStubTransaction( $rows) : bool
Parameters
Return values
bool —setRemittanceSourceAccount()
Updates the remote remittance bank account information.
public
setRemittanceSourceAccount( $rows) : bool
Parameters
Return values
bool —setUser()
Uploads user data to TimeTrex PaymentServices.
public
setUser( $rows) : bool
Parameters
Return values
bool —validateBankAccount()
Deep validation of bank account.
public
validateBankAccount( $row) : bool