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 structure represents the fields associated with an expense type

Format


PwsExpenseType
  • PwsExpenseType
    • ExpenseTypeId: Int32
    • ExpenseTypeName: String (50)
    • ExpenseTypeUid: Int64
    • DefaultUnitCost: Double
    • DefaultUnitPrice: Double
    • ExpenseEntryInstructions: String (1000)
    • HardCostFlag: Boolean
    • MileageFlag: Boolean
    • ReceiptRequiredFlag: Boolean
    • SoftCostFlag: Boolean
    • TreatCostsAsPassthroughFlag: Boolean
    • Udf1Treatment: String
    • Udf2Treatment: String
    • UnitDrivenFlag: Boolean
    • UnitPluralName: String
    • UnitSingularName: String
    • VendorInvoiceCostFlag: Boolean
    • DescriptionRequiredFlag: Boolean
    • ExpenseTypeGroupIdentity: PwsExpenseTypeGroupRef
    • SubcontractorInvoiceFlag: Boolean
    • DefaultMarkupPercentage: Double
    • InactiveFlag: Boolean
    • UnitDrivenPricingFlag: Boolean
    • LockUnitCostFlag: Boolean

Elements


Element

Data Type

Required?

Default

Description

Sample Data

ExpenseTypeId

Int32

No 


The expense type Id is a unique identifier for an expense type. For internal use only.

 

ExpenseTypeName

String (50)

One of ExpenseTypeName or ExpenseTypeUid is required


The expense type name is a unique identifier for an expense type

 

ExpenseTypeUid

Int64

See ExpenseTypeName 


A unique and immutable identifier for an expense type

 

DefaultUnitCost

Double

Yes (if UnitDrivenFlag = 'true')


The default cost per unit (for unit based expense types only)

 

DefaultUnitPrice

Double

Yes (if UnitDrivenFlag = 'true')


The default price per unit (for unit based expense types only)

 

ExpenseEntryInstructions

String (1000)

No


The expense entry instructions for the expense type

 

HardCostFlag

Boolean

No

false

If set to 'true', the expense type is enabled for expense reports

 

MileageFlag

Boolean

No 

false

If set to 'true', the expense type is mileage based

 

ReceiptRequiredFlag

Boolean

No

false

If set to 'true', receipts are required for expenses logged against this expense type

 

SoftCostFlag

Boolean

No 

false

If set to 'true', the expense type is enabled for soft costs

 

TreatCostsAsPassthroughFlag

Boolean

No 

false

If set to 'true', expenses logged against this expense type are treated as passthrough expenses

 

Udf1Treatment

String

No


User Defined Treatement for the first UDF associated with the expense type:

  • "R" for required – UDF should be displayed and requires a value. Yes/no UDFs never have this status, and always have a value of yes or no (checked or unchecked). There’s no third (i.e., null) state for yes/no UDFs.
  • "A" for available—UDF should be displayed and null is a valid value (except for yes/no; see above)
  • "N" for unavailable—This calls for displaying the UDF as read only if populated, and not displaying it at all otherwise. In the case of yes/no, only a value of yes/checked should cause the UDF to be displayed. <N> could be (a) UDF inactive flag = T, (b) Cost UDF expense type setting: Not available, or (c) Not enabled via Enterprise Configuration for a certain engagement type. 

 

Udf2Treatment

String

No 


User Defined Treatement for the second UDF associated with the expense type:

  • "R" for required – UDF should be displayed and requires a value. Yes/no UDFs never have this status, and always have a value of yes or no (checked or unchecked). There’s no third (i.e., null) state for yes/no UDFs.
  • "A" for available—UDF should be displayed and null is a valid value (except for yes/no; see above)
  • "N" for unavailable—This calls for displaying the UDF as read only if populated, and not displaying it at all otherwise. In the case of yes/no, only a value of yes/checked should cause the UDF to be displayed. <N> could be (a) UDF inactive flag = T, (b) Cost UDF expense type setting: Not available, or (c) Not enabled via Enterprise Configuration for a certain engagement type. 

 

UnitDrivenFlag

Boolean

No

false

If set to 'true', the expense type is unit based

 

UnitPluralName

String

Yes (if UnitDrivenFlag = 'true')


The plural name for a unit based expense type (i.e. widgets)

 

UnitSingularName

String

Yes (if UnitDrivenFlag = 'true')


The singular name for a unit based expense type (i.e. widget)

 

VendorInvoiceCostFlag

Boolean

No 

false

If set to 'true', the expense type is enabled for vendor invoices

 

DescriptionRequiredFlag

Boolean

No 

false

If set to 'true', descriptions are required for expenses logged against this expense type

 

ExpenseTypeGroupIdentity

PwsExpenseTypeGroupRef

Yes


The expense type group this expense type resides under

 

SubcontractorInvoiceFlag

Boolean

No 

false

If set to 'true', the expense type is enabled for subcontractor invoices

 

DefaultMarkupPercentage

Double

No

0

The default mark up percentage that will be applied to expenses entered against this expense type 

 

InactiveFlag

Boolean

No 

false

If set to 'true', this expense type is marked as inactive

 

UnitDrivenPricingFlag

Boolean

Yes (if UnitDrivenFlag = 'true')

false

If set to 'true', the expense type's pricing is unit based

 

LockUnitCostFlag

Boolean

No 

false

If set to 'true', the expense type's pricing is unit based and the unit cost is locked during expense entry

 

Usage Example(s)


Example 01
               <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/">1152921504606878414</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>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>Travel</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>
  • No labels