Claim Line — entity reference

One claimed item on a claim: the quantity claimed, its unit price, and the approved and rejected quantities the reviewer decides. Lines are typed in from the claim's Claim Lines tab, created automatically when a service order is invoiced, built by a claim generation setup's line mapping, or built by the claim's Populate Lines routine. Settlement and reconciliation work only from lines with an Approve Quantity greater than zero, priced at Unit Price times Approve Quantity. Line discounts are shown in the line's calculated amounts but are not deducted by settlement. The line's own Claim Type, not the claim's, decides the follow-up documents: Part To Part lines add delivery-order lines when their approved or rejected quantity changes, and Reimbursment lines are the ones a claim reconciliation invoices. Lines are named from the Claim Line document name setting (default series CLN).

Fields

Field	Label	Type	Required	What it does
`ApproveAmount`	Approve Amount	Calculated (calculated)		Calculated on save: Approve Base Amount less Approve Net Discount. It is a display figure only; settlement recomputes the value as Unit Price times Approve Quantity and ignores any approve discount.
`ApproveBaseAmount`	Approve Base Amount	Calculated (calculated)		Calculated on save: Approve Quantity times Unit Price. This is the figure settlement actually pays for the line.
`ApproveDiscount`	ApproveDiscount	Decimal		A fractional discount on the approved part (0.1 means 10 percent), used in Approve Net Discount when Approve Discount Amount is zero. It is on no shipped form. A claim reconciliation copies it to the invoice line it raises.
`ApproveDiscountAmount`	Approve Discount Amount	Currency	Yes	An absolute discount on the approved part. The New and Edit form marks it as required, so enter 0 when there is none. It lowers Approve Amount and is copied to the invoice a claim reconciliation raises, but claim settlement ignores it. The shipped Scheme Claim (Invoice) generation setup writes the scheme amount here.
`ApproveNetDiscount`	Approve Net Discount	Calculated (calculated)		Calculated on save: Approve Discount Amount when it is greater than zero, otherwise Approve Base Amount times Approve Discount.
`ApproveQuantity`	Approve Quantity	Decimal		The quantity the supplier or principal accepted. Defaults to 0 and cannot be negative. It is set by editing the line, by the Approve button in Open Checklist, or by the claim's Approve All routine. Only lines with an Approve Quantity above zero are settled. On a Part To Part line every change adds a line to the claim's approved-part delivery order.
`BaseAmount`	Base Amount	Calculated (calculated)		Calculated on save: Claim Quantity times Unit Price.
`BatchClaimId`	Batch Claim	Lookup → Claim		Not used by xMatix and on no shipped form. The owning claim is always the Claim field.
`BillReturnLineId`	Bill Return Line	Lookup → BillReturnLine		An optional reference to a supplier-return line, offered on the New and Edit form. Nothing reads it: the claim's Populate Lines routine records the return line it used in a separate internal link, not in this field.
`BranchId`	Branch	Lookup → Branch		The branch of the source document. Lines built from a service order or a supplier return take that document's branch. Lines added by hand leave it empty; the claim's own Branch is what counts.
`ClaimAmount`	Claim Amount	Calculated (calculated)		Calculated on save: Base Amount less Net Discount. It is read-only on the form. For a service line shared with other service contracts, this is the claim's share after the contract split, which is lower than Claim Quantity times Unit Price.
`ClaimBatchId`	Claim Batch	Lookup → ClaimBatch		The claim batch this line was gathered into. Written, together with Claim Batch Line, when the batch's lines are populated from its member claims.
`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	The claim the line belongs to. Required, and filled automatically when you add the line from the claim's Claim Lines tab.
`ClaimQuantity`	Claim Quantity	Decimal		The quantity claimed. Defaults to 0, and a value of zero or less is refused on save with Claim Quantity cannot be Negative. For a line raised from a service order line, it is the quantity still claimable on that line, and changing it updates the service order line's claimed quantity.
`ClaimType`	Claim Type	PickList		The line's own type: Damaged, Part To Part, Reimbursment or Shortage. Lines created from a service order are Reimbursment; lines built from supplier returns are left empty; generation-setup lines take the setup's claim type. Part To Part lines raise delivery-order lines when their quantities change, and Reimbursment lines (or untyped service lines) are the ones a claim reconciliation invoices. Values: Part To Part, Reimbursment, Shortage, Damaged, Marketing.
`ComplaintFaultId`	Complaint Fault	Lookup → ComplaintFault		Not filled by xMatix and on no shipped form. Claims raised from service orders copy the technician, service order, service order line and service contract, not the complaint or fault.
`ComplaintId`	Complaint	Lookup → Complaint		Not filled by xMatix and on no shipped form. Claims raised from service orders do not carry the complaint.
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`Discount`	Discount	Decimal		A fractional discount (0.2 means 20 percent), used in Net Discount when Discount Amount is zero. It is on no shipped form. On lines created from a service order whose value is shared with other service contracts, it holds the share those contracts carry, so Claim Amount shows only this claim's part.
`DiscountAmount`	Discount Amount	Currency		An absolute discount on the claimed value. It lowers Net Discount and Claim Amount, but claim settlement does not deduct it. On contract-split lines it holds the contract's share of the service order line's discount.
`ExternalId`	External	Text		A free reference for an outside system's id for the line. It sits in the Amount Details section of the New and Edit form; nothing in xMatix reads it.
`GoodsReceiptId`	Goods Receipt	Lookup → GoodsReceipt		An optional link to the goods receipt behind a damaged, short or excess claim. Reference only.
`GoodsReceiptLineId`	Goods Receipt Line	Lookup → GoodsReceiptLine		The goods receipt line a line was raised from. The shipped Damaged Claim (Goods Receipt) generation setup fills it; otherwise you may set it by hand. Reference only.
`Id`	Id	Guid	Yes
`InvoiceLineId`	Invoice Line	Lookup → InvoiceLine		The sales invoice line a line was raised from. The shipped Scheme Claim (Invoice) generation setup fills it. Shown on the line's Details tab; reference only.
`IsBatchId`	Batch	Boolean	Yes	Not stored. Changes to this tick box are discarded on save, so ignore it.
`IsClaimReconciliationCreated`	Claim Reconciliation Created	Boolean		Never set or read by xMatix. Use the claim's Reconciled box instead.
`IsReconciliationCreated`	IsReconciliationCreated	Boolean		Ticked on every line of a claim batch when that batch's reconciliation routine runs. A single claim's reconciliation does not set it, and the shipped screens offer no batch reconciliation button.
`ItemCode`	Item Code	Text		A free-text item code. Nothing in xMatix fills or reads it, and it is on no shipped form.
`ItemId`	Item	Lookup → Item		The item being claimed. It picks the checklist template that Open Checklist loads, and it becomes the item on the settlement credit note, invoice or adjustment line. For a contract-split service line it is the contract's weightage charge item rather than the serviced item.
`ItemServiceContractId`	Item Service Contract	Lookup → ItemServiceContract		The service contract that owes this line. Filled on lines created from a service order; for a contract-split line it is the contract the line is raised for. Shown on the line's Details tab.
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`Name`	Name	Text	Yes	Assigned on save from the Claim Line document name setting: by default the series CLN, the date and a six-digit running number.
`NetDiscount`	Net Discount	Calculated (calculated)		Calculated on save: Discount Amount when it is greater than zero, otherwise Base Amount times Discount.
`OwnerId`	Owner	Lookup → UserAccount	Yes	The user who owns the line, normally whoever created it.
`PartnerAccountId`	Partner Account	Lookup → Account		Not filled by xMatix's own line-creation paths and on no shipped form. The claim's Partner Account is what counts.
`PurchaseReturnLineId`	Purchase Return Line	Lookup → PurchaseReturnLine		Shown on the line's Details tab, but nothing in xMatix creates purchase return lines, so it is normally empty. Supplier returns are recorded as bill returns.
`RecordTypeId`	Record Type	Guid, hidden
`RejectAmount`	Reject Amount	Calculated (calculated)		Calculated on save from Reject Base Amount less the reject discount. A display figure only: rejected quantities are never paid out.
`RejectBaseAmount`	Reject Base Amount	Calculated (calculated)		Calculated on save: Reject Quantity times Unit Price.
`RejectDiscountAmount`	Reject Discount Amount	Currency		An absolute discount on the rejected part, used only in the line's reject amounts.
`RejectNetDiscount`	Reject Net Discount	Calculated (calculated)		Calculated on save from Reject Discount Amount. Used only in Reject Amount.
`RejectQuantity`	Reject Quantity	Number		The quantity the supplier or principal refused. Defaults to 0 and cannot be negative. It is never settled. On a Part To Part line every change adds a line to the claim's rejected-part delivery order.
`SchemeLedgerId`	Scheme Ledger	Lookup → SchemeLedger		An optional link to a scheme ledger entry. Filled only when a claim generation setup's line mapping writes it. Shown on the line's Details tab.
`ServiceOrderId`	Service Order	Lookup → ServiceOrder		The service order the line comes from. Filled on lines created from a service order.
`ServiceOrderLineId`	Service Order Line	Lookup → ServiceOrderLine		The service order line the line comes from. Every save or delete of the claim line recalculates that service order line's claimed quantity from the claim lines for its own item, which is what stops the same work being claimed twice.
`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		Never set by xMatix and on no shipped form. The approval state lives on the claim, and the decision for each line is its Approve Quantity and Reject Quantity. Values: Draft, Approved, Rejected.
`TaxGroupId`	Tax Group	Lookup → TaxGroup		An optional tax group. A claim reconciliation copies it to the invoice line it raises; settlement does not read it.
`TechnicianId`	Technician	Lookup → Resource		The technician who did the work. Copied from the service order line on lines created from a service order.
`TotalAmount`	TotalAmount	Decimal		A spare amount column. Nothing in xMatix calculates or reads it.
`UIProps`	UI Props	Text
`UnitPrice`	Unit Price	Currency		The price per unit, and the price settlement pays: approved value is Unit Price times Approve Quantity. Required to be greater than zero (Unit Price cannot be Negative). On the New and Edit form it sits in the Related Documents section. On a contract-split service line it holds the contract's whole share against a quantity of one.
`UnitPrice2`	Unit Price	Currency		Not stored. Changes to it are discarded on save, so it never overrides Unit Price.
`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