Templating
Global Functions
Website
\Components\Website\Designs \Components\Website\Pages \Components\Website\Pages\Forms \Components\Website\Posts \Components\Website\Posts\Categories
Customers
\Components\Customers\Contacts \Components\Customers\Contacts\Relationships \Components\Customers\Contacts\Relationships\Types \Components\Customers\Groups
Marketing
\Components\Marketing\EmailMarketing \Components\Marketing\Events \Components\Marketing\Events\Attendees \Components\Marketing\Events\Locations
Commerce
\Components\Commerce\Configuration\PaymentMethods \Components\Commerce\Configuration\ShippingMethods \Components\Commerce\Discounts \Components\Commerce\Products \Components\Commerce\Products\Brands \Components\Commerce\Products\Categories \Components\Commerce\Products\Inventory \Components\Commerce\Sales \Components\Commerce\Sales\Items \Components\Commerce\Sales\Receipts \Components\Commerce\Sales\Receipts\Allocations
Settings
\Components\Settings\Administrators \Components\Settings\Domains
Other Apps
\Components\Website\Comments \Components\Commerce\Affiliates \Components\Commerce\Affiliates\Administrators \Components\Commerce\Affiliates\Commissions \Components\Commerce\Affiliates\Payments \Components\Commerce\RecurringSales \Components\Commerce\RecurringSales\StoredCards
Framework
\Framework\Caching\FileBased \Framework\Data\Util \Framework\HTML\Converters \Framework\HTTP\Cookies \Framework\HTTP\Redirection \Framework\HTTP\Request \Framework\HTTP\Session \Framework\HTTP\UserAgent \Framework\I18N\CompanyTypes \Framework\I18N\Countries \Framework\I18N\Languages \Framework\Network\GeoIP
Methods

\Components\Commerce\Sales\Receipts::

Receipts are payments recorded towards sales or adjustments.

Methods

Invoke via \Components\Commerce\Sales\Receipts::method()
Click a method name to copy it.
array get($iReceiptId)
Gets a record from the database
Parameters
$iReceiptId
int unsigned
A record's receipt_id
Return
array getAll($arrQuery)
Return a set of records from the database
Parameters
$arrQuery
array|null
Return
Array of Receipts
mixed getColumn($iReceiptId, $strColumn)
Gets a single field from a record
Parameters
$iReceiptId
int unsigned
A record's receipt_id
$strColumn
string
Return
mixed
int getCount($arrFilter)
Returns the number of records in the database (matching the filter if specified)
Parameters
$arrFilter
array|null
Return
int
array getMostRecentForSale($iSaleId)
Returns the most recent receipt for a sale
Parameters
$iSaleId
int
Return
array
string renderReceiptData($arrReceipt)
Renders the receipt data
Parameters
$arrReceipt
array
Return
string
int unsigned save($arrEntity)
Saves a record into the database
Parameters
$arrEntity
array
Return
The record's receipt_id
void saveColumn($iReceiptId, $strColumn, $strValue)
Saves a specific column of a row into a database
Parameters
$iReceiptId
int unsigned
A record's receipt_id
$strColumn
string
$strValue
string
array search($strSearch, $arrQuery)
Performs a search
Parameters
$strSearch
string
Search query
$arrQuery
array|null
Return
Array of Receipts that match the search query.
bool delete($iReceiptId, $bDeleteMedia)
Deletes a record from the database
Parameters
$iReceiptId
int unsigned
A record's receipt_id
$bDeleteMedia
bool
Return
Returns true if record existed and was deleted, otherwise false

Database Fields

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