One cheque and its clearing lifecycle, either drawn by the company or received from a customer. Rows are normally created automatically when a cheque-mode Payment is saved — drawn from an active register when the number was left blank, otherwise recorded as typed — and they link back to that document by source entity name and source record id. Moving the status to Cleared posts the clearing journal that moves the money between the Cheques In Hand account and the bank; moving it to Bounced reverses the originating document's posted journal. Presented and Cancelled are recorded only and trigger no posting, and the rule that a cheque in a terminal state cannot change state lives in the cheque service rather than in save-time validation, so editing the record directly can still move it out of Cleared or Bounced.
Fields
| Field | Label | Type | Required | What it does |
|---|
Amount | Amount | Currency | | The cheque value, always positive — a save at zero or below is rejected — and the amount of the clearing journal posted when the cheque clears. Direction, not the sign of this figure, decides which way the money moves. |
BankAccountId | Bank Account | Lookup → BankAccount | | The company's bank account the cheque is drawn on. It is populated only when the number was drawn from a register — cheques recorded from a payment with a manually entered number are saved with it empty, which also means the duplicate-number check, scoped per bank account, does not apply to them. |
ChequeDate | Cheque Date | DateAndTime | | The date written on the cheque face. Save is rejected when it is in the future, and it is the date used when a cheque is generated automatically from a payment. |
ChequeNumber | Cheque Number | Text | | The printed cheque number, including the register prefix when one was allocated. It must be unique per bank account, so cheques saved without a bank account escape that check entirely. |
ChequeRegisterId | Cheque Register | Lookup → ChequeRegister | | The cheque book the number came from, set only when the number was allocated automatically. When present it activates the save-time check that the cheque number lies inside that register's start-to-end range. |
ClearedDate | Cleared Date | DateAndTime | | Stamped when the status moves to Cleared, defaulting to today when none is supplied, and it becomes the date of the clearing journal. It is stamped once and is not cleared again if the status is later changed. |
CreatedById | Created By | Lookup → UserAccount | Yes | |
CreatedDateTime | Created On | DateAndTime | Yes | |
Direction | Direction | Text | | Issued for a cheque the company writes, Received for one taken from a customer. It decides which way the clearing journal goes — a received cheque debits the bank and credits Cheques In Hand, an issued one does the reverse — and only issued cheques draw a number from a register. Note that a received cheque is still created with status Issued, so direction and status carry different meanings. |
Id | Id | Guid | Yes | |
ModifiedById | Modified By | Lookup → UserAccount | Yes | |
Name | Name | Text | Yes | |
OwnerId | Owner | Lookup → UserAccount | Yes | |
PartnerAccountId | Partner Account | Lookup → Account | | |
PartyAccountId | Party Account | Lookup → Account | | The customer or supplier on the other side of the cheque, taken from the originating payment's account when the cheque is generated. It is a different link from the partner account, which is the owning company. |
RecordTypeId | Record Type | Guid, hidden | | |
SourceEntityName | Source Entity Name | Text | | The entity name of the money document the cheque came from — in practice Payment. Together with the source record id it is the idempotency key that stops a second cheque being created for the same document. |
SourceRecordId | Source Record | Guid | | The id of the originating money document. |
Status | Status | PickList | | Only Cleared and Bounced do anything — they post the clearing journal and reverse the source document respectively — and the terminal-state lock exists only in the cheque service, not in save-time validation, so editing the record directly can still move a cleared or bounced cheque back out of that state. |
UIProps | UI Props | Text | | |
UpdatedDateTime | Updated On | DateAndTime | Yes | |
Actions
| Action | Label | Type | What it does |
|---|
Clone | Clone | ServerAction (Clone) | Create a copy of this record |
Delete | Delete | Delete | Delete |
Edit | Edit | Edit | Edit |
EditInline | Edit Inline | EditInline | Edit Inline |
New | New | New | New |
Validations
| Validation | Applies to | Error message | Notes |
|---|
| Amount Validation | Amount, Error | Amount cannot be 0 or Negative | Amount Validation |
Lookup filters
| Filter | Lookup field | Notes |
|---|
| Bank Account Filter | BankAccountId | |
