Overview

This web service can be used to create a web invoice. You specify the attributes to use for invoice creation by providing a InvoiceSpec, an instance of PwsCandidateInvoiceSpec. This structure allows you to specify the name, scope and content of the invoice, the approval statuses and other invoice attributes. See below for full details. The caller can optionally request that the full invoice detail PwsInvoiceElement be included in the response.

...

Panel

title	PwsCreateInvoice Request

* PwsCreateInvoiceRq
	* InvoiceSpec
		* InvoiceName : String(100)
		* ClientIdentity : PwsClientRef
		* PurchaseOrderNumber : String(50)
		* EngagementIdentity : PwsEngagementRef
		* ProjectIdentity : PwsProjectRef
		* ApprovedByFinanceFlag : Boolean
		* ApprovedByProjectManagerFlag : Boolean
		* ApprovedByManagementFlag : Boolean
		* EngagementCurrencyIdentity : PwsCurrencyRef
		* CostCenterIdentity : PwsCostCenterRef
		* BillingCultureIdentity : PwsCultureRef
		* EngagementInvoiceContent : String(1)
		* InvoiceScope : String(1)
		* InvoiceContent : String(1)
		* CardBeginDate : Date
		* CardEndDate : Date
	* NotifyFinanceTeamFlag : Boolean
	* NotifyPmTeamFlag : Boolean
	* NotifyManagementTeamFlag : Boolean
	* NewInvoiceMessages: String(1000)
	* AddCommentsToInvoiceMessagesFlag : Boolean
	* ExcludeZeroAmountTimeCardsFlag : Boolean
	* ExcludeZeroAmountCostCardsFlag : Boolean
	* FullDetailFlag : Boolean
	* IncludeAdjustmentHistoryFlag : Boolean
	* IncludeFullAdjustmentHistoryFlag : Boolean

Request Elements

Element	Data Type	Required?	Default	Description
RequestId	Int32	No		Click here for more information
SessionTicket	String	Yes		Click here for more information
AddCommentsToInvoiceMessagesFlag	Boolean	No	False	True to prepend comments (NewInvoiceMessages) to invoice message
ExcludeZeroAmountCostCardsFlag	Boolean	No	False	True to exclude time cards with no value from invoice
ExcludeZeroAmountTimeCardsFlag	Boolean	No	False	True to exclude cost cards with no value from invoice
FullDetailFlag	Boolean	No	False	True to include the full details of the invoice in the response
IncludeAdjustmentHistoryFlag	Boolean	No	False	If FullDetailsFlag is set, true to include adjustment history in invoice detail
IncludeFullAdjustmentHistoryFlag	Boolean	No	False	If FullDetailsFlag is set and IncludeAdjustmentHistoryFlag is set, true to include full card breakdown with each
InvoiceSpec	PwsCandidateInvoiceSpec	Yes		Attributes of the new invoice to be created
NewInvoiceMessages	String (1000)	No		Invoice message to include workflow email. May also be added to invoice messages for the new invoice
NotifyFinanceTeamFlag	Boolean	No	False	True to send an e-mail to the finance team response for finance approval of invoice upon creation
NotifyManagementTeamFlag	Boolean	No	False	True to send an e-mail to the management team response for management approval of invoice upon creation
NotifyPmTeamFlag	Boolean	No	False	True to send an e-mail to the PM team response for project manager approval of invoice upon creation

Request Usage Example(s)

Code Block

language	xml
title	Example 01
collapse	true

