BxXeroApi Class Reference

Inheritance diagram for BxXeroApi:

Public Member Functions
	__construct (&$oModule)
	authorize ()
	isAuthorized ()
	callback ($sCode)
	actionTest ()
	actionAddContact ($iProfileId, $sProfileName, $sProfileEmail)
	actionGetContact ($sProfileEmail)
	actionGetContacts ($oDate=null, $sWhere=null, $sOrder=null, $aIds=null, $iPage=1, $bIncludeArchived=false)
	actionIsContact ($sProfileEmail)
	actionAddInvoice ($sProfileEmail, $sName, $mixedAmount, $iQuantity=1, $mixedDueDate=false, $sAccount=BX_XERO_ACCOUNT_CODE_SALES)
	actionGetInvoices ($oDate=null, $sWhere=null, $sOrder=null, $aIds=null, $aNumbers=null, $aContactIds=null, $aStatuses=null, $iPage=1, $bIncludeArchived=false)
	actionGetInvoice ($sId, $iUnitDp=2)
	sendInvoice ($sInvoiceId)
	_getRandNum ()

Protected Member Functions
	_getProvider ()
	_getApiObject ()

Protected Attributes
	$_oModule
	$_oProvider

Member Function Documentation

actionAddInvoice()

BxXeroApi::actionAddInvoice	(		$sProfileEmail,
			$sName,
			$mixedAmount,
			$iQuantity = 1,
			$mixedDueDate = false,
			$sAccount = BX_XERO_ACCOUNT_CODE_SALES )

Parameters

type	$sProfileEmail
type	$sName
type	$mixedAmount	- float Amount or an array with float Amount and float Tax Amount.
type	$iQuantity
mixed	$mixedDueDate	- e.g. string '2021-12-01' or a date object
type	$sAccount

Returns

invoice ID or boolean false on failure.

actionGetContacts()

BxXeroApi::actionGetContacts	(		$oDate = null,
			$sWhere = null,
			$sOrder = null,
			$aIds = null,
			$iPage = 1,
			$bIncludeArchived = false )

Get contacts by parameter(s).

Parameters

DateTime	$oDate	- Only records created or modified since this timestamp will be returned. Example: new DateTime("2019-01-02T19:20:30+01:00")
string	$sWhere
string	$sOrder
string	$aIds	- Filter by a comma-separated list of Invoice Ids.
int	$iPage	- e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items.
bool	$bIncludeArchived	- e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included

Returns

array of contacts or boolean false on failure.

actionGetInvoices()

BxXeroApi::actionGetInvoices	(		$oDate = null,
			$sWhere = null,
			$sOrder = null,
			$aIds = null,
			$aNumbers = null,
			$aContactIds = null,
			$aStatuses = null,
			$iPage = 1,
			$bIncludeArchived = false )

Note. Isn't used for now.

---

The documentation for this class was generated from the following file:

• modules/boonex/xero/classes/BxXeroApi.php