Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
titlePwsCostCardDetail
  • PwsCostCardDetail
    • CostCardId: Int32
    • CostCardUid: Int64
    • ReferenceId: String
    • Description: String (4000)
    • DescriptionClearFlag: Boolean
    • ExpenseTypeIdentity: PwsExpenseTypeRef
    • IncurredAmount: Double
    • IncurredDate: DateTime
    • IncurredOpsCurrencyIdentity: PwsOpsCurrencyRef
    • IncurredVatAmount: Double
    • LocationClearFlag: Boolean
    • LocationIdentity: PwsLocationRef
    • NonBillableFlag: Boolean
    • OverrideClientAmount: Double
    • OverrideClientAmountClearFlag: Boolean
    • PayeeVendorClearFlag: Boolean
    • PayeeVendorIdentity: PwsVendorRef
    • ProjectIdentity: PwsProjectRef
    • ResourceClearFlag: Boolean
    • ResourceIdentity: PwsResourceRef
    • Timestamp: String
    • TotalAmountDisbursedCurrency: Double
    • Udf1: PwsUserDefinedFieldDetail
    • Udf1ClearFlag: Boolean
    • Udf2: PwsUserDefinedFieldDetail
    • Udf2ClearFlag: Boolean
    • Units: Double
    • ExternalGroupingIdentifier: Int32
    • ExternalGroupingIdentifierClearFlag: Boolean

Elements


Element
 

xElement

Data Type

Required?

Default

Description

Sample Data

CostCardId

Int32

 

 

 

 

On Insert: No

On Update: No


The cost card Id is a unique identifier for a cost card. For internal use only.  


CostCardUid

Int64

 

 

 

 

On Insert: Yes

On Update: Yes


The cost card Uid is a unique and immutable identifier for a cost card

1152921504614515248

ReferenceId

String

 

 

 

On Insert: No

On Update: No


Reference id (used to affiliate PwsSaveCostCardResult records with associated PwsCostCardDetail records). 

123

Description

String

 

 

 

 

(4000)

On Insert: Yes (if the associated expense type requires a description)

On Update: No


The cost card description. This field can be defined as a required field based on an expense type setting.

Breakfast Meeting

DescriptionClearFlag

Boolean

  

No

 

 

 

false

If set to 'true', the cost card description will be set to null

false

ExpenseTypeIdentity

PwsExpenseTypeRef

 

 

 

 

On Insert: Yes

On Update: No


The expense type associated with the cost card


IncurredAmount

Double

 

 

 

 

On Insert: Yes

On Update: No


The incurred amount (i.e. the amount that was spent) associated with the cost card

179.99

IncurredDate

DateTime

 

 

 

 

On Insert: Yes

On Update: No


The date the expense was incurred (in midnight UTC format)

2018-02-06T00:00:00Z

IncurredOpsCurrencyIdentity

PwsOpsCurrencyRef

 

 

 

 

On Insert: Yes

On Update: No


The currency associated with the incurred amount


IncurredVatAmount

Double

 

 

 

On Insert: No

On Update: No


The value added tax associated with the expense

0

LocationClearFlag

Boolean

 

 

 

  

On Insert: No

On Update: No

false

If set to 'true', the cost card location will be set to null

false

LocationIdentity

PwsLocationRef

 

 

 

 

On Insert: Yes (if location is required on cost cards due to installation settings)

On Update: No


The location associated with the cost card. This field can be defined as a required field based on an installation setting.


NonBillableFlag

Boolean

 

 

 

 

On Insert: No

On Update: No

false

If set to 'true', the expense will not be billable to the client

false

OverrideClientAmount

Double

 

 

 

 

On Insert: No

On Update: No


The amount provided here will override the calculated client amount for the cost card

false

OverrideClientAmountClearFlag

Boolean

 

 

 

 

On Insert: No

On Update: No


If set to 'true', the overridden client amount will be reset to the calculated client amount

false

PayeeVendorClearFlag

Boolean

 

 

 

 

On Insert: No

On Update: No


If set to 'true', the payee vendor will be reset to null

false

PayeeVendorIdentity

PwsVendorRef

 

 

 

 

On Insert: Yes

On Update: No


The payee vendor associated with the cost card


ProjectIdentity

PwsProjectRef

 

 

 

On Insert: Yes

On Update: No


The project associated with the cost card


ResourceClearFlag

Boolean

 

 

 

  

On Insert: No

On Update: No

false

If set to 'true', the resource associated with the cost card will be reset to null (note: a null resouce is not valid for a cost card on an expense report)

false

ResourceIdentity

PwsResourceRef

 

 

 

 

On Insert: Yes (if the cost card is on an expense report)

On Update: No


The resource associated with the cost card


Timestamp

String

 

 

 

 

On Insert: Yes

On Update: No


This is a Base64 encoded timestamp optionally utilized for cost card locking 

AAAAAA62IdY=

TotalAmountDisbursedCurrency

Double

 

 

 

 

On Insert: Yes

On Update: No


The total amount in disbursed currency

179.99

Udf1

