Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
cfl_ch_6-property_references [2019/03/20 11:41]
pmonaghan
cfl_ch_6-property_references [2019/03/20 11:43] (current)
pmonaghan
Line 11: Line 11:
 ENDIF ENDIF
 </​code>​ </​code>​
- 
- 
  
 Cyrious applications use objects to model the real world. What this means is that the programs create an "Order Object"​ for the order, an "​Account Object"​ for the customer, a "​Contact Object"​ for the customer contact, and so forth. From within CFL, it is possible to access the information about a customer by referencing properties of the account object. This is what is meant by "​property references"​. They are powerful tools that give the user unprecedented access to information surrounding an order. For example. "​text"​ is a property name which can be used with objects to retrieve values as in Transheader.SalesStation.text which returns the Station at Sale setting for an Order (See Coded example above). Cyrious applications use objects to model the real world. What this means is that the programs create an "Order Object"​ for the order, an "​Account Object"​ for the customer, a "​Contact Object"​ for the customer contact, and so forth. From within CFL, it is possible to access the information about a customer by referencing properties of the account object. This is what is meant by "​property references"​. They are powerful tools that give the user unprecedented access to information surrounding an order. For example. "​text"​ is a property name which can be used with objects to retrieve values as in Transheader.SalesStation.text which returns the Station at Sale setting for an Order (See Coded example above).
