PwsAdjustCostUnits
Overview
This web service updates the number of units (i.e. miles traveled or units sold) associated with one or more existing cost cards. Updating the quantity of units on cost cards for unit-based expense types will cause the client amount on adjusted cost cards to be recalculated. This entails reversing out any prior adjustments and recalculating the value based on the default markup percentage of the current expense type.
Request Format
PwsAdjustCostUnits Request
PwsAdjustCostDescription
- serviceRequest: PwsAdjustCostDescriptionRq
- RequestId: Int32
- SessionTicket: String
- AdjustmentCodeIdentity: PwsAdjustmentCodeRef
- AdjustmentOrders: PwsCostUnitsAdjustmentOrder [1..100]
- Explanation: String (1024)
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 | AZZLhIFhqIg+w/UlZKyCfg== | |
AdjustmentCodeIdentity | PwsAdjustmentCodeRef | No | This structure represents the unique key fields associated with identifying an adjustment code. | ||
AdjustmentOrders | PwsCostUnitsAdjustmentOrder [1..100] | Yes | This structure represents the fields associated with a cost card unit adjustment. | ||
Explanation | String (1024) | No | An explanation as to why this adjustment was applied. | Change units on cost card |
Request Usage Example(s)
Response Format
PwsAdjustCostUnits Response
- PwsAdjustCostUnitsResponse
- PwsAdjustCostUnitsResult: PwsAdjustCostUnitsRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- CostCardIdentities: PwsCostCardRef
- PwsAdjustCostUnitsResult: PwsAdjustCostUnitsRs
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-11T20:04:56.6324809Z |
CostCardIdentities | PwsCostCardRef [1..100] | The identities of the cost cards that were updated. |
Response Usage Example(s)
PwsAdjustCostUnits - Common Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
---|---|---|
10111 | RequiredFieldMissing | A required field is missing: NewClientAmount. |
10111 | RequiredFieldMissing | A required field is missing: NewDisbursedAmountDisbursedCurrency. |
10111 | RequiredFieldMissing | A required field is missing: NewUnits. |
10111 | RequiredFieldMissing | A required field is missing: NewVatAmountDisbursedCurrency. |
64365 | OneOrMoreTimeCardsIneligibleForAdjustment | Adjustment cannot be completed because one or more cards has changed or is ineligible for adjustment. |