Overview
This structure is returned by services such as PwsGetExpenseDocument, which return the full details about expense documents, including full details about each cost card on the expense document. This structure contains a cost card detail structure (PwsCostCardDetail). It is also where additional related information about the cost card, that is not directly an attribute of the cost card itself or is not a modifiable attribute, is found.
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
- DefaultVatPercentage: Double
- MaintainReceiptsUnavailableReason: String
Elements
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
AdjustedRevenueAmount | Double | n/a | The adjusted revenue amount. | ||
ApprovalWorkflowStatus | String | n/a | The cost card's approval workflow status: "D" - Draft "R" - Rejected "S" - Submitted "A" - Approved | A | |
ApprovedByUser | n/a | The identity of the user who approved the cost card. | |||
ApprovedTimestamp | DateTime | n/a | The date and time when the cost card was approved. | 2018-02-08T14:03:21.913Z | |
ApprovedToInvoiceByUser | n/a | The identity of the user who approved the cost card to invoice. | |||
ApprovedToInvoiceTimestamp | DateTime | n/a | The date and time when the cost card was approved to invoice/bill. | 2018-02-08T14:03:21.9Z | |
BilledTimestamp | DateTime | n/a | The date and time when the cost card was invoiced/billed. | 2018-02-08T14:05:47.313Z | |
ClientAmount | Double | n/a | The client amount. | 150.01 | |
CostCardDetail | n/a | The complete set of information about the constant cost card. This substructure can be modified and passed back up to services such as PwsSaveExpenseDocumentCostCard to save changes to the cost card. | |||
CreatedByUser | n/a | The identity of the user who created the cost card. | |||
CreatedTimestamp | DateTime | n/a | The date and time when the cost card was invoiced/billed . | 2018-02-08T13:52:45.937Z | |
CreditedCostCardIdentity | n/a | This is the identity of the associated credit cost card (if any). | |||
DisbursedAmountDisbursedCurrency | Double | n/a | The disbursed amount in disbursed currency. | ||
DisbursedAmountEngagementCurrency | Double | n/a | The disbursed amount in engagement currency. | ||
DocumentCount | Int32 | n/a | The number of documents (i.e. receipts) that are attached to this cost card. | ||
EngagementCurrency | n/a | The currency of the engagement this cost card is entered against. | |||
ExpenseAmount | Double | n/a | The expense amount, the amount that the company is responsible for paying in association with this cost card. | 0 | |
ForReportingOnlyFlag | Boolean | n/a | If set to 'true', the card is defined as for reporting only. | false | |
FxRate | Double | n/a | The default/system foreign exchange rate associated with the cost card. | 1 | |
FxRateActual | Double | n/a | The actual foreign exchange rate associated with the cost card. | 1 | |
InvoiceIdentity | n/a | The invoice associated with the cost card (if any). | |||
InvoiceWorkflowStatus | String | n/a | The invoice workflow status: "N" - Not approved "A" - Approved "I" - Invoiced (Draft) "B" - Invoiced | B | |
InvoicedAmount | Double | n/a | The invoice amount. | 150.01 | |
LastUpdatedByUser | n/a | The identity of the user who last udpated the cost card. | |||
LastUpdatedTimestamp | DateTime | n/a | The date and time when the cost card was last updated. | 2018-02-08T14:04:34.653Z | |
LockedFlag | Boolean | n/a | If set to 'true', the cost card is locked and cannot be edited. | true | |
NoteCount | Int32 | n/a | The number of receipt notes associated with the cost card (if any). | 0 | |
RejectedByUser | n/a | The identity of the user who rejected the cost card. | |||
RejectedReason | String (255) | n/a | The reject reason associated with the cost card. | ||
RejectedTimestamp | DateTime | n/a | The date and time when the cost card was rejected. | ||
RevRecAdjustmentAmount | Double | n/a | The revenue recognition adjustment amount. | ||
RevenueAmount | Double | n/a | The revenue amount. | ||
Status | String | n/a | The current status of the cost card: "N" - Not approved "R" - Rejected "A" - Approved "I" - Invoiced (Draft) "B" - Invoiced | B | |
SubmittedByUser | n/a | The identity of the user who submitted the cost card. | |||
SubmittedTimestamp | DateTime | n/a | The date and time when the cost card was submitted. | 2018-02-08T13:52:46.533Z | |
SystemRatePerMileageUnit | Double | n/a | The default/system mileage rate. | 0.575 | |
UnitCost | Double | n/a | The unit cost. | 150.01 | |
UnitPrice | Double | n/a | The unit price. | 150.01 | |
VatAmountDisbursedCurrency | Double | n/a | The value-added tax in the disbursed currency. | 0 | |
VoucherIdentity | n/a | The payment voucher associated with the cost card (if any). | |||
WipAmount | Double | n/a | The work in progress amount. | ||
ChargeableFlag | Boolean | n/a | If set to 'true', the cost card is marked as chargeable/billable to the client. | true | |
DisbursingCostCenterIdentity | n/a | The disbursing cost card. | |||
EngagementCurrencyDecimalDigits | Byte | n/a | 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 | n/a | If set to 'true', the engagement the cost card is entered against is defined as billable. | true | |
IncurredCurrencyDecimalDigits | Byte | n/a | 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 | n/a | The key cost card fields that are associated with managing the cost card after it has been submitted for approval. | |||
PaymentVoucherPaymentWorkflowStatus | String | n/a | The payment workflow status: "N" - Not Approved "A" - Approved "T" - Transmitted "PR" - Partially Received "R" - Received | N | |
ProjectName | String | n/a | The identity of the project this cost card is entered against. | Project A | |
DefaultVatPercentage | Double | n/a | The default VAT value for the expense type and location combo. | 0.05 | |
MaintainReceiptsUnavailableReason | String | n/a | The list of reasons that prohibit user from modifying receipts on the cost card: 'CRC' - credit cost card 'FRO' - for-report-only cost card 'LCK' - receipt document is locked 'PRM' - does not have permission
| LCK |