GET v1/Punch/GetClockPunchMetaDataSampleObject

Retrieve a Sample Clock Meta Data Object

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Retrieve a Sample Clock Meta Data Object

ClockPunchMetaData
NameDescriptionTypeAdditional information
EmployeeNumber

string

None.

PunchType

PunchType

None.

TimePunch

date

None.

CostCenter1

string

None.

CostCenter2

string

None.

CostCenter3

string

None.

CostCenter4

string

None.

CostCenter5

string

None.

Job

string

None.

Task

string

None.

Quantity

integer

None.

EntryDetails

string

None.

Note

string

None.

ISExplicit

boolean

None.

PunchID

Should only be filled for edit and leave null for Add Punch

globally unique identifier

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.

Response Formats

application/json, text/json

Sample:
{
  "EmployeeNumber": "sample string 1",
  "PunchType": 0,
  "TimePunch": "2024-03-29T03:03:23.7192864-04:00",
  "CostCenter1": "sample string 3",
  "CostCenter2": "sample string 4",
  "CostCenter3": "sample string 5",
  "CostCenter4": "sample string 6",
  "CostCenter5": "sample string 7",
  "Job": "sample string 8",
  "Task": "sample string 9",
  "Quantity": 10,
  "EntryDetails": "sample string 11",
  "Note": "sample string 12",
  "ISExplicit": true,
  "PunchID": "8e87d1c2-48f2-421a-86ea-c2b2216fc0bd",
  "PayWithCheckDate": "2024-03-29T03:03:23.7192864-04:00",
  "PayWithRunNumber": 1
}

application/xml, text/xml

Sample:
<ClockPunchMetaData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.WebAPI.Models">
  <CostCenter1>sample string 3</CostCenter1>
  <CostCenter2>sample string 4</CostCenter2>
  <CostCenter3>sample string 5</CostCenter3>
  <CostCenter4>sample string 6</CostCenter4>
  <CostCenter5>sample string 7</CostCenter5>
  <EmployeeNumber>sample string 1</EmployeeNumber>
  <EntryDetails>sample string 11</EntryDetails>
  <ISExplicit>true</ISExplicit>
  <Job>sample string 8</Job>
  <Note>sample string 12</Note>
  <PayWithCheckDate>2024-03-29T03:03:23.7192864-04:00</PayWithCheckDate>
  <PayWithRunNumber>1</PayWithRunNumber>
  <PunchID>8e87d1c2-48f2-421a-86ea-c2b2216fc0bd</PunchID>
  <PunchType>In</PunchType>
  <Quantity>10</Quantity>
  <Task>sample string 9</Task>
  <TimePunch>2024-03-29T03:03:23.7192864-04:00</TimePunch>
</ClockPunchMetaData>