PwsInvoiceElement
Overview
This structure represents the complete details of a retrieved invoice
Format
- PwsInvoiceElement
- AdjustmentHistory: PwsInvoiceAdjustmentHistory[]
- AllowAccountingPeriodOverrideFlag: Boolean
- ApprovedByFinanceFlag: Boolean
- ApprovedByFinanceTimestamp: DateTime
- ApprovedByFinanceUser: PwsUserSummary
- ApprovedByManagementFlag: Boolean
- ApprovedByManagementTimestamp: DateTime
- ApprovedByManagementUser: PwsUserSummary
- ApprovedByProjectManagerFlag: Boolean
- ApprovedByProjectManagerTimestamp: DateTime
- ApprovedByProjectManagerUser: PwsUserSummary
- AutoManagementApprovalFlag: Boolean
- AvailableBalances: PwsInvoiceAvailableBalance[]
- AvailableMilestones: PwsInvoiceAvailableMilestone[]
- CardBeginDate: DateTime
- CardEndDate: DateTime
- Client: PwsClientSummary
- CompanyIdentity: PwsCompanyRef
- CostCardAdjustmentAmount: Double
- CostCardExclusionsAmount: Double
- CostCardInvoicedAmount: Double
- CostCardRequireLocationFlag: Boolean
- CostCenterIdentity: PwsCostCenterRef
- CreatedByUser: PwsUserSummary
- CreatedTimestamp: DateTime
- DeletedFlag: Boolean
- DraftCostCardCount: Int32
- DraftInvoiceNumber: String
- DraftTimeCardCount: Int32
- Engagement: PwsEngagementSummary
- ExcludeZeroAmountCostCardsFlag: Boolean
- ExcludeZeroAmountTimeCardsFlag: Boolean
- ExcludedCostCardAmount: Double
- ExcludedCostCardCount: Int32
- ExcludedMilestoneAmount: Double
- ExcludedMilestoneCount: Int32
- ExcludedTimeCardAmount: Double
- ExcludedTimeCardCount: Int32
- GrossInvoiceAmount: Double
- IncludedCostCardCount: Int32
- IncludedMilestoneCount: Int32
- IncludedMilestones: PwsInvoiceMilestone[]
- IncludedTimeCardCount: Int32
- InvoiceContent: String
- InvoiceCurrencyDecimalDigits: Byte
- InvoiceCurrencyIdentity: PwsCurrencyRef
- InvoiceDetail: PwsInvoiceDetail
- InvoiceNumberHistory: String
- InvoiceRecipients: PwsUserSummary[]
- InvoiceScope: String
- InvoiceStatus: String
- IssuedByUser: PwsUserSummary
- IssuedTimestamp: DateTime
- LastUpdatedByUser: PwsUserSummary
- LastUpdatedTimestamp: DateTime
- ManagementApprovalThresholdAmount: Double
- ManagementApprovalThresholdPercent: Double
- MilestoneInvoicedAmount: Double
- NetInvoiceAmount: Double
- PaidByUser: PwsUserSummary
- PaidTimestamp: DateTime
- PaymentComment: String
- PostFailedFlag: Boolean
- PostFailureStatusMessage: String
- PostStatus: String
- PostedByUser: PwsUserSummary
- PostedFlag: Boolean
- PostedTimestamp: DateTime
- Project: PwsProjectSummary
- RejectedCostCardCount: Int32
- RejectedTimeCardCount: Int32
- RevaluePlEffect: Double
- SendFailedFlag: Boolean
- SendFailureStatusMessage: String
- SendStatus: String
- SentByUser: PwsUserSummary
- SentFlag: Boolean
- SentTimestamp: DateTime
- TimeCardAdjustmentAmount: Double
- TimeCardExclusionsAmount: Double
- TimeCardInvoicedAmount: Double
- TimeCardRequireLocationFlag: Boolean
- UnapprovedCostCardCount: Int32
- UnapprovedTimeCardCount: Int32
- VoidedByUser: PwsUserSummary
- VoidedTimestamp: DateTime
- WebInvoiceFlag: Boolean
- WriteUpWriteDownPlEffect: Double
Elements
Element | Data Type | Description |
---|---|---|
AdjustmentHistory | The complete adjustment history in association with this invoice | |
AllowAccountingPeriodOverrideFlag | Boolean | If set to 'true', the accounting period can be overridden on this invoice |
ApprovedByFinanceFlag | Boolean | If set to 'true', the invoice has been approved by Finance |
ApprovedByFinanceTimestamp | DateTime | The date / time the invoice was approved by Finance |
ApprovedByFinanceUser | The user from finance who approved the invoice | |
ApprovedByManagementFlag | Boolean | If set to 'true', the invoice has been approved by Management |
ApprovedByManagementTimestamp | DateTime | The date / time the invoice was approved by Management |
ApprovedByManagementUser | The user from management who approved the invoice | |
ApprovedByProjectManagerFlag | Boolean | If set to 'true', the invoice has been approved by the Project Manager |
ApprovedByProjectManagerTimestamp | DateTime | The date / time the invoice was approved by the Project Manager |
ApprovedByProjectManagerUser | The user from the project management team who approved the invoice | |
AutoManagementApprovalFlag | Boolean | If set to 'true', the invoice has been auto approve |
AvailableBalances | The deferred revenue balance | |
AvailableMilestones | The milestones associated with this invoice in pending status | |
CardBeginDate | DateTime | Only time cards on or after this date will be included in the invoice |
CardEndDate | DateTime | Only time cards before or on this date will be included in the invoice |
Client | The client on the invoice | |
CompanyIdentity | The invoice is associated with this company | |
CostCardAdjustmentAmount | Double | The amount of the cost cards inclusive of adjustments |
CostCardExclusionsAmount | Double | The amount associated with excluded cost cards |
CostCardInvoicedAmount | Double | The amount on the invoice associated with cost cards |
CostCardRequireLocationFlag | Boolean | If "true", locations are required for cost cards on this invoice |
CostCenterIdentity | The cost center associated with this invoice | |
CreatedByUser | The user who created this invoice | |
CreatedTimestamp | DateTime | The date / time this invoice was created |
DeletedFlag | Boolean | If 'true', this invoice has been deleted |
DraftCostCardCount | Int32 | The number of cost cards on the draft invoice |
DraftInvoiceNumber | String | The draft invoice number |
DraftTimeCardCount | Int32 | The number of time cards on the draft invoice |
Engagement | The engagement associated with the invoice | |
ExcludeZeroAmountCostCardsFlag | Boolean | If 'true', all cost cards with a value of zero will be excluded from the invoice |
ExcludeZeroAmountTimeCardsFlag | Boolean | If 'true', all time cards with a value of zero will be excluded from the invoice |
ExcludedCostCardAmount | Double | The value associated with all cost cards excluded from the invoice |
ExcludedCostCardCount | Int32 | The number of cost cards excluded from the invoice |
ExcludedMilestoneAmount | Double | The value associated with all milestones excluded from the invoice |
ExcludedMilestoneCount | Int32 | The number of milestones excluded from the invoice |
ExcludedTimeCardAmount | Double | The value associated with all time cards excluded from the invoice |
ExcludedTimeCardCount | Int32 | The number of time cards excluded from the invoice |
GrossInvoiceAmount | Double | The gross invoice amount |
IncludedCostCardCount | Int32 | The number of cost cards included on the invoice |
IncludedMilestoneCount | Int32 | The number of milestones included on the invoice |
IncludedMilestones | The milestones included on the invoice | |
IncludedTimeCardCount | Int32 | The number of time cards associated with the invoice |
InvoiceContent | String | The contents of the invoice: B for time and cost together or S for separately |
InvoiceCurrencyDecimalDigits | Byte | The number of decimal digits associated with the invoice currency |
InvoiceCurrencyIdentity | The currency identity on the invoice | |
InvoiceDetail | This structure contains the complete set of information about an invoice The structure is used both to retrieve detailed invoice information and to pass information about an invoice back to the server to get updated. | |
InvoiceNumberHistory | String | The invoice number history |
InvoiceRecipients | Users who are defined as invoice recipients | |
InvoiceScope | String | The Invoice Scope: C (Client), E (Engagement), N (Purchase Order Number) or P (Project) |
InvoiceStatus | String | The Invoice Status: D (Overdue), P (Paid), U (Unpaid) or V (Void) |
IssuedByUser | The user who issued the invoice | |
IssuedTimestamp | DateTime | The date / time that the invoice was issued |
LastUpdatedByUser | The user who last updated the invoice | |
LastUpdatedTimestamp | DateTime | The date / time the invoice was last updated |
ManagementApprovalThresholdAmount | Double | Management Approval is required only if the net invoice adjustments exceed this threshold amount |
ManagementApprovalThresholdPercent | Double | Management Approval is required only if the net invoice adjustments exceed this threshold percent |
MilestoneInvoicedAmount | Double | The milestone amount billed on the invoice |
NetInvoiceAmount | Double | The invoice net amount |
PaidByUser | The user who paid the invoice | |
PaidTimestamp | DateTime | The date/time the invoice was paid |
PaymentComment | String | Comments associated with the payment |
PostFailedFlag | Boolean | If 'true', posting the invoice failed |
PostFailureStatusMessage | String | The failure status message for any invoice that failed to post |
PostStatus | String | The posting status of the invoice |
PostedByUser | The user who posted the invoice | |
PostedFlag | Boolean | If 'true', the invoice has been posted successfully |
PostedTimestamp | DateTime | The date / time the invoice was posted |
Project | The project associated with the invoice | |
RejectedCostCardCount | Int32 | The number of rejected cost cards associated with the invoice |
RejectedTimeCardCount | Int32 | The number of rejected time cards associated with the invoice |
RevaluePlEffect | Double | The profit / loss effect resulting from a revalue |
SendFailedFlag | Boolean | If 'true', the sending of the invoice has failed |
SendFailureStatusMessage | String | The status message associated with the failure |
SendStatus | String | The invoice send status |
SentByUser | The user who sent the invoice | |
SentFlag | Boolean | If 'true', the invoice was successfully sent |
SentTimestamp | DateTime | The date / time the invoice was sent |
TimeCardAdjustmentAmount | Double | The amount of the time cards inclusive of adjustments |
TimeCardExclusionsAmount | Double | The amount associated with excluded time cards |
TimeCardInvoicedAmount | Double | The amount on the invoice associated with time cards |
TimeCardRequireLocationFlag | Boolean | If "true", locations are required for time cards on this invoice |
UnapprovedCostCardCount | Int32 | The number of unapproved cost cards associated with the invoice |
UnapprovedTimeCardCount | Int32 | The number of unapproved time cards associated with the invoice |
VoidedByUser | The user who voided the invoice | |
VoidedTimestamp | DateTime | The date / time the invoice was voided |
WebInvoiceFlag | Boolean | If "true" the invoice was created in PWEB |
WriteUpWriteDownPlEffect | Double | The effect a write up/down adjustment has on profit/loss |