POST v1/payroll/InsertPayroll?checkDate={checkDate}&runNumber={runNumber}

Add payroll entries to a payroll batch for a given check date and run number. If the batch doesn't exist, it will be created. If the PayEntry for an employee and pay number doesn't exist, it will be created. If the PayEntry exists, it will be updated with the provided data. This allows for flexible importing of payroll data from external systems.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
checkDate

The check date for the payroll batch.

date

Required

runNumber

The run number for the payroll batch.

integer

Required

Body Parameters

The list of payroll metadata objects.

Collection of PayrollMetaData
NameDescriptionTypeAdditional information
EmployeeNumber

Employee number (required)

string

Required

PayNumber

Pay number (required, must be > 0)

integer

Required

PayCode

Code for earning/deduction/tax (required)

string

Required

RecordType

Record type: E = Earning, D = Deduction, T = Tax (defaults to E if not specified)

string

None.

Hours

Hours worked (for earnings)

decimal number

None.

Rate

Rate per hour/unit

decimal number

None.

Amount

Dollar amount (for fixed amounts or deductions)

decimal number

None.

RateCode

Rate code

string

None.

CostCenter1

Cost center 1 code

string

None.

CostCenter2

Cost center 2 code

string

None.

CostCenter3

Cost center 3 code

string

None.

CostCenter4

Cost center 4 code

string

None.

CostCenter5

Cost center 5 code

string

None.

Job

Job code

string

None.

JobMapCode

Job mapping code (alternative to Job)

string

None.

Task

Task code

string

None.

TaxLocation

Tax location code

string

None.

PeriodBegin

Period begin date (overrides payroll default)

date

None.

PeriodEnd

Period end date (overrides payroll default)

date

None.

DateWorked

Date work was performed

date

None.

CheckType

Check type code

string

None.

EntryType

Entry type: P = Prepaid, V = Void

string

None.

StubMessage

Message to display on pay stub (max 300 characters)

string

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "EmployeeNumber": "sample string 1",
    "PayNumber": 2,
    "PayCode": "sample string 3",
    "RecordType": "sample string 4",
    "Hours": 1.0,
    "Rate": 1.0,
    "Amount": 1.0,
    "RateCode": "sample string 5",
    "CostCenter1": "sample string 6",
    "CostCenter2": "sample string 7",
    "CostCenter3": "sample string 8",
    "CostCenter4": "sample string 9",
    "CostCenter5": "sample string 10",
    "Job": "sample string 11",
    "JobMapCode": "sample string 12",
    "Task": "sample string 13",
    "TaxLocation": "sample string 14",
    "PeriodBegin": "2026-11-22T11:19:48.4999936-05:00",
    "PeriodEnd": "2026-11-22T11:19:48.4999936-05:00",
    "DateWorked": "2026-11-22T11:19:48.4999936-05:00",
    "CheckType": "sample string 15",
    "EntryType": "sample string 16",
    "StubMessage": "sample string 17"
  },
  {
    "EmployeeNumber": "sample string 1",
    "PayNumber": 2,
    "PayCode": "sample string 3",
    "RecordType": "sample string 4",
    "Hours": 1.0,
    "Rate": 1.0,
    "Amount": 1.0,
    "RateCode": "sample string 5",
    "CostCenter1": "sample string 6",
    "CostCenter2": "sample string 7",
    "CostCenter3": "sample string 8",
    "CostCenter4": "sample string 9",
    "CostCenter5": "sample string 10",
    "Job": "sample string 11",
    "JobMapCode": "sample string 12",
    "Task": "sample string 13",
    "TaxLocation": "sample string 14",
    "PeriodBegin": "2026-11-22T11:19:48.4999936-05:00",
    "PeriodEnd": "2026-11-22T11:19:48.4999936-05:00",
    "DateWorked": "2026-11-22T11:19:48.4999936-05:00",
    "CheckType": "sample string 15",
    "EntryType": "sample string 16",
    "StubMessage": "sample string 17"
  }
]

application/xml, text/xml

Sample:
<ArrayOfPayrollMetaData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.WebAPI.Models">
  <PayrollMetaData>
    <Amount>1</Amount>
    <CheckType>sample string 15</CheckType>
    <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>
    <DateWorked>2026-11-22T11:19:48.4999936-05:00</DateWorked>
    <EmployeeNumber>sample string 1</EmployeeNumber>
    <EntryType>sample string 16</EntryType>
    <Hours>1</Hours>
    <Job>sample string 11</Job>
    <JobMapCode>sample string 12</JobMapCode>
    <PayCode>sample string 3</PayCode>
    <PayNumber>2</PayNumber>
    <PeriodBegin>2026-11-22T11:19:48.4999936-05:00</PeriodBegin>
    <PeriodEnd>2026-11-22T11:19:48.4999936-05:00</PeriodEnd>
    <Rate>1</Rate>
    <RateCode>sample string 5</RateCode>
    <RecordType>sample string 4</RecordType>
    <StubMessage>sample string 17</StubMessage>
    <Task>sample string 13</Task>
    <TaxLocation>sample string 14</TaxLocation>
  </PayrollMetaData>
  <PayrollMetaData>
    <Amount>1</Amount>
    <CheckType>sample string 15</CheckType>
    <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>
    <DateWorked>2026-11-22T11:19:48.4999936-05:00</DateWorked>
    <EmployeeNumber>sample string 1</EmployeeNumber>
    <EntryType>sample string 16</EntryType>
    <Hours>1</Hours>
    <Job>sample string 11</Job>
    <JobMapCode>sample string 12</JobMapCode>
    <PayCode>sample string 3</PayCode>
    <PayNumber>2</PayNumber>
    <PeriodBegin>2026-11-22T11:19:48.4999936-05:00</PeriodBegin>
    <PeriodEnd>2026-11-22T11:19:48.4999936-05:00</PeriodEnd>
    <Rate>1</Rate>
    <RateCode>sample string 5</RateCode>
    <RecordType>sample string 4</RecordType>
    <StubMessage>sample string 17</StubMessage>
    <Task>sample string 13</Task>
    <TaxLocation>sample string 14</TaxLocation>
  </PayrollMetaData>
</ArrayOfPayrollMetaData>

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.