Overview
This web service applies a revenue recognition adjustment to a specified contract line item (PwsContractLineItemRef).
Format
| Panel | ||
|---|---|---|
| ||
|
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. | Af2v8Ie/yFiUtqHqc3felw== | |
BeginDate | DateTime | No | Start Date of the associated engagement | The begin date for your revenue recognition period. If you choose a specific start date, then all recognized revenue on time cards BEFORE that date is left alone and is considered sacrosanct. All time cards after and up to the end date will have their recognized revenue recalculated. | |
ContractLineItemIdentity | Yes | The identity of the contract line item to make the revenue recognition adjustment for. | |||
CutoffDate | DateTime | Yes | The cut off date or end date for your revenue recognition period. If you have run revenue recognition previously, and there is revenue sitting on time cards AFTER this date, that revenue will be zeroed out. | 2017-07-03T00:00:00.000Z | |
EngagementCurrencyIdentity | Yes (if TotalRevenueRecognized is specified) | This identifies the currency for the engagement the contract line item is associated with. | |||
EngagementTimestamp | String | No | This is a Base64 encoded timestamp utilized for engagement locking. To protect against overwriting other changes, you may optionally echo back the timestamp returned by a call to PwsGetEngagement (or a prior call to PwsSaveEngagement). This will cause the request to fail if any change has been made between when the timestamp was retrieved and when this service was invoked. | ||
FractionComplete | Double | One of FractionComplete, IncludeRequestsFlag, TotalRevenueRecognized or IntervalRevenueRecognized is required | The fractional amount of total revenue that should be recognized for the date range provided. | .30 | |
IncludeRequestsFlag | Boolean | See FractionComplete | false | If set to 'true', the basis units the revenue will be recognized against will include requested hours. | |
Notes | String (1000) | No | Notes that are stored with the revenue recognition record. | Recognizing 30% | |
StealLockFlag | Boolean | If set to 'true', any locks on the engagement will be stolen if it is currently locked, otherwise, if it is set to 'false' and a lock is in place the service will fail. | true | ||
TotalRevenueRecognized | Double | See FractionComplete | The total amount of revenue to be recognized for the date range provided. | ||
IntervalRevenueRecognized | Double | See FractionComplete - this is only applicable for contract line items with a revenue schedule | The total amount of revenue to be recognized for revenue that is defined within a revenue schedule. |
Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:sch="http://projectorpsa.com/DataContracts/Shared/Scheduling/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsApplyRevRecAdjustment>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>Af2v8Ie/yFiUtqHqc3felw==</req:SessionTicket>
<sch:ContractLineItemIdentity>
<com:ContractLineItemCode>P001243-CL2</com:ContractLineItemCode>
</sch:ContractLineItemIdentity>
<sch:CutoffDate>2017-07-03T00:00:00.000Z</sch:CutoffDate>
<sch:EngagementCurrencyIdentity>
<com:CurrencyCode>USD</com:CurrencyCode>
</sch:EngagementCurrencyIdentity>
<sch:FractionComplete>.30</sch:FractionComplete>
<sch:Notes>Recognizing 30%</sch:Notes>
<sch:StealLockFlag>true</sch:StealLockFlag>
</pws:serviceRequest>
</pws:PwsApplyRevRecAdjustment>
</soapenv:Body>
</soapenv:Envelope> |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:sch="http://projectorpsa.com/DataContracts/Shared/Scheduling/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsApplyRevRecAdjustment>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>Af2v8Ie/yFiUtqHqc3felw==</req:SessionTicket>
<sch:BeginDate>2017-12-01T00:00:00.000Z</sch:BeginDate>
<sch:ContractLineItemIdentity>
<com:ContractLineItemCode>P001386-CL1</com:ContractLineItemCode>
</sch:ContractLineItemIdentity>
<sch:CutoffDate>2017-12-31T00:00:00.000Z</sch:CutoffDate>
<sch:EngagementCurrencyIdentity>
<com:CurrencyCode>USD</com:CurrencyCode>
</sch:EngagementCurrencyIdentity>
<sch:Notes>Revenue Recognition Adjustment</sch:Notes>
<sch:StealLockFlag>true</sch:StealLockFlag>
<sch:IntervalRevenueRecognized>5000</sch:IntervalRevenueRecognized>
</pws:serviceRequest>
</pws:PwsApplyRevRecAdjustment>
</soapenv:Body>
</soapenv:Envelope> |
Response Format
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | 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. | 2018-02-02T16:30:03.8860867Z |
EngagementTimestamp | String | This is a Base64 encoded timestamp optionally utilized for engagement locking. | AAAAAA61fBk= |
LockStolenFromUserIdentity | If a lock is stolen in the process of updating an engagement, this identifies the user from which the lock was stolen from. |
Response Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsApplyRevRecAdjustmentResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsApplyRevRecAdjustmentResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/Scheduling/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
<Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-02-02T16:30:03.8860867Z</ServerTimestampUtc>
<a:EngagementTimestamp>AAAAAA61fBk=</a:EngagementTimestamp>
<a:LockStolenFromUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<a:ContractLineItemTimestamp>AAAAAA62D3k=</a:ContractLineItemTimestamp>
<a:StolenLocks xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
</PwsApplyRevRecAdjustmentResult>
</PwsApplyRevRecAdjustmentResponse>
</s:Body>
</s:Envelope> |
PwsApplyRevRecAdjustment - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 29000 | NoContractLineItemSpecifiedForRevRec | No Contract Line Item specified on which to apply Revenue Recognition Adjustment. |
| 29001 | InvalidValueForRevRecCutoffDate | Invalid value for Revenue Recognition Adjustment Cutoff Date. |
| 29002 | InvalidValueForRevRecBeginDate | Invalid value for Revenue Recognition Adjustment Begin Date. |
| 29003 | RevRecFractionCompleteOutOfRange | Revenue Recognition Adjustment Fraction Complete out of range. |
| 29004 | RevRecTotalRevenueRecognizedOutOfRange | Revenue Recognition Adjustment Total Revenue Recognized out of range. |
| 29005 | RevRecNotesTruncated | Revenue Recognition Adjustment Notes truncated. |
| 29006 | InvalidRevRecDateCombinationSpecified | Illegal combination of Revenue Recognition Adjustment Dates specified. |
| 29007 | SpecifyNoMoreThanOneRevRecAxis | May specify at most one of Fraction Complete, Include Requests Flag, and Total Revenue Recognized on Revenue Recognition Adjustment. |
| 29008 | MustSpecifyRevRecCurrencyIfSpecifyingAmount | When specifying Total Revenue Recognized on Revenue Recognition Adjustment, must also specify Currency. |
| 29009 | RevRecIntervalRevenueRecognizedOutOfRange | Revenue Recognition Adjustment Interval Revenue Recognized out of range. |