Versions Compared

Version Old Version 1 New Version 2
Changes made by

Bettina Borces

Bettina Borces

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
titlePwsApplyRevRecAdjustment Request
  • PwsApplyRevRecAdjustment
    • serviceRequest: PwsApplyRevRecAdjustmentRq
      • RequestId: Int32
      • SessionTicket: String
      • BeginDate: DateTime
      • ContractLineItemIdentity: PwsContractLineItemRef
      • CutoffDate: DateTime
      • EngagementCurrencyIdentity: PwsCurrencyRef
      • EngagementTimestamp: String
      • FractionComplete: Double
      • IncludeRequestsFlag: Boolean
      • Notes: String (1000)
      • StealLockFlag: Boolean
      • TotalRevenueRecognized: Double
      • IntervalRevenueRecognized: Double

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

PwsContractLineItemRef

Yes 

 

 

 




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

PwsCurrencyRef

No 

 


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 PwsSaveEngagement(or a prior call to PwsSaveEngagement). This will cause the request to fail if any change has been made between invocations of PwsGetEngagement and PwsSaveEngagement. 

 


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
languagexml
titleExample 01 - non-revenue schedule
collapsetrue
<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>?</sch:BeginDate-->             <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:EngagementTimestamp>?</sch:EngagementTimestamp--><sch:FractionComplete>.30</sch:FractionComplete>
            <sch:Notes>Recognizing 30%</sch:Notes>
            <sch:FractionComplete>.30<StealLockFlag>true</sch:FractionComplete>StealLockFlag>
         </pws:serviceRequest>
      <!--sch:IncludeRequestsFlag>true</sch:IncludeRequestsFlag-->/pws:PwsApplyRevRecAdjustment>
   </soapenv:Body>
</soapenv:Envelope>
Code Block
languagexml
titleExample 02 - revenue schedule
collapsetrue
<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>
       <sch:Notes>Recognizing 30%</sch:Notes>     <req:RequestId>1</req:RequestId>
            <req:SessionTicket>Af2v8Ie/yFiUtqHqc3felw==</req:SessionTicket>
            <sch:BeginDate>2017-12-01T00:00:00.000Z</sch:BeginDate>
            <sch:StealLockFlag>true<:ContractLineItemIdentity>
               <com:ContractLineItemCode>P001386-CL1</com:ContractLineItemCode>
            </sch:StealLockFlag>ContractLineItemIdentity>
            <!<sch:CutoffDate>2017-12-31T00:00:00.000Z</sch:TotalRevenueRecognized>100</sch:TotalRevenueRecognized-->:CutoffDate>
            <sch:EngagementCurrencyIdentity>
               <com:CurrencyCode>USD</com:CurrencyCode>
            <!--sch:IntervalRevenueRecognized>100</sch:IntervalRevenueRecognized-->/sch:EngagementCurrencyIdentity>
            <sch:Notes>Revenue Recognition Adjustment</sch:Notes>
            <!--sch:ContractLineItemTimestamp>?</sch:ContractLineItemTimestamp--><sch:StealLockFlag>true</sch:StealLockFlag>
            <sch:IntervalRevenueRecognized>5000</sch:IntervalRevenueRecognized>
         </pws:serviceRequest>
      </pws:PwsApplyRevRecAdjustment>
   </soapenv:Body>
</soapenv:Envelope>