Line 29: Line 27:
 |**Object.FieldName** ||**Data Type** ||**Description** ||   ​||TransHeader.Account||Account||| ​  ​||TransHeader.ActiveVariation||TransVariation||| ​  ​||TransHeader.BalanceDue||Number||| ​  ​||TransHeader.BasePrice||Number||| ​  ​||TransHeader.BasePriceStr||String||| ​  ​||TransHeader.BuiltDate||DateTime||| ​  ​||TransHeader.ClosedDate||DateTime||| ​  ​||TransHeader.Contact||Contact||| ​  ​||TransHeader.ContactName||String||| ​  ​||TransHeader.ConvertedDate||DateTime||| ​  ​||TransHeader.CostSet||CostSet||| ​  ​||TransHeader.CreditMemoAmount||Number||| ​  ​||TransHeader.CreditMemoOrder||CustTransHeader||| ​  ​||TransHeader.Customer||Customer||| ​  ​||TransHeader.CustomerContractType||String||| ​  ​||TransHeader.CustomerName||String||| ​  ​||TransHeader.Depth||Number||| ​  ​||TransHeader.Description||String||| ​  ​||TransHeader.DiscountLevel||Number||| ​  ​||TransHeader.DiscountLevelOverridden||Boolean||| ​  ​||TransHeader.DiscountPrice||Number||| ​  ​||TransHeader.DiscountPriceStr||String||| ​  ​||TransHeader.Disposition||Disposition||| ​  ​||TransHeader.DivisionIDOverridden||Boolean||| ​  ​||TransHeader.DueDate||DateTime||| ​  ​||TransHeader.EnteredBy||Employee||| ​  ​||TransHeader.EstimateCreatedDate||DateTime||| ​  ​||TransHeader.EstimateGreeting||String||| ​  ​||TransHeader.EstimateGreetingTemplate||String||| ​  ​||TransHeader.EstimateNumber||Number||| ​  ​||TransHeader.FinanceChargeAmount||Number||| ​  ​||TransHeader.HTMLLongFormat||String||| ​  ​||TransHeader.HTMLShortFormat||String||| ​  ​||TransHeader.InternalNotes||String||| ​  ​||TransHeader.InternalNotesTemplate||String||| ​  ​||TransHeader.InvoiceAddressLink||Address||| ​  ​||TransHeader.InvoiceAddressOverridden||Boolean||| ​  ​||TransHeader.InvoiceContact||Contact||| ​  ​||TransHeader.InvoiceNumber||Number||| ​  ​||TransHeader.InvoiceToText||String||| ​  ​||TransHeader.IsFirmDueDate||Boolean||| ​  ​||TransHeader.IsTaxExempt||Boolean||| ​  ​||TransHeader.LastFinanceChargeDate||DateTime||| ​  ​||TransHeader.LostDate||DateTime||| ​  ​||TransHeader.ManuallyReOpened||Boolean||| ​  ​||TransHeader.ModifierPrice||Number||| ​  ​||TransHeader.ModifierPriceStr||String||| ​  ​||TransHeader.NextRefNumber||Number||| ​  ​||TransHeader.OrderCreatedDate||DateTime||| ​  ​||TransHeader.OrderNotes||String||| ​  ​||TransHeader.OrderNotesTemplate||String||| ​  ​||TransHeader.OrderNumber||Number||| ​  ​||TransHeader.OrderOriginName||String||| ​  ​||TransHeader.ParentHeaderCreated||Boolean||| ​  ​||TransHeader.PartGLList||PartGLEntry Collection||| ​  ​||TransHeader.PaymentTerms||PaymentTerms||| ​  ​||TransHeader.PaymentTermsName||String||| ​  ​||TransHeader.PaymentTotal||Number||| ​  ​||TransHeader.PONumber||String||| ​  ​||TransHeader.PriceSet||PriceSet||| ​  ​||TransHeader.PricingLevel||Number||| ​  ​||TransHeader.PricingLevelName||String||| ​  ​||TransHeader.PricingLevelOverridden||Boolean||| ​  ​||TransHeader.PricingLevelPlan||PricingLevel||| ​  ​||TransHeader.Promotion||Promotion||| ​  ​||TransHeader.PromotionName||String||| ​  ​||TransHeader.ProofDate||DateTime||| ​  ​||TransHeader.SaleDate||DateTime||| ​  ​||TransHeader.SalesDisposition||Disposition||| ​  ​||TransHeader.SalesPerson1||Employee||| ​  ​||TransHeader.SalesPerson2||Employee||| ​  ​||TransHeader.SalesPerson3||Employee||| ​  ​||TransHeader.ServiceTicketNumber||Number||| ​  ​||TransHeader.ShippingCount||Number||This field indicates how many Shipments are on the order. ​ ||   ​||TransHeader.ShippingItems[x]||Array of ShippingItem||This field provides access to the individual shipments on an order.|| ​  ​||TransHeader.ShippingAddressLink||Address||| ​  ​||TransHeader.ShippingAddressOverridden||Boolean||| ​  ​||TransHeader.ShippingCompanyOverridden||Boolean||| ​  ​||TransHeader.ShippingContactOverridden||Boolean||| ​  ​||TransHeader.ShipToText||String||| ​  ​||TransHeader.ShippingTrackingNumbers||String||This pulls all the tracking numbers for all the shipment items into one comma delimited string.|| ​  ​||TransHeader.ShowFlag||Boolean||| ​  ​||TransHeader.StatusFlagShown||Boolean||| ​  ​||TransHeader.StatusID||TransStatus||| ​  ​||TransHeader.StatusName||String||| ​  ​||TransHeader.SubTotalPrice||Number||| ​  ​||TransHeader.SubTotalPriceStr||String||| ​  ​||TransHeader.TaxClass||TaxClass||| ​  ​||TransHeader.TaxClassName||String||| ​  ​||TransHeader.TaxClassOverridden||Boolean||| ​  ​||TransHeader.TaxNumber||String||| ​  ​||TransHeader.TemplateNumber||Number||| ​  ​||TransHeader.TransactionType||TransactionType||| ​  ​||TransHeader.UseTaxClassLookup||Boolean||| ​  ​||TransHeader.Version||Number||| ​  ​||TransHeader.VoidedDate||DateTime||| ​  ​||TransHeader.WriteOffAmount||Number||| |**Object.FieldName** ||**Data Type** ||**Description** ||   ​||TransHeader.Account||Account||| ​  ​||TransHeader.ActiveVariation||TransVariation||| ​  ​||TransHeader.BalanceDue||Number||| ​  ​||TransHeader.BasePrice||Number||| ​  ​||TransHeader.BasePriceStr||String||| ​  ​||TransHeader.BuiltDate||DateTime||| ​  ​||TransHeader.ClosedDate||DateTime||| ​  ​||TransHeader.Contact||Contact||| ​  ​||TransHeader.ContactName||String||| ​  ​||TransHeader.ConvertedDate||DateTime||| ​  ​||TransHeader.CostSet||CostSet||| ​  ​||TransHeader.CreditMemoAmount||Number||| ​  ​||TransHeader.CreditMemoOrder||CustTransHeader||| ​  ​||TransHeader.Customer||Customer||| ​  ​||TransHeader.CustomerContractType||String||| ​  ​||TransHeader.CustomerName||String||| ​  ​||TransHeader.Depth||Number||| ​  ​||TransHeader.Description||String||| ​  ​||TransHeader.DiscountLevel||Number||| ​  ​||TransHeader.DiscountLevelOverridden||Boolean||| ​  ​||TransHeader.DiscountPrice||Number||| ​  ​||TransHeader.DiscountPriceStr||String||| ​  ​||TransHeader.Disposition||Disposition||| ​  ​||TransHeader.DivisionIDOverridden||Boolean||| ​  ​||TransHeader.DueDate||DateTime||| ​  ​||TransHeader.EnteredBy||Employee||| ​  ​||TransHeader.EstimateCreatedDate||DateTime||| ​  ​||TransHeader.EstimateGreeting||String||| ​  ​||TransHeader.EstimateGreetingTemplate||String||| ​  ​||TransHeader.EstimateNumber||Number||| ​  ​||TransHeader.FinanceChargeAmount||Number||| ​  ​||TransHeader.HTMLLongFormat||String||| ​  ​||TransHeader.HTMLShortFormat||String||| ​  ​||TransHeader.InternalNotes||String||| ​  ​||TransHeader.InternalNotesTemplate||String||| ​  ​||TransHeader.InvoiceAddressLink||Address||| ​  ​||TransHeader.InvoiceAddressOverridden||Boolean||| ​  ​||TransHeader.InvoiceContact||Contact||| ​  ​||TransHeader.InvoiceNumber||Number||| ​  ​||TransHeader.InvoiceToText||String||| ​  ​||TransHeader.IsFirmDueDate||Boolean||| ​  ​||TransHeader.IsTaxExempt||Boolean||| ​  ​||TransHeader.LastFinanceChargeDate||DateTime||| ​  ​||TransHeader.LostDate||DateTime||| ​  ​||TransHeader.ManuallyReOpened||Boolean||| ​  ​||TransHeader.ModifierPrice||Number||| ​  ​||TransHeader.ModifierPriceStr||String||| ​  ​||TransHeader.NextRefNumber||Number||| ​  ​||TransHeader.OrderCreatedDate||DateTime||| ​  ​||TransHeader.OrderNotes||String||| ​  ​||TransHeader.OrderNotesTemplate||String||| ​  ​||TransHeader.OrderNumber||Number||| ​  ​||TransHeader.OrderOriginName||String||| ​  ​||TransHeader.ParentHeaderCreated||Boolean||| ​  ​||TransHeader.PartGLList||PartGLEntry Collection||| ​  ​||TransHeader.PaymentTerms||PaymentTerms||| ​  ​||TransHeader.PaymentTermsName||String||| ​  ​||TransHeader.PaymentTotal||Number||| ​  ​||TransHeader.PONumber||String||| ​  ​||TransHeader.PriceSet||PriceSet||| ​  ​||TransHeader.PricingLevel||Number||| ​  ​||TransHeader.PricingLevelName||String||| ​  ​||TransHeader.PricingLevelOverridden||Boolean||| ​  ​||TransHeader.PricingLevelPlan||PricingLevel||| ​  ​||TransHeader.Promotion||Promotion||| ​  ​||TransHeader.PromotionName||String||| ​  ​||TransHeader.ProofDate||DateTime||| ​  ​||TransHeader.SaleDate||DateTime||| ​  ​||TransHeader.SalesDisposition||Disposition||| ​  ​||TransHeader.SalesPerson1||Employee||| ​  ​||TransHeader.SalesPerson2||Employee||| ​  ​||TransHeader.SalesPerson3||Employee||| ​  ​||TransHeader.ServiceTicketNumber||Number||| ​  ​||TransHeader.ShippingCount||Number||This field indicates how many Shipments are on the order. ​ ||   ​||TransHeader.ShippingItems[x]||Array of ShippingItem||This field provides access to the individual shipments on an order.|| ​  ​||TransHeader.ShippingAddressLink||Address||| ​  ​||TransHeader.ShippingAddressOverridden||Boolean||| ​  ​||TransHeader.ShippingCompanyOverridden||Boolean||| ​  ​||TransHeader.ShippingContactOverridden||Boolean||| ​  ​||TransHeader.ShipToText||String||| ​  ​||TransHeader.ShippingTrackingNumbers||String||This pulls all the tracking numbers for all the shipment items into one comma delimited string.|| ​  ​||TransHeader.ShowFlag||Boolean||| ​  ​||TransHeader.StatusFlagShown||Boolean||| ​  ​||TransHeader.StatusID||TransStatus||| ​  ​||TransHeader.StatusName||String||| ​  ​||TransHeader.SubTotalPrice||Number||| ​  ​||TransHeader.SubTotalPriceStr||String||| ​  ​||TransHeader.TaxClass||TaxClass||| ​  ​||TransHeader.TaxClassName||String||| ​  ​||TransHeader.TaxClassOverridden||Boolean||| ​  ​||TransHeader.TaxNumber||String||| ​  ​||TransHeader.TemplateNumber||Number||| ​  ​||TransHeader.TransactionType||TransactionType||| ​  ​||TransHeader.UseTaxClassLookup||Boolean||| ​  ​||TransHeader.Version||Number||| ​  ​||TransHeader.VoidedDate||DateTime||| ​  ​||TransHeader.WriteOffAmount||Number|||
 |**Object.FieldName** ||**Data Type** ||**Description** ||   ​||TransDetail.Account||Account||| ​  ​||TransDetail.BasePrice||Number||| ​  ​||TransDetail.BasePriceStr||String||| ​  ​||TransDetail.ChildItems||TransDetail Collection||| ​  ​||TransDetail.CostSet||CostSet||| ​  ​||TransDetail.Depth||Number||| ​  ​||TransDetail.Description||String||| ​  ​||TransDetail.DetailImage||Graphic||| ​  ​||TransDetail.DiscountLevel||Number||| ​  ​||TransDetail.DiscountLevelOverridden||Boolean||| ​  ​||TransDetail.DiscountPrice||Number||| ​  ​||TransDetail.DiscountPriceStr||String||| ​  ​||TransDetail.GoodsItem||GoodsItem||| ​  ​||TransDetail.GoodsItemCode||String||| ​  ​||TransDetail.HasWorkAssignment||Boolean||| ​  ​||TransDetail.HTMLLongFormat||String||| ​  ​||TransDetail.HTMLShortFormat||String||| ​  ​||TransDetail.InternalNotes||String||| ​  ​||TransDetail.IsComplete||Boolean||| ​  ​||TransDetail.IsPriceCalcLocked||Boolean||| ​  ​||TransDetail.LineItemIndex||Number||| ​  ​||TransDetail.LineItemNumber||String||| ​  ​||TransDetail.LongImage||Graphic||| ​  ​||TransDetail.ModifierCode||String||| ​  ​||TransDetail.ModifierCostSet||CostSet||| ​  ​||TransDetail.ModifierPrice||Number||| ​  ​||TransDetail.ModifierPriceStr||String||| ​  ​||TransDetail.Modifiers||TransMod Collection||| ​  ​||TransDetail.Parameters||TransDetailParam Collection||| ​  ​||TransDetail.ParentHeaderCreated||Boolean||| ​  ​||TransDetail.PriceSet||PriceSet||| ​  ​||TransDetail.PricingLevel||Number||| ​  ​||TransDetail.PricingLevelOverridden||Boolean||| ​  ​||TransDetail.PriorityName||String||| ​  ​||TransDetail.ProductCode||String||| ​  ​||TransDetail.ProductNameOnEstimate||String||| ​  ​||TransDetail.Quantity||Number||| ​  ​||TransDetail.SaleAccountName||String||| ​  ​||TransDetail.SaleAccountOverridden||Boolean||| ​  ​||TransDetail.ServiceTicketItemNumber||Number||| ​  ​||TransDetail.ShippingAddressLink||Address||| ​  ​||TransDetail.ShippingAddressOverridden||Boolean||| ​  ​||TransDetail.ShippingCompanyOverridden||Boolean||| ​  ​||TransDetail.ShippingContactOverridden||Boolean||| ​  ​||TransDetail.ShipToText||String||| ​  ​||TransDetail.ShowFlag||Boolean||| ​  ​||TransDetail.Stage||Stage||| ​  ​||TransDetail.StageName||String||| ​  ​||TransDetail.StatusFlagShown||Boolean||| ​  ​||TransDetail.SubTotalPrice||Number||| ​  ​||TransDetail.SubTotalPriceStr||String||| ​  ​||TransDetail.TaxClass||TaxClass||| ​  ​||TransDetail.TaxClassName||String||| ​  ​||TransDetail.TaxClassOverridden||Boolean||| ​  ​||TransDetail.TicketTypeName||String||| ​  ​||TransDetail.TransactionType||TransactionType||| ​  ​||TransDetail.TransHeaderNumber||Number||| ​  ​||TransDetail.UnitPriceVariableName||String||| ​  ​||TransDetail.UnitPriceVariableValue||Number||| ​  ​||TransDetail.UseTaxClassLookup||Boolean||| ​  ​||**Sonssubtotalprice** ||Number||Returns the total of all child items|| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |**Object.FieldName** ||**Data Type** ||**Description** ||   ​||TransDetail.Account||Account||| ​  ​||TransDetail.BasePrice||Number||| ​  ​||TransDetail.BasePriceStr||String||| ​  ​||TransDetail.ChildItems||TransDetail Collection||| ​  ​||TransDetail.CostSet||CostSet||| ​  ​||TransDetail.Depth||Number||| ​  ​||TransDetail.Description||String||| ​  ​||TransDetail.DetailImage||Graphic||| ​  ​||TransDetail.DiscountLevel||Number||| ​  ​||TransDetail.DiscountLevelOverridden||Boolean||| ​  ​||TransDetail.DiscountPrice||Number||| ​  ​||TransDetail.DiscountPriceStr||String||| ​  ​||TransDetail.GoodsItem||GoodsItem||| ​  ​||TransDetail.GoodsItemCode||String||| ​  ​||TransDetail.HasWorkAssignment||Boolean||| ​  ​||TransDetail.HTMLLongFormat||String||| ​  ​||TransDetail.HTMLShortFormat||String||| ​  ​||TransDetail.InternalNotes||String||| ​  ​||TransDetail.IsComplete||Boolean||| ​  ​||TransDetail.IsPriceCalcLocked||Boolean||| ​  ​||TransDetail.LineItemIndex||Number||| ​  ​||TransDetail.LineItemNumber||String||| ​  ​||TransDetail.LongImage||Graphic||| ​  ​||TransDetail.ModifierCode||String||| ​  ​||TransDetail.ModifierCostSet||CostSet||| ​  ​||TransDetail.ModifierPrice||Number||| ​  ​||TransDetail.ModifierPriceStr||String||| ​  ​||TransDetail.Modifiers||TransMod Collection||| ​  ​||TransDetail.Parameters||TransDetailParam Collection||| ​  ​||TransDetail.ParentHeaderCreated||Boolean||| ​  ​||TransDetail.PriceSet||PriceSet||| ​  ​||TransDetail.PricingLevel||Number||| ​  ​||TransDetail.PricingLevelOverridden||Boolean||| ​  ​||TransDetail.PriorityName||String||| ​  ​||TransDetail.ProductCode||String||| ​  ​||TransDetail.ProductNameOnEstimate||String||| ​  ​||TransDetail.Quantity||Number||| ​  ​||TransDetail.SaleAccountName||String||| ​  ​||TransDetail.SaleAccountOverridden||Boolean||| ​  ​||TransDetail.ServiceTicketItemNumber||Number||| ​  ​||TransDetail.ShippingAddressLink||Address||| ​  ​||TransDetail.ShippingAddressOverridden||Boolean||| ​  ​||TransDetail.ShippingCompanyOverridden||Boolean||| ​  ​||TransDetail.ShippingContactOverridden||Boolean||| ​  ​||TransDetail.ShipToText||String||| ​  ​||TransDetail.ShowFlag||Boolean||| ​  ​||TransDetail.Stage||Stage||| ​  ​||TransDetail.StageName||String||| ​  ​||TransDetail.StatusFlagShown||Boolean||| ​  ​||TransDetail.SubTotalPrice||Number||| ​  ​||TransDetail.SubTotalPriceStr||String||| ​  ​||TransDetail.TaxClass||TaxClass||| ​  ​||TransDetail.TaxClassName||String||| ​  ​||TransDetail.TaxClassOverridden||Boolean||| ​  ​||TransDetail.TicketTypeName||String||| ​  ​||TransDetail.TransactionType||TransactionType||| ​  ​||TransDetail.TransHeaderNumber||Number||| ​  ​||TransDetail.UnitPriceVariableName||String||| ​  ​||TransDetail.UnitPriceVariableValue||Number||| ​  ​||TransDetail.UseTaxClassLookup||Boolean||| ​  ​||**Sonssubtotalprice** ||Number||Returns the total of all child items|| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
