POST api/{programid}/Timesheets/Adjustment?ignoreOptionalRules={ignoreOptionalRules}

Create an adjustment timesheet. It supports sending only the lines that are being adjusted. It creates a new timesheet that includes the reversal lines for all the time entries in the period and the lines that where adjusted. The lines that did not change will generate a net-zero (one negative line and one positive)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
programid

Program Id

string

Required

ignoreOptionalRules

Submit anyway functionality

boolean

Required

Body Parameters

Information about the lines that are being adjusted.

TimesheetAdjustParams
NameDescriptionTypeAdditional information
EmployeeNo

string

Required

ConsumerNo

string

None.

BeginDate

date

Required

EndDate

date

Required

ServiceCode

string

None.

ServiceModifier

string

None.

Status

string

None.

StatusSubcode

string

None.

ExternalDocumentNo

string

None.

Notes

string

None.

AdjustedTimesheetNo

Used for adjustments only. It identifies the timesheet to be adjusted

string

None.

UserID

string

None.

ApprovalRequired

boolean

None.

AdjustmentReasonCode

string

None.

TimesheetModel

0=Hybrid (Timesheet level submission), 1=EVV (Line level submission)

integer

None.

TimesheetLines

Collection of TimesheetAdjustParams.TimesheetLine

None.

Request Formats

application/json, text/json

Sample:
{
  "EmployeeNo": "sample string 1",
  "ConsumerNo": "sample string 2",
  "BeginDate": "2024-11-15T22:57:38.0338049-05:00",
  "EndDate": "2024-11-15T22:57:38.0338049-05:00",
  "ServiceCode": "sample string 5",
  "ServiceModifier": "sample string 6",
  "Status": "sample string 7",
  "StatusSubcode": "sample string 8",
  "ExternalDocumentNo": "sample string 9",
  "Notes": "sample string 10",
  "AdjustedTimesheetNo": "sample string 11",
  "UserID": "sample string 12",
  "ApprovalRequired": true,
  "AdjustmentReasonCode": "sample string 14",
  "TimesheetModel": 15,
  "TimesheetLines": [
    {
      "ConsumerNo": "sample string 1",
      "EmployeeNo": "sample string 2",
      "DateWorked": "2024-11-15T22:57:38.0338049-05:00",
      "ServiceCode": "sample string 4",
      "ServiceModifier": "sample string 5",
      "ServiceModifier1": "sample string 6",
      "ServiceModifier2": "sample string 7",
      "ServiceModifier3": "sample string 8",
      "ServiceModifier4": "sample string 9",
      "TimeIn": "2024-11-15T22:57:38.0338049-05:00",
      "TimeOut": "2024-11-15T22:57:38.0338049-05:00",
      "Units": 10.0,
      "Comment": "sample string 11",
      "ExternalReferenceID": "sample string 12",
      "ExternalReferenceID2": "sample string 13",
      "ExternalReferenceID3": "sample string 14",
      "LineEntryType": 15,
      "TimesheetServiceActivities": [
        "sample string 1",
        "sample string 2"
      ],
      "AdditionalServices": [
        {
          "ServiceCode": "sample string 1",
          "Units": 2.0,
          "AdjustedEntryNo": 3,
          "Deleted": true
        },
        {
          "ServiceCode": "sample string 1",
          "Units": 2.0,
          "AdjustedEntryNo": 3,
          "Deleted": true
        }
      ],
      "AdjustedEntryNo": 16,
      "AdjustmentReasonCode": "sample string 17",
      "AdjustmentNotes": "sample string 18",
      "Deleted": true
    },
    {
      "ConsumerNo": "sample string 1",
      "EmployeeNo": "sample string 2",
      "DateWorked": "2024-11-15T22:57:38.0338049-05:00",
      "ServiceCode": "sample string 4",
      "ServiceModifier": "sample string 5",
      "ServiceModifier1": "sample string 6",
      "ServiceModifier2": "sample string 7",
      "ServiceModifier3": "sample string 8",
      "ServiceModifier4": "sample string 9",
      "TimeIn": "2024-11-15T22:57:38.0338049-05:00",
      "TimeOut": "2024-11-15T22:57:38.0338049-05:00",
      "Units": 10.0,
      "Comment": "sample string 11",
      "ExternalReferenceID": "sample string 12",
      "ExternalReferenceID2": "sample string 13",
      "ExternalReferenceID3": "sample string 14",
      "LineEntryType": 15,
      "TimesheetServiceActivities": [
        "sample string 1",
        "sample string 2"
      ],
      "AdditionalServices": [
        {
          "ServiceCode": "sample string 1",
          "Units": 2.0,
          "AdjustedEntryNo": 3,
          "Deleted": true
        },
        {
          "ServiceCode": "sample string 1",
          "Units": 2.0,
          "AdjustedEntryNo": 3,
          "Deleted": true
        }
      ],
      "AdjustedEntryNo": 16,
      "AdjustmentReasonCode": "sample string 17",
      "AdjustmentNotes": "sample string 18",
      "Deleted": true
    }
  ]
}

application/xml, text/xml

