Says what xMatix creates when a claim of one claim type is approved. When an approval process approves a claim, the Settle claim background job looks up the active setup whose Claim Type equals the claim's Claim Type exactly, with no fallback, and creates a Draft credit note or invoice on the claim's supplier account from the approved lines (Unit Price times Approve Quantity), or nothing when the document is None. The claim then becomes Settled. A setup whose Settlement Grouping is PerBatch leaves approved claims for the Batch claims for settlement job and the Settle Batch action instead. With Simulate Mode on, the job only reports what it would create. Setups are listed in the Claims app under Claim Settlement Setups; the mappings, batching and event fields are edited on the record page, not in the create form.
Fields
| Field | Label | Type | Required | What it does |
|---|
ApplyToOpenInvoices | Apply To Open Invoices | Boolean | Yes | When on, a settlement credit note is applied against the supplier account's open invoices, oldest first, right after it is saved. It has no effect on invoice settlement. |
AutoGLPosting | Auto GL Posting | Boolean | Yes | Copied onto the created credit note or invoice as its posting request. A settlement credit note is still created as Draft and is posted with Post General Ledger. |
ClaimType | Claim Type | PickList | Yes | The claim type this setup settles. It must equal the claim's Claim Type exactly, and only one setup per type should be active. Choose the same value your claims carry; a claim type that is not in this setup's own list needs the same value added to it before claims of that type can be settled. 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 | | Optional JSON object that overrides fields on the created document's header. Each key is a document field; each value is a claim field path, @approvedAmount (the claim's Total Approved Amount), @approvedQuantity (its Total Approved Quantity) or @const:<value>. It is applied after xMatix fills the document, and it is not checked on save; an error fails the settlement run. For a batch it reads the first claim. |
IsActive | Active | Boolean | Yes | Only active setups are used by settlement and batching. A new setup starts inactive. |
LineMapping | Line Mapping | MultiLineText | | Optional JSON object that overrides fields on each created document line. Values are claim line field paths, @approvedAmount (Unit Price times Approve Quantity of that line), @approvedQuantity (its Approve Quantity) or @const:<value>. Only lines with an Approve Quantity above zero produce a document line. It is not checked on save. |
ModifiedById | Modified By | Lookup → UserAccount | Yes | |
Name | Document Number | Text | Yes | The setup's name, typed when the setup is created. Nothing numbers setups and the name does not have to be unique. |
OwnerId | Owner | Lookup → UserAccount | Yes | |
RaiseEventName | Raise Event Name | Text | | Optional business-rule event raised on the claim after settlement. It is also raised when the document is None or when no setup matches the claim's type, so a setup can be used for events only. If the event cannot be raised, the settlement still succeeds. |
SettlementDocument | Settlement Document | PickList | Yes | What an approved claim produces, from approved quantity times unit price. Credit Note (the default) or Invoice: a Draft document on the claim's supplier account. Adjustment (Part to Part): a Draft inventory adjustment, per claim only. By line type (adjustment + invoice): per claim only, the approved Part To Part lines become an inventory adjustment and the approved Reimbursment lines an invoice to the supplier; a claim with an approved line of any other type is refused and the lines are named. None creates nothing and only raises the event. Batch settlement accepts only a credit note or an invoice. Values: Credit Note, None. |
SimulateMode | Simulate Mode | Boolean | Yes | When on, the settlement and batching jobs only report what they would create and write nothing, so the claim stays Approved. The reported amount is the claim's Total Approved Amount, not the line total. Claims approved while it was on are not settled automatically when it is switched off; start a settlement run for them. |
UpdatedDateTime | Modified Date | DateAndTime | Yes | |
Actions
| Action | Label | Type | What it does |
|---|
BulkDelete | Delete | Delete | Delete the selected records. |
ClaimSettled | ClaimSettled | ServerAction (ClaimSettled) | Not on any shipped screen and has no server handler. Settlement runs as the Settle claim background job when a claim is approved. |
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. |
