• Class name: APIUserExpense
• Namespace:
• Parent class: APIFactory

protected mixed $main_class = 'UserExpenseFactory'

• Visibility: protected

public mixed $data = array()

• Visibility: public

protected mixed $main_class_obj = NULL

• Visibility: protected

protected mixed $AMF_message_id = NULL

• Visibility: protected

protected mixed $pager_obj = NULL

• Visibility: protected

protected mixed $current_company = NULL

• Visibility: protected

protected mixed $current_user = NULL

• Visibility: protected

protected mixed $current_user_prefs = NULL

• Visibility: protected

protected mixed $permission = NULL

• Visibility: protected

protected mixed $progress_bar_obj = NULL

• Visibility: protected

mixed APIFactory::__construct()

APIFactory constructor.

• Visibility: public
• This method is defined by APIFactory

array|boolean APIFactory::getOptions(boolean $name, string|integer $parent)

• Visibility: public
• This method is defined by APIFactory

• $name boolean
• $parent string|integer

array APIUserExpense::getUserExpenseDefaultData()

Get default user expense data for creating new user expensees.

• Visibility: public

array APIUserExpense::calcRelatedExpenses(string $expense_policy_id, $gross_amount, null $amount_arr, boolean $is_reimbursable)

Get all the related expense policies to the one in the argument .

• Visibility: public

• $expense_policy_id string - UUID
• $gross_amount mixed
• $amount_arr null
• $is_reimbursable boolean

array APIUserExpense::getUserExpense(array $data, boolean $disable_paging)

Get user expense data for one or more user expensees.

• Visibility: public

• $data array - filter data
• $disable_paging boolean

array APIUserExpense::exportUserExpense(string $format, array $data, boolean $disable_paging)

Export data to csv

• Visibility: public

• $format string - file format (csv)
• $data array - filter data
• $disable_paging boolean

array APIUserExpense::getCommonUserExpenseData(array $data)

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

• Visibility: public

• $data array - filter data

array APIUserExpense::validateUserExpense(array $data)

Validate user expense data for one or more user expensees.

• Visibility: public

• $data array - user expense data

array|boolean APIUserExpense::setUserExpense(array $data, boolean $validate_only, boolean $ignore_warning)

Set user expense data for one or more user expensees.

• Visibility: public

• $data array - user expense data
• $validate_only boolean
• $ignore_warning boolean

array|boolean APIUserExpense::deleteUserExpense(array $data)

Delete one or more user expenses.

• Visibility: public

• $data array - user expense data

array APIUserExpense::copyUserExpense(array $data)

Copy one or more user expensees.

• Visibility: public

• $data array - user expense IDs

array|boolean APIUserExpense::getDocumentDefaultData()

• Visibility: public

array|boolean APIUserExpense::addAttachment($name, integer $object_type_id, string $object_id, string $description, integer $group, boolean $private, boolean $template)

• Visibility: public

• $name mixed
• $object_type_id integer
• $object_id string - UUID
• $description string
• $group integer
• $private boolean
• $template boolean

array|boolean APIUserExpense::getAttachment(null $data, boolean $disable_paging)

• Visibility: public

• $data null
• $disable_paging boolean

integer APIFactory::getProtocolVersion()

• Visibility: public
• This method is defined by APIFactory

boolean|null APIFactory::getAMFMessageID()

• Visibility: public
• This method is defined by APIFactory

boolean APIFactory::setAMFMessageID(string $id)

• Visibility: public
• This method is defined by APIFactory

• $id string - UUID

boolean|\CompanyFactory APIFactory::getCurrentCompanyObject()

• Visibility: public
• This method is defined by APIFactory

boolean|\UserFactory APIFactory::getCurrentUserObject()

• Visibility: public
• This method is defined by APIFactory

boolean|\UserPreferenceFactory APIFactory::getCurrentUserPreferenceObject()

• Visibility: public
• This method is defined by APIFactory

boolean|null|\Permission APIFactory::getPermissionObject()

• Visibility: public
• This method is defined by APIFactory

null|\ProgressBar APIFactory::getProgressBarObject()

• Visibility: public
• This method is defined by APIFactory

boolean APIFactory::setPagerObject(object $lf)

• Visibility: public
• This method is defined by APIFactory

• $lf object

array|boolean APIFactory::getPagerData()

• Visibility: public
• This method is defined by APIFactory

boolean APIFactory::setMainClassObject(object $obj)

• Visibility: public
• This method is defined by APIFactory

• $obj object

string APIFactory::getMainClassObject()

• Visibility: public
• This method is defined by APIFactory

array|boolean APIFactory::initializeFilterAndPager(array $data, boolean $disable_paging)

• Visibility: public
• This method is defined by APIFactory

• $data array
• $disable_paging boolean

array|null APIFactory::handlePermissionFilterColumns(array $filter_columns, array $allowed_columns)

• Visibility: public
• This method is defined by APIFactory

• $filter_columns array
• $allowed_columns array

mixed APIFactory::convertToSingleRecord(array $data)

• Visibility: public
• This method is defined by APIFactory

• $data array

array APIFactory::convertToMultipleRecords(array $data)

• Visibility: public
• This method is defined by APIFactory

• $data array

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

downloaded a result_set as a csv.

• Visibility: public
• This method is defined by APIFactory

• $format string
• $file_name string
• $result array
• $filter_columns array

string APIFactory::getNextInsertID()

• Visibility: public
• This method is defined by APIFactory

array APIFactory::getPermissionChildren()

• Visibility: public
• This method is defined by APIFactory

array|boolean APIFactory::returnHandler(boolean $retval, boolean $code, boolean $description, boolean $details, boolean $validator_stats, boolean $user_generic_status_batch_id, boolean $request_data)

• Visibility: public
• This method is defined by APIFactory

• $retval boolean
• $code boolean
• $description boolean
• $details boolean
• $validator_stats boolean
• $user_generic_status_batch_id boolean
• $request_data boolean

mixed APIFactory::stripReturnHandler(mixed $retarr)

• Visibility: public
• This method is defined by APIFactory

• $retarr mixed

array APIFactory::getVariableToFunctionMap(string $name, string|integer $parent)

• Visibility: public
• This method is defined by APIFactory

• $name string
• $parent string|integer

boolean|\Validator APIFactory::convertAPIReturnHandlerToValidatorObject($api_retarr, boolean $validator_obj)

• Visibility: public
• This method is defined by APIFactory

• $api_retarr mixed
• $validator_obj boolean

array|boolean APIFactory::setValidationArray(string $primary_validator, string $secondary_validator, boolean $tertiary_validator)

• Visibility: public
• This method is defined by APIFactory

• $primary_validator string - UUID
• $secondary_validator string - UUID
• $tertiary_validator boolean

array APIFactory::handleRecordValidationResults(object|boolean $validator, array $validator_stats, integer $key, array|boolean $save_result)

• Visibility: public
• This method is defined by APIFactory

• $validator object|boolean
• $validator_stats array
• $key integer
• $save_result array|boolean