<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:PwsCreateProjectCostBaseline>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AXoSoNYPC/IRu5ISV3f2Ew==</req:SessionTicket>
            <sch:ActualsCutoffDate>2018-03-31T00:00:00.000Z</sch:ActualsCutoffDate>
            <sch:Basis>N</sch:Basis>
            <sch:Dimension>E</sch:Dimension>
            <sch:FullDetailFlag>true</sch:FullDetailFlag>
            <sch:IntervalCount>2</sch:IntervalCount>
            <sch:ProjectCostBaseline>
               <com:ActiveProjectCostBaselineFlag>true</com:ActiveProjectCostBaselineFlag>
               <com:CaMetricActiveFlag>true</com:CaMetricActiveFlag>
               <com:DaMetricActiveFlag>false</com:DaMetricActiveFlag>
               <com:Description>Client Amount Cost Baseline</com:Description>
               <com:EaMetricActiveFlag>false</com:EaMetricActiveFlag>
               <com:PrimaryMetric>C</com:PrimaryMetric>
               <com:ProjectCostBaselineName>Client Amount Budget</com:ProjectCostBaselineName>
               <com:ProjectCostBaselineBuckets>
                  <com:PwsProjectCostBaselineBucket>
                     <com:ClientAmount>2000</com:ClientAmount>
                     <com:EndDate>2018-01-31T00:00:00.000Z</com:EndDate>
                     <com:ExpenseTypeIdentity>
                        <com:ExpenseTypeName>Per Diem</com:ExpenseTypeName>
                     </com:ExpenseTypeIdentity>
                     <com:StartDate>2018-01-01T00:00:00.000Z</com:StartDate>
                  </com:PwsProjectCostBaselineBucket>
                  <com:PwsProjectCostBaselineBucket>
                     <com:ClientAmount>2000</com:ClientAmount>
                     <com:EndDate>2018-02-28T00:00:00.000Z</com:EndDate>
                     <com:ExpenseTypeIdentity>
                        <com:ExpenseTypeName>Per Diem</com:ExpenseTypeName>
                     </com:ExpenseTypeIdentity>
                     <com:StartDate>2018-02-01T00:00:00.000Z</com:StartDate>
                  </com:PwsProjectCostBaselineBucket>
               </com:ProjectCostBaselineBuckets>
            </sch:ProjectCostBaseline>
            <sch:ProjectIdentity>
               <com:ProjectCode>P001407-001</com:ProjectCode>
            </sch:ProjectIdentity>
            <sch:StartDate>2018-01-01T00:00:00.000Z</sch:StartDate>
            <sch:StealEngagementLockFlag>false</sch:StealEngagementLockFlag>
            <sch:TimePhase>M</sch:TimePhase>
         </pws:serviceRequest>
      </pws:PwsCreateProjectCostBaseline>
   </soapenv:Body>
</soapenv:Envelope>

...

Panel

title	PwsCreateProjectCostBaseline Response

PwsCreateProjectCostBaselineResponse
- PwsCreateProjectCostBaselineResult: PwsCreateProjectCostBaselineRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - EngagementLockStolenFromUserIdentity: PwsUserRef **deprecated**
  - EngagementTimestamp: String **deprecated**
  - ProjectCostBaseline: PwsProjectCostBaselineElement
  - ProjectCostBaselineIdentity: PwsProjectCostBaselineRef
  - ProjectTimestamp: String
  - StolenLocks: PwsEntityLockSummary [1..100]

...

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	2018-01-29T21:55:08.7579802Z
EngagementLockStolenFromUserIdentity	PwsUserRef	deprecated
EngagementTimestamp	String	deprecated	AAAAAA62DGw=
ProjectCostBaseline	PwsProjectCostBaselineElement	The complete set of information about the project cost baseline. Specify FullDetailFlag = true in request to get this value returned in the response.
ProjectCostBaselineIdentity	PwsProjectCostBaselineRef	The unique keys used to identify the project cost baseline
ProjectTimestamp	String	This is an optimistic locking timestamp that, if provided on update request, will cause the request to fail when the timestamp stored in the database does not match the provided value.	AAAAABFFCOw=
StolenLocks	PwsEntityLockSummary[1..100]	This structure contains information about the locks that were stolen in order to complete this request, Will be included only when LocksToSteal is specified in the request.

...

Versions Compared

Old Version 1

New Version 2

Key

Overview

Request Elements

Request Usage Example(s)

Page Comparison

Versions Compared

Old Version 1

New Version 2

Key

Request Elements

Request Usage Example(s)