Overview

Packages

  • blesta
    • app
      • controllers
      • models
    • components
      • auth
        • ldap
        • motp
        • oath
      • delivery
        • interfax
        • postal
          • methods
      • download
      • email
      • events
      • exchange
        • rates
          • currency
            • layer
          • fixer
          • open
            • exchange
              • rates
          • x
            • rates
      • gateway
        • payments
      • gateways
      • invoice
        • delivery
        • templates
          • perforated
            • invoice
          • quickbooks
            • invoice
          • templates
            • default
      • modules
      • net
        • amazon
          • s3
        • http
        • net
          • geo
            • ip
      • plugins
      • reports
        • aging
          • invoices
        • client
          • data
            • portability
        • custom
          • report
        • invoice
          • creation
        • package
          • revenue
        • tax
          • liability
        • transactions
          • applied
          • received
      • security
      • session
        • cart
      • settingscollection
      • upgrades
        • tasks
      • upload
      • vcard
    • core
      • Automation
        • Tasks
          • Common
          • Task
        • Type
          • Common
          • Cron
      • Pricing
        • ItemComparator
        • MetaItem
        • Modifier
          • Type
            • Description
              • Type
                • Discount
                • Option
                • Service
                • Tax
            • Discount
            • Price
            • Proration
        • Presenter
          • Build
            • Invoice
            • InvoiceData
            • Options
            • Service
            • ServiceChange
            • ServiceData
          • Collection
          • Format
            • Fields
            • Type
              • Discount
              • Item
              • Option
              • Options
              • Package
              • Pricing
              • Service
              • Tax
          • Items
            • Invoice
            • Service
          • Type
      • ServiceProviders
      • Util
        • Captcha
          • Captchas
          • Common
        • Common
          • Traits
        • Events
          • Common
          • Handlers
          • Observers
        • Filters
          • Common
        • GeoIp
        • Input
          • Fields
            • Common
        • Tax
        • Widgets
    • helpers
      • currency
        • format
      • data
        • structure
          • array
          • string
      • text
        • parser
      • widget
        • client
  • minPHP
    • helpers
      • color
      • data
        • structure
  • None
  • PHP

Classes

  • _404
  • AdminBilling
  • AdminClients
  • AdminClientsService
  • AdminCompanyAutomation
  • AdminCompanyBilling
  • AdminCompanyClientOptions
  • AdminCompanyCurrencies
  • AdminCompanyEmails
  • AdminCompanyGateways
  • AdminCompanyGeneral
  • AdminCompanyGroups
  • AdminCompanyLookandfeel
  • AdminCompanyMessengers
  • AdminCompanyModules
  • AdminCompanyPlugins
  • AdminCompanyTaxes
  • AdminCompanyThemes
  • AdminDialog
  • AdminLicense
  • AdminLogin
  • AdminLogout
  • AdminMain
  • AdminMyinfo
  • AdminPackageOptions
  • AdminPackages
  • AdminReports
  • AdminReportsCustomize
  • AdminSearch
  • AdminSettings
  • AdminSystemApi
  • AdminSystemAutomation
  • AdminSystemBackup
  • AdminSystemCompanies
  • AdminSystemGeneral
  • AdminSystemHelp
  • AdminSystemMarketplace
  • AdminSystemStaff
  • AdminSystemUpgrade
  • AdminTheme
  • AdminTools
  • AdminUpgrade
  • Api
  • Callback
  • ClientAccounts
  • ClientContacts
  • ClientDialog
  • ClientEmails
  • ClientInvoices
  • ClientLogin
  • ClientLogout
  • ClientMain
  • ClientMaintenance
  • ClientPay
  • ClientServices
  • ClientTheme
  • ClientTransactions
  • ClientVerify
  • Cron
  • Install
  • Main
  • Uploads
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated

Class AdminClients

Admin Clients Management

AppController
Extended by AdminClients
Package: blesta\app\controllers
Copyright: Copyright (c) 2010, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at app/controllers/admin_clients.php
Methods summary
public
# preAction( )

Pre-action setup method that is called before the index method, or the set controller action

Pre-action setup method that is called before the index method, or the set controller action

public
# index( )

Browse Clients

Browse Clients

public
# view( string $content = null )

View a specific client profile, may optionally set what content to view within the content view.

View a specific client profile, may optionally set what content to view within the content view.

Parameters

$content
The content to set in the content view of the client profile page
public
# services( )

List services

List services

public
# serviceCount( )

Service count

Service count

public
# invoices( )

List invoices or perform action (deliver or void) on selected invoices

List invoices or perform action (deliver or void) on selected invoices

public
# invoiceCount( )

Invoice count

Invoice count

public
# invoiceApplied( )

AJAX request for all transactions an invoice has applied

AJAX request for all transactions an invoice has applied

public
# transactions( )

List transactions

List transactions

public
# transactionCount( )

Transaction count

Transaction count

public
# transactionApplied( )

AJAX request for all invoices a transaction has been applied to

AJAX request for all invoices a transaction has been applied to

public
# emails( )

View mail log

View mail log

public
# notes( )

List notes

List notes

public
# addNote( )

Add note

Add note

public
# editNote( )

Edit note

Edit note

public
# deleteNote( )

Delete Note

Delete Note

public
# stickyNotes( )

Displays/removes sticky notes

Displays/removes sticky notes

public
# vCard( )

