\Linusx\Empyr\ControllersEmpyrBillingAccounts

Class EmpyrBillingAccounts.

Summary

Methods

Properties

Constants

__construct()
billingAccount()
search()
links()
add()
link()
update()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

File: Controllers/EmpyrBillingAccounts.php
Package: Empyr
Class hierarchy: \Linusx\Empyr\Controllers\EmpyrController

\Linusx\Empyr\Controllers\EmpyrBillingAccounts

Tags

author	Bill Van Pelt (linusx@gmail.com)

Methods

__construct()

__construct(array  $data = array())

Create new Empyr Billing Account.

Parameters

array

$data

Data to set field with.

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

billingAccount()

billingAccount(integer  $id) : boolean|mixed

Allows lookup up of an individual account by id.

Parameters

integer

$id

Billing Account ID to get

Throws

\GuzzleHttp\Exception\GuzzleException

Returns

boolean|mixed

Tags

mogl	https://www.mogl.com/api/docs/v2/BillingAccounts/accounts

search()

search(array  $options = array()) : boolean|mixed

Allows the searching or listing of accounts.

Parameters

array

$options

Throws

\GuzzleHttp\Exception\GuzzleException

Returns

boolean|mixed

Tags

mogl	https://www.mogl.com/api/docs/v2/BillingAccounts/search
options	query The query to try to lookup the name with. Mutually exclusive with business. Ignored if business supplied. business The business to look up by. If provided we look for the account associated with this business. Mutually exclusive with query. offset Start offset. numResults Number of results to retrieve (max 100).

links()

links(array  $options = array()) : boolean|mixed

Shows the business links for this account.

Parameters

array

$options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

boolean|mixed

Tags

mogl	https://www.mogl.com/api/docs/v2/BillingAccounts/links
options	query The query to try to lookup the name with. Mutually exclusive with business. Ignored if business supplied. business The business to look up by. If provided we look for the account associated with this business. Mutually exclusive with query. offset Start offset. numResults Number of results to retrieve (max 100).
todo	Call to Empyr doesn't seem to be working properly.

add()

add(array  $options = array()) : boolean|mixed

Allows the adding of accounts.

Parameters

array

$options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

boolean|mixed

Tags

mogl

https://www.mogl.com/api/docs/v2/BillingAccounts/add

options

account.name required The name of the account.
account.accountingEmail required The email address that will receive invoices.
account.paymentMethod required The method of payment [MANUAL|BILLINGDETAIL]
card.cardNumber The card number without spaces or hyphens.
card.expirationMonth A valid expiration month (1 to 12).
card.expirationYear A valid expiration year.
echeck.business Whether the checking account is personal or business.
echeck.nameOnAccount The name on the checking account.
echeck.accountType CHECKING or SAVINGS
echeck.accountNumber The account number.
echeck.routingNumber The bank routing number.

link()

link(array  $options = array()) : boolean|mixed

Allows the linking of accounts with businesses.

Parameters

array

$options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

boolean|mixed

Tags

mogl	https://www.mogl.com/api/docs/v2/BillingAccounts/link

update()

update(array  $options = array()) : boolean|mixed

Allows the updating of accounts.

Parameters

array

$options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

boolean|mixed