PwsExpenseDocument
Overview
This structure represents the fields associated with an expense document
Format
- PwsExpenseDocument
- DocumentNumber: String (50)
- ExpenseDocumentId: Int32
- ExpenseDocumentUid: Int64
- CashAdvanceReturnAmount: Double
- CostCenterIdentity: PwsCostCenterRef
- DocumentName: String (100)
- DocumentType: String
- LocationIdentity: PwsLocationRef
- ResourceIdentity: PwsResourceRef
- VendorIdentity: PwsVendorRef
- VendorInvoiceDate: DateTime
- VendorInvoiceReferenceNumber: String (20)
- Vendor: PwsVendorSummary
- SubcontractorInvoiceDate: DateTime
- SubcontractorInvoiceReferenceNumber: String (20)
- AllowCloneFlag: Boolean
- AllowDeleteFlag: Boolean
- Category: String
- CompanyPaidAmount: Double
- CostCardCount: Int32
- CreatedByUser: PwsUserSummary
- CreatedTimestamp: DateTime
- DisbursedCurrencyIdentity: PwsCurrencyRef
- EarliestIncurredDate: DateTime
- LatestIncurredDate: DateTime
- MileageUom: String
- PaymentVoucherItems: PwsPaymentVoucherItem
- Projects: PwsProjectSummary
- ReimbursementAmount: Double
- Status: String
- TitleIdentity: PwsTitleRef
- TotalAmount: Double
- DisbursedCurrencyDecimalDigits: Byte
- ExpenseDocumentVatFlag: Boolean
- ExpenseDocumentLockedFlag: Boolean
Elements
Element | Data Type | Description | Sample Data |
---|---|---|---|
DocumentNumber | String (50) | The expense document number is a unique identifier for an expense document | |
ExpenseDocumentId | Int32 | The expense document Id is a unique identifier for an expense document. For internal use only. | |
ExpenseDocumentUid | Int64 | The expense document Uid is a unique and immutable identifier for an expense document. | |
CashAdvanceReturnAmount | Double | The cash advance associated with the expense document. Applies to expense reports. | |
CostCenterIdentity | The cost center associated with the expense document. | ||
DocumentName | String | The expense document name. | |
DocumentType | String | The expense document type: "E" for Expense Report "C" for Subcontractor Invoice "V" for Vendor Invoice "S" for Soft Cost Batch | |
LocationIdentity | The unique keys identifying the location associated with the expense document. Applies to expense reports. | ||
ResourceIdentity | The unique keys identifying the resource associated with the expense document. Applies to expense reports. | ||
VendorIdentity | The unique keys identifying the vendor associated with the expense document. Applies to expense reports, vendor invoices and subcontractor invoices. | ||
VendorInvoiceDate | DateTime | The vendor invoice date associated with the expense document. Applies for vendor invoices. | |
VendorInvoiceReferenceNumber | String (20) | The vendor invoice reference number is a unique identifier for a vendor. Applies for vendor invoices. | |
Vendor | Additional information about the vendor associated with the expense document. Applies to expense reports, vendor invoices and subcontractor invoices. | ||
SubcontractorInvoiceDate | DateTime | The subcontractor invoice date associated with the expense document. Applies to subcontractor invoices. | |
SubcontractorInvoiceReferenceNumber | String (20) | The subcontractor invoice reference number. Applies to subcontractor invoices. | |
AllowCloneFlag | Boolean | If set to 'true', the expense document can be cloned | |
AllowDeleteFlag | Boolean | If set to 'true', the expense document can be deleted | |
Category | String | The category the expense document falls under in Projector Web's expense document landing page. When the cost cards in the expense document have different statuses, the expense document will have a "partial" status. The "partial" status will adopt the status of the cost card with the lowest level of status (i.e. Partially Rejected, Partially Submitted or Partially Approved) "D" - Draft - all cost cards in the expense document are in Draft status "PR" - Partially Rejected - one or more cost cards (but not all) in the expense document has a status of Rejected "R" - Rejected - all cost cards in the expense document has a status of Rejected "PS" - Partially Submitted - one or more cost cards (but not all) in the expense document has a status of Submitted "S" - Submitted - all cost cards in the expense document has a status of Submitted "PA" - Partially Approved - one or more cost cards (but not all) in the expense document has a status of Approved "A" - Approved - all cost cards in the expense document has a status of Approved | |
CompanyPaidAmount | Double | The company paid amount within the expense document. | |
CostCardCount | Int32 | The number of cost cards associated with the expense document. | |
CreatedByUser | The user who created the expense document. | ||
CreatedTimestamp | DateTime | The date and time this expense document was created (in UTC format). | |
DisbursedCurrencyIdentity | The currency associated with the disbursed amount. | ||
EarliestIncurredDate | DateTime | The incurred date and time of the cost card with the earliest incurred date within this expense document. | |
LatestIncurredDate | DateTime | The incurred date and time of the cost card with the latest incurred date within this expense document. | |
MileageUom | String | The mileage unit of measure associated with the expense document. Applies to expense reports. | |
PaymentVoucherItems | The payment voucher(s) associated with the expense document. | ||
Projects | The project(s) cost cards on the expense document were entered against. | ||
ReimbursementAmount | Double | The reimbursement amount associated with the expense document. | |
Status | String | The expense document's approval workflow status. When the cost cards in the expense document have different approval workflow statuses, the expense document will have a partial approval workflow status, the "partial" status will take on the highest level status (i.e. Partially Rejected, Partially Submitted or Partially Approved) "D" - Draft - all cost cards in the expense document are in Draft status "PR" - Partially Rejected - one or more cost cards (but not all) in the expense document have a status of Rejected "R" - Rejected - all cost cards in the expense document have a status of Rejected "PS" - Partially Submitted - one or more cost cards (but not all) in the expense document have a status of Submitted "S" - Submitted - all cost cards in the expense document have a status of Submitted "PA" - Partially Approved - one or more cost cards (but not all) in the expense document have a status of Approved "A" - Approved - all cost cards in the expense document have a status of Approved | |
TitleIdentity | The title of the resource associated with the expense document. | ||
TotalAmount | Double | The total amount associated with the expense document. | |
DisbursedCurrencyDecimalDigits | Byte | The number of decimal places associated with the disbursed currency. Note: Computed amounts are always rounded to the nearest minor currency unit as identified by the currency's decimalDigits property. | |
ExpenseDocumentVatFlag | Boolean | If set to 'true', this expense document include value added tax (i.e. GST). | |
ExpenseDocumentLockedFlag | Boolean | If set to 'true', the expense document is locked and cannot be edited. |