-|**Object.FieldName** ||**CFL CODE** ||   ​|| ​  ​|| ​  ​|| ​  ​|||Part Category||Parts[x].Part.PartCategoryName||string|| ​  ​|| ​  ​|| ​  ​|||Part Name||Parts[x]||string|| ​  ​|| ​  ​|| ​  ​|||Price||Parts[x].SuggestedPrice||number|| ​  ​|| ​  ​|| ​  ​|||Cost (Price Before Multiplier)||Parts[x].EstimatedCost||number|| ​  ​|| ​  ​|| ​  ​|||Quantity (Estimated Usage)||Parts[x].EstimatedQuantity||number|| ​  ​|| ​  ​|| ​  ​|||Part Unit Cost||Parts[x].Part.InventoryUnitCost|| ​  ​|| ​  ​|| ​  ​|| ​  ​|||Multiplier||Parts[x].Part.CostMultiplier||Returns a string of the contents of the multiplier field of the part– \\ E.g. if a formula, returns the formula and not the results|| ​  ​|| ​  ​|| ​  ​|||Actual Multiplier (Returns %)||(1-(Parts[counter].part.inventoryunitcost)/​ \\ (Parts[counter].SuggestedPrice/​Parts[counter].EstimatedQuantity))*100|| ​  ​|| ​  ​|| ​  ​|| ​  ​||| ​  ​|| ​  ​|| ​  ​|| ​  ​|| ​  || | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |+|**Object.FieldName** ||**CFL CODE** ||   ​|| ​  ​|| ​  ​|| ​  ​|||Part Category||Parts[x].Part.PartCategoryName||string|| ​  ​|| ​  ​|| ​  ​|||Part Name||Parts[x]||string|| ​  ​|| ​  ​|| ​  ​|||Price||Parts[x].SuggestedPrice||number|| ​  ​|| ​  ​|| ​  ​|||Cost (Price Before Multiplier)||Parts[x].EstimatedCost||number|| ​  ​|| ​  ​|| ​  ​|||Quantity (Estimated Usage)||Parts[x].EstimatedQuantity||number|| ​  ​|| ​  ​|| ​  ​|||Part Unit Cost||Parts[x].Part.InventoryUnitCost|| ​  ​|| ​  ​|| ​  ​|| ​  ​|||Multiplier||Parts[x].Part.CostMultiplier||Returns a string of the contents of the multiplier field of the part– \\ E.g. if a formula, returns the formula and not the results|| ​  ​|| ​  ​|| ​  ​|||Actual Multiplier (Returns %)||(1-(Parts[counter].part.inventoryunitcost)/​ \\ (Parts[counter].SuggestedPrice/​Parts[counter].EstimatedQuantity))*100|| ​  ​|| ​  ​|| ​  ​|| ​  ​||| ​  ​|| ​  ​|| ​  ​|| ​  ​|| ​  || | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
 |**Object.FieldName** ||**Data Type** ||**Description** ||   ​||Product.BarCode||String||| ​  ​||Product.CustNotes||String||Returns the Customer (Invoice) Notes from the product|| ​  ​||Product.Description||String||| ​  ​||Product.ExcludeFromPromotions||Boolean||| ​  ​||Product.Flags||String||| ​  ​||Product.HelpText||String||| ​  ​||Product.Image||Graphic||| ​  ​||Product.InternalNotes||String||| ​  ​||Product.IsChildByDefault||Boolean||| ​  ​||Product.IsTaxExempt||Boolean||| ​  ​||Product.ItemName||String||| ​  ​||Product.NameOnEstimate||String||| ​  ​||Product.PricingPlans||PricingPlanCollection||| ​  ​||Product.PrintAs||String||| ​  ​||Product.ProductCode||String||| ​  ​||Product.ProductionTime||Number||| ​  ​||Product.ReCalcTransHeader||Boolean||| ​  ​||Product.TaxabilityCodeName||String||| ​  ​||Product.Variables||Variables Collection||| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |**Object.FieldName** ||**Data Type** ||**Description** ||   ​||Product.BarCode||String||| ​  ​||Product.CustNotes||String||Returns the Customer (Invoice) Notes from the product|| ​  ​||Product.Description||String||| ​  ​||Product.ExcludeFromPromotions||Boolean||| ​  ​||Product.Flags||String||| ​  ​||Product.HelpText||String||| ​  ​||Product.Image||Graphic||| ​  ​||Product.InternalNotes||String||| ​  ​||Product.IsChildByDefault||Boolean||| ​  ​||Product.IsTaxExempt||Boolean||| ​  ​||Product.ItemName||String||| ​  ​||Product.NameOnEstimate||String||| ​  ​||Product.PricingPlans||PricingPlanCollection||| ​  ​||Product.PrintAs||String||| ​  ​||Product.ProductCode||String||| ​  ​||Product.ProductionTime||Number||| ​  ​||Product.ReCalcTransHeader||Boolean||| ​  ​||Product.TaxabilityCodeName||String||| ​  ​||Product.Variables||Variables Collection||| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
  
 \\ \\
