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

« Previous Version 3 Next »

Overview


This web service retrieves a list of expense types (PwsExpenseType) for the installation of the authenticated user

Request Format


PwsGetExpenseTypes Request
  • PwsGetExpenseTypes
    • serviceRequest: PwsGetExpenseTypesRq
      • RequestId: Int32
      • SessionTicket: String
      • IncludeHardCostsFlag: Boolean
      • IncludeInactiveFlag: Boolean
      • IncludeMileageCostsFlag: Boolean
      • IncludeSoftCostsFlag: Boolean
      • IncludeVendorInvoiceCostsFlag: Boolean
      • ResourceIdentity: PwsResourceRef
      • IncludeSubcontractorInvoiceCostsFlag: Boolean

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

Ad9FlVn3Ywb5bdt3cQE3tg==

IncludeHardCostsFlag

Boolean

No 

false 

If set to 'true', expense types enabled for expense report entry are included in the results

true 

IncludeInactiveFlag

Boolean

No 

false 

If set to 'true', inactive expense types are included in the results

true 

IncludeMileageCostsFlag

Boolean

No 

false 

If set to 'true', mileage expense types are included in the results

true 

IncludeSoftCostsFlag

Boolean

No 

false 

If set to 'true', expense types enabled for soft costs are included in the results

true 

IncludeVendorInvoiceCostsFlag

Boolean

No 

false 

If set to 'true', expense types enabled for vendor invoices are included in the results

true 

ResourceIdentity

PwsResourceRef

No


??? 

true 

IncludeSubcontractorInvoiceCostsFlag

Boolean

No 

false 

If set to 'true', expense types enabled for subcontractor invoices are included in the results

true 

Request Usage Example(s)


Example 01 
<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:PwsGetExpenseTypes>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>Ad9FlVn3Ywb5bdt3cQE3tg==</req:SessionTicket>
            <tim:IncludeHardCostsFlag>true</tim:IncludeHardCostsFlag>
            <tim:IncludeInactiveFlag>true</tim:IncludeInactiveFlag>
            <tim:IncludeMileageCostsFlag>true</tim:IncludeMileageCostsFlag>
            <tim:IncludeSoftCostsFlag>true</tim:IncludeSoftCostsFlag>
            <tim:IncludeVendorInvoiceCostsFlag>true</tim:IncludeVendorInvoiceCostsFlag>
            <tim:IncludeSubcontractorInvoiceCostsFlag>true</tim:IncludeSubcontractorInvoiceCostsFlag>
         </pws:serviceRequest>
      </pws:PwsGetExpenseTypes>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


PwsGetExpenseTypes Response

Response Elements


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-02-28T18:50:42.6296994Z 

ExpenseTypes

PwsExpenseType

This structure represents the fields associated with an expense type


Response Usage Example(s)


