Payment — entity reference

A single money movement: a customer receipt (Payment Type Payment Taken) or a payment you make, for example to a supplier (Payment Given). It is recorded on the payment form, which lists the account's open documents so the payment can be applied to invoices, bills, orders, credit and debit notes or expense vouchers. When the payment's company has GL posting enabled, saving a new payment posts it immediately: the money side goes to the bank account picked on the form or, failing that, to the company's account for the mode (Cash, Bank, Cheques In Hand or Credit Card), against accounts receivable or payable. Whatever is not applied stays on the account as an advance.

Fields

Field	Label	Type	Required	What it does
`AccountId`	Account	Lookup → Account		The customer who paid or the supplier who was paid. Selecting it on the payment form loads the account's open documents. Locked once the payment is saved.
`AdjustedAmount`	Adjusted Amount	Currency		How much of the payment has been applied to documents, maintained from the payment's allocations.
`Amount`	Amount	Currency		The total amount of money, always positive; the direction comes from Payment Type. Must be greater than zero. Changing it on a posted payment re-posts the payment.
`BankName`	Bank Name	Text		The bank named on a cheque or card, or the bank of the company bank account picked in Deposited to / Paid from.
`BillId`	Bill	Lookup → Bill		Legacy direct link to a bill. Payments are now applied to bills through allocations made on the payment form or with Apply payment on the bill, and this field is not filled by the standard form.
`BranchId`	Branch	Lookup → Branch		The branch of the company whose books take the payment. Defaults to the user's own branch; required when the company works with branches. Locked once saved.
`CardExpiry`	Card Expiry	Date		Expiry date of the card used, entered on the payment form in Bank mode.
`CardNumber`	Card Number	Number		Card number entered in Bank mode. Enter only the last four digits.
`CardType`	Card Type	PickList		Credit card or debit card, entered in Bank mode. Values: 3.
`ChequeDate`	Cheque Date	Date		The date written on the cheque.
`ChequeNumber`	Cheque Number	Number		The cheque number. For a cheque you pay out, leaving it empty takes the next number from the company's active cheque register.
`ClaimId`	Claim	Lookup → Claim		Not filled by the standard screens.
`ClaimReconciliationId`	Claim Reconciliation	Lookup → ClaimReconciliation		Not filled by the standard screens.
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`CreditNoteId`	Credit Note	Lookup → CreditNote		On a refund payment, the credit note being refunded. Not on the standard payment form.
`DebitNoteId`	Debit Note	Lookup → DebitNote		Not filled by the standard payment form; debit notes are applied to bills through allocations.
`ElectronicMode`	Electronic Mode	PickList		The transfer method for an Electronic Transfer payment, such as NEFT, RTGS, IMPS or UPI. Values: 2.
`ExpenseVoucherId`	Expense Voucher	Lookup → ExpenseVoucher		Legacy direct link to an expense voucher. Vouchers are now settled through allocations made on the payment form.
`ExternalId`	External	Text, unique		Reference of the payment in an external system, such as an online payment gateway or an accounting integration.
`GeneralLedgerId`	General Ledger	Lookup → GeneralLedger		Not filled for payments; the posted journal is found from the payment itself.
`GLAccountId`	GL Account	Lookup → GLAccount		The money-side GL account the payment posts to. Set by choosing a bank account in Deposited to / Paid from. When empty, posting uses a Payment posting definition with role Header or the company's account of the type matching the mode.
`GLAmount`	GL Amount	Calculated		Calculated signed amount: positive for a receipt, negative for a payment given. Posting uses Amount.
`Id`	Id	Guid	Yes
`InvoiceId`	Invoice	Lookup → Invoice		Legacy direct link to an invoice. Payments are now applied to invoices through allocations made on the payment form or with Apply payment on the invoice, and this field is not filled by the standard form.
`IsGLPosted`	GL Posted	Boolean		Not filled for payments; use GL Posting Status.
`IsGLPostingApproved`	GL Posting Approved	Boolean		Set by posting when a new payment is saved in a company with GL posting enabled. The Post General Ledger action sets it for a payment that was saved while posting was off.
`IsRelatedGLPosted`	Related GL Posted	Boolean		Not used.
`LastModifiedById`	LastModifiedBy	Guid		Not stored.
`ModeOfPayment`	Mode Of Payment	PickList		How the money moved, chosen under How was it paid? on the payment form. Cash posts to Cash, Bank and Electronic Transfer to Bank, Cheque to Cheques In Hand (Bank if the company has none), Card to Credit Card when paying out or Bank when receiving; any other value posts to Cash. Values: Cash, Cheque, Bank, Electronic Transfer.
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`Name`	Document Number	Text		The payment's document number, set from the PAY series.
`Name (dup-9bd92512)`	Document Number	Text
`OpenAmount`	Open Amount	Calculated (calculated)		What is still unapplied: Amount minus Adjusted Amount, less any related GL amount. This is the advance left on the account.
`OrderId`	Order	Lookup → Order		The sales order a receipt was taken against as an advance. The payment stays open and is applied to the invoice raised from the order.
`OwnerId`	Owner	Lookup → UserAccount	Yes
`PartnerAccountId`	Partner Account	Lookup → Account		The company (partner account) whose books take the payment. Defaults to the user's own company. GL posting must be enabled on it for the payment to post. Locked once saved.
`PaymentDate`	Document Date	Date		The accounting date of the payment; its fiscal period must be open. Defaults to today.
`PaymentMode`	PaymentMode	Text		A second copy of the mode, read by the cheque register: a payment creates its cheque transaction only when this is Cheque. The web payment form fills it with the same value as Mode Of Payment; the mobile app does not.
`PaymentType`	Payment Type	PickList		Payment Taken (a receipt from a customer, posted against accounts receivable) or Payment Given (a payment you make, posted against accounts payable). Defaults to Payment Taken; locked once saved. Values: Payment Given, Payment Taken.
`PayrollRunId`	Payroll Run	Lookup → PayrollRun		Not filled by the standard screens; payroll is paid through payroll payment batches.
`PurchaseOrderId`	Purchase Order	Lookup → PurchaseOrder		The purchase order a supplier payment was made against as an advance. It is applied to the bill raised from that order.
`RecordTypeId`	Record Type	Guid, hidden
`RelatedGeneralLedgerId`	Related General Ledger	Lookup → GeneralLedger		Not filled by the standard screens.
`RelatedGLAccountId`	Related GL Account	Lookup → GLAccount		Optional account for a third journal line, such as exchange gain or loss or bank charges. Must be filled together with Related GL Amount. Not on the standard web form.
`RelatedGLAmount`	Related GL Amount	Calculated		Amount of the third journal line: positive for a gain, negative for a charge or loss. Must be smaller than the payment amount.
`Remarks`	Remarks	LongMultiLineText		Free text entered on the payment form and shown on the receipt.
`ServiceOrderId`	Service Order	Lookup → ServiceOrder		The service order a receipt was taken against.
`Status`	Status	PickList		Draft when the payment is created; set to Posted when the payment posts, and back to Draft if the posting is withdrawn. Not changed when a cheque bounces. Values: Draft, Posted.
`TransactionDate`	Transaction Date	Date		The date the bank executed an electronic transfer.
`TransactionReference`	Transaction Reference	Text		The bank's reference for the payment, entered as the UTR number for an electronic transfer.
`UIProps`	UI Props	Text
`UpdatedDateTime`	Modified Date	DateAndTime	Yes

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
`EditEntity`	Edit	Edit	EditEntity
`EditInLine`	Edit	EditInline	Delete in page.
`EditInList`	Edit	EditInline	Edit
`EditListRow`	Edit	Edit	EditListRow
`New`	New	New	New
`PostGeneralLedger`	Post General Ledger	ServerAction (`PostGeneralLedger`)	Despite the name, the action body only turns IsGLPostingApproved on and saves. The journal, the settlement allocation or on-account open item, and the cheque, TDS and TCS side effects are all produced afterwards by the payment's save pipeline, which posts whenever that flag becomes true. Payments created through the ordinary insert path already post without this action, so it is mainly a way to post one that was entered while GL posting was withheld.
`UIAction`	UI Action	UIAction	A placeholder entry of UI type; the payment handler supports only PostGeneralLedger, so nothing on the server claims this name and invoking it performs no server-side work.

