Overview

This web service inserts or updates a single expense document based on a detailed expense document structure (PwsExpenseDocumentDetail). The service returns the identity (PwsClientRef) of the client that has been inserted or updated. The caller can optionally request that the full client detail (PwsClientElement) be included in the response.

Request Format

PwsSaveExpenseDocument Request

PwsSaveExpenseDocument
- serviceRequest: PwsSaveExpenseDocumentRq
  - RequestId: Int32
  - SessionTicket: String
  - AdministratorComments: String
  - ApproverIdentities: PwsUserRef[]
  - DeleteCostCards: PwsCostCardRef[]
  - DeleteReceipts: PwsReceiptRef[]
  - ExcludeCreditCostCardsFlag: Boolean
  - ExpenseDocument: PwsExpenseDocumentDetail
  - ExpenseDocumentIdentity: PwsExpenseDocumentRef
  - FullDetailFlag: Boolean
  - InsertReceiptsIfNotFoundOnUpdateFlag: Boolean
  - ResourceIdentity: PwsResourceRef
  - RetrieveCostCardsFlag: Boolean
  - RetrieveReceiptsFlag: Boolean
  - SaveCostCards: PwsCostCardDetail[]
  - SaveReceipts: PwsReceiptDetail[]
  - SendNotificationEmailFlag: Boolean
  - SubmissionComments: String
  - SubmitFlag: Boolean
  - UpdateReceiptsIfFoundOnInsertFlag: Boolean
  - ExpenseDocumentTimestamp: String
  - PreserveCostCardStatusFlag: Boolean ** deprecated **

Request Elements

Element	Data Type	Required?	Default	Description
RequestId	Int32	No		Click here for more information.
SessionTicket	String	Yes		Click here for more information.
AdministratorComments	String	No		Administrator comments to be stored with the expense document upon save
ApproverIdentities	PwsUserRef[]	No		Projector users who have the ability to approve this expense document
DeleteCostCards	PwsCostCardRef[]	No		Key fields identifying the cost cards that should be deleted from the expense document
DeleteReceipts	PwsReceiptRef[]	No		Key fields identifying the receipts that should be deleted from the expense documents
ExcludeCreditCostCardsFlag	Boolean	No	true	If set to 'true', credit cost cards will be excluded from the expense document
ExpenseDocument	PwsExpenseDocumentDetail	On Insert: Yes On Update: No		The detailed expense document information to be inserted or updated
ExpenseDocumentIdentity	PwsExpenseDocumentRef	On Insert: No On Update: Yes		The unique keys used to identify the expense document
FullDetailFlag	Boolean	No	false
InsertReceiptsIfNotFoundOnUpdateFlag	Boolean	No	false
ResourceIdentity	PwsResourceRef	On Insert: Yes (for expense documents only) On Update: No
RetrieveCostCardsFlag	Boolean	No	false
RetrieveReceiptsFlag	Boolean	No	false
SaveCostCards	PwsCostCardDetail[]	No
SaveReceipts	PwsReceiptDetail[]	No
SendNotificationEmailFlag	Boolean	No	false
SubmissionComments	String	No
SubmitFlag	Boolean	No	false
UpdateReceiptsIfFoundOnInsertFlag	Boolean	No	false
ExpenseDocumentTimestamp	String	No
PreserveCostCardStatusFlag	Boolean	deprecated		** This field has been deprecated

Request Usage Example(s)

