phpDocumentor
Back to top  

Invoice

 Methods

Construct a new invoice

__construct(array $data, \Moneybird\Contact $contact, bool $isDirty) 

Parameters

$data

array

$contact

\Moneybird\Contact

$isDirty

bool

new data is dirty, defaults to true

Proxy to disclose method

__get(String $key) : mixed
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::__get()

Parameters

$key

String

Returns

mixed

Magic set method Do not allow set

__set(string $name, mixed $value) 
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::__set()

Parameters

$name

string

$value

mixed

Exceptions

\Moneybird\Domainmodel\Exception

Copy the invoice

copy(array $filter) : \Moneybird\self

Parameters

$filter

array

Returns

\Moneybird\self

Copy the invoice to a credit

createCredit() : \Moneybird\self

Returns

\Moneybird\self

Deletes an invoice

delete(\Moneybird\Service $service) 

Parameters

$service

\Moneybird\Service

Discloses all values of the object that should be visible in the view layer.

disclose(mixed $key) : mixed
Inherited

access public
inherited_from \Moneybird\Domainmodel\AbstractModel::disclose()

Parameters

$key

mixed

Returns

mixed

Returns an array representation of this object's dirty attributes

getDirtyAttributes() : array
Inherited

access public
inherited_from \Moneybird\Domainmodel\AbstractModel::getDirtyAttributes()

Returns

array

Return the objects id or null

getId() : int
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::getId()

Returns

int

Get the raw PDF content

getPdf(\Moneybird\Service $service) : string

Parameters

$service

\Moneybird\Service

Exceptions

\Moneybird\InvalidStateException

Returns

string

Returns true if the object contains any dirty attributes

isDirty() : bool
Inherited

access public
inherited_from \Moneybird\Domainmodel\AbstractModel::isDirty()

Returns

bool

Mark the invoice as sent

markAsSent(\Moneybird\Invoice\Service $service) : \Moneybird\self

Parameters

$service

\Moneybird\Invoice\Service

Returns

\Moneybird\self

Register a payment for the invoice

registerPayment(\Moneybird\Service $service, \Moneybird\Payment\AbstractPayment $payment) : \Moneybird\self

Parameters

$service

\Moneybird\Service

$payment

\Moneybird\Payment\AbstractPayment

Exceptions

\Moneybird\InvalidStateException

Returns

\Moneybird\self

Send a reminder for the invoice

remind(\Moneybird\Invoice\Service $service, string $method, \Moneybird\type $email, \Moneybird\type $message) : \Moneybird\self

Parameters

$service

\Moneybird\Invoice\Service

$method

string

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

$email

\Moneybird\type

Address to send to; default: contact e-mail

$message

\Moneybird\type

Exceptions

\Moneybird\InvalidStateException

Returns

\Moneybird\self

Updates or inserts an invoice

save(\Moneybird\Service $service) : \Moneybird\self

Parameters

$service

\Moneybird\Service

Exceptions

\Moneybird\NotValidException

Returns

\Moneybird\self

Send the invoice

send(\Moneybird\Service $service, string $method, \Moneybird\type $email, \Moneybird\type $message) : \Moneybird\self

Parameters

$service

\Moneybird\Service

$method

string

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

$email

\Moneybird\type

Address to send to; default: contact e-mail

$message

\Moneybird\type

Returns

\Moneybird\self

Copy info from contact to invoice

setContact(\Moneybird\Contact $contact, bool $isDirty) : \Moneybird\self

access public

Parameters

$contact

\Moneybird\Contact

$isDirty

bool

new data is dirty, defaults to true

Returns

\Moneybird\self

Sets data

setData(array $data, bool $isDirty) 
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::setData()

Parameters

$data

array

$isDirty

bool

new data is dirty, defaults to true

Get array representation of Subject

toArray() : Array
Inherited

inherited_from \Moneybird\Mapper\Mapable::toArray()

Returns

Array

Create disclosedAttributes array

_initDisclosedAttributes() 
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::_initDisclosedAttributes()

Initialize vars

_initVars() 

Extract will take an array and try to automatically map the array values to properties in this object

extract(array $values, Array $filter, bool $isDirty) 
Inherited

access protected
inherited_from \Moneybird\Domainmodel\AbstractModel::extract()

Parameters

$values

Array

$filter

Array

$isDirty

bool

new data is dirty, defaults to true

Initialize

init() 
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::init()

Adopt the data from $self

reload(\Moneybird\Domainmodel\AbstractModel $self) : \Moneybird\Domainmodel\self
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::reload()

Parameters

$self

\Moneybird\Domainmodel\AbstractModel

Returns

\Moneybird\Domainmodel\self

Returns an array representation of this object