-These references are only valid for CFL being evaluated inside of pricing for a modifier.\\ +These references are only valid for CFL being evaluated inside of pricing for a modifier. 
-|| **Object.FieldName** || **Data Type** || **Description** ||\\ + 
-|| Modifier.BarCode || String |||\\ +|**Object.FieldName** ||**Data Type** ||**Description** ||   ​||Modifier.BarCode||String||| ​  ​||Modifier.DefaultEntryOption||ModEntryOption||| ​  ​||Modifier.DefaultLimitToList||Boolean||| ​  ​||Modifier.DefaultPart2ConsumptionFormula||String||| ​  ​||Modifier.DefaultPartConsumptionFormula||String||| ​  ​||Modifier.DefaultSelectionListID||IDRecord||| ​  ​||Modifier.Description||String||| ​  ​||Modifier.ModifierCode||String||| ​  ​||Modifier.PrintAs||String||| ​  ​||Modifier.Question||String||| ​  ​||Modifier.SaveTransRecord||Boolean||| ​  ​||Modifier.SortOrder||Integer|||
-|| Modifier.DefaultEntryOption || ModEntryOption |||\\ +
-|| Modifier.DefaultLimitToList || Boolean |||\\ +
-|| Modifier.DefaultPart2ConsumptionFormula || String |||\\ +
-|| Modifier.DefaultPartConsumptionFormula || String |||\\ +
-|| Modifier.DefaultSelectionListID || IDRecord |||\\ +
-|| Modifier.Description || String |||\\ +
-|| Modifier.ModifierCode || String |||\\ +
-|| Modifier.PrintAs || String |||\\ +
-|| Modifier.Question || String |||\\ +
-|| Modifier.SaveTransRecord || Boolean |||\\ +
-|| Modifier.SortOrder || Integer |||+
  
 ==== Pricing Plan Property References ==== ==== Pricing Plan Property References ====
  