Example 01 
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetExpenseTypesResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetExpenseTypesResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" 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-28T18:50:42.6296994Z</ServerTimestampUtc>
            <a:ExpenseTypes>
               <a:PwsExpenseType>
                  <ExpenseTypeId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <ExpenseTypeName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">Hotel</ExpenseTypeName>
                  <ExpenseTypeUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606879697</ExpenseTypeUid>
                  <a:DefaultUnitCost i:nil="true"/>
                  <a:DefaultUnitPrice i:nil="true"/>
                  <a:ExpenseEntryInstructions i:nil="true"/>
                  <a:HardCostFlag>false</a:HardCostFlag>
                  <a:MileageFlag>false</a:MileageFlag>
                  <a:ReceiptRequiredFlag>false</a:ReceiptRequiredFlag>
                  <a:SoftCostFlag>true</a:SoftCostFlag>
                  <a:TreatCostsAsPassthroughFlag>false</a:TreatCostsAsPassthroughFlag>
                  <a:Udf1Treatment>N</a:Udf1Treatment>
                  <a:Udf2Treatment>N</a:Udf2Treatment>
                  <a:UnitDrivenFlag>false</a:UnitDrivenFlag>
                  <a:UnitPluralName i:nil="true"/>
                  <a:UnitSingularName i:nil="true"/>
                  <a:VendorInvoiceCostFlag>false</a:VendorInvoiceCostFlag>
                  <a:DescriptionRequiredFlag>false</a:DescriptionRequiredFlag>
                  <a:ExpenseTypeGroupIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:ExpenseTypeGroupId i:nil="true"/>
                     <b:ExpenseTypeGroupName>Test Cases</b:ExpenseTypeGroupName>
                     <b:ExpenseTypeGroupUid>1152921504606849219</b:ExpenseTypeGroupUid>
                  </a:ExpenseTypeGroupIdentity>
                  <a:SubcontractorInvoiceFlag>false</a:SubcontractorInvoiceFlag>
                  <a:DefaultMarkupPercentage>0.1</a:DefaultMarkupPercentage>
                  <a:InactiveFlag>false</a:InactiveFlag>
                  <a:UnitDrivenPricingFlag>false</a:UnitDrivenPricingFlag>
                  <a:LockUnitCostFlag>false</a:LockUnitCostFlag>
               </a:PwsExpenseType>
               <a:PwsExpenseType>
                  <ExpenseTypeId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <ExpenseTypeName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">Subcontractor Expense Type</ExpenseTypeName>
                  <ExpenseTypeUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606872821</ExpenseTypeUid>
                  <a:DefaultUnitCost>0</a:DefaultUnitCost>
                  <a:DefaultUnitPrice>0</a:DefaultUnitPrice>
                  <a:ExpenseEntryInstructions>Subcontractor Expense Type</a:ExpenseEntryInstructions>
                  <a:HardCostFlag>false</a:HardCostFlag>
                  <a:MileageFlag>false</a:MileageFlag>
                  <a:ReceiptRequiredFlag>false</a:ReceiptRequiredFlag>
                  <a:SoftCostFlag>false</a:SoftCostFlag>
                  <a:TreatCostsAsPassthroughFlag>false</a:TreatCostsAsPassthroughFlag>
                  <a:Udf1Treatment>N</a:Udf1Treatment>
                  <a:Udf2Treatment>N</a:Udf2Treatment>
                  <a:UnitDrivenFlag>true</a:UnitDrivenFlag>
                  <a:UnitPluralName>hours</a:UnitPluralName>
                  <a:UnitSingularName>hour</a:UnitSingularName>
                  <a:VendorInvoiceCostFlag>false</a:VendorInvoiceCostFlag>
                  <a:DescriptionRequiredFlag>true</a:DescriptionRequiredFlag>
                  <a:ExpenseTypeGroupIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:ExpenseTypeGroupId i:nil="true"/>
                     <b:ExpenseTypeGroupName>Test Cases</b:ExpenseTypeGroupName>
                     <b:ExpenseTypeGroupUid>1152921504606849219</b:ExpenseTypeGroupUid>
                  </a:ExpenseTypeGroupIdentity>
                  <a:SubcontractorInvoiceFlag>true</a:SubcontractorInvoiceFlag>
                  <a:DefaultMarkupPercentage>-1</a:DefaultMarkupPercentage>
                  <a:InactiveFlag>false</a:InactiveFlag>
                  <a:UnitDrivenPricingFlag>true</a:UnitDrivenPricingFlag>
                  <a:LockUnitCostFlag>false</a:LockUnitCostFlag>
               </a:PwsExpenseType>
               <a:PwsExpenseType>
                  <ExpenseTypeId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <ExpenseTypeName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">Breakfast</ExpenseTypeName>
                  <ExpenseTypeUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606879679</ExpenseTypeUid>
                  <a:DefaultUnitCost i:nil="true"/>
                  <a:DefaultUnitPrice i:nil="true"/>
                  <a:ExpenseEntryInstructions>Treat Cost as Fees</a:ExpenseEntryInstructions>
                  <a:HardCostFlag>true</a:HardCostFlag>
                  <a:MileageFlag>false</a:MileageFlag>
                  <a:ReceiptRequiredFlag>false</a:ReceiptRequiredFlag>
                  <a:SoftCostFlag>true</a:SoftCostFlag>
                  <a:TreatCostsAsPassthroughFlag>false</a:TreatCostsAsPassthroughFlag>
                  <a:Udf1Treatment>N</a:Udf1Treatment>
                  <a:Udf2Treatment>N</a:Udf2Treatment>
                  <a:UnitDrivenFlag>false</a:UnitDrivenFlag>
                  <a:UnitPluralName i:nil="true"/>
                  <a:UnitSingularName i:nil="true"/>
                  <a:VendorInvoiceCostFlag>true</a:VendorInvoiceCostFlag>
                  <a:DescriptionRequiredFlag>true</a:DescriptionRequiredFlag>
                  <a:ExpenseTypeGroupIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:ExpenseTypeGroupId i:nil="true"/>
                     <b:ExpenseTypeGroupName>Test Cases</b:ExpenseTypeGroupName>
                     <b:ExpenseTypeGroupUid>1152921504606849219</b:ExpenseTypeGroupUid>
                  </a:ExpenseTypeGroupIdentity>
                  <a:SubcontractorInvoiceFlag>false</a:SubcontractorInvoiceFlag>
                  <a:DefaultMarkupPercentage>0</a:DefaultMarkupPercentage>
                  <a:InactiveFlag>false</a:InactiveFlag>
                  <a:UnitDrivenPricingFlag>false</a:UnitDrivenPricingFlag>
                  <a:LockUnitCostFlag>false</a:LockUnitCostFlag>
               </a:PwsExpenseType>
               <a:PwsExpenseType>
                  <ExpenseTypeId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <ExpenseTypeName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">Lunch</ExpenseTypeName>
                  <ExpenseTypeUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606879680</ExpenseTypeUid>
                  <a:DefaultUnitCost i:nil="true"/>
                  <a:DefaultUnitPrice i:nil="true"/>
                  <a:ExpenseEntryInstructions>Treat Costs as Fees (untrue)</a:ExpenseEntryInstructions>
                  <a:HardCostFlag>true</a:HardCostFlag>
                  <a:MileageFlag>false</a:MileageFlag>
                  <a:ReceiptRequiredFlag>false</a:ReceiptRequiredFlag>
                  <a:SoftCostFlag>true</a:SoftCostFlag>
                  <a:TreatCostsAsPassthroughFlag>false</a:TreatCostsAsPassthroughFlag>
                  <a:Udf1Treatment>N</a:Udf1Treatment>
                  <a:Udf2Treatment>N</a:Udf2Treatment>
                  <a:UnitDrivenFlag>false</a:UnitDrivenFlag>
                  <a:UnitPluralName i:nil="true"/>
                  <a:UnitSingularName i:nil="true"/>
                  <a:VendorInvoiceCostFlag>true</a:VendorInvoiceCostFlag>
                  <a:DescriptionRequiredFlag>false</a:DescriptionRequiredFlag>
                  <a:ExpenseTypeGroupIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:ExpenseTypeGroupId i:nil="true"/>
                     <b:ExpenseTypeGroupName>Test Cases</b:ExpenseTypeGroupName>
                     <b:ExpenseTypeGroupUid>1152921504606849219</b:ExpenseTypeGroupUid>
                  </a:ExpenseTypeGroupIdentity>
                  <a:SubcontractorInvoiceFlag>false</a:SubcontractorInvoiceFlag>
                  <a:DefaultMarkupPercentage>0</a:DefaultMarkupPercentage>
                  <a:InactiveFlag>false</a:InactiveFlag>
                  <a:UnitDrivenPricingFlag>false</a:UnitDrivenPricingFlag>
                  <a:LockUnitCostFlag>false</a:LockUnitCostFlag>
               </a:PwsExpenseType>
               <a:PwsExpenseType>
                  <ExpenseTypeId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <ExpenseTypeName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">Dinner</ExpenseTypeName>
                  <ExpenseTypeUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606879694</ExpenseTypeUid>
                  <a:DefaultUnitCost i:nil="true"/>
                  <a:DefaultUnitPrice i:nil="true"/>
                  <a:ExpenseEntryInstructions i:nil="true"/>
                  <a:HardCostFlag>true</a:HardCostFlag>
                  <a:MileageFlag>false</a:MileageFlag>
                  <a:ReceiptRequiredFlag>true</a:ReceiptRequiredFlag>
                  <a:SoftCostFlag>false</a:SoftCostFlag>
                  <a:TreatCostsAsPassthroughFlag>true</a:TreatCostsAsPassthroughFlag>
                  <a:Udf1Treatment>N</a:Udf1Treatment>
                  <a:Udf2Treatment>N</a:Udf2Treatment>
                  <a:UnitDrivenFlag>false</a:UnitDrivenFlag>
                  <a:UnitPluralName i:nil="true"/>
                  <a:UnitSingularName i:nil="true"/>
                  <a:VendorInvoiceCostFlag>false</a:VendorInvoiceCostFlag>
                  <a:DescriptionRequiredFlag>true</a:DescriptionRequiredFlag>
                  <a:ExpenseTypeGroupIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:ExpenseTypeGroupId i:nil="true"/>
                     <b:ExpenseTypeGroupName>Test Cases</b:ExpenseTypeGroupName>
                     <b:ExpenseTypeGroupUid>1152921504606849219</b:ExpenseTypeGroupUid>
                  </a:ExpenseTypeGroupIdentity>
                  <a:SubcontractorInvoiceFlag>false</a:SubcontractorInvoiceFlag>
                  <a:DefaultMarkupPercentage>0</a:DefaultMarkupPercentage>
                  <a:InactiveFlag>false</a:InactiveFlag>
                  <a:UnitDrivenPricingFlag>false</a:UnitDrivenPricingFlag>
                  <a:LockUnitCostFlag>false</a:LockUnitCostFlag>
               </a:PwsExpenseType>
            </a:ExpenseTypes>
         </PwsGetExpenseTypesResult>
      </PwsGetExpenseTypesResponse>
   </s:Body>
</s:Envelope>

PwsGetExpenseTypes - Common Errors and Warnings

ErrorNumber

ErrorCode

ErrorText

65168SpecifiedResourceDoesNotMatchExpenseReportResourceThe resource display name for an expense report mapping item must match the expense report resource.
  • No labels