PHP Class XeroPHP\Models\Accounting\CreditNote

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
addAllocation ( Allocation $value ) : CreditNote
addLineItem ( LineItem $value ) : CreditNote
getAPIStem ( ) : string \| null	Get the stem of the API (core.xro) etc
getAllocations ( ) : Allocation[] \| Collection
getBrandingThemeID ( ) : string
getContact ( ) : Contact
getCreditNoteID ( ) : string
getCreditNoteNumber ( ) : string
getCurrencyCode ( ) : string
getCurrencyRate ( ) : float
getDate ( ) : DateTimeInterface
getFullyPaidOnDate ( ) : DateTimeInterface
getGUIDProperty ( ) : string	Get the guid property
getHasAttachments ( ) : boolean
getLineAmountTypes ( ) : string
getLineItems ( ) : LineItem[] \| 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
getRemainingCredit ( ) : 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
getTotalTax ( ) : float
getType ( ) : string
getUpdatedDateUTC ( ) : DateTimeInterface
isPageable ( )
setBrandingThemeID ( string $value ) : CreditNote
setContact ( Contact $value ) : CreditNote
setCreditNoteID ( string $value ) : CreditNote
setCreditNoteNumber ( string $value ) : CreditNote
setCurrencyCode ( string $value ) : CreditNote
setCurrencyRate ( float $value ) : CreditNote
setDate ( DateTimeInterface $value ) : CreditNote
setFullyPaidOnDate ( DateTimeInterface $value ) : CreditNote
setHasAttachment ( $value )
setLineAmountType ( string $value ) : CreditNote
setReference ( string $value ) : CreditNote
setRemainingCredit ( string $value ) : CreditNote
setSentToContact ( boolean $value ) : CreditNote
setStatus ( string $value ) : CreditNote
setSubTotal ( float $value ) : CreditNote
setTotal ( float $value ) : CreditNote
setTotalTax ( float $value ) : CreditNote
setType ( string $value ) : CreditNote
setUpdatedDateUTC ( DateTimeInterface $value ) : CreditNote

Method Details

addAllocation() public method

public addAllocation ( Allocation $value ) : CreditNote
$value	XeroPHP\Models\Accounting\CreditNote\Allocation
return	CreditNote

addLineItem() public method

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

getAPIStem() public static method

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

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

getAllocations() public method

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

getBrandingThemeID() public method

public getBrandingThemeID ( ) : string
return	string

getContact() public method

public getContact ( ) : Contact
return	Contact

getCreditNoteID() public method

public getCreditNoteID ( ) : string
return	string

getCreditNoteNumber() public method

public getCreditNoteNumber ( ) : string
return	string

getCurrencyCode() public method

public getCurrencyCode ( ) : string
return	string

getCurrencyRate() public method

public getCurrencyRate ( ) : float
return	float

getDate() public method

public getDate ( ) : DateTimeInterface
return	DateTimeInterface

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

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

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

getRemainingCredit() public method

public getRemainingCredit ( ) : 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

getTotalTax() public method

public getTotalTax ( ) : float
return	float

getType() public method

public getType ( ) : string
return	string

getUpdatedDateUTC() public method

public getUpdatedDateUTC ( ) : DateTimeInterface
return	DateTimeInterface

isPageable() public static method

public static isPageable ( )

setBrandingThemeID() public method

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

setContact() public method

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

setCreditNoteID() public method

public setCreditNoteID ( string $value ) : CreditNote
$value	string
return	CreditNote

setCreditNoteNumber() public method

public setCreditNoteNumber ( string $value ) : CreditNote
$value	string
return	CreditNote

setCurrencyCode() public method

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

setCurrencyRate() public method

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

setDate() public method

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

setFullyPaidOnDate() public method

public setFullyPaidOnDate ( DateTimeInterface $value ) : CreditNote
$value	DateTimeInterface
return	CreditNote

setHasAttachment() public method

Deprecation: - this is a read only property and this method will be removed in future versions

public setHasAttachment ( $value )
$value

setLineAmountType() public method

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

setReference() public method

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

setRemainingCredit() public method

public setRemainingCredit ( string $value ) : CreditNote
$value	string
return	CreditNote

setSentToContact() public method

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

setStatus() public method

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

setSubTotal() public method

public setSubTotal ( float $value ) : CreditNote
$value	float
return	CreditNote

setTotal() public method

public setTotal ( float $value ) : CreditNote
$value	float
return	CreditNote

setTotalTax() public method

public setTotalTax ( float $value ) : CreditNote
$value	float
return	CreditNote

setType() public method

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

setUpdatedDateUTC() public method

public setUpdatedDateUTC ( DateTimeInterface $value ) : CreditNote
$value	DateTimeInterface
return	CreditNote