phpDocumentor
Back to top  

Invoice

 Methods

Construct a new invoice

__construct(array $data, \Moneybird\Contact $contact) 
Inherited

inherited_from \Moneybird\Invoice::__construct()

Parameters

$data

array

$contact

\Moneybird\Contact

Proxy to disclose method

__get(String $key) : mixed
Inherited

inherited_from \Moneybird\Domainmodel_Abstract::__get()
inherited_from \Moneybird\Invoice::__get()

Parameters

$key

String

Returns

mixed

Magic set method Do not allow set

__set(string $name, mixed $value) 
Inherited

inherited_from \Moneybird\Domainmodel_Abstract::__set()
inherited_from \Moneybird\Invoice::__set()

Parameters

$name

string

$value

mixed

Exceptions

\Moneybird\Domainmodel_Exception

Deletes an invoice

delete(\Moneybird\Service $service) 
Inherited

inherited_from \Moneybird\Invoice::delete()

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_Abstract::disclose()
inherited_from \Moneybird\Invoice::disclose()

Parameters

$key

mixed

Returns

mixed

Return the objects id or null

getId() : int
Inherited

inherited_from \Moneybird\Domainmodel_Abstract::getId()
inherited_from \Moneybird\Invoice::getId()

Returns

int

Get the raw PDF content

getPdf(\Moneybird\Service $service) : string
Inherited

inherited_from \Moneybird\Invoice::getPdf()

Parameters

$service

\Moneybird\Service

Exceptions

\Moneybird\InvalidStateException

Returns

string

Mark the invoice as sent

markAsSent(\Moneybird\Invoice_Service $service) : \Moneybird\self
Inherited

inherited_from \Moneybird\Invoice::markAsSent()

Parameters

$service

\Moneybird\Invoice_Service

Returns

\Moneybird\self

Register a payment for the invoice

registerPayment(\Moneybird\Service $service, \Moneybird\Payment_Abstract $payment) : \Moneybird\self
Inherited

inherited_from \Moneybird\Invoice::registerPayment()

Parameters

$service

\Moneybird\Service

$payment

\Moneybird\Payment_Abstract

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
Inherited

inherited_from \Moneybird\Invoice::remind()

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
Inherited

inherited_from \Moneybird\Invoice::save()

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
Inherited

inherited_from \Moneybird\Invoice::send()

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) : \Moneybird\self
Inherited

access public
inherited_from \Moneybird\Invoice::setContact()

Parameters

$contact

\Moneybird\Contact

Returns

\Moneybird\self

Sets data

setData(array $data) 
Inherited

inherited_from \Moneybird\Domainmodel_Abstract::setData()
inherited_from \Moneybird\Invoice::setData()

Parameters

$data

array

Get array representation of Subject

toArray() : Array
Inherited

inherited_from \Moneybird\Mapper_Mapable::toArray()
inherited_from \Moneybird\Invoice::toArray()

Returns

Array

Create disclosedAttributes array

_initDisclosedAttributes() 
Inherited

inherited_from \Moneybird\Domainmodel_Abstract::_initDisclosedAttributes()
inherited_from \Moneybird\Invoice::_initDisclosedAttributes()

Initialize vars

_initVars() 
Inherited

inherited_from \Moneybird\Invoice::_initVars()

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

extract(array $values, Array $filter) 
Inherited

access protected
inherited_from \Moneybird\Domainmodel_Abstract::extract()
inherited_from \Moneybird\Invoice::extract()

Parameters

$values

Array

$filter

Array

Initialize

init() 
Inherited

inherited_from \Moneybird\Domainmodel_Abstract::init()
inherited_from \Moneybird\Invoice::init()

Adopt the data from $self

reload(\Moneybird\Domainmodel_Abstract $self) : \Moneybird\self
Inherited

inherited_from \Moneybird\Domainmodel_Abstract::reload()
inherited_from \Moneybird\Invoice::reload()

Parameters

$self

\Moneybird\Domainmodel_Abstract

Returns

\Moneybird\self

Returns an array representation of this object

selfToArray(array $filter) : array
Inherited

