ModelQuotes module

Quote

A model in the Quotes module, with 37 members for templates, 39 API properties and 39 members for admin templates.

Quotes\Models\Frontend\Quote Quotes\Models\Api\Quote Quotes\Models\Backend\Quote
View
What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Templates view

Properties 37

Take no arguments.

# getId()
?int
# getExpiryDate()
?DateTime
Gets the expiry date
# getItemTotalAsMoney()
Money
Gets the item total as a Money object. Represents the sum of all items' Amount values.
# getShippingTotalAsMoney()
Money
Gets the shipping total as a Money object. Represents the net shipping total. Tax and discount on shipping are tracked in Tax Total and Discount Total.
# getHandlingTotalAsMoney()
Money
Gets the handling total as a Money object. Represents the net handling total. Tax and discount on handling are tracked in Tax Total and Discount Total.
# getInsuranceTotalAsMoney()
Money
Gets the insurance total as a Money object. Represents the net insurance total. Tax and discount on insurance are tracked in Tax Total and Discount Total.
# getDiscountTotalAsMoney()
Money
Gets the discount total as a Money object. Represents the sum of discount values across all line items, including shipping, handling, etc.
# getTaxTotalAsMoney()
Money
Gets the tax total as a Money object. Represents the sum of tax values across all line items, including shipping, handling, etc.
# getSurchargeTotalAsMoney()
Money
Gets the surcharge total as a Money object. Represents the surcharge total.
# getTotalAsMoney()
Money
Gets the grand total as a Money object. Represents the final value calculated as Item Total + Shipping Total + Handling Total + Insurance Total - Discount Total + Tax Total + Surcharge Total.
# getInvoices()
Collection
Get all invoices linked to this order (Order, Checkout)
# getCurrencyCode()
string
Get currency code
# getUuid()
?string
# getExternalId()
?string
# getComments()
?string
# getAppliedDiscounts()
array
Metadata of the applied discounts.
# getDiscountCodes()
array
List of the applied discount codes.
# getShippingTotal()
?string
Represents the net shipping total. Tax and discount on shipping are tracked in Tax Total and Discount Total.
# getHandlingTotal()
?string
Represents the net handling total. Tax and discount on handling are tracked in Tax Total and Discount Total.
# getInsuranceTotal()
?string
Represents the net insurance total. Tax and discount on insurance are tracked in Tax Total and Discount Total.
# getDiscountTotal()
?string
Represents the sum of discount values across all line items, including shipping, handling, etc.
# getTaxTotal()
?string
Represents the sum of tax values across all line items, including shipping, handling, etc.
# getSurchargeTotal()
?string
Represents the surcharge total.
# getTotal()
?string
Represents the final value calculated as Item Total + Shipping Total + Handling Total + Insurance Total - Discount Total + Tax Total + Surcharge Total.
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getBillingAddress()
?Address
# getDeliveryAddress()
?Address
# getCurrency()
?Currency
# getPerson()
?Person
# getSite()
?Site
# getItems()
?Collection<Item>
# getFulfillments()
?Collection<Fulfillment>
# getMetadataFieldValues()
?Collection<MetadataFieldValue>
# getSourceEntity()
?string
Get the source record entity
# getSourceUuid()
?string
Get the source record uuid
# getDiscountLogs()
?Collection<Log>

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 39

Read-only values on the record.

