Empyr Documentation
\
Linusx
Empyr
Controllers
Exceptions
Facades
Providers

\Linusx\Empyr\ControllersEmpyrInvoice

Class EmpyrInvoice.

Summary

Methods
Properties
Constants
__construct()
invoice()
lookup()
adjustments()
invoiceTransactions()
transactions()
leave()
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

Methods

__construct()

__construct(array  $data = array())

Empyr Invoices Methods.

Parameters

array $data

Data to set field with.

Throws

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

invoice()

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

Allows lookup up of an invoice by id.

Parameters

array $options

Throws

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

Returns

boolean|mixed

lookup()

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

Allows lookup up of invoices given criteria.

Parameters

array $options

Throws

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

Returns

boolean|mixed

adjustments()

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

Get all adjustments given the invoice.

Parameters

array $options

Throws

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

Returns

boolean|mixed

invoiceTransactions()

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

Get all transactions run on a given an invoice.

Parameters

array $options

Throws

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

Returns

boolean|mixed

transactions()

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

Get all the transactions that were run to bill this invoice.

Parameters

array $options

Throws

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

Returns

boolean|mixed

leave()

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

Attempts collection of the invoice.

Parameters

array $options

Throws

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

Returns

boolean|mixed