Overview
This web service updates the disbursed amount on one or more existing cost cards.
Request Format
PwsAdjustCostDisbursedAmount Request
- PwsAdjustCostDisbursedAmount
- serviceRequest: PwsAdjustCostDisbursedAmountRq
- RequestId: Int32
- SessionTicket: String
- AdjustmentCodeIdentity: PwsAdjustmentCodeRef
- CostCardIdentities: PwsVersionedCostCardRef
- AdjustmentOrders: PwsCostDisbursedAmountAdjustmentOrder
- Explanation: String (1024)
- serviceRequest: PwsAdjustCostDisbursedAmountRq
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. | ||
| CostCardIdentities | PwsVersionedCostCardRef | Yes | This structure represents the unique key fields associated with identifying a cost Card. | ||
| Explanation | String (1024) | No | An explanation as to why this adjustment was applied. | made a mistake earlier | |
| NewDescription | String (1000) | No | The description to be added / updated to the cost card. If omitted, the cost card's description will be cleared. | 2-night hotel stay |
Request Usage Example(s)
Response Format
PwsAdjustCostDisbursedAmount response
- PwsAdjustCostDisbursedAmountResponse
- PwsAdjustCostDisbursedAmountResult: PwsAdjustCostDisbursedAmountRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- CostCardIdentities: PwsCostCardRef
- PwsAdjustCostDisbursedAmountResult: PwsAdjustCostDisbursedAmountRs
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 |
| CostCardIdentities | PwsCostCardRef | The identities of the cost cards that were updated. |
Response Usage Example(s)
PwsAdjustCostDisbursedAmount - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 10111 | RequiredFieldMissing | A required field is missing: NewIncurredOpsCurrencyIdentity. |
| 10111 | RequiredFieldMissing | A required field is missing: NewTotalAmountIncurredCurrency. |
| 10111 | RequiredFieldMissing | A required field is missing: NewVatAmountIncurredCurrency. |
| 50024 | EntityNotFound | Cost Card was not found. Another user may have deleted it. |