phpDocumentor
Back to top  

Estimate service

 Methods

Constructor

__construct(\Moneybird\ApiConnector $connector) 

Parameters

$connector

\Moneybird\ApiConnector

Deletes an estimate

delete(\Moneybird\Estimate $estimate) : \Moneybird\Estimate\self

Parameters

$estimate

\Moneybird\Estimate

Returns

\Moneybird\Estimate\self

Get all estimates

getAll(string | integer $filter, \Moneybird\Estimate\Subject $parent) : \Moneybird\Estimate\ArrayObject

Parameters

$filter

stringinteger

Filter name or id (advanced filters)

$parent

\Moneybird\Estimate\Subject

Exceptions

\Moneybird\InvalidFilterException

Returns

\Moneybird\Estimate\ArrayObject

Get estimate by id

getById(int $id) : \Moneybird\Estimate

Parameters

$id

int

Returns

\Moneybird\Estimate

Get the raw PDF content

getPdf(\Moneybird\Estimate $estimate) : string

Parameters

$estimate

\Moneybird\Estimate

Returns

string

Updates or inserts an estimate

save(\Moneybird\Estimate $estimate) : \Moneybird\Estimate

Parameters

$estimate

\Moneybird\Estimate

Returns

\Moneybird\Estimate

Send the estimate.

send(\Moneybird\Estimate $estimate, string $method, \Moneybird\Estimate\type $email, \Moneybird\Estimate\type $message) : \Moneybird\Estimate

Returns the updated estimate

Parameters

$estimate

\Moneybird\Estimate

$method

string

Send method (email|hand|post); default: email

$email

\Moneybird\Estimate\type

Address to send to; default: contact e-mail

$message

\Moneybird\Estimate\type

Returns

\Moneybird\Estimate

Build an envelope to send the estimate or reminder with

buildEnvelope(string $method, \Moneybird\Estimate\type $email, \Moneybird\Estimate\type $message) : \Moneybird\Estimate\Envelope

access protected

Parameters

$method

string

Send method (email|hand|post); default: email

$email

\Moneybird\Estimate\type

Address to send to; default: contact e-mail

$message

\Moneybird\Estimate\type

Returns

\Moneybird\Estimate\Envelope

 Properties

 

ApiConnector object

$connector : \Moneybird\ApiConnector