# editUrl Not in Templates
?string
Get the url for editing the record.
# id
?int
# expiryDate
?DateTime
Gets the expiry date
# itemTotalAsMoney
Money
Gets the item total as a Money object. Represents the sum of all items' Amount values.
# shippingTotalAsMoney
Money
Gets the shipping total as a Money object. Represents the net shipping total. Tax and discount on shipping are tracked in Tax Total and Discount Total.
# handlingTotalAsMoney
Money
Gets the handling total as a Money object. Represents the net handling total. Tax and discount on handling are tracked in Tax Total and Discount Total.
# insuranceTotalAsMoney
Money
Gets the insurance total as a Money object. Represents the net insurance total. Tax and discount on insurance are tracked in Tax Total and Discount Total.
# discountTotalAsMoney
Money
Gets the discount total as a Money object. Represents the sum of discount values across all line items, including shipping, handling, etc.
# taxTotalAsMoney
Money
Gets the tax total as a Money object. Represents the sum of tax values across all line items, including shipping, handling, etc.
# surchargeTotalAsMoney
Money
Gets the surcharge total as a Money object. Represents the surcharge total.
# totalAsMoney
Money
Gets the grand total as a Money object. Represents the final value calculated as Item Total + Shipping Total + Handling Total + Insurance Total - Discount Total + Tax Total + Surcharge Total.
# invoices
Collection
Get all invoices linked to this order (Order, Checkout)
# currencyCode
string
Get currency code
# uuid
?string
# externalId
?string
# comments
?string
# appliedDiscounts
array
Metadata of the applied discounts.
# discountCodes
array
List of the applied discount codes.
# shippingTotal
?string
Represents the net shipping total. Tax and discount on shipping are tracked in Tax Total and Discount Total.
# handlingTotal
?string
Represents the net handling total. Tax and discount on handling are tracked in Tax Total and Discount Total.
# insuranceTotal
?string
Represents the net insurance total. Tax and discount on insurance are tracked in Tax Total and Discount Total.
# discountTotal
?string
Represents the sum of discount values across all line items, including shipping, handling, etc.
# taxTotal
?string
Represents the sum of tax values across all line items, including shipping, handling, etc.
# surchargeTotal
?string
Represents the surcharge total.
# total
?string
Represents the final value calculated as Item Total + Shipping Total + Handling Total + Insurance Total - Discount Total + Tax Total + Surcharge Total.
# created
?DateTime
Date the record was created.
# modified
?DateTime
Last modification date for the record.
# billingAddress
?Address
# deliveryAddress
?Address
# currency
?Currency
# person
?Person
# site
?Site
# items
?Collection<Item>
# fulfillments
?Collection<Fulfillment>
# metadataFieldValues
?Collection<MetadataFieldValue>
# sourceEntity
?string
Get the source record entity
# sourceUuid
?string
Get the source record uuid
# discountLogs
?Collection<Log>

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 39

Take no arguments.

# getEditUrl() Not in Templates
?string
Get the url for editing the record.
# getId()
?int
# getExpiryDate()
?DateTime
Gets the expiry date
# getItemTotalAsMoney()
Money
Gets the item total as a Money object. Represents the sum of all items' Amount values.
# getShippingTotalAsMoney()
Money
Gets the shipping total as a Money object. Represents the net shipping total. Tax and discount on shipping are tracked in Tax Total and Discount Total.
# getHandlingTotalAsMoney()
Money
Gets the handling total as a Money object. Represents the net handling total. Tax and discount on handling are tracked in Tax Total and Discount Total.
# getInsuranceTotalAsMoney()
Money
Gets the insurance total as a Money object. Represents the net insurance total. Tax and discount on insurance are tracked in Tax Total and Discount Total.
# getDiscountTotalAsMoney()
Money
Gets the discount total as a Money object. Represents the sum of discount values across all line items, including shipping, handling, etc.
# getTaxTotalAsMoney()
Money
Gets the tax total as a Money object. Represents the sum of tax values across all line items, including shipping, handling, etc.
# getSurchargeTotalAsMoney()
Money
Gets the surcharge total as a Money object. Represents the surcharge total.
# getTotalAsMoney()
Money
Gets the grand total as a Money object. Represents the final value calculated as Item Total + Shipping Total + Handling Total + Insurance Total - Discount Total + Tax Total + Surcharge Total.
# getInvoices()
Collection
Get all invoices linked to this order (Order, Checkout)
# getCurrencyCode()
string
Get currency code
# getUuid()
?string
# getExternalId()
?string
# getComments()
?string
# getAppliedDiscounts()
array
Metadata of the applied discounts.
# getDiscountCodes()
array
List of the applied discount codes.
# getShippingTotal()
?string
Represents the net shipping total. Tax and discount on shipping are tracked in Tax Total and Discount Total.
# getHandlingTotal()
?string
Represents the net handling total. Tax and discount on handling are tracked in Tax Total and Discount Total.
# getInsuranceTotal()
?string
Represents the net insurance total. Tax and discount on insurance are tracked in Tax Total and Discount Total.
# getDiscountTotal()
?string
Represents the sum of discount values across all line items, including shipping, handling, etc.
# getTaxTotal()
?string
Represents the sum of tax values across all line items, including shipping, handling, etc.
# getSurchargeTotal()
?string
Represents the surcharge total.
# getTotal()
?string
Represents the final value calculated as Item Total + Shipping Total + Handling Total + Insurance Total - Discount Total + Tax Total + Surcharge Total.
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getBillingAddress()
?Address
# getDeliveryAddress()
?Address
# getCurrency()
?Currency
# getPerson()
?Person
# getSite()
?Site
# getItems()
?Collection<Item>
# getFulfillments()
?Collection<Fulfillment>
# getMetadataFieldValues()
?Collection<MetadataFieldValue>
# getSourceEntity()
?string
Get the source record entity
# getSourceUuid()
?string
Get the source record uuid
# getDiscountLogs()
?Collection<Log>