PwsUserDefinedFieldDetail

 

 

 

On Insert: Yes (if the associated expense type requires this UDF)

On Update: No


The first user defined field. Cost Cards may have a maximum of two User Defined Fields.


Udf1ClearFlag

Boolean

 

 

 

  

On Insert: No

On Update: No

false

If set to 'true', Udf1 will be reset to null

false

Udf2

PwsUserDefinedFieldDetail

 

 

 

 

On Insert: Yes (if the associated expense type requires this UDF)

On Update: No


The second user defined field. Cost Cards may have a maximum of two User Defined Fields.


Udf2ClearFlag

Boolean

 

 

 

On Insert: No

On Update: No


If set to 'true', Udf2 will be reset to null

false

Units

Double

 

 

 

  

On Insert: No

On Update: No

1

The number of units associated with the cost card expense

1

ExternalGroupingIdentifier

Int32

 

 

 

On Insert: No

On Update: No


This unique identifier allows users to group multiple cost cards together, most commonly user for reporting purposes

123

ExternalGroupingIdentifierClearFlag

Boolean

 

 

 

 

...

On Insert: No

On Update: No

false

If set to 'true', the external grouping identifier is reset to null

false

Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
                      <a:CostCardDetail>
                        <CostCardId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <CostCardUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504614515248</CostCardUid>
                        <ReferenceId xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">123</ReferenceId>
                        <a:Description>Breakfast Meeting</a:Description>
                        <a:DescriptionClearFlag>false</a:DescriptionClearFlag>
                        <a:ExpenseTypeIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:ExpenseTypeId i:nil="true"/>
                           <b:ExpenseTypeName>Meals</b:ExpenseTypeName>
                           <b:ExpenseTypeUid>1152921504606878415</b:ExpenseTypeUid>
                        </a:ExpenseTypeIdentity>
                        <a:IncurredAmount>179.99</a:IncurredAmount>
                        <a:IncurredDate>2018-02-06T00:00:00Z</a:IncurredDate>
                        <a:IncurredOpsCurrencyIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:OpsCurrencyCode>USD</b:OpsCurrencyCode>
                           <b:OpsCurrencyId i:nil="true"/>
                        </a:IncurredOpsCurrencyIdentity>
                        <a:IncurredVatAmount>0</a:IncurredVatAmount>
                        <a:LocationClearFlag>false</a:LocationClearFlag>
                        <a:LocationIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:LocationId i:nil="true"/>
                           <b:LocationName>USA</b:LocationName>
                           <b:LocationUid>1152921504606855985</b:LocationUid>
                        </a:LocationIdentity>
                        <a:NonBillableFlag>false</a:NonBillableFlag>
                        <a:OverrideClientAmount i:nil="true"/>
                        <a:OverrideClientAmountClearFlag>false</a:OverrideClientAmountClearFlag>
                        <a:PayeeVendorClearFlag>false</a:PayeeVendorClearFlag>
                        <a:PayeeVendorIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:VendorId i:nil="true"/>
                           <b:VendorName>Beth Brown</b:VendorName>
                           <b:VendorUid>1152921504607055834</b:VendorUid>
                           <b:VendorNumber>Beth Brown</b:VendorNumber>
                        </a:PayeeVendorIdentity>
                        <a:ProjectIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:ProjectCode>P001407-001</b:ProjectCode>
                           <b:ProjectId i:nil="true"/>
                           <b:ProjectUid>1152921504607413030</b:ProjectUid>
                        </a:ProjectIdentity>
                        <a:ResourceClearFlag>false</a:ResourceClearFlag>
                        <a:ResourceIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:ResourceDisplayName>Beth Brown</b:ResourceDisplayName>
                           <b:ResourceId i:nil="true"/>
                           <b:ResourceReferenceSystemId>E125</b:ResourceReferenceSystemId>
                           <b:ResourceUid>1152921504607111786</b:ResourceUid>
                        </a:ResourceIdentity>
                        <a:Timestamp>AAAAAA62IdY=</a:Timestamp>
                        <a:TotalAmountDisbursedCurrency>179.99</a:TotalAmountDisbursedCurrency>
                        <a:Udf1 xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>Attendees</b:UdfName>
                           <b:UdfUid>1152921504606860180</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>I</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue>10</b:IntegerValue>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue>10</b:NumericValue>
                           <b:RelationValue i:nil="true"/>
                        </a:Udf1>
                        <a:Udf1ClearFlag>false</a:Udf1ClearFlag>
                        <a:Udf2 xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>Purpose</b:UdfName>
                           <b:UdfUid>1152921504606860181</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>L</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue>Team Building</b:TextValue>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </a:Udf2>
                        <a:Udf2ClearFlag>false</a:Udf2ClearFlag>
                        <a:Units>1</a:Units>
                        <a:ExternalGroupingIdentifier>123</a:ExternalGroupingIdentifier>
                        <a:ExternalGroupingIdentifierClearFlag>false</a:ExternalGroupingIdentifierClearFlag>
                     </a:CostCardDetail>