API Docs / Schemas / TimePayRunDto

TimePayRunDto

A payment of tracked time to one team member — the receipt for a batch of their time
entries paid at the cost rates stamped on the entries. Totals were computed when the
run was created and never change; deleting the run releases its entries back to approved.

Properties

Name Type Description
codestring

Unique code for the pay run

Unique code for the pay run

userCodeAndNameDto
createdByCodeAndNameDto
fromEntryDatestring

Entry date of the earliest entry in the run

Entry date of the earliest entry in the run

toEntryDatestring

Entry date of the latest entry in the run

Entry date of the latest entry in the run

totalMinutesinteger

Total minutes paid on the run

Total minutes paid on the run

totalAmountnumber

Total amount paid: hours rounded to 2dp per distinct cost rate, then multiplied by the rate

Total amount paid: hours rounded to 2dp per distinct cost rate, then multiplied by the rate

entryCountinteger

Number of time entries paid on the run

Number of time entries paid on the run

createdDatestring

When the payment was recorded

When the payment was recorded

JSON Example

{
  "code": "string",
  "user": {
    "code": "string",
    "name": "string"
  },
  "createdBy": {
    "code": "string",
    "name": "string"
  },
  "fromEntryDate": "2024-01-01",
  "toEntryDate": "2024-01-01"
}

Used By Operations

Contained in Schemas