selfToArray(array $filter) : array
Inherited

access protected
inherited_from \Moneybird\Domainmodel\AbstractModel::selfToArray()

Parameters

$filter

Returns

array

Set dirty state to clean

setClean(string $attr) : \Moneybird\Domainmodel\self
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::setClean()

Parameters

$attr

string

Name of attribute, if null (default) set all attribures clean

Returns

\Moneybird\Domainmodel\self

Set details

setDetailsAttr(\Moneybird\Invoice\Detail\ArrayObject $value, bool $isDirty) 

Parameters

$value

\Moneybird\Invoice\Detail\ArrayObject

$isDirty

bool

new value is dirty, defaults to true

Set dirty state to dirty

setDirty(string $attr) : \Moneybird\Domainmodel\self
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::setDirty()

Parameters

$attr

string

Name of attribute, if null (default) set all attribures dirty

Returns

\Moneybird\Domainmodel\self

Set dirty state based on bool

setDirtyState(bool $isDirty, string $attr) : \Moneybird\Domainmodel\self
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::setDirtyState()

Parameters

$isDirty

bool

$attr

string

Name of attribute, if null (default) change state of all attribures

Returns

\Moneybird\Domainmodel\self

Set history

setHistoryAttr(\Moneybird\Invoice\History\ArrayObject $value, bool $isDirty) 

Parameters

$value

\Moneybird\Invoice\History\ArrayObject

$isDirty

bool

new value is dirty, defaults to true

Set Id

setIdAttr(int $value) 

Parameters

$value

int

Exceptions

\Moneybird\InvalidIdException

Set payments

setPaymentsAttr(\Moneybird\Invoice\Payment\ArrayObject $value, bool $isDirty) 

Parameters

$value

\Moneybird\Invoice\Payment\ArrayObject

$isDirty

bool

new value is dirty, defaults to true

Set url

setUrlAttr(string $value) 

Parameters

$value

string

Validate object

validate() : bool

Returns

bool

 Properties

 

Array of attributes that are dirty

$_dirtyAttr : Array
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::$$_dirtyAttr
 

Array containing attributes to disclose

$_discloseAttr : array
Inherited

access protected
inherited_from \Moneybird\Domainmodel\AbstractModel::$$_discloseAttr
 

Disclosure

$_disclosure : \Moneybird\Disclosure
Inherited

access protected
inherited_from \Moneybird\Domainmodel\AbstractModel::$$_disclosure
 

Array of attributes that can't be modified

$_readonlyAttr : Array

 

Array of attributes that are required

$_requiredAttr : Array

 

$address1

$address1 

 

$address2

$address2 

 

$attention

$attention 

 

$city

$city 

 

$companyName

$companyName 

 

$conceptId

$conceptId 

 

$contactId

$contactId 

 

$contactName

$contactName 

 

$country

$country 

 

$createdAt

$createdAt 

 

$currency

$currency 

 

$customerId

$customerId 

 

$daysOpen

$daysOpen 

 

$description

$description 

 

$details

$details 

 

$discount

$discount 

 

$dueDateInterval

$dueDateInterval 

 

$email

$email 

 

$exchangeRate

$exchangeRate 

 

$firstname

$firstname 

 

$history

$history 

 

$id

$id 

 

$invoiceDate

$invoiceDate 

 

$invoiceEmail

$invoiceEmail 

 

$invoiceEmailReminder

$invoiceEmailReminder 

 

$invoiceHash

$invoiceHash 

 

$invoiceId

$invoiceId 

 

$invoiceProfileId

$invoiceProfileId 

 

$invoiceProfileVersionId

$invoiceProfileVersionId 

 

$language

$language 

 

$lastname

$lastname 

 

$name

$name 

 

$originalEstimateId

$originalEstimateId 

 

$originalInvoiceId

$originalInvoiceId 

 

$payUrl

$payUrl 

 

$payments

$payments 

 

$pdfUrl

$pdfUrl 

 

$poNumber

$poNumber 

 

$pricesAreInclTax

$pricesAreInclTax 

 

$recurringTemplateId

$recurringTemplateId 

 

$revision

$revision 

 

$sendMethod

$sendMethod 

 

$showCustomerId

$showCustomerId 

 

$showTax

$showTax 

 

$showTaxNumber

$showTaxNumber 

 

$state

$state 

 

$taxNumber

$taxNumber 

 

$totalPaid

$totalPaid 

 

$totalPriceExclTax

$totalPriceExclTax 

 

$totalPriceInclTax

$totalPriceInclTax 

 

$totalTax

$totalTax 

 

$totalUnpaid

$totalUnpaid 

 

$updatedAt

$updatedAt 

 

$url

$url 

 

$zipcode

$zipcode