Stratus Aperture

API Family:Default

Version:23.200.001

Screen ID:PR301000

Properties

Select a row for its DAC field and description

	Property	Type	Data Type
	`BatchID`	`StringValue`	string
DAC Field:`PX.Objects.PR.PRBatch.BatchNbr` Description:No description available
	`DeductionsAndBenefitsDetails`	`List`	BatchDeductionOrBenefitDetail
DAC Field:Not mapped to a DAC field Description:No description available
	`Description`	`StringValue`	string
DAC Field:`PX.Objects.PR.PRBatch.DocDesc` Description:No description available
	`EarningDetails`	`List`	BatchEarningDetail
DAC Field:Not mapped to a DAC field Description:No description available
	`EmployeeSummary`	`List`	EmployeePaycheckSummary
DAC Field:Not mapped to a DAC field Description:No description available
	`Hold`	`BooleanValue`	boolean
DAC Field:`PX.Objects.PR.PRBatch.Hold` Description:When set to "true" indicates that the document is on hold and thus cannot be released.
	`LastModifiedDateTime`	`DateTimeValue`	DateTime
DAC Field:`PX.Objects.PR.PRBatch.LastModifiedDateTime` Description:No description available
	`NumberofEmployees`	`IntValue`	int
DAC Field:`PX.Objects.PR.PRBatch.NumberOfEmployees` Description:No description available
	`OvertimeRules`	`BatchOvertimeRules`	BatchOvertimeRules
DAC Field:Not mapped to a DAC field Description:No description available
	`PayGroup`	`StringValue`	string
DAC Field:`PX.Objects.PR.PRBatch.PayGroupID` Description:No description available
	`PayPeriod`	`StringValue`	string
DAC Field:`PX.Objects.PR.PRBatch.PayPeriodID` Description:No description available
	`TotalEarnings`	`DecimalValue`	decimal
DAC Field:`PX.Objects.PR.PRBatchTotalsFilter.TotalEarnings` Description:No description available
	`TotalHourQty`	`DecimalValue`	decimal
DAC Field:`PX.Objects.PR.PRBatchTotalsFilter.TotalHourQty` Description:No description available
	`PayrollType`	`StringValue`	string
DAC Field:`PX.Objects.PR.PRBatch.PayrollType` Description:No description available
	`PeriodEnd`	`DateTimeValue`	DateTime
DAC Field:`PX.Objects.PR.PRBatch.EndDate` Description:No description available
	`PeriodStart`	`DateTimeValue`	DateTime
DAC Field:`PX.Objects.PR.PRBatch.StartDate` Description:No description available
	`Status`	`StringValue`	string
DAC Field:`PX.Objects.PR.PRBatch.Status` Description:No description available
	`TransactionDate`	`DateTimeValue`	DateTime
DAC Field:`PX.Objects.PR.PRBatch.TransactionDate` Description:No description available

Minimum Payload

Derived from static analysis of the 2025.2 source; runtime configuration may require additional fields.

{
  "PayGroup": {
    "value": "string"
  },
  "PayPeriod": {
    "value": "string"
  },
  "PeriodEnd": {
    "value": "2025-01-01T00:00:00Z"
  },
  "PeriodStart": {
    "value": "2025-01-01T00:00:00Z"
  },
  "TransactionDate": {
    "value": "2025-01-01T00:00:00Z"
  }
}

For every property this entity accepts, see the properties table.

Optional Children

None of these child collections is required — a payload without them is valid. If you do include one, these are the fields each row of it needs; keys the parent record supplies are named separately and must not be sent.

DeductionsAndBenefitsDetailsa list of BatchDeductionOrBenefitDetailrequired if you include one:DeductionCodesupplied by the parent:BatchNumber
EarningDetailsa list of BatchEarningDetailrequired if you include one:CodeDate

Available in Versions

25.200.001 24.200.001 23.200.001 22.200.001