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
- PwsCostCardElement
- AdjustedRevenueAmount: Double
- ApprovalWorkflowStatus: String
- ApprovedByUser: PwsUserSummary
- ApprovedTimestamp: DateTime
- ApprovedToInvoiceByUser: PwsUserSummary
- ApprovedToInvoiceTimestamp: DateTime
- BilledTimestamp: DateTime
- ClientAmount: Double
- CostCardDetail: PwsCostCardDetail
- CreatedByUser: PwsUserSummary
- CreatedTimestamp: DateTime
- CreditedCostCardIdentity: PwsCostCardRef
- DisbursedAmountDisbursedCurrency: Double
- DisbursedAmountEngagementCurrency: Double
- DocumentCount: Int32
- EngagementCurrency: PwsCurrencyRef
- ExpenseAmount: Double
- ForReportingOnlyFlag: Boolean
- FxRate: Double
- FxRateActual: Double
- InvoiceIdentity: PwsInvoiceRef
- InvoiceWorkflowStatus: String
- InvoicedAmount: Double
- LastUpdatedByUser: PwsUserSummary
- LastUpdatedTimestamp: DateTime
- LockedFlag: Boolean
- NoteCount: Int32
- RejectedByUser: PwsUserSummary
- RejectedReason: String (255)
- RejectedTimestamp: DateTime
- RevRecAdjustmentAmount: Double
- RevenueAmount: Double
- Status: RequestStatus
- SubmittedByUser: PwsUserSummary
- SubmittedTimestamp: DateTime
- SystemRatePerMileageUnit: Double
- UnitCost: Double
- UnitPrice: Double
- VatAmountDisbursedCurrency: Double
- VoucherIdentity: PwsPaymentVoucherRef
- WipAmount: Double
- ChargeableFlag: Boolean
- DisbursingCostCenterIdentity: PwsCostCenterRef
- EngagementCurrencyDecimalDigits: Byte
- EngagementTypeBillableFlag: Boolean
- IncurredCurrencyDecimalDigits: Byte
- ManagementData: PwsCostCardManagementData
- PaymentVoucherPaymentWorkflowStatus: String
- ProjectName: String
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 |