Lookup filters

Filter	Lookup field	Notes
BranchFilter	`BranchId`
Customer Account Filter	`AccountId`
PartnerAccountFilter	`PartnerAccountId`

PayrollRun — looks up via PayrollRunId
GLAccount — looks up via GLAccountId
GLAccount — looks up via RelatedGLAccountId
ServiceOrder — looks up via ServiceOrderId
Account — looks up via AccountId
Invoice — looks up via InvoiceId
UserAccount — looks up via OwnerId
ExpenseVoucher — looks up via ExpenseVoucherId
Account — looks up via PartnerAccountId
Order — looks up via OrderId
Branch — looks up via BranchId
Claim — looks up via ClaimId
Bill — looks up via BillId
DebitNote — looks up via DebitNoteId
GeneralLedger — looks up via GeneralLedgerId
UserAccount — looks up via ModifiedById
CreditNote — looks up via CreditNoteId
PurchaseOrder — looks up via PurchaseOrderId
ClaimReconciliation — looks up via ClaimReconciliationId
UserAccount — looks up via CreatedById
GeneralLedger — looks up via RelatedGeneralLedgerId
PaymentAdjustment — referenced by via PaymentId
Journal — referenced by via SourceRecordId
InterestCharge — referenced by via SourceRecordId
Visit — referenced by via PaymentId
VisitTaskActivity — referenced by via PaymentId
SettlementAllocation — referenced by via PaymentId
OpenTransaction — referenced by via SourceRecordId

Payment — entity reference

Fields

Actions

Lookup filters

Related entities

Related topics