access protected
inherited_from \Moneybird\Domainmodel_Abstract::selfToArray()
inherited_from \Moneybird\Invoice::selfToArray()

Parameters

$filter

Returns

array

Set details

setDetailsAttr(\Moneybird\Invoice_Detail_Array $value) 
Inherited

inherited_from \Moneybird\Invoice::setDetailsAttr()

Parameters

$value

\Moneybird\Invoice_Detail_Array

Set history

setHistoryAttr(\Moneybird\Invoice_History_Array $value) 
Inherited

inherited_from \Moneybird\Invoice::setHistoryAttr()

Parameters

$value

\Moneybird\Invoice_History_Array

Set Id

setIdAttr(int $value) 
Inherited

inherited_from \Moneybird\Invoice::setIdAttr()

Parameters

$value

int

Exceptions

\Moneybird\InvalidIdException

Set payments

setPaymentsAttr(\Moneybird\Invoice_Payment_Array $value) 
Inherited

inherited_from \Moneybird\Invoice::setPaymentsAttr()

Parameters

$value

\Moneybird\Invoice_Payment_Array

Set url

setUrlAttr(string $value) 
Inherited

inherited_from \Moneybird\Invoice::setUrlAttr()

Parameters

$value

string

Validate object

validate() : bool
Inherited

inherited_from \Moneybird\Invoice::validate()

Returns

bool

 Properties

 

Array containing attributes to disclose

$_discloseAttr : array
Inherited

access protected
inherited_from \Moneybird\Domainmodel_Abstract::$$_discloseAttr
inherited_from \Moneybird\Invoice::$$_discloseAttr
 

Disclosure

$_disclosure : \Moneybird\Disclosure
Inherited

access protected
inherited_from \Moneybird\Domainmodel_Abstract::$$_disclosure
inherited_from \Moneybird\Invoice::$$_disclosure
 

Array of attributes that can't be modified

$_readonlyAttr : Array
Inherited

inherited_from \Moneybird\Invoice::$$_readonlyAttr
 

Array of attributes that are required

$_requiredAttr : Array
Inherited

inherited_from \Moneybird\Invoice::$$_requiredAttr
 

$address1

$address1 
Inherited

inherited_from \Moneybird\Invoice::$$address1
 

$address2

$address2 
Inherited

inherited_from \Moneybird\Invoice::$$address2
 

$attention

$attention 
Inherited

inherited_from \Moneybird\Invoice::$$attention
 

$city

$city 
Inherited

inherited_from \Moneybird\Invoice::$$city
 

$companyName

$companyName 
Inherited

inherited_from \Moneybird\Invoice::$$companyName
 

$conceptId

$conceptId 
Inherited

inherited_from \Moneybird\Invoice::$$conceptId
 

$contactId

$contactId 
Inherited

inherited_from \Moneybird\Invoice::$$contactId
 

$contactName

$contactName 
Inherited

inherited_from \Moneybird\Invoice::$$contactName
 

$country

$country 
Inherited

inherited_from \Moneybird\Invoice::$$country
 

$createdAt

$createdAt 
Inherited

inherited_from \Moneybird\Invoice::$$createdAt
 

$currency

$currency 
Inherited

inherited_from \Moneybird\Invoice::$$currency
 

$customerId

$customerId 
Inherited

inherited_from \Moneybird\Invoice::$$customerId
 

$daysOpen

$daysOpen 
Inherited

inherited_from \Moneybird\Invoice::$$daysOpen
 

$description

$description 
Inherited

inherited_from \Moneybird\Invoice::$$description
 

$details

$details 
Inherited

inherited_from \Moneybird\Invoice::$$details
 

$discount

$discount 
Inherited

inherited_from \Moneybird\Invoice::$$discount
 

$dueDateInterval

$dueDateInterval 
Inherited

inherited_from \Moneybird\Invoice::$$dueDateInterval
 

$email

$email 
Inherited

inherited_from \Moneybird\Invoice::$$email
 

$firstname

$firstname 
Inherited

inherited_from \Moneybird\Invoice::$$firstname
 

