Claim Line — entity reference

One claimable item on a Claim, holding the claimed quantity and unit price alongside the approved and rejected splits that everything downstream reads. Lines are written by ClaimLineService when the PerformPopulateLines action runs — from service-order lines flagged 'Generate Claims'/'Auto Generate Claims' with ClaimableQuantity remaining, or from CreditNoteLine rows (the real supplier-return path, TransactionType 'BillReturn') for Purchase, Damaged, Shortage and Excess claims — and by the claims.generate engine, which maps them field-by-field from the setup's LineMapping. The line's own ClaimType, not the header's, steers the follow-ups: 'Part To Part' lines create reject/approve delivery orders when quantities change, and 'Reimbursment' lines with approved quantity let the reconcile action raise a sale invoice.

Fields

Field	Label	Type	Required	What it does
`ApproveAmount`	Approve Amount	Calculated (calculated)		Settlement computes approved value on the fly as UnitPrice times ApproveQuantity rather than reading this column, so it can be blank on fully settled lines.
`ApproveBaseAmount`	Approve Base Amount	Calculated (calculated)
`ApproveDiscount`	ApproveDiscount	Decimal
`ApproveDiscountAmount`	Approve Discount Amount	Currency	Yes
`ApproveNetDiscount`	Approve Net Discount	Calculated (calculated)
`ApproveQuantity`	Approve Quantity	Decimal		The quantity the principal accepted, and the figure everything financial reads: settlement builds the credit note or adjustment only from lines where it is greater than zero, and multiplies it by unit price for the amount. It is set line by line, or in bulk from the header's ApproveAll flag.
`BaseAmount`	Base Amount	Calculated (calculated)
`BatchClaimId`	Batch Claim	Lookup → Claim		A second claim reference, separate from ClaimId, used to point a line at the claim that represents its batch. No first-party service writes it; ClaimId remains the owning-claim link that all line creation and settlement code uses.
`BillReturnLineId`	Bill Return Line	Lookup → BillReturnLine
`BranchId`	Branch	Lookup → Branch
`ClaimAmount`	Claim Amount	Calculated (calculated)		An amount column that no first-party code writes or reads — line value is carried by UnitPrice times ClaimQuantity everywhere in the claim, settlement and reconcile paths. Populated only by tenant rules or imports.
`ClaimBatchId`	Claim Batch	Lookup → ClaimBatch
`ClaimBatchLineId`	Claim Batch Line	Lookup → ClaimBatchLine		Stamped onto the line, together with ClaimBatchId, by the ClaimBatch populate action: it records which batch junction row (and therefore which member claim) brought this line into the batch.
`ClaimId`	Claim	Lookup → Claim	Yes
`ClaimQuantity`	Claim Quantity	Decimal
`ClaimType`	Claim Type	PickList		Line-level type that drives the downstream documents independently of the header's type. 'Part To Part' lines make ClaimLineHandler raise reject or approve delivery orders whenever the rejected or approved quantity changes, and 'Reimbursment' lines with an approved quantity are what allow the reconcile action to raise a sale invoice. Values: Part To Part, Reimbursment, Shortage, Damaged, Marketing.
`ComplaintFaultId`	Complaint Fault	Lookup → ComplaintFault
`ComplaintId`	Complaint	Lookup → Complaint
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`Discount`	Discount	Decimal		For service-contract claim lines this is written as 100 minus the line's service-contract weightage — that is, the share of the value the contract does not cover — rather than a discount the dealer granted.
`DiscountAmount`	Discount Amount	Currency
`ExternalId`	External	Text
`GoodsReceiptId`	Goods Receipt	Lookup → GoodsReceipt
`GoodsReceiptLineId`	Goods Receipt Line	Lookup → GoodsReceiptLine
`Id`	Id	Guid	Yes
`InvoiceLineId`	Invoice Line	Lookup → InvoiceLine
`IsBatchId`	Batch	Boolean	Yes	Do not use it in rules, filters or layouts.
`IsClaimReconciliationCreated`	Claim Reconciliation Created	Boolean		A second, similarly named reconciliation flag that no code path in the platform ever sets or reads. Ignore it when reasoning about reconciliation state and use IsReconciliationCreated instead.
`IsReconciliationCreated`	IsReconciliationCreated	Boolean		Set to true for every line of a ClaimBatch when that batch's reconcile action completes. The single-claim reconcile path does not set it, so it only ever marks batch-processed lines.
`ItemCode`	Item Code	Text
`ItemId`	Item	Lookup → Item
`ItemServiceContractId`	Item Service Contract	Lookup → ItemServiceContract
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`Name`	Name	Text	Yes
`NetDiscount`	Net Discount	Calculated (calculated)
`OwnerId`	Owner	Lookup → UserAccount	Yes
`PartnerAccountId`	Partner Account	Lookup → Account
`PurchaseReturnLineId`	Purchase Return Line	Lookup → PurchaseReturnLine
`RecordTypeId`	Record Type	Guid, hidden
`RejectAmount`	Reject Amount	Calculated (calculated)
`RejectBaseAmount`	Reject Base Amount	Calculated (calculated)
`RejectDiscountAmount`	Reject Discount Amount	Currency
`RejectNetDiscount`	Reject Net Discount	Calculated (calculated)
`RejectQuantity`	Reject Quantity	Number		The quantity the principal refused. Changing it on a 'Part To Part' line triggers creation of a reject delivery order so the physical part is returned; no settlement document is produced from rejected quantity.
`SchemeLedgerId`	Scheme Ledger	Lookup → SchemeLedger		Link back to the scheme-ledger accrual row a trade-scheme claim line was generated from.
`ServiceOrderId`	Service Order	Lookup → ServiceOrder
`ServiceOrderLineId`	Service Order Line	Lookup → ServiceOrderLine
`SourceLineKey`	Source Line Key	Text		Line-level idempotency key for engine-generated lines, formed as the parent claim's GenerationKey plus a discriminator (the source row id for per-record aggregation, or '0' for the single summed line). It is also the merge key when the engine accumulates a group across query chunks: two chunks producing the same key have their amounts added rather than duplicated.
`Status`	Status	PickList		Values: Draft, Approved, Rejected.
`TaxGroupId`	Tax Group	Lookup → TaxGroup
`TechnicianId`	Technician	Lookup → Resource
`TotalAmount`	TotalAmount	Decimal
`UIProps`	UI Props	Text
`UnitPrice`	Unit Price	Currency		Not always a per-unit rate. For service-contract lines it is the source line's unit price, but for weightage lines it holds the whole computed contribution (claimable quantity times unit price times the weightage percentage) against a quantity of one, and for Sum-aggregate engine lines it holds the entire aggregated claim amount for the group, with the netting leg subtracted from it.
`UnitPrice2`	Unit Price	Currency		Treat it as unusable here.
`UpdatedDateTime`	Modified Date	DateAndTime	Yes

