Overview
This structure contains the complete set of information about an expense document (less any subordinate entities). The structure is used both to retrieve detailed expense document information and to pass information about an expense document back to the server to get updated.
Format
- PwsExpenseDocumentElement
- AllowAttachReceiptsToCcFlag: Boolean
- AllowAttachReceiptsToEdFlag: Boolean
- CostCards: PwsCostCardElement
- DisbursedCurrencyIdentity: PwsCurrencyRef
- DocumentCount: Int32
- ExpenseDocumentDetail: PwsExpenseDocumentDetail
- ExpenseDocumentVatFlag: Boolean
- Invoices: PwsExpenseEntryInvoice
- Locations: PwsLocationSummary
- LockedFlag: Boolean
- NoteCount: Int32
- PayeeVendors: PwsVendorSummary
- Projects: PwsExpenseEntryProject
- Receipts: PwsReceiptDetail
- TitleIdentity: PwsTitleRef
- Vouchers: PwsPaymentVoucherSummary
- AllowCloneFlag: Boolean
- AllowDeleteFlag: Boolean
- Category: String
- CreatedByUser: PwsUserSummary
- CreatedTimestamp: DateTime
- LastUpdatedByUser: PwsUserSummary
- LastUpdatedTimestamp: DateTime
- PaymentVoucherItems: PwsPaymentVoucherItem
- Status: RequestStatus
- DisbursedCurrencyDecimalDigits: Byte
- MileageUom: String
- ExpenseDocumentLockedFlag: Boolean
- ApprovalWorkflowStatus: String
- CostCardTotalDisbursedAmount: Double
- DeleteExpenseDocumentUnavailableReason: String
- DueToOtherPayeesAmount: Double
- InvoiceWorkflowStatus: String
- MaintainExpenseDocumentUnavailableReason: String
- PaymentWorkflowStatus: String
- ViewInExpenseEntryFlag: Boolean
Elements
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
AllowAttachReceiptsToCcFlag | Boolean | On Insert: No On Update: No | Dependent on installation setting | ||
AllowAttachReceiptsToEdFlag | Boolean | On Insert: No On Update: No | Dependent on installation setting | ||
CostCards | On Insert: No On Update: No | The complete set of information regarding the cost card(s) on this expense document | |||
DisbursedCurrencyIdentity | On Insert: Yes On Update: No | The currency associated with disbursed amount on this expense document | |||
DocumentCount | Int32 | On Insert: No On Update: No | The number of receipts attached to this expense document | ||
ExpenseDocumentDetail | On Insert: Yes On Update: Yes | The complete set of information regarding the expense document | |||
ExpenseDocumentVatFlag | Boolean | On Insert: No On Update: No | false | If set to 'true', the expense document includes VAT (value added tax) | |
Invoices | On Insert: No On Update: No | The invoice(s) associated with the cost card(s) on this expense document | |||
Locations | On Insert: No On Update: No | The location(s) associated with the cost card(s) on this expense document | |||
LockedFlag | Boolean | On Insert: No On Update: No | false | If set to 'true', the expense document is locked | |
NoteCount | Int32 | On Insert: No On Update: No | The number of receipt notes attached to the cost card(s) on this expense document or the entire expense document | ||
PayeeVendors | On Insert: No On Update: No | The payee vendor(s) associated with the expense document | |||
Projects | On Insert: No On Update: No | The project(s) associated with the cost card(s) expense document | |||
Receipts | On Insert: No On Update: No | The receipt(s) associated with the expense document | |||
TitleIdentity | On Insert: No On Update: No | The title(s) of the resource(s) with cost cards on the expense document | |||
Vouchers | On Insert: No On Update: No | The payment voucher(s) associated with the cost card(s) on this expense document | |||
AllowCloneFlag | Boolean | On Insert: No On Update: No | This is dependent on permission settings | If set to 'true', this expense document can be cloned | |
AllowDeleteFlag | Boolean | On Insert: No On Update: No | This is dependent on the expense document status. Expense documents that have a status of partially approved or higher cannot be deleted. | If set to 'true', this expense document can be deleted | |
Category | String | On Insert: No On Update: No | 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 highest 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 | ||
CreatedByUser | On Insert: No On Update: No | The identity of the user who created the expense document | |||
CreatedTimestamp | DateTime | On Insert: No On Update: No | The date and time this expense document was created (in UTC format) | ||
LastUpdatedByUser | On Insert: No On Update: No | The identity of the user who last updated the expense document | |||
LastUpdatedTimestamp | DateTime | On Insert: No On Update: No | The date and time this expense document was last updated (in UTC format) | ||
PaymentVoucherItems | On Insert: No On Update: No | The payment voucher(s) associated with this expense document | |||
Status | String | On Insert: No On Update: No | The status of the expense document | ||
DisbursedCurrencyDecimalDigits | Byte | On Insert: No On Update: No | The number of decimal places displayed and stored with the disbursed amount | ||
MileageUom | String | On Insert: No On Update: No | The unit of measure associated with mileage expense types (i.e. miles / kilometers) | ||
ExpenseDocumentLockedFlag | Boolean | On Insert: No On Update: No | If set to 'true', the expense document is locked | ||
ApprovalWorkflowStatus | String | On Insert: No On Update: No | 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 | ||
CostCardTotalDisbursedAmount | Double | On Insert: No On Update: No | The expense document's total disbursed amount | ||
DeleteExpenseDocumentUnavailableReason | String | On Insert: No On Update: No | If an expense document cannot be deleted, this code indicates the reason: "LOK" - The expense document is locked. This could be the result of multiple reasons including the presence of an approved cost card. "PRM" - The user attempting to edit the expense document lacks permission Null - Unknown reason | ||
DueToOtherPayeesAmount | Double | On Insert: No On Update: No | The amount due to be paid back to a payee other than the resource associated with the expense document (i.e. a third party / company credit card) | ||
InvoiceWorkflowStatus | String | On Insert: No On Update: No | The expense document's invoice workflow status. When the cost cards in the expense document have different invoice workflow statuses, the expense document will have a partial invoice workflow status, the "partial" status will take on the highest level status (i.e. Partially Approved, Partially Transmitted, Partially Paid or Partially Received) "N" - Not approved - all cost cards in the expense document have not been approved to invoice "PA" - Partially Approved - one or more cost cards (but not all) in the expense document have been approved to invoice "A" - Approved - all cost cards in the expense document have been approved to invoice "PI" - Partially Invoiced (Draft) - one or more cost cards (but not all) in the expense document is on a Draft invoice "I" - Invoiced (Draft) - all cost cards in the expense document is on a draft invoice "PB" - Partially Invoiced - one or more cost cards (but not all) in the expense document is on an issued invoice "B" - Invoiced - all cost cards in the expense document is on an issued invoice | ||
MaintainExpenseDocumentUnavailableReason | String | On Insert: No On Update: No | If an expense document cannot be maintained/updated, this code indicates the reason: "LOK" - The expense document is locked. This could be the result of multiple reasons including the presence of an approved cost card. "PRM" - The user attempting to edit the expense document lacks permission Null - Unknown reason | ||
PaymentWorkflowStatus | String | On Insert: No On Update: No | The expense document's payment workflow status. When the cost cards in the expense document have different payment workflow statuses, the expense document will have a partial payment workflow status, the "partial" status will take on the highest level status (i.e. Partially Approved, Partially Transmitted, Partially Paid or Partially Received) "N" - Not Approved - all cost cards in the expense document have not been approved to pay "PA" - Partially Approved - one or more cost cards (but not all) in the expense document have been approved to pay "A" - Approved - all cost cards in the expense document have not been approved "PT" - Partially Transmitted - one or more cost cards (but not all) in the expense document have been transmitted to an accounting system (i.e. Great Plains) "T" - Transmitted - all cost cards in the expense document have been transmitted to an accounting system (i.e. Great Plains) "PR" - Partially Received - one or more cost cards (but not all) in the expense document have been received by the vendor/resource "R" - Received - all cost cards in the expense document have been received by the vendor/resource | ||
ViewInExpenseEntryFlag | Boolean | On Insert: No On Update: No | If set to 'true', this expense document can be viewed in Projector Web's Expense Entry |