PHP Class XeroPHP\Models\Accounting\Invoice

Inheritance: extends XeroPHP\Remote\Object, use trait XeroPHP\Traits\PDFTrait, use trait XeroPHP\Traits\AttachmentTrait

Show file Open project: calcinai/xero-php

Public Methods

Method	Description
addLineItem ( LineItem $value ) : Invoice
getAPIStem ( ) : string \| null	Get the stem of the API (core.xro) etc
getAmountCredited ( ) : float
getAmountDue ( ) : float
getAmountPaid ( ) : float
getBrandingThemeID ( ) : string
getContact ( ) : Contact
getCreditNotes ( ) : CreditNote[] \| Collection
getCurrencyCode ( ) : string
getCurrencyRate ( ) : float
getDate ( ) : DateTimeInterface
getDueDate ( ) : DateTimeInterface
getExpectedPaymentDate ( ) : string
getFullyPaidOnDate ( ) : DateTimeInterface
getGUIDProperty ( ) : string	Get the guid property
getHasAttachments ( ) : boolean
getInvoiceID ( ) : string
getInvoiceNumber ( ) : string
getLineAmountTypes ( ) : string
getLineItems ( ) : LineItem[] \| Collection
getOverpayments ( ) : Overpayment[] \| Collection
getPayments ( ) : Payment[] \| Collection
getPlannedPaymentDate ( ) : string
getPrepayments ( ) : Prepayment[] \| Collection
getProperties ( ) : array	Get the properties of the object. Indexed by constants [0] - Mandatory [1] - Type [2] - PHP type [3] - Is an Array [4] - Saves directly
getReference ( ) : string
getResourceURI ( ) : string	Get the resource uri of the class (Contacts) etc
getRootNodeName ( ) : string	Get the root node name. Just the unqualified classname
getSentToContact ( ) : boolean
getStatus ( ) : string
getSubTotal ( ) : float
getSupportedMethods ( )	Get the supported methods
getTotal ( ) : float
getTotalDiscount ( ) : float
getTotalTax ( ) : float
getType ( ) : string
getUpdatedDateUTC ( ) : DateTimeInterface
getUrl ( ) : string
isPageable ( )
setBrandingThemeID ( string $value ) : Invoice
setContact ( Contact $value ) : Invoice
setCurrencyCode ( string $value ) : Invoice
setCurrencyRate ( float $value ) : Invoice
setDate ( DateTimeInterface $value ) : Invoice
setDueDate ( DateTimeInterface $value ) : Invoice
setExpectedPaymentDate ( string $value ) : Invoice
setInvoiceID ( string $value ) : Invoice
setInvoiceNumber ( string $value ) : Invoice
setLineAmountType ( string $value ) : Invoice
setPlannedPaymentDate ( string $value ) : Invoice
setReference ( string $value ) : Invoice
setSentToContact ( boolean $value ) : Invoice
setStatus ( string $value ) : Invoice
setType ( string $value ) : Invoice
setUrl ( string $value ) : Invoice

Method Details

addLineItem() public method

public addLineItem ( LineItem $value ) : Invoice
$value	XeroPHP\Models\Accounting\Invoice\LineItem
return	Invoice

getAPIStem() public static method

Get the stem of the API (core.xro) etc

public static getAPIStem ( ) : string \| null
return	string \| null

getAmountCredited() public method

public getAmountCredited ( ) : float
return	float

getAmountDue() public method

public getAmountDue ( ) : float
return	float

getAmountPaid() public method

public getAmountPaid ( ) : float
return	float

getBrandingThemeID() public method

public getBrandingThemeID ( ) : string
return	string

getContact() public method

public getContact ( ) : Contact
return	Contact

getCreditNotes() public method

public getCreditNotes ( ) : CreditNote[] \| Collection
return	CreditNote[] \| Collection	Always returns a collection, switch is for type hinting

getCurrencyCode() public method

public getCurrencyCode ( ) : string
return	string

getCurrencyRate() public method

public getCurrencyRate ( ) : float
return	float

getDate() public method

public getDate ( ) : DateTimeInterface
return	DateTimeInterface

getDueDate() public method

public getDueDate ( ) : DateTimeInterface
return	DateTimeInterface

getExpectedPaymentDate() public method

public getExpectedPaymentDate ( ) : string
return	string

getFullyPaidOnDate() public method

public getFullyPaidOnDate ( ) : DateTimeInterface
return	DateTimeInterface

