\Commerce\Sales\Receipts\Allocations
Templating
Global Functions
Website
\Components\Website\Designs \Components\Website\Media \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\Categories \Components\Marketing\Events\Locations
Commerce
\Components\Commerce\Carts \Components\Commerce\Carts\Current \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\CustomFields \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 \Framework\Data\Util \Framework\DOM\CurrentContext \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

Allocations

The relationship between receipts and the sales/adjustments they are allocated to.

Methods

Invoke via \Components\Commerce\Sales\Receipts\Allocations::method()
Click a method name to copy it.
- ` void deleteAllForReceipt($iReceiptId) `
Deallocates all for a specific receipt
Parameters:
- $iReceiptId
mixed
- ` void deleteAllForReceiptAndSale($iReceiptId, $iSaleId) `
Deallocates all allocations for a receipt and sale
Parameters:
- $iReceiptId
mixed
- $iSaleId
mixed
- ` void deleteAllForSale($iSaleId) `
Deallocates all receipts for a sale
Parameters:
- $iSaleId
mixed
- ` int allocate($iReceiptId, $iSaleId, $fAmount) `
Allocates a receipt to a sale or adjustment
Parameters:
- $iReceiptId
mixed
- $iSaleId
mixed
- $fAmount
mixed
Return
Allocation id
- ` void allocateRemaining($iReceiptId, $iContactId) `
Allocates a receipt to any unpaid invoices, or allocates a refunded amount to the most appropriate.

Requires the receipt to have a contact_id or $iContactId to be specified
Parameters:
- $iReceiptId
mixed
- $iContactId
mixed
- ` bool delete($iReceiptAllocationId, $bDeleteMedia) `
Deletes a record from the database
Parameters:
- $iReceiptAllocationId
int unsigned
A record's receipt_allocation_id
- $bDeleteMedia
mixed
Return
Returns true if record existed and was deleted, otherwise false
- ` array get($iReceiptAllocationId) `
Gets a record from the database
Parameters:
- $iReceiptAllocationId
int unsigned
A record's receipt_allocation_id
Return
Allocations
- ` array getAll($arrQuery) `
Return a set of records from the database
Parameters:
- $arrQuery
mixed
Return
Array of Allocations
- ` array getAllForReceipt($iReceiptId, $arrQuery) `
Returns all the allocations for a given receipt id
Parameters:
- $iReceiptId
mixed
- $arrQuery
mixed
Return
Array of Allocations
- ` array getAllForSale($iSaleId, $arrQuery) `
Returns all receipt allocations for a given sale id
Parameters:
- $iSaleId
mixed
- $arrQuery
mixed
Return
Array of Allocations
- ` mixed getColumn($iReceiptAllocationId, $strColumn) `
Gets a single field from a record
Parameters:
- $iReceiptAllocationId
int unsigned
A record's receipt_allocation_id
- $strColumn
mixed
Return
mixed
- ` int getCount($arrFilter) `
Returns the number of records in the database (matching the filter if specified)
Parameters:
- $arrFilter
mixed
Return
int
- ` float getTotalAllocatedForReceipt($iReceiptId) `
Returns the amount allocated to sales for a receipt
Parameters:
- $iReceiptId
mixed
Return
float
- ` float getTotalAllocatedForReceiptToSale($iReceiptId, $iSaleId) `
Returns the amount allocated to an sale for a specific receipt
Parameters:
- $iReceiptId
mixed
- $iSaleId
mixed
Return
float
- ` float getTotalAllocatedForSale($iSaleId, $arrQuery) `
Returns the amount allocated to a sale
Parameters:
- $iSaleId
mixed
- $arrQuery
mixed
Return
float
- ` bool isReceiptAllocated($iReceiptId) `
Determines if a receipt is allocated to some sales
Parameters:
- $iReceiptId
mixed
Return
bool
- ` string|int save($arrEntity) `
Saves a record into the database
Parameters:
- $arrEntity
mixed
Return
string|int
- ` void saveColumn($iReceiptAllocationId, $strColumn, $strValue) `
Saves a specific column of a row into a database
Parameters:
- $iReceiptAllocationId
int unsigned
A record's receipt_allocation_id
- $strColumn
mixed
- $strValue
mixed
- ` array search($strSearch, $arrQuery) `
Performs a search
Parameters:
- $strSearch
mixed
- $arrQuery
mixed
Return
Array of Allocations that match the search query.

Database Fields

The following fields are used when retrieving and saving entities:
- `receipt_allocation_id`
int unsigned (10)
- `receipt_allocation_datetime`
datetime
- `sale_id`
int unsigned (10)
- `receipt_id`
int unsigned (10)
- `receipt_allocation_amount`
decimal (8,2)