xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField SalesCRMRewardsClaimsInventoryProcurementWarehouse ManagementField ServiceServiceSupportTelephony & MessagingFinance & AccountingPayrollExpense ManagementCommercePortalsAnalytics & ReportingData StudioMobile AppSee all products →
PLATFORM
Platform overviewApp BuilderAutomationIntegrationsSecurity & GovernanceChange ManagementDevelopers
SENSE AI
Sense AI overviewSense AssistSense ControlSense VisionAI StudioTrust & governanceIn Claude & ChatGPTUse cases
SOLUTIONS
FMCG & DistributionManufacturing & Dealer NetworksAutomotive & DealershipsPharma & HealthcareConsumer DurablesAgri-InputsBuilding MaterialsService NetworksWarehousing & 3PLFinancial AccountingERP SoftwareIndia GST ComplianceUAE VAT & e-InvoicingSaudi ZATCA & VATAll solutions →
RESOURCES
Knowledge CenterDeveloper & CLIBlogGuidesWhat is xMatix?Company facts
COMPANY
AboutCareersPartnersEventsContactAuthorsLegal
Sign in Request demo
Home/Docs/Entity Reference/Payment Batch — entity reference
REFERENCE · Last reviewed

Payment Batch — entity reference

A header intended to group money movements for one bank run — an outgoing vendor payment file or an incoming customer deposit slip, distinguished by BatchType — with a count and total rolled up from its lines. In the current code base it is a metadata-only structure: no entity handler, server action or job creates a batch, rolls it up or advances its state. The roll-up helper PaymentBatchService.RecomputeTotalsAsync exists but is invoked from nothing except an integration test, and the NEFT/RTGS and cheque-register exports select Payment rows by company and date range without consulting batches at all.

Fields

FieldLabelTypeRequiredWhat it does
BankAccountIdBank AccountLookup → BankAccountThe company bank account the run is drawn on or deposited into. It is a plain reference — no posting, file export or reconciliation path reads it today, so it records intent rather than driving the money side of anything.
BatchDateBatch DateDateAndTime
BatchTypeBatch TypeTextDistinguishes an outgoing vendor payment run from an incoming customer deposit slip, with 'Payment' as the default. It has no seeded pick list, and no code branches on it today — the roll-up helper merely echoes it back — so it is descriptive metadata rather than a behavioural switch.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
IdIdGuidYes
ItemCountItem CountNumberMeant to be the number of non-deleted lines in the batch, set alongside the total by the same roll-up routine. Since nothing invokes that routine outside tests, it is not maintained automatically and should be verified against the actual lines before being trusted.
ModifiedByIdModified ByLookup → UserAccountYes
NameDocument NumberTextYes
OwnerIdOwnerLookup → UserAccountYes
PartnerAccountIdPartner AccountLookup → Account
RecordTypeIdRecord TypeGuid, hidden
ReferenceReferenceText
StatusStatusTextAny movement here is manual data entry and implies nothing about whether a bank file was produced or the member payments were posted.
TotalAmountTotal AmountCurrencyMeant to be the sum of the non-deleted line amounts, rounded to two decimals.
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
CloneCloneServerAction (Clone)Create a copy of this record
DeleteEntityDeleteDeleteDeleteEntity
DeleteListHeaderDeleteDeleteDeleteListHeader
DeleteListRowDeleteDeleteDeleteListRow
EditEntityEditEditEdit
EditInLineEditInLineEditInlineEditInLine
EditListRowEditEditEditListRow
NewNewNewNew