Overview
This web service can be used to save changes to an existing web invoice. Use PwsCreateInvoice to create a new web invoice. The caller can optionally request that the full invoice detail PwsInvoiceElement be included in the response.
Note that this service will update web invoices only, and cannot be used to update Management Portal invoices.
Request Format
- PwsSaveInvoiceRq
- RequestId: Int32
- SessionTicket: String
- AddCommentsToInvoiceMessagesFlag: Boolean
- AddressClearFlag: Boolean
- AppliedPrepaidAmountsClearFlag: Boolean
- BillingInstructionsClearFlag: Boolean
- ClientMessageClearFlag: Boolean
- FinanceApprovalStatus: String
- FullDetailFlag: Boolean
- IncludeAdjustmentHistoryFlag: Boolean
- IncludeFullAdjustmentHistoryFlag: Boolean
- Invoice: PwsInvoiceDetail
- InvoiceDateClearFlag: Boolean
- InvoiceEmailRecipientsClearFlag: Boolean
- InvoiceMessagesClearFlag: Boolean
- InvoiceTaxesClearFlag: Boolean
- LocksToSteal: PwsEntityLockSummary[]
- ManagementApprovalStatus: String
- NewInvoiceMessages: String
- NotifyFinanceTeamFlag: Boolean
- NotifyManagementTeamFlag: Boolean
- NotifyPmTeamFlag: Boolean
- OverrideAccountingPeriodClearFlag: Boolean
- OverrideCapExceededWarningFlag: Boolean
- ProjectManagerApprovalStatus: String
- ProjectorLockSetId: Int32
- PurchaseOrderNumberClearFlag: Boolean
Request Elements
Element | Data Type | Required? | Default | Description |
|---|---|---|---|---|
| RequestId | Int32 | Boolean | ||
| SessionTicket | String | Boolean | ||
AddCommentsToInvoiceMessagesFlag | Boolean | No | false | True to prepend comments (NewInvoiceMessages) to invoice messages |
AddressClearFlag | Boolean | No | false | True to null out address (if false, address is left as is if all address fields are null in PwsInvoiceDetail structure |
AppliedPrepaidAmountsClearFlag | Boolean | No | false | True to null out applied prepaid amounts (if false, applied prepaid amounts are left as is if it not specified in PwsInvoiceDetail structure. |
BillingInstructionsClearFlag | Boolean | No | false | True to null out billing instructions (if false, billing instructions are left as is if it null in PwsInvoiceDetail structure. |
ClientMessageClearFlag | Boolean | No | false | True to null out client message (if false, client message is left as is if it is null in PwsInvoiceDetail |
FinanceApprovalStatus | String (1) | No | A to set to approved, U to set to unapproved, null to leave as is | |
FullDetailFlag | Boolean | No | false | True to include the full details of the invoice in the response |
IncludeAdjustmentHistoryFlag | Boolean | No | false | If FullDetailsFlag is set, true to include adjustment history in invoice detail. |
IncludeFullAdjustmentHistoryFlag | Boolean | No | false | If FullDetailsFlag is set and IncludeAdjustmentHistoryFlag is set, true to include full card breakdown with each adjustment history record. |
Invoice | Yes | Invoice to be saved | ||
InvoiceDateClearFlag | Boolean | No | false | True to null out invoice date (if false, invoice date is left as is if it is null in PwsInvoiceDetail structure. |
InvoiceEmailRecipientsClearFlag | Boolean | No | false | True to null out invoice email recipients (if false, invoice email recipients are left as is if it not specified in PwsInvoiceDetail structure. |
InvoiceMessagesClearFlag | Boolean | No | false | True to null out invoice messages (if false, invoice messages are left as is if it is null in PwsInvoiceDetail structure. |
InvoiceTaxesClearFlag | Boolean | No | false | True to null out invoice taxes (if false, invoice taxes are left as is if not specified in PwsInvoiceDetail structure. |
LocksToSteal | No | If stealing existing locks, specify lock holders from PwsFault response | ||
ManagementApprovalStatus | String (1) | No | A to set to approved, U to set to unapproved, null to leave as is | |
NewInvoiceMessages | String (1000) | No | Invoice messages to include in workflow email. May also be added to invoice messages for the new invoice. | |
NotifyFinanceTeamFlag | Boolean | No | True to send an e-mail to the finance team response for finance approval of invoice upon update. | |
NotifyManagementTeamFlag | Boolean | No | True to send an e-mail to the management team response for management approval of invoice upon update. | |
NotifyPmTeamFlag | Boolean | No | True to send an e-mail to the PM team response for project manager approval of invoice upon update. | |
OverrideAccountingPeriodClearFlag | Boolean | No | false | True to null out override accounting period (if false, override accounting period is left as is if it is null in PwsInvoiceDetail structure. |
OverrideCapExceededWarningFlag | Boolean | No | false | True to override cap exceeded warning and allow invoice to be updated anyway |
ProjectManagerApprovalStatus | String (1) | No | A to set to approved, U to set to unapproved, null to leave as is | |
ProjectorLockSetId | Int32 | No | A projector lock set id is an identifier for a group of one or more locks held as a unit | |
PurchaseOrderNumberClearFlag | Boolean | No | false | True to null out purchase order number (if false, purchase order number is left as is if it is null in PwsInvoiceDetail structure |
Request Usage Example(s)
Response Format
Response Elements
Response Usage Example(s)
PwsUpdateProjectTimeBaseline - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
34000 | InvalidValueForProjectTimeBaselineBasis | The value specified for time baseline basis is invalid. Valid values are T for Task Plan, R for Resource Requests, P for Previous Resource Requests, S for Scheduled Resources, A for Approved And Current Requested, B for Approved And Current Booked, and for None. |
| 34002 | InvalidValueForProjectTimeBaselineDimension | The value specified for time baseline dimension is invalid. Valid values are M for Rate Type, K for Task Type, D for Resource Department, T for Resource Title, R for Role, S for Resource, and N for None. |
| 54292 | PrimaryBaselineMetricMustBeEnabled | Primary baseline metrics must be an enabled metric in the baseline. |
| 54518 | SpecifiedProjectBaselineBucketDatesInvalid | The specified bucket dates for a project baseline bucket are invalid. |
| 54923 | SpecifiedProjectTimeBaselineNotFound | Specified project time baseline was not found. |
| 54961 | ProjectTimeBaselineRefRequired | A project time baseline must be specified. |