Prompts to download a vCard of the client's address information

Prompts to download a vCard of the client's address information

public
# add( )

Add New Client

Add New Client

public
# edit( )

Edit Client

Edit Client

public
# delete( )

Delete Client

Delete Client

public
# getCustomFields( )

AJAX request for retrieving all custom fields for a client group

AJAX request for retrieving all custom fields for a client group

public
# quickUpdate( )

AJAX quick update client to set status, invoice method, auto debit status, or auto suspension status

AJAX quick update client to set status, invoice method, auto debit status, or auto suspension status

public
# delaySuspension( )

Modal for viewing/setting delay suspension date

Modal for viewing/setting delay suspension date

public
# email( )

Email Client

Email Client

public
# passwordReset( )

Send the password reset email to the client

Send the password reset email to the client

public
# loginAsClient( )

Login as the client

Login as the client

public
# logoutAsClient( )

Logout as the client

Logout as the client

public
# merge( )

Merge clients together

Merge clients together

public
# addContact( )

Add Contact

Add Contact

public
# editContact( )

Edit Contact

Edit Contact

public
# deleteContact( )

Delete Contact

Delete Contact

public
# accounts( )

Manage Payment Accounts

Manage Payment Accounts

public
# accountTypes( )

Manages the payment account types enabled for this client

Manages the payment account types enabled for this client

public
# addCcAccount( )

Add Credit Card account

Add Credit Card account

public
# addAchAccount( )

Add ACH account

Add ACH account

public
# editCcAccount( )

Edit a CC account

Edit a CC account

public
# editAchAccount( )

Edit an ACH account

Edit an ACH account

public
# deleteCcAccount( )

Delete a CC account

Delete a CC account

public
# deleteAchAccount( )

Delete an ACH account

Delete an ACH account

public
# showcard( )

Renders a form to enter a passphrase for decrypting a card and returns the card on success

Renders a form to enter a passphrase for decrypting a card and returns the card on success

public
# showaccount( )

Renders a form to enter a passphrase for decrypting a bank account and routing number and returns the values on success

Renders a form to enter a passphrase for decrypting a bank account and routing number and returns the values on success

public
# makePayment( )

Processes a payment for this client

Processes a payment for this client

public
# makePaymentInvoices( )

Fetches a table of invoices for the given currency

Fetches a table of invoices for the given currency

public
# recordPayment( )

Manually record a payment for this client (i.e. record payment by check)

Manually record a payment for this client (i.e. record payment by check)

public string
# getRecordCreditFields( integer $client_id = null, string $currency = null, stdClass $vars = null )

AJAX Fetches a partial containing the record payment/credit fields

AJAX Fetches a partial containing the record payment/credit fields

Parameters

$client_id
The client ID
$currency
The currency to fetch credits in
$vars
An stdClass object representing input vars

Returns

string
A partial of the fields

See

AdminClients::recordPayment()
public
# getCurrencyAmounts( )

AJAX Fetches the currency amounts for the client profile sidebar

AJAX Fetches the currency amounts for the client profile sidebar

public
# createInvoice( )

Create invoice

Create invoice

public
# editInvoice( )

Edit invoice

Edit invoice

public
# editRecurInvoice( )

Edit a recurring invoice

Edit a recurring invoice

public
# calcLineTotals( )

Sums line items and returns the sub total, total, and tax amount based on currency and company settings for the given set of data and tax rules that apply to each. Outputs a JSON encoded array including:

Sums line items and returns the sub total, total, and tax amount based on currency and company settings for the given set of data and tax rules that apply to each. Outputs a JSON encoded array including:

  • subtotal - amount The decimal format for the subtotal - amount_formatted The currency format for the subtotal - total - amount The decimal format for the total - amount_formatted The currency format for the total - total_w_tax - amount The decimal format for the total with tax - amount_formatted The currency format for the total with tax - total_paid - amount The decimal format for the total paid - amount_formatted The currency format for the total paid - total_due - amount The decimal format for the total due - amount_formatted The currency format for the total due - tax A list of tax rules, each including: - amount The decimal format for the total tax amount - amount_formatted The currency format for the total tax amount
public
# deleteDraftInvoice( )

Deletes a draft invoice

Deletes a draft invoice

public
# deleteRecurInvoice( )

Delete recurring invoice

Delete recurring invoice

public
# viewInvoice( )

Streams the given invoice to the browser

Streams the given invoice to the browser

public
# editTransaction( )

Edit a Transaction

Edit a Transaction

public
# unapplyTransaction( )

Unapplies a transaction from the given invoice

Unapplies a transaction from the given invoice

public
# packages( )

Sets Restricted Packages

Sets Restricted Packages

public
# addService( )

Add a service

Add a service

public
# editService( )

Edit service

Edit service

public
# editServiceAddons( )

Edit service add-ons

Edit service add-ons

public
# deleteService( )

Deletes a pending service

Deletes a pending service

public
# serviceTab( )

Service tab request

Service tab request

public
# serviceInfo( )

Service Info

Service Info

public
# packageOptions( )

Fetch all packages options for the given pricing ID and optional service ID

Fetch all packages options for the given pricing ID and optional service ID

public
# getStates( )

AJAX Fetch all states belonging to a given country (json encoded ajax request)

AJAX Fetch all states belonging to a given country (json encoded ajax request)

Blesta API documentation generated by ApiGen