Actions

Action	Label	Type	What it does
`Approve`	Approve	UIAction	Approve
`Clone`	Clone	ServerAction (`Clone`)	Create a copy of this record
`Delete`	Delete	Delete	Delete
`DeleteEntity`	Delete	Delete	DeleteEntity
`Edit`	Edit	Edit	Edit
`EditEntity`	Edit	Edit	EditEntity
`EditInLine`	Edit In Line	EditInline	Edit In Line
`EditListRow`	Edit List Row	EditInline	Edit List Row
`New`	New	New	New
`NewInLine`	Quick Add	NewInline	NewInLine
`OpenChecklist`	Open Checklist	UIAction	Opens the claim-checklist layout for the line — a manual verification list (warranty form completed, purchase invoice available, purchase from an authorised dealer, no prior claim on the same invoice) rendered as tick-boxes. It is a UI-only action: no server handler implements it, so it records nothing and changes no field on the claim line.
`Reject`	Reject	UIAction	Reject

Validations

Validation	Applies to	Error message	Notes
XM_ApprovedQuantityValidationRule	`ApproveAmount`, Error	Approved Quantity cannot be Negative	Approved Quantity cannot be Negative
XM_ClaimQuantityValidationRule	`ClaimQuantity`, Error	Claim Quantity cannot be Negative	Claim Quantity cannot be Negative
XM_RejectedQuantityValidationRule	`RejectQuantity`, Error	Rejected Quantity Cannot be Negative	Rejected Quantity Cannot be Negative
XM_UnitPriceValidationRule	`UnitPrice`, Error	Unit Price cannot be Negative	Unit Price cannot be Negative

Account — looks up via PartnerAccountId
GoodsReceipt — looks up via GoodsReceiptId
SchemeLedger — looks up via SchemeLedgerId
ServiceOrder — looks up via ServiceOrderId
Claim — looks up via ClaimId
ServiceOrderLine — looks up via ServiceOrderLineId
TaxGroup — looks up via TaxGroupId
InvoiceLine — looks up via InvoiceLineId
Branch — looks up via BranchId
ItemServiceContract — looks up via ItemServiceContractId
Resource — looks up via TechnicianId
UserAccount — looks up via ModifiedById
ClaimBatch — looks up via ClaimBatchId
UserAccount — looks up via OwnerId
ComplaintFault — looks up via ComplaintFaultId
UserAccount — looks up via CreatedById
PurchaseReturnLine — looks up via PurchaseReturnLineId
Claim — looks up via BatchClaimId
Complaint — looks up via ComplaintId
GoodsReceiptLine — looks up via GoodsReceiptLineId
ClaimBatchLine — looks up via ClaimBatchLineId
Item — looks up via ItemId
ClaimReconciliationLine — referenced by via ClaimLineId
InvoiceLine — referenced by via ClaimLineId
AdjustmentLine — referenced by via ClaimLineId
CreditNoteLine — referenced by via ClaimLineId

Claim Line — entity reference

Fields

Actions

Validations

Related entities

Related topics