Components \ commerce \ affiliates administrators commissions payments \ configuration paymentmethods \ shippingmethods \ methods delivery discounts \ products brands categories \ recurringsales storedcards \ sales items \ receipts allocations \ customers \ contacts passwords referrertypes \ relationships types \ groups contacts \ marketing \ emailmarketing \ sends contacts unsubscribers \ events attendees locations \ reminders \ automation eventremindertrigger \ settings administrators components configurationitems cpanel customfields \ developer scheduledtasks threads domains \ website \ analytics sessions comments \ designs generator media pages \ posts categories Framework \ architecture publicassets \ assets css javascript \ caching filebased \ components textualids \ data util \ database mainconnection date \ dom currentcontext renderer \ html converters highlighter javascript \ http redirection request session useragent \ i18n companytypes countries languages \ network cidr dns geoip random \ reflection api \ system filenames filesystem toasts
.
.
.
quick access
\ methods

\Components\Commerce\Sales\Receipts::

Receipts are payments recorded towards sales or adjustments.

Class Methods

The following static methods are available on this class:
string configGetValue($strConfigId)
Description
Retrieves the value of a config item for the current component
Parameters
$strConfigId
string
Return
Config item value
bool delete($strKeyValue, $bDeleteMedia, $strReason)
Description
Deletes an entity and triggers the pre/post component events
Parameters
$strKeyValue
string
$bDeleteMedia
bool
$strReason
mixed
Return
bool
array get($strKey)
Description
Returns an entity
Parameters
$strKey
mixed
Value of the primary key
Return
{Array} getAll($arrProperties)
Description
Return all entities in the database.
Parameters
$arrProperties
mixed
Return
Array of Receipts
mixed getColumn($strKey, $strColumn)
Description
Returns a single column of an entity
Parameters
$strKey
string
$strColumn
string
Return
mixed
int getCount($arrFilter)
Description
Returns a count of all rows in the data adapter
Parameters
$arrFilter
array
Return
int
array getMostRecentForSale($iSaleId)
Description
Returns the most recent receipt for a sale
Parameters
$iSaleId
int
Return
array
string mediaFolderGet($strKey)
Description
Returns the media folder for this data adapter
Parameters
$strKey
mixed
Return
Folder
string renderReceiptData($arrReceipt)
Description
Renders the receipt data
Parameters
$arrReceipt
array
Return
string
mixed save($arrEntity, $strReason)
Description
Saves an entity and triggers the pre/post component events
Parameters
$arrEntity
array
$strReason
string
Return
mixed
mixed saveColumn($strKeyValue, $strColumn, $strValue, $strReason)
Description
Changes a column of an existing entity Supports primary keys spanning on several columns if passing $strKeyValue as an associative arry
Parameters
$strKeyValue
string
$strColumn
string
$strValue
string
$strReason
string
Return
Id
array search($strSearch, $arrProperties)
Description
Performs a search
Parameters
$strSearch
string
$arrProperties
mixed
Return
array

Database Fields

The following fields are used when retrieving and saving entities.
administrator_id
int (11)
contact_company
varchar (127)
contact_first_name
varchar (63)
contact_id
int (11)
contact_last_name
varchar (63)
payment_method_id
int unsigned (10)
receipt_amount
decimal (8,2)
Default value: 0.00
receipt_amount_unallocated
decimal (8,2)
receipt_authcode
varchar (32)
receipt_country_id
varchar (3)
Default value: AUS
receipt_currency_id
varchar (3)
Default value: AUD
receipt_data
text
receipt_datetime
datetime
Default value: 0000-00-00 00:00:00
receipt_from
varchar (255)
receipt_gateway_id
varchar (255)
receipt_id
int unsigned (10)
receipt_is_relaypay
tinyint unsigned (1)
receipt_parent_id
int unsigned (10)
receipt_synced
varchar (255)
receipt_title
varchar (255)
receipt_verified
tinyint unsigned (1)
receipt_xero_id
varchar (255)