POST v1/Punch/AddPaidHour

Add Paid Hours to the system, parameter is Paid Hour Meta Data Object

Request Information

URI Parameters

None.

Body Parameters

The PaidHour MetaData Object.

PaidHourMetaData
NameDescriptionTypeAdditional information
EmployeeNumber

string

None.

Date

date

None.

EarningCode

string

None.

PaidHourType

Set Paid Hour Type

TimeClockPaidHourType

None.

Hours

decimal number

None.

Amount

decimal number

None.

TempRate

decimal number

None.

CostCenter1

string

None.

CostCenter2

string

None.

CostCenter3

string

None.

CostCenter4

string

None.

CostCenter5

string

None.

Job

Valid Job Code

string

None.

Task

Valid Task Code

string

None.

Note

string

None.

PayWithCheckDate

Force to pay back with specified payroll check date, leave null by default

date

None.

PayWithRunNumber

Force to pay back with specified payroll run number (must have CheckDate specified), leave null by default

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "EmployeeNumber": "sample string 1",
  "Date": "2024-04-26T18:05:16.3852086-04:00",
  "EarningCode": "sample string 3",
  "PaidHourType": 0,
  "Hours": 4.0,
  "Amount": 5.0,
  "TempRate": 1.0,
  "CostCenter1": "sample string 6",
  "CostCenter2": "sample string 7",
  "CostCenter3": "sample string 8",
  "CostCenter4": "sample string 9",
  "CostCenter5": "sample string 10",
  "Job": "sample string 11",
  "Task": "sample string 12",
  "Note": "sample string 13",
  "PayWithCheckDate": "2024-04-26T18:05:16.3852086-04:00",
  "PayWithRunNumber": 1
}

application/xml, text/xml

Sample:
<PaidHourMetaData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.WebAPI.Models">
  <Amount>5</Amount>
  <CostCenter1>sample string 6</CostCenter1>
  <CostCenter2>sample string 7</CostCenter2>
  <CostCenter3>sample string 8</CostCenter3>
  <CostCenter4>sample string 9</CostCenter4>
  <CostCenter5>sample string 10</CostCenter5>
  <Date>2024-04-26T18:05:16.3852086-04:00</Date>
  <EarningCode>sample string 3</EarningCode>
  <EmployeeNumber>sample string 1</EmployeeNumber>
  <Hours>4</Hours>
  <Job>sample string 11</Job>
  <Note>sample string 13</Note>
  <PaidHourType>Worked</PaidHourType>
  <PayWithCheckDate>2024-04-26T18:05:16.3852086-04:00</PayWithCheckDate>
  <PayWithRunNumber>1</PayWithRunNumber>
  <Task>sample string 12</Task>
  <TempRate>1</TempRate>
</PaidHourMetaData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.