Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Overview


This web service applies a revenue recognition adjustment to a specified contract line item (PwsContractLineItemRef).

Format


PwsApplyRevRecAdjustment 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.

 

SessionTicket

String

Yes 

 

Click here for more information.

 

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.

 

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

 

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

 

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 

 

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)


Example 01 - non-revenue schedule
<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:IncludeRequestsFlag>true</sch:IncludeRequestsFlag-->
            <sch:Notes>Recognizing 30%</sch:Notes>
            <sch:StealLockFlag>true</sch:StealLockFlag>
            <!--sch:TotalRevenueRecognized>100</sch:TotalRevenueRecognized-->
            <!--sch:IntervalRevenueRecognized>100</sch:IntervalRevenueRecognized-->
            <!--sch:ContractLineItemTimestamp>?</sch:ContractLineItemTimestamp-->
         </pws:serviceRequest>
      </pws:PwsApplyRevRecAdjustment>
   </soapenv:Body>
</soapenv:Envelope>
  • No labels