A group of claims of one claim type that is settled as a single credit note or invoice. Batches are built by the Batch claims for settlement job for claim types whose active Claim Settlement Setup uses Per Batch settlement grouping; claims are grouped by the setup's batch grouping fields (default partner account, branch and supplier account) and optionally by month. The Settle Batch action queues one consolidated settlement from the approved claim lines and then marks the batch and its settled claims Settled. The batch's member claims are the claims whose Claim Batch field points at it.
Fields
| Field | Label | Type | Required | What it does |
|---|
ApproveAll | Approve All | Boolean | Yes | Not read for batches. Approving claim lines happens on each claim, with the claim's own Approve All and Reject All. |
BranchId | Branch | Lookup → Branch | | Branch shared by every claim in the batch when the default grouping is used; copied to the settlement document. |
CreatedById | Created By | Lookup → UserAccount | Yes | |
CreatedDateTime | Created Date | DateAndTime | Yes | |
DocumentDate | Document Date | Date | | Set to the day the batching job created the batch. |
ExternalId | External | Text, unique | | |
Id | Id | Guid | Yes | |
IsClaimLinePopulated | Claim Line Populated | Boolean | Yes | Set when the claims' lines have been stamped with this batch. The batching job sets it as it creates or tops up the batch. |
IsReconciled | Reconciled | Boolean | Yes | Set only by the batch reconciliation routine, which no seeded button runs. A reconciled batch is never reused by the batching job. |
ModifiedById | Modified By | Lookup → UserAccount | Yes | |
Name | Name | Text | Yes | Assigned from the Claim Batch document name setting (default series CBT, the date and a six-digit running number) when the batch is created. |
OwnerId | Owner | Lookup → UserAccount | Yes | |
PartnerAccountId | Partner Account | Lookup → Account | | Partner (company) whose claims are in the batch; copied to the settlement document. |
PerformPopulateClaimLines | Perform Populate Claim Lines | Boolean | Yes | A request flag with no effect on save. The populate routine it belongs to has no button on the seeded screens, and the batching job stamps the lines itself. |
PerformReconciliation | Perform Reconciliation | Boolean | Yes | A request flag with no effect on save. The reconciliation routine it belongs to has no button on the seeded screens. |
RecordTypeId | Record Type | Guid, hidden | | |
RejectAll | Reject All | Boolean | Yes | Not read for batches. Rejecting claim lines happens on each claim. |
Remarks | Remarks | Text | | Free-text note on the batch, edited on the Information tab of the Edit form. Nothing reads it, and it is not copied to the settlement document. |
Status | Status | PickList | | Draft when the batching job creates the batch and Settled after Settle Batch creates the settlement document. Only a Draft batch is topped up by later batching runs. Settled is written by the system and is not one of the shipped picklist values. Values: Status, Draft. |
SupplierAccountId | Supplier Account | Lookup → Account | | The supplier or manufacturer the batch is claimed from; it becomes the party of the settlement credit note or invoice. It is read when Settle Batch runs, so correcting it on a Draft batch changes the settlement party. Settle Batch fails without it. |
TotalApprovedAmount | Total Approved Amount | Currency | Yes | Claimed value of the batch while its claims are undecided, or their approved value once lines are approved; Settle Batch replaces it with the approved value it settles. Zero or a negative value is refused. |
TotalApprovedQuantity | Total Approved Quantity | Decimal | | Claimed quantity while the claims are undecided, or the approved quantity; Settle Batch replaces it with the approved quantity it settles. Zero or a negative value is refused. |
UIProps | UI Props | Text | | |
UpdatedDateTime | Modified Date | DateAndTime | Yes | |
Actions
| Action | Label | Type | What it does |
|---|
BulkDelete | Delete | Delete | Delete |
Clone | Clone | ServerAction (Clone) | Create a copy of this record |
Delete | Delete | Delete | Delete |
DeleteInList | Delete | Delete | Delete |
Edit | Edit | Edit | Edit |
EditEntity | Edit | Edit | EditEntity |
EditInLine | Edit | Edit | Edit |
EditListheader | Edit | EditInline | edit |
New | New | New | New |
Validations
| Validation | Applies to | Error message | Notes |
|---|
| XM_TotalApprovedAmountValidationRule | TotalApprovedAmount, Error | Total Approved Amount Cannot be Negative | Total Approved Amount Cannot be Negative |
| XM_TotalApprovedQuantityValidationRule | TotalApprovedQuantity, Error | Total Approved Quantity cannot be Negative | Total Approved Quantity cannot be Negative |
