Overview
This web service updates the invoice workflow status for one or more cost cards. Cost card's invoice workflow statuses are: 'N' for Not Approved to Invoice, 'A' for Approved to Invoice, 'D' for Draft Invoiced and 'I' for Invoiced. But You cannot "set" a cost card to statuses such as D or I. You affect it by adding the cost card to an invoice (status D) and issuing the invoice (status I). D and I are valid when querying because you can query for cost cards on issued invoices or on draft invoices.
Request Format
| Panel | ||
|---|---|---|
| ||
|
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 | No | Click here for more information. | ||
SessionTicket | String | Yes | Click here for more information. | AQOEFtV1TzXKcVR0VSE/sg== | |
CostCardIdentities | PwsVersionedCostCardRef[1..100] | Yes | This is the identities of a list of cost cards that will be updated with a new invoice workflow status | ||
InvoiceWorkflowStatus | String | Yes | The invoice workflow status: 'N' for Not Approved to Invoice 'A' for Approved to Invoice 'D' for Draft Invoiced 'I' for Invoiced You cannot "set" a cost card to statuses such as D or I. You affect it by adding the cost card to an invoice (status D) and issuing the invoice (status I). D and I are valid when querying because you can query for cost cards on issued invoices or on draft invoices. | A | |
SendApprovalEmailFlag | Boolean | No | false | If set to "true" and this web services causes the cost card to get approved (vs. approved to pay), the cost card resource will get an email notification. For example, when a submitted cost card is set to transmitted status, the submitted cost card will automatically get approved. | false |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:tim="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsSetCostCardInvoiceWorkflowStatus>
<pws:serviceRequest>
<req:SessionTicket>AQOEFtV1TzXKcVR0VSE/sg==</req:SessionTicket>
<tim:CostCardIdentities>
<!--Zero or more repetitions:-->
<tim:PwsVersionedCostCardRef>
<com:CostCardUid>1152921504613936990</com:CostCardUid>
</tim:PwsVersionedCostCardRef>
</tim:CostCardIdentities>
<tim:InvoiceWorkflowStatus>A</tim:InvoiceWorkflowStatus>
<tim:SendApprovalEmailFlag>false</tim:SendApprovalEmailFlag>
</pws:serviceRequest>
</pws:PwsSetCostCardInvoiceWorkflowStatus>
</soapenv:Body>
</soapenv:Envelope> |
Response Format
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data TypeDefault | Description | Sample Data |
|---|---|---|---|
Messages | Click here for more information. | ||
ResponseId | Int32 | Click here for more information. | 10 |
Status | Click here for more information. | Ok | |
ServerTimestampUtc | DateTime | Click here for more information. | 2018-0809-22T1711T15:5022:2348.1025831Z5091758Z |
CostCardIdentities | PwsCostCardRef[1..100] | The identity of the cost cards that have been updated. |
Response Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <PwsSetCostCardInvoiceWorkflowStatusResponse xmlns="http://projectorpsa.com/PwsProjectorServices/"> <PwsSetCostCardInvoiceWorkflowStatusResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId> <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status> <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-09-11T15:22:48.5091758Z</ServerTimestampUtc> <a:CostCardIdentities xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:PwsCostCardRef> <b:CostCardId i:nil="true"/> <b:CostCardUid>1152921504613936990</b:CostCardUid> <b:ReferenceId i:nil="true |
...
"/>
</b:PwsCostCardRef>
</a:CostCardIdentities>
</PwsSetCostCardInvoiceWorkflowStatusResult>
</PwsSetCostCardInvoiceWorkflowStatusResponse>
</s:Body>
</s:Envelope> |
PwsSetCostCardInvoiceWorkflowStatus - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 19057 | InvalidValueForCostCardInvoiceWorkflowStatus | The specified value for cost card invoice workflow status is invalid. Valid values are N for Not Approved to Invoice, A for Approved to Invoice, D for Draft Invoiced and I for Invoiced. Values of D and I are only valid when querying for existing data. |
| 65489 | CostCardRefInvalid | CostCardRef is required |
| 65723 | StatusChangeCannotBeCompletedCostCardsChangedOrIneligible | Status change cannot be completed because one or more cards has changed or is ineligible. |