xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField SalesCRMRewardsClaimsInventoryProcurementWarehouse ManagementField ServiceServiceSupportTelephony & MessagingFinance & AccountingPayrollExpense ManagementCommercePortalsAnalytics & ReportingData StudioMobile AppSee all products →
PLATFORM
Platform overviewApp BuilderAutomationIntegrationsSecurity & GovernanceChange ManagementDevelopers
SENSE AI
Sense AI overviewSense AssistSense ControlSense VisionAI StudioTrust & governanceIn Claude & ChatGPTUse cases
SOLUTIONS
FMCG & DistributionManufacturing & Dealer NetworksAutomotive & DealershipsPharma & HealthcareConsumer DurablesAgri-InputsBuilding MaterialsService NetworksWarehousing & 3PLFinancial AccountingERP SoftwareIndia GST ComplianceUAE VAT & e-InvoicingSaudi ZATCA & VATAll solutions →
RESOURCES
Knowledge CenterDeveloper & CLIBlogGuidesWhat is xMatix?Company facts
COMPANY
AboutCareersPartnersEventsContactAuthorsLegal
Sign in Request demo
Home/Docs/Entity Reference/Price List — entity reference
REFERENCE · Last reviewed

Price List — entity reference

A named collection of item prices whose actual amounts live in child PriceListRule rows. Two separate resolutions use it: PriceListService fills in a document header's price list when it is empty, keeping only active lists of the requested type whose partner account, branch, partner account group and (sale side only) customer account group fit the document, ordering them by SequenceNumber, then branch, partner account, partner account group, customer account group, IsDefault and finally oldest created, and taking the first match. PriceListRuleService then prices each line from the line's own price list, else the parent document's, else any list flagged as the default. Account-group membership is read from AccountGroupMember rows whose account group is of type Price.

Fields

FieldLabelTypeRequiredWhat it does
BranchIdBranchLookup → BranchConfines the list to documents raised in that branch; leaving it empty makes the list eligible for every branch, and a branch-specific list outranks an unscoped one during selection.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
CustomerAccountGroupIdCustomer Account GroupLookup → AccountGroupRestricts the list to customers belonging to that account group, with membership resolved from active AccountGroupMember rows whose account group is of type Price. It is only evaluated when defaulting a sale-side price list; purchase-side selection ignores it entirely.
CustomerAccountIdCustomerAccountGuidScope by customer account group instead.
ExternalIdExternalGuid
IdIdGuidYes
IsActiveActiveBooleanOnly active lists are eligible for automatic price-list defaulting on a document header. It is not re-checked when a line is priced, so an inactive list already stored on a header or line still supplies its rules.
IsDefaultDefaultBooleanMarks the fallback list a line is priced from when neither the line nor its parent document names one. In default-list selection it is only a late tie-break, ranking below sequence number, branch, partner account, partner account group and customer account group.
ModifiedByIdModified ByLookup → UserAccountYes
NameNameText
OwnerIdOwnerLookup → UserAccountYes
PartnerAccountGroupIdPartner Account GroupLookup → AccountGroupRestricts the list to documents whose partner account belongs to that group, again through active AccountGroupMember rows in an account group of type Price. Unlike the customer group, it is evaluated on both the sale and purchase sides.
PartnerAccountIdPartner AccountLookup → AccountConfines the list to documents for that partner account; empty means the list is open to all partners, and a partner-specific list is preferred over an unscoped one.
PartnerGroupIdPartnerGroupGuidPopulating this one changes nothing.
PriceListTypePrice List TypePickListYesFilters which lists are eligible when a document header's price list is defaulted: the caller's type is normalised to 'Sale Price' or 'Purchase Price' first, so a list typed 'Cost Price' — although the pick list offers it — is never auto-selected onto a document. It plays no part in choosing a price once a list is already attached. Values: Cost Price, Sale Price, Purchase Price.
RecordTypeIdRecord TypeGuid, hidden
SequenceNumberSequence NumberNumberThe primary ranking key when several lists match a document: higher values are considered first and the first match is taken. It has no bearing on which price is chosen inside a list.
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete the selected records.
CloneCloneServerAction (Clone)Runs the platform's generic record clone rather than opening a form: it copies every persisted column and custom field of the price list onto a new record, then deep-copies the child rows the delete cascade owns, so the copy comes with its price rules. Identity, audit, soft-delete and job columns are not copied, unique fields other than the name are blanked, and the new record is named after the source with a copy suffix unless document numbering overwrites it. The copies go through the normal save pipeline, so defaults, validation and audit all apply.
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete in a list page
EditEditEditEdit
EditInLineEditEditInlineEdit In Pages
EditInListEditEditEdit
EditListHeaderEditEditInlineEditListHeader
NewNewNewNEW