GET v1/payroll/GetUpcomingPayrolls
Get a list of upcoming payrolls that have not been completed yet, including their start and end dates. This can be used to display payroll batches that are currently in progress or scheduled to run in the near future.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of LookupEntity| Name | Description | Type | Additional information |
|---|---|---|---|
| Code | string |
None. |
|
| Description | string |
None. |
|
| EndDate | date |
None. |
|
| ID | Object |
None. |
|
| InActive | boolean |
None. |
|
| SortOrder | integer |
None. |
|
| StartDate | date |
None. |
|
| CodeAndDescription | string |
None. |
|
| LongDescription | string |
None. |
|
| AttachmentCount | integer |
None. |
|
| AdditionalValue | integer |
None. |
|
| GroupID | integer |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"ID": {},
"Code": "sample string 1",
"Description": "sample string 2",
"StartDate": "2026-11-22T00:05:32.6923489-05:00",
"EndDate": "2026-11-22T00:05:32.6923489-05:00",
"SortOrder": 6,
"InActive": true,
"CodeAndDescription": "sample string 1 - sample string 2",
"LongDescription": "sample string 9",
"AttachmentCount": 10,
"AdditionalValue": 11,
"GroupID": 1
},
{
"ID": {},
"Code": "sample string 1",
"Description": "sample string 2",
"StartDate": "2026-11-22T00:05:32.6923489-05:00",
"EndDate": "2026-11-22T00:05:32.6923489-05:00",
"SortOrder": 6,
"InActive": true,
"CodeAndDescription": "sample string 1 - sample string 2",
"LongDescription": "sample string 9",
"AttachmentCount": 10,
"AdditionalValue": 11,
"GroupID": 1
}
]
application/xml, text/xml
Sample:
<ArrayOfLookupEntity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.Entities">
<LookupEntity>
<ID />
<Code>sample string 1</Code>
<Description>sample string 2</Description>
<StartDate>2026-11-22T00:05:32.6923489-05:00</StartDate>
<EndDate>2026-11-22T00:05:32.6923489-05:00</EndDate>
<SortOrder>6</SortOrder>
<InActive>true</InActive>
<CodeAndDescription>sample string 1 - sample string 2</CodeAndDescription>
<AttachmentCount>10</AttachmentCount>
<LongDescription>sample string 9</LongDescription>
<AdditionalValue>11</AdditionalValue>
<GroupID>1</GroupID>
</LookupEntity>
<LookupEntity>
<ID />
<Code>sample string 1</Code>
<Description>sample string 2</Description>
<StartDate>2026-11-22T00:05:32.6923489-05:00</StartDate>
<EndDate>2026-11-22T00:05:32.6923489-05:00</EndDate>
<SortOrder>6</SortOrder>
<InActive>true</InActive>
<CodeAndDescription>sample string 1 - sample string 2</CodeAndDescription>
<AttachmentCount>10</AttachmentCount>
<LongDescription>sample string 9</LongDescription>
<AdditionalValue>11</AdditionalValue>
<GroupID>1</GroupID>
</LookupEntity>
</ArrayOfLookupEntity>