Claim — entity reference

A trade claim: an amount a partner company recovers from a supplier, manufacturer or principal for warranty and service work, damaged, short or excess goods, scheme payouts and similar. It is created by hand from the Claims app, by a claim generation setup run, or automatically when a service order with Auto Generate Claims lines is invoiced. Its Claim Lines carry the claimed, approved and rejected quantities. When an approval process approves the claim, the settlement job for its claim type creates the settlement document (credit note, invoice or adjustment) on the Supplier Account from the approved lines and sets Status to Settled; claim types settled per batch wait for a claim batch instead.

Fields

Field	Label	Type	Required	What it does
`ApproveAll`	Approve All	Boolean		Request flag for the Approve All routine, which copies every line's Claim Quantity into Approve Quantity and zeroes Reject Quantity. The routine applies this flag rather than the button pressed, and checks it before Reject All. The flag is not on the seeded claim forms and is never cleared.
`AsOndate`	As On Date	Date		Cut-off date for line population when no specific source is linked: service-order lines and supplier-return lines are taken only from documents dated on or before it. Not on the seeded claim forms; claims created from a service order fill it with the order's date.
`BillReturnId`	Bill Return	Lookup → BillReturn		Supplier return (bill return) the claim relates to, for reference. Line population does not read this field.
`BranchId`	Branch	Lookup → Branch		Branch raising the claim. Line population only considers source documents of this branch, and settlement copies it to the settlement document. Read-only on the record page; hidden for an organization with one location.
`ClaimBatchId`	Claim Batch	Lookup → ClaimBatch		Claim batch the claim belongs to. Written by the batching job for claim types settled per batch; a claim with a batch is skipped by later batching runs. Deleting a batch does not clear it.
`ClaimType`	Claim Type	PickList		Kind of claim. It decides how lines are populated (Service reads service orders; Purchase, Damaged, Shortage and Excess read supplier-return credit-note lines; other types are generated or entered by hand) and which Claim Settlement Setup settles the claim, matched on the exact value. Values: Scheme, Marketing, Damaged, Sale, Service, Purchase, Shortage, Excess, Transport, Part To Part.
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`DocumentDate`	Document Date	Date		Date of the claim document. Claims created from a service order get the day they were created.
`ExternalId`	External	Text, unique		Identifier of the claim in an external system, for integrations. Must be unique.
`GenerationKey`	Generation Key	Text		Duplicate guard for claims created by a claim generation setup: claim type, group key and run month. A run skips any group whose key already exists. Blank on hand-made claims.
`GoodsReceiptId`	Goods Receipt	Lookup → GoodsReceipt		Goods receipt the claim relates to, for reference. Not read by line population or settlement.
`Id`	Id	Guid	Yes
`InvoiceGroup`	Invoice Group	PickList		Invoice group of the service-order lines the claim covers. Set on claims created from a service order; when the claim names a service order, line population only takes lines of this invoice group.
`InvoiceId`	Sale Invoice	Lookup → Invoice		Sale invoice the claim relates to, for reference. Not read by line population or settlement.
`IsLinePopulated`	Line Populated	Boolean	Yes	Not set by line population. Check the Claim Lines tab to see whether a claim has lines.
`IsReconciled`	Reconciled	Boolean	Yes	Set when the Perform Reconciliation routine has run. It records that the routine was attempted, not that the supplier has paid.
`ItemServiceContractId`	Service Contract	Lookup → ItemServiceContract		Service contract (warranty or free-service contract) the claim recovers against. When the claim names a service order, line population only takes lines covered by this contract.
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`Name`	Name	Text	Yes	Claim number, assigned on save from the Claim document name setting (default series CN, the date and a six-digit running number).
`OwnerId`	Owner	Lookup → UserAccount	Yes	User who owns the claim. Claims from a generation setup are owned by the resolved resource's user or the branch owner.
`PartnerAccountId`	Partner Account	Lookup → Account		Partner company (the dealer or distributor) raising the claim. Copied to the settlement document; the settlement document's party is the Supplier Account. Read-only on the record page; hidden for an organization with one company.
`PerformPopulateLines`	Perform Populate Lines	Boolean	Yes	Request flag on the create and edit form. Saving with it ticked does not build lines; lines are built only when the Perform Populate Lines action runs, which the seeded record page does not offer.
`PerformReconciliation`	Perform Reconciliation	Boolean	Yes	Request flag on the create and edit form. Saving with it ticked does nothing on its own; the Perform Reconciliation routine clears it when it runs.
`PurchaseReturnId`	Purchase Return	Lookup → PurchaseReturn		Not used. Supplier returns are recorded as bill returns.
`RecordTypeId`	Record Type	Guid, hidden
`RejectAll`	Reject All	Boolean	Yes	Request flag for the Reject All routine, which copies every line's Claim Quantity into Reject Quantity and zeroes Approve Quantity. It applies only when Approve All is off. Not on the seeded claim forms and never cleared.
`Remarks`	Remarks	Text		Free-text notes.
`SchemeId`	Scheme	Lookup → Scheme		Trade scheme the claim comes from. Filled only when a claim generation setup maps it.
`ServiceInvoiceAsOnDate`	Service Invoice As On Date	Date		Not read by line population or settlement.
`ServiceOrderAsonDate`	Service Order As on Date	Date		Not read by line population or settlement; the cut-off used is As On Date.
`ServiceOrderId`	Service Order	Lookup → ServiceOrder		Service order the claim covers. For a Service claim, line population reads this order's claimable lines; without it, population sweeps the branch's invoiced or delivered service orders up to As On Date.
`Status`	Status	PickList		Where the claim is in its life: Draft (default), Pending Approval, Approved, Rejected or Settled. Approval and rejection values are written by the approval process's field updates; settlement sets Settled. Changing it by hand triggers nothing. Values: Draft, Pending Approval, Approved, Rejected, Settled.
`SupplierAccountId`	Supplier Account	Lookup → Account		Supplier, manufacturer or principal the claim is made against. Settlement books the credit note or invoice to this account and refuses to settle without it. Claims from a service order take the contract's billing account; generated claims take the setup's supplier.
`TotalAmount`	Total Amount	Calculated		Claim total. Not calculated from the lines; filled only when a claim generation setup maps it.
`TotalApprovedAmount`	Total Approved Amount	Calculated		Approved total. Not calculated from the lines. When filled, settlement uses it as the settlement document's amount instead of the sum of the approved lines.
`TotalApprovedQuantity`	Total Approved Quantity	Calculated		Not calculated from the lines.
`TotalQuantity`	Total Quantity	Calculated		Not calculated from the lines.
`TotalRejectedAmount`	Total Rejected Amount	Calculated		Not calculated from the lines.
`TotalRejectedQuantity`	Total Rejected Quantity	Calculated		Not calculated from the lines.
`UIProps`	UI Props	Text
`UpdatedDateTime`	Modified Date	DateAndTime	Yes

