POST api/UKG/AddPayrollData
Request Information
URI Parameters
None.
Body Parameters
UKGPayrollAPIModel| Name | Description | Type | Additional information |
|---|---|---|---|
| earnings | Collection of Earning |
None. |
Request Formats
application/json, text/json
Sample:
{
"earnings": [
{
"refId": "sample string 1",
"companyCode": "sample string 2",
"empNo": "sample string 3",
"chargeDate": "sample string 4",
"code": "sample string 5",
"hours": 6.0,
"amount": 7.0,
"pieceCount": 8,
"shiftCode": "sample string 9",
"location": "sample string 10",
"job": "sample string 11",
"project": "sample string 12",
"orgLvl1": "sample string 13",
"orgLvl2": "sample string 14",
"orgLvl3": "sample string 15",
"orgLvl4": "sample string 16",
"payRate": 17.0,
"pieceRate": 18,
"roePayDate": "2026-11-22T04:39:20.1900028-08:00",
"adjEarnPeriodStartDate": "2026-11-22T04:39:20.1900028-08:00",
"adjEarnPeriodEndDate": "2026-11-22T04:39:20.1900028-08:00",
"checkSequence": 19,
"createPayType": "sample string 20",
"forcePayCreation": "sample string 21",
"grossUp": "sample string 22",
"grossUpTarget": 23,
"grossUpTaxCalcMethod": 24,
"source": "sample string 25",
"requestedPayGroup": "sample string 26",
"isImportedIntoPayroll": true
},
{
"refId": "sample string 1",
"companyCode": "sample string 2",
"empNo": "sample string 3",
"chargeDate": "sample string 4",
"code": "sample string 5",
"hours": 6.0,
"amount": 7.0,
"pieceCount": 8,
"shiftCode": "sample string 9",
"location": "sample string 10",
"job": "sample string 11",
"project": "sample string 12",
"orgLvl1": "sample string 13",
"orgLvl2": "sample string 14",
"orgLvl3": "sample string 15",
"orgLvl4": "sample string 16",
"payRate": 17.0,
"pieceRate": 18,
"roePayDate": "2026-11-22T04:39:20.1900028-08:00",
"adjEarnPeriodStartDate": "2026-11-22T04:39:20.1900028-08:00",
"adjEarnPeriodEndDate": "2026-11-22T04:39:20.1900028-08:00",
"checkSequence": 19,
"createPayType": "sample string 20",
"forcePayCreation": "sample string 21",
"grossUp": "sample string 22",
"grossUpTarget": 23,
"grossUpTaxCalcMethod": 24,
"source": "sample string 25",
"requestedPayGroup": "sample string 26",
"isImportedIntoPayroll": true
}
]
}
application/xml, text/xml
Sample:
<UKGPayrollAPIModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WurkNowDTO.UKG">
<earnings>
<Earning>
<adjEarnPeriodEndDate>2026-11-22T04:39:20.1900028-08:00</adjEarnPeriodEndDate>
<adjEarnPeriodStartDate>2026-11-22T04:39:20.1900028-08:00</adjEarnPeriodStartDate>
<amount>7</amount>
<chargeDate>sample string 4</chargeDate>
<checkSequence>19</checkSequence>
<code>sample string 5</code>
<companyCode>sample string 2</companyCode>
<createPayType>sample string 20</createPayType>
<empNo>sample string 3</empNo>
<forcePayCreation>sample string 21</forcePayCreation>
<grossUp>sample string 22</grossUp>
<grossUpTarget>23</grossUpTarget>
<grossUpTaxCalcMethod>24</grossUpTaxCalcMethod>
<hours>6</hours>
<isImportedIntoPayroll>true</isImportedIntoPayroll>
<job>sample string 11</job>
<location>sample string 10</location>
<orgLvl1>sample string 13</orgLvl1>
<orgLvl2>sample string 14</orgLvl2>
<orgLvl3>sample string 15</orgLvl3>
<orgLvl4>sample string 16</orgLvl4>
<payRate>17</payRate>
<pieceCount>8</pieceCount>
<pieceRate>18</pieceRate>
<project>sample string 12</project>
<refId>sample string 1</refId>
<requestedPayGroup>sample string 26</requestedPayGroup>
<roePayDate>2026-11-22T04:39:20.1900028-08:00</roePayDate>
<shiftCode>sample string 9</shiftCode>
<source>sample string 25</source>
</Earning>
<Earning>
<adjEarnPeriodEndDate>2026-11-22T04:39:20.1900028-08:00</adjEarnPeriodEndDate>
<adjEarnPeriodStartDate>2026-11-22T04:39:20.1900028-08:00</adjEarnPeriodStartDate>
<amount>7</amount>
<chargeDate>sample string 4</chargeDate>
<checkSequence>19</checkSequence>
<code>sample string 5</code>
<companyCode>sample string 2</companyCode>
<createPayType>sample string 20</createPayType>
<empNo>sample string 3</empNo>
<forcePayCreation>sample string 21</forcePayCreation>
<grossUp>sample string 22</grossUp>
<grossUpTarget>23</grossUpTarget>
<grossUpTaxCalcMethod>24</grossUpTaxCalcMethod>
<hours>6</hours>
<isImportedIntoPayroll>true</isImportedIntoPayroll>
<job>sample string 11</job>
<location>sample string 10</location>
<orgLvl1>sample string 13</orgLvl1>
<orgLvl2>sample string 14</orgLvl2>
<orgLvl3>sample string 15</orgLvl3>
<orgLvl4>sample string 16</orgLvl4>
<payRate>17</payRate>
<pieceCount>8</pieceCount>
<pieceRate>18</pieceRate>
<project>sample string 12</project>
<refId>sample string 1</refId>
<requestedPayGroup>sample string 26</requestedPayGroup>
<roePayDate>2026-11-22T04:39:20.1900028-08:00</roePayDate>
<shiftCode>sample string 9</shiftCode>
<source>sample string 25</source>
</Earning>
</earnings>
</UKGPayrollAPIModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |