Overview
This web service can be used to create a web invoice. You specify the attributes to use for invoice creation by providing a InvoiceSpec, an instance of PwsCandidateInvoiceSpec. This structure allows you to specify the name, scope and content of the invoice, the approval statuses and other invoice attributes. See below for full details. The caller can optionally request that the full invoice detail PwsInvoiceElement be included in the response.
...
| Panel | ||
|---|---|---|
| ||
* PwsCreateInvoiceRq
* InvoiceSpec
* InvoiceName : String(100)
* ClientIdentity : PwsClientRef
* PurchaseOrderNumber : String(50)
* EngagementIdentity : PwsEngagementRef
* ProjectIdentity : PwsProjectRef
* ApprovedByFinanceFlag : Boolean
* ApprovedByProjectManagerFlag : Boolean
* ApprovedByManagementFlag : Boolean
* EngagementCurrencyIdentity : PwsCurrencyRef
* CostCenterIdentity : PwsCostCenterRef
* BillingCultureIdentity : PwsCultureRef
* EngagementInvoiceContent : String(1)
* InvoiceScope : String(1)
* InvoiceContent : String(1)
* CardBeginDate : Date
* CardEndDate : Date
* NotifyFinanceTeamFlag : Boolean
* NotifyPmTeamFlag : Boolean
* NotifyManagementTeamFlag : Boolean
* NewInvoiceMessages: String(1000)
* AddCommentsToInvoiceMessagesFlag : Boolean
* ExcludeZeroAmountTimeCardsFlag : Boolean
* ExcludeZeroAmountCostCardsFlag : Boolean
* FullDetailFlag : Boolean
* IncludeAdjustmentHistoryFlag : Boolean
* IncludeFullAdjustmentHistoryFlag :
|
Request Elements
Element | Data Type | Required? | Default | Description | |
|---|---|---|---|---|---|
| RequestId | Int32 | No | Click here for more information | ||
| SessionTicket | String | Yes | Click here for more information | ||
| AddCommentsToInvoiceMessagesFlag | Boolean | No | False | True to prepend comments (NewInvoiceMessages) to invoice message | |
| ExcludeZeroAmountCostCardsFlag | Boolean | No | False | True to exclude time cards with no value from invoice | |
| ExcludeZeroAmountTimeCardsFlag | Boolean | No | False | True to exclude cost cards with no value from invoice | |
| 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 | |
| InvoiceSpec | PwsCandidateInvoiceSpec | Yes | Attributes of the new invoice to be created | ||
| NewInvoiceMessages | String (1000) | No | Invoice message to include workflow email. May also be added to invoice messages for the new invoice | ||
| NotifyFinanceTeamFlag | Boolean | No | False | True to send an e-mail to the finance team response for finance approval of invoice upon creation | |
| NotifyManagementTeamFlag | Boolean | No | False | True to send an e-mail to the management team response for management approval of invoice upon creation | |
| NotifyPmTeamFlag | Boolean | No | False | True to send an e-mail to the PM team response for project manager approval of invoice upon creation |
...
| Panel | ||
|---|---|---|
| ||
{panel:title=PwsCreateInvoice Response} * PwsCreateInvoiceResponse ** PwsCreateInvoiceResult: [PwsCreateInvoiceRs] *** Messages: [PwsMessage][] *** [ResponseId]: Int32 *** [Status]: RequestStatus *** [ServerTimestampUtc]: DateTime *** Invoice: [PwsInvoiceElement] *** InvoiceIdentity: [PwsInvoiceRef] *** InvoiceTimestamp: String {panel} |
...
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
ResponseId | Int32 | Click here for more information | 1 |
Status | Click here for more information. | Ok | |
ServerTimestampUtc | DateTime | Click here for more information | 2018-01-29T21:55:08.7579802Z |
EngagementLockStolenFromUserIdentity | **deprecated** | ||
EngagementTimestamp | String | **deprecated** | AAAAAA62DGw= |
ProjectCostBaseline | The complete set of information about the project cost baseline. Specify FullDetailFlag = true in request to get this value returned in the response. | ||
ProjectCostBaselineIdentity | The unique keys used to identify the project cost baseline | ||
| ProjectTimestamp | String | This is an optimistic locking timestamp that, if provided on update request, will cause the request to fail when the timestamp stored in the database does not match the provided value. | AAAAABFFCOw= |
| StolenLocks | PwsEntityLockSummary[1..100] | This structure contains information about the locks that were stolen in order to complete this request, Will be included only when LocksToSteal is specified in the request. |
...