Actions

Action	Label	Type	What it does
`ApproveAll`	Approve All	UIAction	Approve All. On the seeded record page this button runs nothing, because the action is a UI action with no dialog. When run as a server action it applies the claim's Approve All and Reject All flags to every line's quantities; it does not approve the claim.
`BulkDelete`	Delete	Delete	Delete the selected records.
`Clone`	Clone	ServerAction (`Clone`)	Create a copy of this record
`Delete`	Delete	Delete	Delete
`DeleteInList`	Delete	Delete	Delete
`Edit`	Edit	Edit	Edit
`EditEntity`	Edit	Edit	EditEntity
`EditInLine`	Edit	EditInline	Edit in page.
`EditInList`	Edit	EditInline	Edit list header
`New`	New	New	New
`PerformPopulateLines`	Perform Populate Lines	UIAction	Perform Populate Lines. Not on the seeded record page. When run as a server action it builds claim lines from the source documents for the claim type and marks those source lines as claimed, so a rerun does not duplicate them.
`PerformReconciliation`	Perform Reconciliation	UIAction	Perform Reconciliation. On the seeded record page this button runs nothing, because the action is a UI action with no dialog. When run as a server action it raises a sale invoice on the Supplier Account from the Reimbursment lines with an approved quantity and marks the claim Reconciled.
`RejectAll`	Reject All	UIAction	Reject All. Not on the seeded record page; shares the Approve All routine.

Account — looks up via SupplierAccountId
Branch — looks up via BranchId
ItemServiceContract — looks up via ItemServiceContractId
ClaimBatch — looks up via ClaimBatchId
GoodsReceipt — looks up via GoodsReceiptId
PurchaseReturn — looks up via PurchaseReturnId
UserAccount — looks up via OwnerId
ServiceOrder — looks up via ServiceOrderId
UserAccount — looks up via ModifiedById
UserAccount — looks up via CreatedById
Invoice — looks up via InvoiceId
Account — looks up via PartnerAccountId
Scheme — looks up via SchemeId
ClaimReconciliationLine — referenced by via ClaimId
ClaimBatchLine — referenced by via ClaimId
ClaimLine — referenced by via ClaimId
CreditNote — referenced by via ClaimId
Payment — referenced by via ClaimId
DeliveryOrder — referenced by via ClaimId
ClaimLine — referenced by via BatchClaimId
Adjustment — referenced by via ClaimId
Invoice — referenced by via ClaimId
AdjustmentLine — referenced by via ClaimId

Claim — entity reference

Fields

Actions

Related entities

Related topics