One settlement of one OpenTransaction by one settling document, and the successor of PaymentAdjustment. The settling document is a Payment (PaymentId) or, for a credit note / advance / write-off document, the polymorphic SourceEntityName + SourceRecordId pair; the single OpenTransactionId FK replaces the six nullable document FKs the legacy design used. Beyond AllocatedAmount it records the non-cash components of the settlement — discount taken, TDS, write-off and rounding — and it POSTS: the allocation carries JournalId, so the ledger and the open items can never drift apart. Reversal is a status change to Reversed, which returns the amount to the open item.
Fields
| Field | Label | Type | Required | What it does |
|---|
AllocatedAmount | Allocated Amount | Currency | | The amount applied to the open item, excluding the non-cash components. Reversing the allocation adds this amount back to OpenTransaction.OpenAmount and returns that item to Open. |
CreatedById | Created By | Lookup → UserAccount | Yes | |
CreatedDateTime | Created On | DateAndTime | Yes | |
DiscountTaken | Discount Taken | Currency | | Settlement (early-payment) discount granted as part of this allocation. It is a non-cash component: it closes part of the open item without money moving, and it posts on the allocation's journal. |
Id | Id | Guid | Yes | |
JournalId | Journal | Lookup → Journal | | The journal this allocation posted. Allocations post precisely so the general ledger and the open items can never disagree — the non-cash components in particular have to reach the ledger. |
Label | Label | Text | | |
ModifiedById | Modified By | Lookup → UserAccount | Yes | |
Name | GL Account Name | Text, unique | Yes | The platform record name/number of the allocation. |
OpenTransactionId | Open Transaction | Lookup → OpenTransaction | | The open item this allocation settles — the single required FK that replaced the legacy design's six nullable document FKs. Every allocation reduces exactly one open item. |
OwnerId | Owner | Lookup → UserAccount | Yes | |
PartnerAccountId | Partner Account | Lookup → Account | | |
PaymentId | Payment | Lookup → Payment | | The payment or receipt doing the settling, when the settling document is a Payment. When it is something else — a credit note, an advance, a write-off document — this is null and the settling document is named by SourceEntityName + SourceRecordId instead. |
RecordTypeId | Record Type | Guid, hidden | | |
RoundingAmount | Rounding Amount | Currency | | Rounding difference absorbed by this settlement, the last of the non-cash components; it posts on the allocation's journal alongside discount, TDS and write-off. |
SettlementDate | Settlement Date | Date | | The date the settlement is effective, and the date its journal is posted on — so it decides which fiscal period the settlement (and any discount, TDS or write-off on it) lands in. |
SourceEntityName | Source Entity Name | Text | | Name of the settling document's entity when it is not a Payment (credit note, advance, write-off document), paired with SourceRecordId. Document reversal finds the allocations a document made by this pair and unwinds only those. |
SourceRecordId | Source Record | Guid | | Id of the settling document row, read together with SourceEntityName. Note this is the SETTLING side; the settled side is OpenTransactionId (whose own source pair identifies the invoice or bill). |
Status | Status | Text | | Posted or Reversed, defaulting to Posted. Reversal does not delete the row: the allocation is marked Reversed and the amount is returned to the open item, keeping the audit trail intact. |
TDSAmount | TDS Amount | Currency | | Withholding tax deducted by the payer on this settlement. Like the discount and write-off components it closes part of the open item without cash and is posted on the allocation's journal, which is why the deduction cannot leave the subledger and the GL disagreeing. |
UIProps | UI Props | Text | | |
UpdatedDateTime | Updated On | DateAndTime | Yes | |
WriteOffAmount | Write Off Amount | Currency | | Balance written off as part of this settlement — the small residual cleared rather than chased. A non-cash component that posts on the allocation's journal. |
Actions
| Action | Label | Type | What it does |
|---|
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 in a list page |
Edit | Edit | Edit | Edit |
EditListRow | Edit | Edit | EditListRow |
New | New | New | New |