Sample:
<TimesheetAdjustParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.WebApi.Models.Timesheet">
  <AdjustedTimesheetNo>sample string 11</AdjustedTimesheetNo>
  <AdjustmentReasonCode>sample string 14</AdjustmentReasonCode>
  <ApprovalRequired>true</ApprovalRequired>
  <BeginDate>2024-11-15T22:57:38.0338049-05:00</BeginDate>
  <ConsumerNo>sample string 2</ConsumerNo>
  <EmployeeNo>sample string 1</EmployeeNo>
  <EndDate>2024-11-15T22:57:38.0338049-05:00</EndDate>
  <ExternalDocumentNo>sample string 9</ExternalDocumentNo>
  <Notes>sample string 10</Notes>
  <ServiceCode>sample string 5</ServiceCode>
  <ServiceModifier>sample string 6</ServiceModifier>
  <Status>sample string 7</Status>
  <StatusSubcode>sample string 8</StatusSubcode>
  <TimesheetLines>
    <TimesheetAdjustParams.TimesheetLine>
      <AdditionalServices>
        <TimesheetAdjustParams.AdditionalService>
          <AdjustedEntryNo>3</AdjustedEntryNo>
          <Deleted>true</Deleted>
          <ServiceCode>sample string 1</ServiceCode>
          <Units>2</Units>
        </TimesheetAdjustParams.AdditionalService>
        <TimesheetAdjustParams.AdditionalService>
          <AdjustedEntryNo>3</AdjustedEntryNo>
          <Deleted>true</Deleted>
          <ServiceCode>sample string 1</ServiceCode>
          <Units>2</Units>
        </TimesheetAdjustParams.AdditionalService>
      </AdditionalServices>
      <AdjustedEntryNo>16</AdjustedEntryNo>
      <AdjustmentNotes>sample string 18</AdjustmentNotes>
      <AdjustmentReasonCode>sample string 17</AdjustmentReasonCode>
      <Comment>sample string 11</Comment>
      <ConsumerNo>sample string 1</ConsumerNo>
      <DateWorked>2024-11-15T22:57:38.0338049-05:00</DateWorked>
      <Deleted>true</Deleted>
      <EmployeeNo>sample string 2</EmployeeNo>
      <ExternalReferenceID>sample string 12</ExternalReferenceID>
      <ExternalReferenceID2>sample string 13</ExternalReferenceID2>
      <ExternalReferenceID3>sample string 14</ExternalReferenceID3>
      <LineEntryType>15</LineEntryType>
      <ServiceCode>sample string 4</ServiceCode>
      <ServiceModifier>sample string 5</ServiceModifier>
      <ServiceModifier1>sample string 6</ServiceModifier1>
      <ServiceModifier2>sample string 7</ServiceModifier2>
      <ServiceModifier3>sample string 8</ServiceModifier3>
      <ServiceModifier4>sample string 9</ServiceModifier4>
      <TimeIn>2024-11-15T22:57:38.0338049-05:00</TimeIn>
      <TimeOut>2024-11-15T22:57:38.0338049-05:00</TimeOut>
      <TimesheetServiceActivities xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </TimesheetServiceActivities>
      <Units>10</Units>
    </TimesheetAdjustParams.TimesheetLine>
    <TimesheetAdjustParams.TimesheetLine>
      <AdditionalServices>
        <TimesheetAdjustParams.AdditionalService>
          <AdjustedEntryNo>3</AdjustedEntryNo>
          <Deleted>true</Deleted>
          <ServiceCode>sample string 1</ServiceCode>
          <Units>2</Units>
        </TimesheetAdjustParams.AdditionalService>
        <TimesheetAdjustParams.AdditionalService>
          <AdjustedEntryNo>3</AdjustedEntryNo>
          <Deleted>true</Deleted>
          <ServiceCode>sample string 1</ServiceCode>
          <Units>2</Units>
        </TimesheetAdjustParams.AdditionalService>
      </AdditionalServices>
      <AdjustedEntryNo>16</AdjustedEntryNo>
      <AdjustmentNotes>sample string 18</AdjustmentNotes>
      <AdjustmentReasonCode>sample string 17</AdjustmentReasonCode>
      <Comment>sample string 11</Comment>
      <ConsumerNo>sample string 1</ConsumerNo>
      <DateWorked>2024-11-15T22:57:38.0338049-05:00</DateWorked>
      <Deleted>true</Deleted>
      <EmployeeNo>sample string 2</EmployeeNo>
      <ExternalReferenceID>sample string 12</ExternalReferenceID>
      <ExternalReferenceID2>sample string 13</ExternalReferenceID2>
      <ExternalReferenceID3>sample string 14</ExternalReferenceID3>
      <LineEntryType>15</LineEntryType>
      <ServiceCode>sample string 4</ServiceCode>
      <ServiceModifier>sample string 5</ServiceModifier>
      <ServiceModifier1>sample string 6</ServiceModifier1>
      <ServiceModifier2>sample string 7</ServiceModifier2>
      <ServiceModifier3>sample string 8</ServiceModifier3>
      <ServiceModifier4>sample string 9</ServiceModifier4>
      <TimeIn>2024-11-15T22:57:38.0338049-05:00</TimeIn>
      <TimeOut>2024-11-15T22:57:38.0338049-05:00</TimeOut>
      <TimesheetServiceActivities xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </TimesheetServiceActivities>
      <Units>10</Units>
    </TimesheetAdjustParams.TimesheetLine>
  </TimesheetLines>
  <TimesheetModel>15</TimesheetModel>
  <UserID>sample string 12</UserID>
</TimesheetAdjustParams>

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 'TimesheetAdjustParams'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.