TimeTrex API Manual
Back to top  

package API\Invoice
inherited_from \APIFactory

 Methods

__construct() 

__construct() 
inherited_from \APIFactory::__construct()

__construct() 

__construct() 
Inherited

convertAPIReturnHandlerToValidatorObject() 

convertAPIReturnHandlerToValidatorObject($api_retarr, $validator_obj = FALSE) 
Inherited

Parameters

$api_retarr

$validator_obj

convertToMultipleRecords() 

convertToMultipleRecords($data) 
Inherited

Parameters

$data

convertToSingleRecord() 

convertToSingleRecord($data) 
Inherited

Parameters

$data

Copy one or more invoicees.

copyInvoice(array $data) : array

Parameters

$data

array

invoice IDs

Returns

array

Delete one or more invoices.

deleteInvoice(array $data) : array

Parameters

$data

array

invoice data

Returns

array

determineStatus() 

determineStatus($invoice_id) 

Parameters

$invoice_id

exportInvoice() 

exportInvoice(string $format = 'csv', null $data = NULL, boolean $disable_paging = TRUE) : array | boolean

Parameters

$format

string

$data

null

$disable_paging

boolean

Returns

arrayboolean

downloaded a result_set as a csv.

exportRecords($format, $file_name, $result, $filter_columns) : array | boolean
Inherited

Parameters

$format

$file_name

$result

$filter_columns

Returns

arrayboolean

getAMFMessageID() 

getAMFMessageID() 
Inherited

Get only the fields that are common across all records in the search criteria. Used for Mass Editing of records.

getCommonInvoiceData(array $data) : array

Parameters

$data

array

filter data

Returns

array

getCurrentCompanyObject() 

getCurrentCompanyObject() 
Inherited

getCurrentUserObject() 

getCurrentUserObject() 
Inherited

getCurrentUserPreferenceObject() 

getCurrentUserPreferenceObject() 
Inherited

Get invoice data for one or more invoicees.

getInvoice(array $data = NULL, $disable_paging = FALSE, $format = FALSE) : array

Parameters

$data

array

filter data

$disable_paging

$format

Returns

array

Get default invoice data for creating new invoicees.

getInvoiceDefaultData() : array

Returns

array

Calculate invoice total data, such as sub-total, shipping, taxes, etc.

getInvoiceTotalData($transaction_data, $invoice_data, $include_unconfirmed_transactions = FALSE) : array

..

Parameters

$transaction_data

$invoice_data

$include_unconfirmed_transactions

Returns

array

getMainClassObject() 

getMainClassObject() 
Inherited

getNextInsertID() 

getNextInsertID() 
Inherited

Get options for dropdown boxes.

getOptions(string $name = FALSE, mixed $parent = NULL) : array
inherited_from \APIFactory::getOptions()

Parameters

$name

string

Name of options to return, ie: 'columns', 'type', 'status'

$parent

mixed

Parent name/ID of options to return if data is in hierarchical format. (ie: Province)

Returns

array

getOptions() 

getOptions($name = FALSE, $parent = NULL) 
Inherited

Parameters

$name

$parent

getPagerData() 

getPagerData() 
Inherited

getPermissionChildren() 

getPermissionChildren() 
Inherited

getPermissionObject() 

getPermissionObject() 
Inherited

getProgressBarObject() 

getProgressBarObject() 
Inherited

getProtocolVersion() 

getProtocolVersion() 
Inherited

Get shipping options

getShippingOptions($transaction_data, $invoice_data) : array

Parameters

$transaction_data

$invoice_data

Returns

array

getVariableToFunctionMap() 

getVariableToFunctionMap($name, $parent = NULL) 
Inherited

Parameters

$name

$parent

handlePermissionFilterColumns() 

handlePermissionFilterColumns($filter_columns, $allowed_columns) 
Inherited

Parameters

$filter_columns

$allowed_columns

handleRecordValidationResults() 

handleRecordValidationResults($validator, $validator_stats, $key, $save_result) 
Inherited

Parameters

$validator

$validator_stats

$key

$save_result

initializeFilterAndPager() 

initializeFilterAndPager($data, $disable_paging = FALSE) 
Inherited

Parameters

$data

$disable_paging

returnHandler() 

returnHandler($retval = TRUE, $code = FALSE, $description = FALSE, $details = FALSE, $validator_stats = FALSE, $user_generic_status_batch_id = FALSE, $request_data = FALSE) 
Inherited

Parameters

$retval

$code

$description

$details

$validator_stats

$user_generic_status_batch_id

$request_data

setAMFMessageID() 

setAMFMessageID($id) 
Inherited

Parameters

$id

Set invoice data for one or more invoicees.

setInvoice(array $data, $validate_only = FALSE, $ignore_warning = TRUE) : array

Parameters

$data

array

invoice data

$validate_only

$ignore_warning

Returns

array

setMainClassObject() 

setMainClassObject($obj) 
Inherited

Parameters

$obj

setPagerObject() 

setPagerObject($lf) 
Inherited

Parameters

$lf

setValidationArray() 

setValidationArray($primary_validator, $secondary_validator, $tertiary_validator = FALSE) 
Inherited

Parameters

$primary_validator

$secondary_validator

$tertiary_validator

stripReturnHandler() 

stripReturnHandler($retarr) 
Inherited

Parameters

$retarr

updateStatus() 

updateStatus($invoice_id) 

Parameters

$invoice_id

Validate invoice data for one or more invoicees.

validateInvoice(array $data) : array

Parameters

$data

array

invoice data

Returns

array

 Properties

 

$data

$data 

Default

array()
 

$AMF_message_id

$AMF_message_id 

Default

NULL
 

$current_company

$current_company 

Default

NULL
 

$current_user

$current_user 

Default

NULL
 

$current_user_prefs

$current_user_prefs 

Default

NULL
 

$main_class

$main_class 

Default

'InvoiceFactory'
 

$main_class_obj

$main_class_obj 

Default

NULL
 

$pager_obj

$pager_obj 

Default

NULL
 

$permission

$permission 

Default

NULL
 

$progress_bar_obj

$progress_bar_obj 

Default

NULL