PR
PREarningDetail
A record detailing a payment's earnings of a specific type.
View API Entity: BatchEarningDetail
/entity/Default/25.200.001/BatchEarningDetail| Field Name | Type | Display Name | Foreign Key | |
|---|---|---|---|---|
AccountID API | int | Account | Account | |
Description:The unique identifier of the earnings account associated with the selected earning type. The field is included in FK.Account. The value of this field corresponds to the value of the Account.AccountID field. | ||||
bool? | - | |||
Description:A boolean value that specifies (if set to true) that the earning detail may be copied. | ||||
Amount API | decimal | Amount | - | |
Description:The amount for the line, which is calculated as the number of units or pieces multiplied by the rate. | ||||
BaseOvertimeRecordID | int | Base RecordID | - | |
Description:The unique identifier of the associated regular earning detail if the current one represents overtime earnings. | ||||
BasePTORecordID | int | - | ||
Description:The unique identifier of the associated regular earning detail if the current one represents paid time-off earnings. | ||||
BatchNbr | nvarchar(15) | Batch Number | PRBatch | |
Description:The unique identifier of the payroll batch. The field is included in FK.PayrollBatch. The value of this field corresponds to the value of the PRBatch.BatchNbr field. | ||||
BranchID API | int | Branch | Branch | |
Description:The unique identifier of the company branch. The field is included in FK.Branch. The value of this field corresponds to the value of the Branch.BranchID field. | ||||
CertifiedJob API | bit | Certified Job | - | |
Description:A boolean value that specifies (if set to true) that the specified project is certified. | ||||
CostCodeID API | int | Cost Code | PMCostCode | |
Description:The unique identifier of the applied cost code, if any. The field is included in FK.CostCode. The value of this field corresponds to the value of the PMCostCode.CostCodeID field. | ||||
CreatedByID | uniqueidentifier | Created By | Users | |
Description:No description available | ||||
CreatedByScreenID | char(8) | - | ||
Description:No description available | ||||
CreatedDateTime | datetime | - | ||
Description:No description available | ||||
Date API | datetime | Date | - | |
Description:The date of the transaction. | ||||
EmployeeAcctCDNonexistent in DB | string | - | ||
Description:The user-friendly unique identifier of the employee. | ||||
EmployeeID API | int | PREmployee | ||
Description:The unique identifier of the employee. The field is included in FK.Employee. The value of this field corresponds to the value of the BAccount.BAccountID field. | ||||
string | Record ID | - | ||
Description:The unique identifier of an earning detail being imported from an Excel document. | ||||
Hours API | decimal | Hours | - | |
Description:The number of earned hours. | ||||
IsAmountBasedNonexistent in DB | bool? | Amount-Based | - | |
Description:A boolean value that specifies (if set to true) that the earning detail is based on a fixed amount as opposed to a rate. | ||||
IsFringeRateEarning | bit | - | ||
Description:A boolean value that specifies (if set to true) that the earning detail represents fringe amounts. | ||||
IsOvertimeNonexistent in DB | bool? | Overtime | - | |
Description:A boolean value that specifies (if set to true) that the earning detail represents overtime earnings. | ||||
IsPayingSettlement | bit | - | ||
Description:A boolean value that specifies (if set to true) that the earning detail line is paying off PTO for settlement purposes. | ||||
IsPieceworkNonexistent in DB | bool? | Piecework | - | |
Description:A boolean value that specifies (if set to true) that the earning detail is based on units other than hours or years. | ||||
IsRegularRate | bit | - | ||
Description:A boolean value that specifies (if set to true) that the rate is the default one, as opposed to overtime for example. | ||||
IsTimeActivityBillableNonexistent in DB | bool? | - | ||
Description:A boolean value that specifies (if set to true) that the associated time activity, if any, represents billable hours. | ||||
LabourItemID API | int | Labor Item | InventoryItem | |
Description:The unique identifier of the labor item, if any. The labor item may change the rate applied to the earning type. The field is included in FK.LaborItem. The value of this field corresponds to the value of the InventoryItem.InventoryID field. | ||||
LastModifiedByID | uniqueidentifier | Last Modified By | Users | |
Description:No description available | ||||
LastModifiedByScreenID | char(8) | - | ||
Description:No description available | ||||
LastModifiedDateTime API | datetime | - | ||
Description:No description available | ||||
LocationID API | int | Location | PRLocation | |
Description:The unique identifier of the work location. The field is included in FK.Location. The value of this field corresponds to the value of the PRLocation.LocationID field. | ||||
ManualRate API | bit | Manual Rate | - | |
Description:A boolean value that specifies (if set to true) that the rate is specified manually. | ||||
PTODisbursementWithAverageRateNonexistent in DB | bool? | - | ||
Description:No description available | ||||
PTODisbursementWithFinancialTransactionNonexistent in DB | bool? | - | ||
Description:No description available | ||||
PaymentDocType | char(3) | Payment Doc. Type | PRPayment | |
Description:The type of the payment. The field is included in FK.Payment. The value of this field corresponds to the value of the PRPayment.DocType field. | ||||
PaymentRefNbr | nvarchar(15) | Payment Ref. Number | PRPayment | |
Description:The unique identifier of the payment. The field is included in FK.Payment. The value of this field corresponds to the value of the PRPayment.RefNbr field. | ||||
ProjectID API | int | Project | PMProject | |
Description:The unique identifier of the associated project. The field is included in FK.Project. The value of this field corresponds to the value of the PMProject.ContractID and PMTask.ProjectID fields. | ||||
ProjectTaskID API | int | Project Task | PMTask | |
Description:The unique identifier of the project task. The field is included in FK.ProjectTask. The value of this field corresponds to the value of the PMTask.TaskID field. | ||||
Rate API | decimal | Rate | - | |
Description:The rate to be multiplied by the units (or pieces, depending on the selected unit type) and any additional factors to determine the gross pay. | ||||
RecordID | int | - | ||
Description:The unique identifier of the earning detail. | ||||
Released | bit | Released | - | |
Description:A boolean value that specifies (if set to true) that the line is released or not. | ||||
ShiftID API | int | Shift Code | EPShiftCode | |
Description:The unique identifier of the work shift during which the activity was performed. The field is included in FK.ShiftCode. The value of this field corresponds to the value of the EPShiftCode.ShiftID field. | ||||
SortingRecordIDNonexistent in DB | int? | Sorting RecordID | - | |
Description:The unique identifier which is used for sorting purposes in BQL queries. The first non-null field from either BaseOvertimeRecordID, BasePTORecordID or RecordID in that specific order. | ||||
SourceCommnPeriod | nvarchar(6) | Source Commn Period | - | |
Description:No description available | ||||
SourceNoteID API | uniqueidentifier | Time Activity | PMTimeActivity | |
Description:The unique global identifier of the associated time activity, if any. | ||||
SourceType | char(3) | Data Source Type | - | |
Description:The type which indicates the origin of the earning detail line. The field can have one of the values described in EarningDetailSourceType.ListAttribute. | ||||
SubID API | int | Subaccount | Sub | |
Description:The unique identifier of the corresponding subaccount. The field is included in FK.Subaccount. The value of this field corresponds to the value of the Sub.SubID field. | ||||
TStamp | timestamp | - | ||
Description:No description available | ||||
TimeCardMinutesNonexistent in DB | int? | - | ||
Description:The amount of minutes logged in the associated time activity, if any. | ||||
TypeCD API | nvarchar(15) | Code | EPEarningType | |
Description:The user-friendly unique identifier of the earning type code. The field is included in FK.EarningType. The value of this field corresponds to the value of the EPEarningType.TypeCD field. | ||||
UnionID API | nvarchar(15) | Union Local | PMUnion | |
Description:The unique identifier of the union local, if any. The union local may change the rate applied to the earning type. The field is included in FK.Union. The value of this field corresponds to the value of the PMUnion.UnionID field. | ||||
UnitType API | char(3) | Unit Type | - | |
Description:The unit of measure for the time entry. The field can have one of the values described in UnitType.ListAttribute. | ||||
Units API | decimal | Units | - | |
Description:The quantity of units (pieces) worked. | ||||
WorkCodeID API | nvarchar(15) | WCC Code | PMWorkCode | |
Description:The unique identifier of the WCC code applied, if any. The field is included in FK.WorkCode. The value of this field corresponds to the value of the PMWorkCode.WorkCodeID field. | ||||