getGUIDProperty() public static method

Get the guid property

public static getGUIDProperty ( ) : string
return	string

getHasAttachments() public method

public getHasAttachments ( ) : boolean
return	boolean

getInvoiceID() public method

public getInvoiceID ( ) : string
return	string

getInvoiceNumber() public method

public getInvoiceNumber ( ) : string
return	string

getLineAmountTypes() public method

public getLineAmountTypes ( ) : string
return	string

getLineItems() public method

public getLineItems ( ) : LineItem[] \| Collection
return	XeroPHP\Models\Accounting\Invoice\LineItem[] \| XeroPHP\Remote\Collection	Always returns a collection, switch is for type hinting

getOverpayments() public method

public getOverpayments ( ) : Overpayment[] \| Collection
return	Overpayment[] \| Collection	Always returns a collection, switch is for type hinting

getPayments() public method

public getPayments ( ) : Payment[] \| Collection
return	Payment[] \| Collection	Always returns a collection, switch is for type hinting

getPlannedPaymentDate() public method

public getPlannedPaymentDate ( ) : string
return	string

getPrepayments() public method

public getPrepayments ( ) : Prepayment[] \| Collection
return	Prepayment[] \| Collection	Always returns a collection, switch is for type hinting

getProperties() public static method

Get the properties of the object. Indexed by constants [0] - Mandatory [1] - Type [2] - PHP type [3] - Is an Array [4] - Saves directly

public static getProperties ( ) : array
return	array

getReference() public method

public getReference ( ) : string
return	string

getResourceURI() public static method

Get the resource uri of the class (Contacts) etc

public static getResourceURI ( ) : string
return	string

getRootNodeName() public static method

Get the root node name. Just the unqualified classname

public static getRootNodeName ( ) : string
return	string

getSentToContact() public method

public getSentToContact ( ) : boolean
return	boolean

getStatus() public method

public getStatus ( ) : string
return	string

getSubTotal() public method

public getSubTotal ( ) : float
return	float

getSupportedMethods() public static method

Get the supported methods

public static getSupportedMethods ( )

getTotal() public method

public getTotal ( ) : float
return	float

getTotalDiscount() public method

public getTotalDiscount ( ) : float
return	float

getTotalTax() public method

public getTotalTax ( ) : float
return	float

getType() public method

public getType ( ) : string
return	string

getUpdatedDateUTC() public method

public getUpdatedDateUTC ( ) : DateTimeInterface
return	DateTimeInterface

getUrl() public method

public getUrl ( ) : string
return	string

isPageable() public static method

public static isPageable ( )

setBrandingThemeID() public method

public setBrandingThemeID ( string $value ) : Invoice
$value	string
return	Invoice

setContact() public method

public setContact ( Contact $value ) : Invoice
$value	Contact
return	Invoice

setCurrencyCode() public method

public setCurrencyCode ( string $value ) : Invoice
$value	string
return	Invoice

setCurrencyRate() public method

public setCurrencyRate ( float $value ) : Invoice
$value	float
return	Invoice

setDate() public method

public setDate ( DateTimeInterface $value ) : Invoice
$value	DateTimeInterface
return	Invoice

setDueDate() public method

public setDueDate ( DateTimeInterface $value ) : Invoice
$value	DateTimeInterface
return	Invoice

setExpectedPaymentDate() public method

public setExpectedPaymentDate ( string $value ) : Invoice
$value	string
return	Invoice

setInvoiceID() public method

public setInvoiceID ( string $value ) : Invoice
$value	string
return	Invoice

setInvoiceNumber() public method

public setInvoiceNumber ( string $value ) : Invoice
$value	string
return	Invoice

setLineAmountType() public method

public setLineAmountType ( string $value ) : Invoice
$value	string
return	Invoice

setPlannedPaymentDate() public method

public setPlannedPaymentDate ( string $value ) : Invoice
$value	string
return	Invoice

setReference() public method

public setReference ( string $value ) : Invoice
$value	string
return	Invoice

setSentToContact() public method

public setSentToContact ( boolean $value ) : Invoice
$value	boolean
return	Invoice

setStatus() public method

public setStatus ( string $value ) : Invoice
$value	string
return	Invoice

setType() public method

public setType ( string $value ) : Invoice
$value	string
return	Invoice

setUrl() public method

public setUrl ( string $value ) : Invoice
$value	string
return	Invoice