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/Discount Group — entity reference
REFERENCE · Last reviewed

Discount Group — entity reference

A container for contract-discount percentages that DiscountGroupService stamps onto a document header when the header has none. Candidates must be active and carry a DiscountType of exactly 'Sale Price' or 'Purchase Price', and must fit the document on partner account, branch, partner account group and customer account group, where group membership comes from AccountGroupMember rows in an account group of type Discount. The percentages themselves live in child DiscountGroupRule rows, and the IncentiveEngine can overwrite a document's discount group from a compensation slab.

Fields

FieldLabelTypeRequiredWhat it does
BranchIdBranchLookup → BranchConfines the group to documents raised in that branch; empty means every branch. Branch is the first ordering key among matching groups, so a branch-specific group is preferred.
ClaimablePercentageClaimable PercentagePercent
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
CustomerAccountGroupIdCustomer Account GroupLookup → AccountGroupRestricts the group to customers in that account group, resolved from AccountGroupMember rows whose account group is of type Discount. Groups of any other type are invisible here.
DiscountTypeDiscount TypePickListYesMust read exactly 'Sale Price' or 'Purchase Price'. The selector coerces anything that is not the sale value to the purchase value before comparing, so a typo or a blank effectively files the group under purchase and it will never be chosen for a sales document. Values: Sale Price, Purchase Price.
IdIdGuidYes
IsActiveActiveBooleanOnly active groups are considered when a document header is given a discount group; deactivating a group stops new documents picking it up but does not disturb groups already stored on existing documents.
IsClaimableClaimableBooleanThe claims engine decides claimability from the scheme's own claimable flag, not from this one, so setting it here does not make a discount recoverable.
IsDefaultDefaultBooleanStored but never consulted by the selector — unlike price lists, discount-group selection has no default fallback, so a document that matches no scoped group simply ends up with no discount group and no contract discount.
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextYes
OwnerIdOwnerLookup → UserAccountYes
PartnerAccountGroupIdPartner Account GroupLookup → AccountGroupRestricts the group to documents whose partner account belongs to that group, again through AccountGroupMember rows in an account group of type Discount.
PartnerAccountIdPartner AccountLookup → AccountConfines the group to documents for that partner account; empty means all partners. It ranks second behind branch when several groups match.
RecordTypeIdRecord TypeGuid, hidden
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete the selected records.
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete in a list page
EditEditEditEdit
EditInLineEditEditInlineDelete in page.
EditInListEditEditEdit
EditListHeaderEditEditInlineEditListHeader
NewNewNewNew
UIActionUI ActionUIActionUI Action

Lookup filters

FilterLookup fieldNotes
Partner Account FilterPartnerAccountId
Related BranchBranchId