Overview
This web service inserts or updates a single expense document cost cards based on a detailed expense document cost card structure (PwsExpenseDocumentDetailPwsCostCardDetail). The service returns the identity (PwsClientRefPwsCostCardRef) of the client cost card that has been inserted or updated. The caller can optionally request that the full cost card detail (PwsClientElementPwsCostCardElement) be included in the response.
...
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 | No | Click here for more information. | ||
SessionTicket | String | Yes | Click here for more information. | ||
Comments | String | No | Cost Card save / update comments | ||
CostCard | On Insert: No On Update Yes | The cost card details of an existing cost card | |||
DeleteReceipts | No | The receipts to be deleted | |||
ExpenseDocumentIdentity | On Insert: yes On Update: No | The expense document associated with the cost card | |||
ExpenseDocumentTimestamp | String | No | This is a Base64 encoded timestamp utilized for expense document locking. To protect against overwriting other changes, you may optionally echo back the timestamp returned by a call to PwsSaveExpenseDocument (or a prior call to PwsSaveExpenseDocument). This will cause the request to fail if any change has been made between invocations of PwsGetExpenseDocument and PwsSaveExpenseDocument. | ||
FullDetailFlag | Boolean | No | false | If set to 'true', include full detailed cost card element in response | |
InsertReceiptsIfNotFoundOnUpdateFlag | Boolean | No | If set to 'true', specified receipts that are not found during an update will instead be inserted | ||
ResourceIdentity | On Insert: No On Update No | The identity of the resource associated with the cost card | |||
SaveReceipts | On Insert: No On Update: No | The receipt details to be inserted or updated | |||
UpdateReceiptsIfFoundOnInsertFlag | Boolean | deprecated | ** This field has been deprecated ** | ||
PreserveCostCardStatusFlag | Boolean | deprecate | ** This field has been deprecated ** | ||
CostCards | On Insert: Yes On Update: No | The cost card details of a new cost card |
...
| 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:PwsSaveExpenseDocumentCostCard>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>AfMtiadjKEErha/5LNfifA==</req:SessionTicket>
<tim:Comments>Cost Card Save</tim:Comments>
<tim:CostCard>
<com:CostCardUid>1152921504614515312</com:CostCardUid>
<tim:Description>Cost Card Save</tim:Description>
<tim:DescriptionClearFlag>false</tim:DescriptionClearFlag>
<tim:ExpenseTypeIdentity>
<com:ExpenseTypeName>Meals</com:ExpenseTypeName>
</tim:ExpenseTypeIdentity>
<tim:IncurredAmount>50.75</tim:IncurredAmount>
<tim:IncurredDate>2018-03-19T00:00:00.000Z</tim:IncurredDate>
<tim:IncurredOpsCurrencyIdentity>
<com:OpsCurrencyCode>USD</com:OpsCurrencyCode>
</tim:IncurredOpsCurrencyIdentity>
<tim:LocationClearFlag>false</tim:LocationClearFlag>
<tim:LocationIdentity>
<com:LocationName>USA</com:LocationName>
</tim:LocationIdentity>
<tim:NonBillableFlag>false</tim:NonBillableFlag>
<tim:OverrideClientAmountClearFlag>false</tim:OverrideClientAmountClearFlag>
<tim:PayeeVendorClearFlag>false</tim:PayeeVendorClearFlag>
<tim:PayeeVendorIdentity>
<com:VendorName>ABC Card</com:VendorName>
</tim:PayeeVendorIdentity>
<tim:ProjectIdentity>
<com:ProjectCode>P001395-001</com:ProjectCode>
</tim:ProjectIdentity>
<tim:ResourceClearFlag>false</tim:ResourceClearFlag>
<tim:ResourceIdentity>
<com:ResourceReferenceSystemId>E123</com:ResourceReferenceSystemId>
</tim:ResourceIdentity>
<tim:TotalAmountDisbursedCurrency>50.75</tim:TotalAmountDisbursedCurrency>
<tim:Udf1>
<com:UdfName>Attendees</com:UdfName>
<com:NumericValue>2</com:NumericValue>
</tim:Udf1>
<tim:Udf1ClearFlag>false</tim:Udf1ClearFlag>
<tim:Udf2>
<com:UdfName>Purpose</com:UdfName>
<com:TextValue>Client Meeting</com:TextValue>
</tim:Udf2>
<tim:Udf2ClearFlag>false</tim:Udf2ClearFlag>
<tim:ExternalGroupingIdentifier>2</tim:ExternalGroupingIdentifier>
<tim:ExternalGroupingIdentifierClearFlag>false</tim:ExternalGroupingIdentifierClearFlag>
</tim:CostCard>
<tim:ExpenseDocumentIdentity>
<com:DocumentNumber>ER00727</com:DocumentNumber>
</tim:ExpenseDocumentIdentity>
<tim:FullDetailFlag>true</tim:FullDetailFlag>
<tim:InsertReceiptsIfNotFoundOnUpdateFlag>false</tim:InsertReceiptsIfNotFoundOnUpdateFlag>
<tim:ResourceIdentity>
<com:ResourceDisplayName>E123</com:ResourceDisplayName>
</tim:ResourceIdentity>
</pws:serviceRequest>
</pws:PwsSaveExpenseDocumentCostCard>
</soapenv:Body>
</soapenv:Envelope> |
Response Format
| Panel | ||
|---|---|---|
| ||
|
Response Elements
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 |
|
Status | Click here for more information |
| |
ServerTimestampUtc | DateTime | Click here for more information |
|
CostCard | The details of the existing cost card (less any subordinate entities) |
| |
CostCardIdentity | The key fields of the updated cost card |
| |
CostCardResult | The error details of a failed cost card save |
| |
ExpenseDocumentTimestamp | String | This is a Base64 encoded timestamp utilized for expense document locking. To protect against overwriting other changes, you may optionally echo back the timestamp returned by a call to PwsSaveExpenseDocument (or a prior call to PwsSaveExpenseDocument). This will cause the request to fail if any change has been made between invocations of PwsGetExpenseDocument and PwsSaveExpenseDocument. |
|
Location | The cost card location |
| |
ReceiptResults | The error details of a failed receipt insert or save |
| |
SaveSucceededFlag | Boolean | If set to 'true', the save has succeeded |
|
CostCardIdentities | The key fields of the inserted cost card |
| |
CostCards | The details of the new cost card (less any subordinate entities) |
|