-These references are only valid for CFL being evaluated inside of pricing for a modifier.\\ +These references are only valid for CFL being evaluated inside of pricing for a modifier. 
-|| **Object.FieldName** || **Data Type** || **Description** ||\\ + 
-|| PricingPlan.GLDepartmentName || String |||\\ +|**Object.FieldName** ||**Data Type** ||**Description** ||   ​||PricingPlan.GLDepartmentName||String||| ​  ​||PricingPlan.InvoiceTemplateName||String||| ​  ​||PricingPlan.Notes||String||| ​  ​||PricingPlan.PricingPlanTypeName||String||| ​  ​||PricingPlan.ScreenTemplateName||String||| ​  ​||PricingPlan.UnitPriceVariableName||String||| ​  ​||PricingPlan.UnitPriceVariableUnitText||String||| ​  ​||PricingPlan.WorkOrderTemplateName||String||| ​  ​||PricingPlan.IncomeAccountName||String||| ​  ​||PricingPlan.FamilyName||String|||
-|| PricingPlan.InvoiceTemplateName || String |||\\ +
-|| PricingPlan.Notes || String |||\\ +
-|| PricingPlan.PricingPlanTypeName || String |||\\ +
-|| PricingPlan.ScreenTemplateName || String |||\\ +
-|| PricingPlan.UnitPriceVariableName || String |||\\ +
-|| PricingPlan.UnitPriceVariableUnitText || String |||\\ +
-|| PricingPlan.WorkOrderTemplateName || String |||\\ +
-|| PricingPlan.IncomeAccountName || String |||\\ +
-|| PricingPlan.FamilyName || String |||+
  
 ==== Supporting Object References ==== ==== Supporting Object References ====
Line 68: Line 46:
 In the following property references, the user would replace the object name (like "​Address"​) with the appropriate direct reference, as in the example below:\\ In the following property references, the user would replace the object name (like "​Address"​) with the appropriate direct reference, as in the example below:\\
 \\ \\
-Do not use Address.FormattedAddress,​ instead, use TransHeader.ShippingAddressLink.FormattedAddress\\+Do not use Address.FormattedAddress,​ instead, use TransHeader.ShippingAddressLink.FormattedAddress 
 ==== Address Property References ==== ==== Address Property References ====
  
Line 196: Line 175:
 PartByName("​Grommet",​ 1) * PartByVariableName("​Accessory1",​ 1) PartByName("​Grommet",​ 1) * PartByVariableName("​Accessory1",​ 1)
 </​code>​ </​code>​
- 
  
 The following properties are available for you to access information about the part using the reference notation The following properties are available for you to access information about the part using the reference notation