Post-approval settlement configuration, one active row per claim type, consumed by the claims.settle job when an approval process returns Approved on a Claim. It decides which document settles the claim, maps that document's header and line fields from the claim using @approvedAmount and @approvedQuantity tokens so partial approvals settle partially, and controls whether the result is marked for posting, knocked off against the partner's open invoices, and announced as a domain event. A missing row for the claim's type is not an error — the job raises any configured event and exits without creating a document.
Fields
| Field | Label | Type | Required | What it does |
|---|
ApplyToOpenInvoices | Apply To Open Invoices | Boolean | Yes | After the credit note is saved, knocks it off against the partner's open invoices oldest first, reducing the note's open amount as it is consumed. It runs as a separate step after the document commits, so it can be retried independently if it fails; it does not apply on the adjustment settlement path. |
AutoGLPosting | Auto GL Posting | Boolean | Yes | Marks the settlement document for posting as it is created — as the credit note's GL-posting flag, or as the inventory-posting flag on the adjustment path. It sets the flag the document's own handlers act on; it does not itself post anything. |
ClaimType | Claim Type | PickList | Yes | The claim type this settlement configuration governs; the settle job looks up the single active setup whose type equals the claim's type, with no fallback. Its picklist offers only the generation engine's coded type vocabulary, so claims carrying the Claim entity's own picklist values (Damaged, Shortage, Service and so on) cannot be matched to a setup through the UI as seeded. Values: Trade Schemes(CLT-04), CLT-04R, QPS Scheme (CLT-04), Cashback(CLT-04), Provision (CLT-04), Structural Rate Difference Contract Pricing, PSR Incentive (CLT6,7), PSR Salary (CG 1,2), Training Claim, Damage, Shortage, Rate Difference, Reimbursment, Sale, Service, Purchase, Excess, Transport, Part To Part. |
CreatedById | Created By | Lookup → UserAccount | Yes | |
CreatedDateTime | Created Date | DateAndTime | Yes | |
HeaderMapping | Header Mapping | MultiLineText | | JSON mapping the settlement document's header fields from claim paths or tokens — a literal constant, the claim's total approved amount, or its total approved quantity. It is applied after the built-in defaults, so it can override the amount, dates, status or transaction type the job would otherwise set. |
IsActive | Active | Boolean | Yes | |
LineMapping | Line Mapping | MultiLineText | | JSON mapping the settlement document's line fields from claim-line paths or tokens, where the approved-amount and approved-quantity tokens resolve per line (unit price times approved quantity, and the approved quantity itself). Only claim lines with an approved quantity above zero produce a settlement line. |
ModifiedById | Modified By | Lookup → UserAccount | Yes | |
Name | Document Number | Text | Yes | |
OwnerId | Owner | Lookup → UserAccount | Yes | |
RaiseEventName | Raise Event Name | Text | | Name of the domain event published after settlement for downstream rules and integrations. Publishing is best-effort — if no event publisher is registered on the host, or publishing throws, the settlement still counts as successful and only a warning is logged. It is also raised when the document type is None or no setup matches, making an events-only settlement possible. |
SettlementDocument | Settlement Document | PickList | Yes | What the settle job creates from an approved claim. Credit Note builds a credit note from the approved figures; the value 'Adjustment' makes it build an inventory part-to-part adjustment instead (the shortage-claim path) but is not offered by the seeded picklist, so it must be set through the API or a rule; None means events only. Any other value fails the job as unsupported. Values: Credit Note, None. |
SimulateMode | Simulate Mode | Boolean | Yes | Defaults to on. In simulate mode the settle job reports the document it would have created and exits without writing anything or stamping the claim — so the claim stays unsettled and will be reconsidered on the next approval event. A per-run payload flag can override it. |
UpdatedDateTime | Modified Date | DateAndTime | Yes | |
Actions
| Action | Label | Type | What it does |
|---|
BulkDelete | Delete | Delete | Delete the selected records. |
ClaimSettled | ClaimSettled | ServerAction (ClaimSettled) | ClaimSettled |
Delete | Delete | Delete | Delete |
DeleteInList | Delete | Delete | Delete the record. |
Edit | Edit | Edit | Edit the ClaimSettlementSetup. |
EditEntity | Edit | Edit | EditEntity |
EditInLine | Edit | EditInline | Edit inline. |
EditInList | Edit | EditInline | Edit inline in the list. |
New | New | New | Create a new ClaimSettlementSetup. |
