POST api/timePayrollBatch

Insert a new record into the PayrollBatches table.

Request Information

URI Parameters

None.

Body Parameters

timePayrollBatchDb
NameDescriptionTypeAdditional information
PayrollBatchID

integer

None.

PayrollBatchName

string

Max length: 300

FromDate

date

None.

ToDate

date

None.

CountryCode

string

None.

EmployeeTypeGroup

string

None.

PayrollTypeGroup

string

None.

CreatedBy

integer

None.

CreatedDate

date

None.

UpdatedBy

integer

None.

UpdatedDate

date

None.

results

Collection of ValidationResult

None.

Request Formats

application/json, text/json

Sample:
{
  "results": null,
  "PayrollBatchID": 1,
  "PayrollBatchName": "sample string 2",
  "FromDate": "2025-12-06T23:37:43.3904137+00:00",
  "ToDate": "2025-12-06T23:37:43.3904137+00:00",
  "CountryCode": "sample string 5",
  "EmployeeTypeGroup": "sample string 6",
  "PayrollTypeGroup": "sample string 7",
  "CreatedBy": 8,
  "CreatedDate": "2025-12-06T23:37:43.3904137+00:00",
  "UpdatedBy": 10,
  "UpdatedDate": "2025-12-06T23:37:43.3904137+00:00"
}

application/xml, text/xml

Sample:
<timePayrollBatchDb xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables">
  <results xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility" />
  <CountryCode>sample string 5</CountryCode>
  <CreatedBy>8</CreatedBy>
  <CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-06T23:37:43.3904137Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CreatedDate>
  <EmployeeTypeGroup>sample string 6</EmployeeTypeGroup>
  <FromDate>2025-12-06T23:37:43.3904137+00:00</FromDate>
  <PayrollBatchID>1</PayrollBatchID>
  <PayrollBatchName>sample string 2</PayrollBatchName>
  <PayrollTypeGroup>sample string 7</PayrollTypeGroup>
  <ToDate>2025-12-06T23:37:43.3904137+00:00</ToDate>
  <UpdatedBy>10</UpdatedBy>
  <UpdatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-06T23:37:43.3904137Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </UpdatedDate>
</timePayrollBatchDb>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'timePayrollBatchDb'.

Response Information

Resource Description

UpsertRetOftimePayrollBatchDb
NameDescriptionTypeAdditional information
returnID

integer

None.

results

Collection of ValidationResult

None.

returnItem

timePayrollBatchDb

None.

displayMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "returnID": 1,
  "results": null,
  "returnItem": {
    "results": null,
    "PayrollBatchID": 1,
    "PayrollBatchName": "sample string 2",
    "FromDate": "2025-12-06T23:37:43.4089441+00:00",
    "ToDate": "2025-12-06T23:37:43.4089441+00:00",
    "CountryCode": "sample string 5",
    "EmployeeTypeGroup": "sample string 6",
    "PayrollTypeGroup": "sample string 7",
    "CreatedBy": 8,
    "CreatedDate": "2025-12-06T23:37:43.4089441+00:00",
    "UpdatedBy": 10,
    "UpdatedDate": "2025-12-06T23:37:43.4089441+00:00"
  },
  "displayMessage": "sample string 1"
}

application/xml, text/xml

Sample:
<UpsertRetOftimePayrollBatchDb66KPc_SrH xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility">
  <displayMessage>sample string 1</displayMessage>
  <results xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" />
  <returnID>1</returnID>
  <returnItem xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables">
    <results xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" />
    <d2p1:CountryCode>sample string 5</d2p1:CountryCode>
    <d2p1:CreatedBy>8</d2p1:CreatedBy>
    <d2p1:CreatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:37:43.4089441Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:CreatedDate>
    <d2p1:EmployeeTypeGroup>sample string 6</d2p1:EmployeeTypeGroup>
    <d2p1:FromDate>2025-12-06T23:37:43.4089441+00:00</d2p1:FromDate>
    <d2p1:PayrollBatchID>1</d2p1:PayrollBatchID>
    <d2p1:PayrollBatchName>sample string 2</d2p1:PayrollBatchName>
    <d2p1:PayrollTypeGroup>sample string 7</d2p1:PayrollTypeGroup>
    <d2p1:ToDate>2025-12-06T23:37:43.4089441+00:00</d2p1:ToDate>
    <d2p1:UpdatedBy>10</d2p1:UpdatedBy>
    <d2p1:UpdatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:37:43.4089441Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:UpdatedDate>
  </returnItem>
</UpsertRetOftimePayrollBatchDb66KPc_SrH>