Overview
This web service modifies the client amount on a time card by writing it up or down.
Request Format
PwsWriteUpDownTime Request
- PwsWriteUpDownTime
- serviceRequest: PwsWriteUpDownTimeRq
- RequestId: Int32
- SessionTicket: String
- AdjustmentCodeIdentity: PwsAdjustmentCodeRef
- Explanation: String (1024)
- WriteUpDownOrders: PwsWriteUpDownTime
- serviceRequest: PwsWriteUpDownTimeRq
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
RequestId | Int32 | No | Click here for more information | 1 | |
SessionTicket | String | Yes | Click here for more information | AWuKIeUvHQC5lNzuzE3Ugg== | |
AdjustmentCodeIdentity | PwsAdjustmentCodeRef | No | This structure represents the unique key fields associated with identifying an adjustment code. Adjustment codes are required whenever you make a monetary adjustment to a time or cost card. This is not applicable to this service. | ||
Explanation | String (1024) | No | An explanation as to why this adjustment was applied. | Time Card Description update | |
Description | String (1000) | Yes | The description to be added / updated to the time card | Preliminary Client Meeting | |
TimeCardIdentities | PwsVersionedTimeCardRef | Yes | This structure represents the unique key fields associated with identifying a Time Card. Time Cards can be identified with a TimeCardUid. |
Request Usage Example(s)
Response Format
PwsWriteUpDownTime Response
- PwsWriteUpDownTimeResponse
- PwsWriteUpDownTimeResult: PwsAdjustTimeDescriptionRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- TimeCardIdentities: PwsTimeCardRef
Response Elements
Element | Data Type | Description | Sample Data |
---|---|---|---|
Messages | PwsMessage[] | The web service response status and message. Click here for more information. | |
ResponseId | Int32 | Click here for more information | 1 |
Status | RequestStatus | Click here for more information | Ok |
ServerTimestampUtc | DateTime | Click here for more information | 2019-11-06T17:18:38.6934436Z |
TimeCardIdentities | PwsTimeCardRef | The identities of the time cards that were updated. |
Response Usage Example(s)
PwsAdjustTimeDescription - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
---|---|---|
20051 | InvalidValueForTimeCardType | The specified value for time card type is invalid. Valid values are T for Time Card and R for Reported Time Off. |
50024 | EntityNotFound | Time Card was not found. Another user may have deleted it. |
57530 | CurrencyNotValidForAccount | The specified currency is not enabled for this account. |
64365 | OneOrMoreTimeCardsIneligibleForAdjustment | Adjustment cannot be completed because one or more cards has changed or is ineligible for adjustment. |