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/Claim Batch — entity reference
REFERENCE · Last reviewed

Claim Batch — entity reference

A working container that groups many Claims through ClaimBatchLine junction rows so they can be populated and reconciled together instead of one at a time. Its PerformPopulateClaimLines action stamps ClaimBatchId and ClaimBatchLineId onto every member claim's ClaimLine rows, and its PerformReconciliation action runs the same inventory-adjustment and sale-invoice creation the single-claim path runs, then marks the batch reconciled. Despite the name it is not a transmission or submission record: no first-party code sends a batch anywhere, assigns it a document number, or tracks an acknowledgement from the principal — submission to the manufacturer is an out-of-platform or integration-flow concern.

Fields

FieldLabelTypeRequiredWhat it does
ApproveAllApprove AllBooleanYesA bulk-approve flag that no code reads. The bulk approve/reject logic only recognises the flag on a Claim record, and the batch's action handler does not support an approve-all action at all, so setting this here has no effect.
BranchIdBranchLookup → Branch
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DocumentDateDocument DateDate
ExternalIdExternalText, unique
IdIdGuidYes
IsClaimLinePopulatedClaim Line PopulatedBooleanYesSet to true when the batch's claim lines have been linked to it. It stays false when the batch has junction rows but no matching claim lines were found, so a false value means 'nothing was linked', not necessarily 'never attempted'.
IsReconciledReconciledBooleanYes
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextYes
OwnerIdOwnerLookup → UserAccountYes
PartnerAccountIdPartner AccountLookup → Account
PerformPopulateClaimLinesPerform Populate Claim LinesBooleanYesTrigger flag for the action that walks the batch's junction rows and stamps ClaimBatchId and ClaimBatchLineId onto every ClaimLine of the member claims. The service clears this flag and sets IsClaimLinePopulated when it finishes — but only if at least one line was actually matched.
PerformReconciliationPerform ReconciliationBooleanYesTrigger flag for the batch-level reconcile: it creates an inventory adjustment and a sale invoice from the batch's claim lines using the same rules as the single-claim path, then marks every line as reconciliation-created and flips the batch to reconciled.
RecordTypeIdRecord TypeGuid, hidden
RejectAllReject AllBooleanYesA bulk-reject flag that no code reads, for the same reason as ApproveAll on this entity: the bulk logic is implemented only for Claim records. Reject lines individually or on the member claims instead.
RemarksRemarksText
StatusStatusPickListBatch state, with only two seeded picklist values, one of which ('Status') is a placeholder left over from setup rather than a real state. No code sets or transitions this column, so it reflects only what a user typed. Values: Status, Draft.
SupplierAccountIdSupplier AccountLookup → Account
TotalApprovedAmountTotal Approved AmountCurrencyYes
TotalApprovedQuantityTotal Approved QuantityDecimal
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete
EditEditEditEdit
EditEntityEditEditEditEntity
EditInLineEditEditEdit
EditListheaderEditEditInlineedit
NewNewNewNew

Validations

ValidationApplies toError messageNotes
XM_TotalApprovedAmountValidationRuleTotalApprovedAmount, ErrorTotal Approved Amount Cannot be NegativeTotal Approved Amount Cannot be Negative
XM_TotalApprovedQuantityValidationRuleTotalApprovedQuantity, ErrorTotal Approved Quantity cannot be NegativeTotal Approved Quantity cannot be Negative