Example 01 - Expense Document

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:tim="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsSaveExpenseDocument>
         <pws:serviceRequest>
            <req:SessionTicket>AcdrvYuS1YjvT27fonW7Cw==</req:SessionTicket>
            <tim:ExcludeCreditCostCardsFlag>true</tim:ExcludeCreditCostCardsFlag>
            <tim:ExpenseDocument>
               <tim:CashAdvanceReturnAmount>1.00</tim:CashAdvanceReturnAmount>
               <tim:DocumentName>Expense Document A</tim:DocumentName>
               <tim:DocumentType>E</tim:DocumentType>
               <tim:LocationIdentity>
                  <com:LocationName>USA</com:LocationName>
               </tim:LocationIdentity>
               <tim:ResourceIdentity>
                  <com:ResourceReferenceSystemId>E125</com:ResourceReferenceSystemId>
               </tim:ResourceIdentity>
               <tim:VendorIdentity>
                  <com:VendorNumber>Beth Brown</com:VendorNumber>
               </tim:VendorIdentity>
               <tim:Vendor>
                  <com:VendorNumber>Beth Brown</com:VendorNumber>
                  <com:ExpenseReportPayeeFlag>true</com:ExpenseReportPayeeFlag>
                  <com:InactiveFlag>false</com:InactiveFlag>
                  <com:ResourceVendorFlag>true</com:ResourceVendorFlag>
                  <com:VendorInvoicePayeeFlag>false</com:VendorInvoicePayeeFlag>
                  <com:SubcontractorInvoicePayeeFlag>false</com:SubcontractorInvoicePayeeFlag>
               </tim:Vendor>
               <tim:SubcontractorInvoiceReferenceNumberClearFlag>false</tim:SubcontractorInvoiceReferenceNumberClearFlag>
               <tim:VendorInvoiceReferenceNumberClearFlag>false</tim:VendorInvoiceReferenceNumberClearFlag>
            </tim:ExpenseDocument>
            <tim:FullDetailFlag>true</tim:FullDetailFlag>
            <tim:InsertReceiptsIfNotFoundOnUpdateFlag>false</tim:InsertReceiptsIfNotFoundOnUpdateFlag>
            <tim:ResourceIdentity>
               <com:ResourceReferenceSystemId>E125</com:ResourceReferenceSystemId>
            </tim:ResourceIdentity>
            <tim:RetrieveCostCardsFlag>false</tim:RetrieveCostCardsFlag>
            <tim:RetrieveReceiptsFlag>false</tim:RetrieveReceiptsFlag>
            <tim:SaveCostCards>
               <tim:PwsCostCardDetail>
                  <tim:Description>Breakfast</tim:Description>
                  <tim:DescriptionClearFlag>false</tim:DescriptionClearFlag>
                  <tim:ExpenseTypeIdentity>
                     <com:ExpenseTypeName>Meals</com:ExpenseTypeName>
                  </tim:ExpenseTypeIdentity>
                  <tim:IncurredAmount>7.99</tim:IncurredAmount>
                  <tim:IncurredDate>2018-02-06T00:00:00.000Z</tim:IncurredDate>
                  <tim:IncurredOpsCurrencyIdentity>
                     <com:OpsCurrencyCode>USD</com:OpsCurrencyCode>
                  </tim:IncurredOpsCurrencyIdentity>
                  <tim:IncurredVatAmount>0</tim:IncurredVatAmount>
                  <tim:LocationClearFlag>false</tim:LocationClearFlag>
                  <tim:LocationIdentity>
                     <com:LocationName>USA</com:LocationName>
                  </tim:LocationIdentity>
                  <tim:NonBillableFlag>false</tim:NonBillableFlag>
                  <tim:OverrideClientAmountClearFlag>false</tim:OverrideClientAmountClearFlag>
                  <tim:PayeeVendorClearFlag>false</tim:PayeeVendorClearFlag>
                  <tim:PayeeVendorIdentity>
                     <com:VendorNumber>Beth Brown</com:VendorNumber>
                  </tim:PayeeVendorIdentity>
                  <tim:ProjectIdentity>
                     <com:ProjectCode>P001407-001</com:ProjectCode>
                  </tim:ProjectIdentity>
                  <tim:ResourceClearFlag>false</tim:ResourceClearFlag>
                  <tim:ResourceIdentity>
                     <com:ResourceReferenceSystemId>E125</com:ResourceReferenceSystemId>
                  </tim:ResourceIdentity>
                  <tim:TotalAmountDisbursedCurrency>7.99</tim:TotalAmountDisbursedCurrency>
                  <tim:Udf1ClearFlag>false</tim:Udf1ClearFlag>
                  <tim:Udf2ClearFlag>false</tim:Udf2ClearFlag>
                  <tim:ExternalGroupingIdentifierClearFlag>false</tim:ExternalGroupingIdentifierClearFlag>
               </tim:PwsCostCardDetail>
            </tim:SaveCostCards>
            <tim:SendNotificationEmailFlag>true</tim:SendNotificationEmailFlag>
            <tim:SubmissionComments>Submitted</tim:SubmissionComments>
            <tim:SubmitFlag>true</tim:SubmitFlag>
            <tim:UpdateReceiptsIfFoundOnInsertFlag>false</tim:UpdateReceiptsIfFoundOnInsertFlag>
         </pws:serviceRequest>
      </pws:PwsSaveExpenseDocument>
   </soapenv:Body>
</soapenv:Envelope>