$history

$history 
Inherited

inherited_from \Moneybird\Invoice::$$history
 

$id

$id 
Inherited

inherited_from \Moneybird\Invoice::$$id
 

$invoiceDate

$invoiceDate 
Inherited

inherited_from \Moneybird\Invoice::$$invoiceDate
 

$invoiceEmail

$invoiceEmail 
Inherited

inherited_from \Moneybird\Invoice::$$invoiceEmail
 

$invoiceEmailReminder

$invoiceEmailReminder 
Inherited

inherited_from \Moneybird\Invoice::$$invoiceEmailReminder
 

$invoiceHash

$invoiceHash 
Inherited

inherited_from \Moneybird\Invoice::$$invoiceHash
 

$invoiceId

$invoiceId 
Inherited

inherited_from \Moneybird\Invoice::$$invoiceId
 

$invoiceProfileId

$invoiceProfileId 
Inherited

inherited_from \Moneybird\Invoice::$$invoiceProfileId
 

$invoiceProfileVersionId

$invoiceProfileVersionId 
Inherited

inherited_from \Moneybird\Invoice::$$invoiceProfileVersionId
 

$language

$language 
Inherited

inherited_from \Moneybird\Invoice::$$language
 

$lastname

$lastname 
Inherited

inherited_from \Moneybird\Invoice::$$lastname
 

$name

$name 
Inherited

inherited_from \Moneybird\Invoice::$$name
 

$originalEstimateId

$originalEstimateId 
Inherited

inherited_from \Moneybird\Invoice::$$originalEstimateId
 

$originalInvoiceId

$originalInvoiceId 
Inherited

inherited_from \Moneybird\Invoice::$$originalInvoiceId
 

$payUrl

$payUrl 
Inherited

inherited_from \Moneybird\Invoice::$$payUrl
 

$payments

$payments 
Inherited

inherited_from \Moneybird\Invoice::$$payments
 

$pdfUrl

$pdfUrl 
Inherited

inherited_from \Moneybird\Invoice::$$pdfUrl
 

$poNumber

$poNumber 
Inherited

inherited_from \Moneybird\Invoice::$$poNumber
 

$recurringTemplateId

$recurringTemplateId 
Inherited

inherited_from \Moneybird\Invoice::$$recurringTemplateId
 

$revision

$revision 
Inherited

inherited_from \Moneybird\Invoice::$$revision
 

$sendMethod

$sendMethod 
Inherited

inherited_from \Moneybird\Invoice::$$sendMethod
 

$showCustomerId

$showCustomerId 
Inherited

inherited_from \Moneybird\Invoice::$$showCustomerId
 

$showTax

$showTax 
Inherited

inherited_from \Moneybird\Invoice::$$showTax
 

$showTaxNumber

$showTaxNumber 
Inherited

inherited_from \Moneybird\Invoice::$$showTaxNumber
 

$state

$state 
Inherited

inherited_from \Moneybird\Invoice::$$state
 

$taxNumber

$taxNumber 
Inherited

inherited_from \Moneybird\Invoice::$$taxNumber
 

$totalPaid

$totalPaid 
Inherited

inherited_from \Moneybird\Invoice::$$totalPaid
 

$totalPriceExclTax

$totalPriceExclTax 
Inherited

inherited_from \Moneybird\Invoice::$$totalPriceExclTax
 

$totalPriceInclTax

$totalPriceInclTax 
Inherited

inherited_from \Moneybird\Invoice::$$totalPriceInclTax
 

$totalTax

$totalTax 
Inherited

inherited_from \Moneybird\Invoice::$$totalTax
 

$totalUnpaid

$totalUnpaid 
Inherited

inherited_from \Moneybird\Invoice::$$totalUnpaid
 

$updatedAt

$updatedAt 
Inherited

inherited_from \Moneybird\Invoice::$$updatedAt
 

$url

$url 
Inherited

inherited_from \Moneybird\Invoice::$$url
 

$zipcode

$zipcode 
Inherited

inherited_from \Moneybird\Invoice::$$zipcode