Overview
This structure contains the complete set of information about a cost card (less any subordinate entities). The structure is used both to retrieve detailed cost card information and to pass information about a cost card back to the server to get updated.
Format
| Panel | ||
|---|---|---|
| ||
|
Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
AdjustedRevenueAmount | Double | On Insert: No On Update: No | The adjusted revenue amount | ||
ApprovalWorkflowStatus | String | On Insert: No On Update: No | D | The cost card's approval workflow status "D" - Draft "R" - Rejected "S" - Submitted "A" - Approved | A |
ApprovedByUser | On Insert: No On Update: No | The identity of the user who approved the cost card | |||
ApprovedTimestamp | DateTime | On Insert: No On Update: No | The date and time when the cost card was approved | 2018-02-08T14:03:21.913Z | |
ApprovedToInvoiceByUser | On Insert: No On Update: No | The identity of the user who approved the cost card to invoice | |||
ApprovedToInvoiceTimestamp | DateTime | On Insert: No On Update: No | The date and time when the cost card was approved to invoice/bill | 2018-02-08T14:03:21.9Z | |
BilledTimestamp | DateTime | On Insert: No On Update: No | The date and time when the cost card was invoiced/billed | 2018-02-08T14:05:47.313Z | |
ClientAmount | Double | On Insert: No On Update: No | The client amount | 150.01 | |
CostCardDetail | On Insert: Yes On Update: Yes | The complete set of information about the constant cost card | |||
CreatedByUser | On Insert: No On Update: No | The identity of the user who created the cost card | |||
CreatedTimestamp | DateTime | On Insert: No On Update: No | The date and time when the cost card was invoiced/billed | 2018-02-08T13:52:45.937Z | |
CreditedCostCardIdentity | On Insert: No On Update: No | This is the identity of the associated credit cost card (if any) | |||
DisbursedAmountDisbursedCurrency | Double | On Insert: No On Update: No | The disbursed amount in disbursed currency | ||
DisbursedAmountEngagementCurrency | Double | On Insert: No On Update: No | The disbursed amount in engagement currency | ||
DocumentCount | Int32 | On Insert: No On Update: No | The number of documents (i.e. receipts) that are attached to this cost card | ||
EngagementCurrency | On Insert: No On Update: No | The currency of the engagement this cost card is entered against | |||
ExpenseAmount | Double | On Insert: Yes On Update: No | The expense amount, the amount that the company is responsible for paying in association with this cost card | 0 | |
ForReportingOnlyFlag | Boolean | On Insert: No On Update: No | If set to 'true', the card is defined as for reporting only | false | |
FxRate | Double | On Insert: No On Update: No | The default/system foreign exchange rate associated with the cost card | 1 | |
FxRateActual | Double | On Insert: No On Update: No | The actual foreign exchange rate associated with the cost card | 1 | |
InvoiceIdentity | On Insert: No On Update: No | The invoice associated with the cost card (if any) | |||
InvoiceWorkflowStatus | String | On Insert: No On Update: No | N | The invoice workflow status "N" - Not approved "A" - Approved "I" - Invoiced (Draft) "B" - Invoiced | B |
InvoicedAmount | Double | On Insert: No On Update: No | The invoice amount | 150.01 | |
LastUpdatedByUser | On Insert: No On Update: No | The identity of the user who last udpated the cost card | |||
LastUpdatedTimestamp | DateTime | On Insert: No On Update: No | The date and time when the cost card was last updated | 2018-02-08T14:04:34.653Z | |
LockedFlag | Boolean | On Insert: No On Update: No | If set to 'true', the cost card is locked and cannot be edited | true | |
NoteCount | Int32 | On Insert: No On Update: No | The number of receipt notes associated with the cost card (if any) | 0 | |
RejectedByUser | On Insert: No On Update: No | The identity of the user who rejected the cost card | |||
RejectedReason | String (255) | On Insert: No On Update: No | The reject reason associated with the cost card | ||
RejectedTimestamp | DateTime | On Insert: No On Update: No | The date and time when the cost card was rejected | ||
RevRecAdjustmentAmount | Double | On Insert: No On Update: No | The revenue recognition adjustment amount | ||
RevenueAmount | Double | On Insert: No On Update: No | The revenue amount | ||
Status | String | On Insert: Yes On Update: No | N | The current status of the cost card: "N" - Not approved "R" - Rejected "A" - Approved "I" - Invoiced (Draft) "B" - Invoiced | B |
SubmittedByUser | On Insert: No On Update: No | The identity of the user who submitted the cost card | |||
SubmittedTimestamp | DateTime | On Insert: No On Update: No | The date and time when the cost card was submitted | 2018-02-08T13:52:46.533Z | |
SystemRatePerMileageUnit | Double | On Insert: No On Update: No | dependent on the resource's location | The default/system mileage rate | 0.575 |
UnitCost | Double | On Insert: No On Update: No | dependent on expense type | The unit cost | 150.01 |
UnitPrice | Double | On Insert: No On Update: No | dependent on expense type | The unit price | 150.01 |
VatAmountDisbursedCurrency | Double | On Insert: No On Update: No | The value-added tax in the disbursed currency | 0 | |
VoucherIdentity | On Insert: No On Update: No | The payment voucher associated with the cost card (if any) | |||
WipAmount | Double | On Insert: No On Update: No | The work in progress amount | ||
ChargeableFlag | Boolean | On Insert: No On Update: No | true | If set to 'true', the cost card is marked as chargeable/billable to the client | true |
DisbursingCostCenterIdentity | On Insert: No On Update: No | The disbursing cost card | |||
EngagementCurrencyDecimalDigits | Byte | On Insert: No On Update: No | The number of decimal places associated with the engagement currency. Note: Computed amounts are always rounded to the nearest minor currency unit as identified by the currency's decimalDigits property | 2 | |
EngagementTypeBillableFlag | Boolean | On Insert: No On Update: No | If set to 'true', the engagement the cost card is entered against is defined as billable | true | |
IncurredCurrencyDecimalDigits | Byte | On Insert: No On Update: No | The number of decimal places associated with the incurred currency. Note: Computed amounts are always rounded to the nearest minor currency unit as identified by the currency's decimalDigits property | 2 | |
ManagementData | On Insert: No On Update: No | The key cost card fields that are associated with managing the cost card after it has been submitted for approval | |||
PaymentVoucherPaymentWorkflowStatus | String | On Insert: No On Update: No | N | The payment workflow status "N" - Not Approved "A" - Approved "T" - Transmitted "PR" - Partially Received "R" - Received | N |
ProjectName | String | On Insert: Yes On Update: No | The identity of the project this cost card is entered against | Project A |
Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<a:PwsCostCardElement>
<a:AdjustedRevenueAmount i:nil="true"/>
<a:ApprovalWorkflowStatus>A</a:ApprovalWorkflowStatus>
<a:ApprovedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:UserDisplayName>Jack Spratt</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
<b:UserUid>1152921504607112369</b:UserUid>
<b:EmailAddress>jack@revcorp.bb</b:EmailAddress>
<b:FirstName>Jack</b:FirstName>
<b:LastName>Spratt</b:LastName>
<b:MiddleName i:nil="true"/>
</a:ApprovedByUser>
<a:ApprovedTimestamp>2018-02-08T14:03:21.913Z</a:ApprovedTimestamp>
<a:ApprovedToInvoiceByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:UserDisplayName>Jack Spratt</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
<b:UserUid>1152921504607112369</b:UserUid>
<b:EmailAddress>jack@revcorp.bb</b:EmailAddress>
<b:FirstName>Jack</b:FirstName>
<b:LastName>Spratt</b:LastName>
<b:MiddleName i:nil="true"/>
</a:ApprovedToInvoiceByUser>
<a:ApprovedToInvoiceTimestamp>2018-02-08T14:03:21.9Z</a:ApprovedToInvoiceTimestamp>
<a:BilledTimestamp>2018-02-08T14:05:47.313Z</a:BilledTimestamp>
<a:ClientAmount>150.01</a:ClientAmount>
<a:CostCardDetail>
<CostCardId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<CostCardUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504614515256</CostCardUid>
<ReferenceId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<a:Description>Team 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>150.01</a:IncurredAmount>
<a:IncurredDate>2018-02-05T00: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>AAAAAA62IwU=</a:Timestamp>
<a:TotalAmountDisbursedCurrency>150.01</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>4</b:IntegerValue>
<b:ResourceIdentityValue i:nil="true"/>
<b:TextValue i:nil="true"/>
<b:UdfTreatment>A</b:UdfTreatment>
<b:StoplightValues/>
<b:NumericValue>4</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 i:nil="true"/>
<a:ExternalGroupingIdentifierClearFlag>false</a:ExternalGroupingIdentifierClearFlag>
</a:CostCardDetail>
<a:CreatedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:UserDisplayName>Beth Brown</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>E125</b:UserReferenceSystemId>
<b:UserUid>1152921504607112693</b:UserUid>
<b:EmailAddress>beth@revcorp.bb</b:EmailAddress>
<b:FirstName>Beth</b:FirstName>
<b:LastName>Brown</b:LastName>
<b:MiddleName i:nil="true"/>
</a:CreatedByUser>
<a:CreatedTimestamp>2018-02-08T13:52:45.937Z</a:CreatedTimestamp>
<a:CreditedCostCardIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<a:DisbursedAmountDisbursedCurrency>150.01</a:DisbursedAmountDisbursedCurrency>
<a:DisbursedAmountEngagementCurrency>150.01</a:DisbursedAmountEngagementCurrency>
<a:DocumentCount>0</a:DocumentCount>
<a:EngagementCurrency xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:CurrencyCode>USD</b:CurrencyCode>
<b:CurrencyId i:nil="true"/>
<b:CurrencyUid>1152921504606851838</b:CurrencyUid>
</a:EngagementCurrency>
<a:ExpenseAmount>0</a:ExpenseAmount>
<a:ForReportingOnlyFlag>false</a:ForReportingOnlyFlag>
<a:FxRate>1</a:FxRate>
<a:FxRateActual>1</a:FxRateActual>
<a:InvoiceIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:InvoiceId i:nil="true"/>
<b:InvoiceNumber>INV00462</b:InvoiceNumber>
<b:InvoiceUid>1152921504607622627</b:InvoiceUid>
</a:InvoiceIdentity>
<a:InvoiceWorkflowStatus>B</a:InvoiceWorkflowStatus>
<a:InvoicedAmount>150.01</a:InvoicedAmount>
<a:LastUpdatedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:UserDisplayName>Jack Spratt</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
<b:UserUid>1152921504607112369</b:UserUid>
<b:EmailAddress>jack@revcorp.bb</b:EmailAddress>
<b:FirstName>Jack</b:FirstName>
<b:LastName>Spratt</b:LastName>
<b:MiddleName i:nil="true"/>
</a:LastUpdatedByUser>
<a:LastUpdatedTimestamp>2018-02-08T14:04:34.653Z</a:LastUpdatedTimestamp>
<a:LockedFlag>true</a:LockedFlag>
<a:NoteCount>0</a:NoteCount>
<a:RejectedByUser i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<a:RejectedReason i:nil="true"/>
<a:RejectedTimestamp i:nil="true"/>
<a:RevRecAdjustmentAmount i:nil="true"/>
<a:RevenueAmount>0</a:RevenueAmount>
<a:Status>B</a:Status>
<a:SubmittedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:UserDisplayName>Beth Brown</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>E125</b:UserReferenceSystemId>
<b:UserUid>1152921504607112693</b:UserUid>
<b:EmailAddress>beth@revcorp.bb</b:EmailAddress>
<b:FirstName>Beth</b:FirstName>
<b:LastName>Brown</b:LastName>
<b:MiddleName i:nil="true"/>
</a:SubmittedByUser>
<a:SubmittedTimestamp>2018-02-08T13:52:46.533Z</a:SubmittedTimestamp>
<a:SystemRatePerMileageUnit>0.575</a:SystemRatePerMileageUnit>
<a:UnitCost>150.01</a:UnitCost>
<a:UnitPrice>150.01</a:UnitPrice>
<a:VatAmountDisbursedCurrency>0</a:VatAmountDisbursedCurrency>
<a:VoucherIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<a:WipAmount i:nil="true"/>
<a:ChargeableFlag>true</a:ChargeableFlag>
<a:DisbursingCostCenterIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:CostCenterId i:nil="true"/>
<b:CostCenterName>Section B</b:CostCenterName>
<b:CostCenterNumber>Section B</b:CostCenterNumber>
<b:CostCenterUid>1152921504606884477</b:CostCenterUid>
</a:DisbursingCostCenterIdentity>
<a:EngagementCurrencyDecimalDigits>2</a:EngagementCurrencyDecimalDigits>
<a:EngagementTypeBillableFlag>true</a:EngagementTypeBillableFlag>
<a:IncurredCurrencyDecimalDigits>2</a:IncurredCurrencyDecimalDigits>
<a:ManagementData>
<a:AccountingPeriodClosedFlag>false</a:AccountingPeriodClosedFlag>
<a:ApprovalWorkflowFlag>true</a:ApprovalWorkflowFlag>
<a:ApproverFlag>false</a:ApproverFlag>
<a:ApproverToInvoiceFlag>true</a:ApproverToInvoiceFlag>
<a:ApproverToPayFlag>false</a:ApproverToPayFlag>
<a:ApproversCanRejectApprovedExpensesFlag>false</a:ApproversCanRejectApprovedExpensesFlag>
<a:AutoApprovalFlag>false</a:AutoApprovalFlag>
<a:AutoApprovalToInvoiceFlag>false</a:AutoApprovalToInvoiceFlag>
<a:AutoApprovalToPayFlag>false</a:AutoApprovalToPayFlag>
<a:AwsApprovedStatusAllowedFlag>false</a:AwsApprovedStatusAllowedFlag>
<a:AwsDraftStatusAllowedFlag>false</a:AwsDraftStatusAllowedFlag>
<a:AwsRejectedStatusAllowedFlag>false</a:AwsRejectedStatusAllowedFlag>
<a:AwsSubmittedStatusAllowedFlag>false</a:AwsSubmittedStatusAllowedFlag>
<a:CanAdjustFlag>true</a:CanAdjustFlag>
<a:CanEditFlag>false</a:CanEditFlag>
<a:ClientIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:ClientId i:nil="true"/>
<b:ClientNumber>PR-PSA</b:ClientNumber>
<b:ClientUid>1152921504606961482</b:ClientUid>
</a:ClientIdentity>
<a:ClientName>Projector PSA</a:ClientName>
<a:DisbursedCurrencyDecimalDigits>2</a:DisbursedCurrencyDecimalDigits>
<a:DisbursedCurrencyIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:CurrencyCode>USD</b:CurrencyCode>
<b:CurrencyId i:nil="true"/>
<b:CurrencyUid>1152921504606851838</b:CurrencyUid>
</a:DisbursedCurrencyIdentity>
<a:DisbursingCostCenterIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:CostCenterId i:nil="true"/>
<b:CostCenterName>Section B</b:CostCenterName>
<b:CostCenterNumber>Section B</b:CostCenterNumber>
<b:CostCenterUid>1152921504606884477</b:CostCenterUid>
</a:DisbursingCostCenterIdentity>
<a:EditSubmitFlag>false</a:EditSubmitFlag>
<a:ExpenseDocumentIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:DocumentNumber>ER00709</b:DocumentNumber>
<b:ExpenseDocumentId i:nil="true"/>
<b:ExpenseDocumentUid>1152921504607683557</b:ExpenseDocumentUid>
</a:ExpenseDocumentIdentity>
<a:ExpenseDocumentName>Status Report</a:ExpenseDocumentName>
<a:ExpenseDocumentTimestamp>AAAAAA62IyE=</a:ExpenseDocumentTimestamp>
<a:ExpenseDocumentType>E</a:ExpenseDocumentType>
<a:ExpenseDocumentVatFlag>false</a:ExpenseDocumentVatFlag>
<a:IwsApprovedStatusAllowedFlag>false</a:IwsApprovedStatusAllowedFlag>
<a:IwsDraftInvoiceStatusAllowedFlag>false</a:IwsDraftInvoiceStatusAllowedFlag>
<a:IwsInvoicedStatusAllowedFlag>false</a:IwsInvoicedStatusAllowedFlag>
<a:IwsUnapprovedStatusAllowedFlag>false</a:IwsUnapprovedStatusAllowedFlag>
<a:MileageUom>M</a:MileageUom>
<a:PwsApprovedStatusAllowedFlag>false</a:PwsApprovedStatusAllowedFlag>
<a:PwsPaidStatusAllowedFlag>false</a:PwsPaidStatusAllowedFlag>
<a:PwsReceivedStatusAllowedFlag>false</a:PwsReceivedStatusAllowedFlag>
<a:PwsTransmittedStatusAllowedFlag>false</a:PwsTransmittedStatusAllowedFlag>
<a:PwsUnapprovedStatusAllowedFlag>false</a:PwsUnapprovedStatusAllowedFlag>
</a:ManagementData>
<a:PaymentVoucherPaymentWorkflowStatus>N</a:PaymentVoucherPaymentWorkflowStatus>
<a:ProjectName>Project A</a:ProjectName>
</a:PwsCostCardElement>
|