Overview
This web service retrieves a an expense document cost cards card (PwsCostCardElement), based upon a unique cost card identifier identifier (PwsCostCardRef), or an expense document (PwsExpenseDocumentRef), or a resource identity (PwsResourceRef).
Request Format
Panel | ||
---|---|---|
| ||
|
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
RequestId | Int32 | No | Click here for more information. | 1 | |
SessionTicket | String | Yes | Click here for more information. | AeB+IjyAtjb5x8rPrBUjXA== | |
CostCardIdentity | Yes | The cost card to be retrieved | |||
ExpenseDocumentIdentity | Yes | The expense document associated with the cost card |
. This must match the expense document of the specified cost card. | ||
ResourceIdentity | No |
** This field has been deprecated. |
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:PwsGetExpenseDocumentCostCard> <pws:serviceRequest> <req:RequestId>1</req:RequestId> <req:SessionTicket>AeB+IjyAtjb5x8rPrBUjXA==</req:SessionTicket> <tim:CostCardIdentity> <com:CostCardUid>1152921504614515296</com:CostCardUid> </tim:CostCardIdentity> <tim:ExpenseDocumentIdentity> <com:DocumentNumber>ER00721</com:DocumentNumber> <com:ExpenseDocumentUid>1152921504607683575</com:ExpenseDocumentUid> </tim:ExpenseDocumentIdentity> <!--tim:ResourceIdentity> <com:ResourceDisplayName>Jack Spratt</com:ResourceDisplayName> <com:ResourceReferenceSystemId>E123</com:ResourceReferenceSystemId> <com:ResourceUid>1152921504607111573</com:ResourceUid> </tim:ResourceIdentity--> </pws:serviceRequest> </pws:PwsGetExpenseDocumentCostCard> </soapenv:Body> </soapenv:Envelope> |
...
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 | 1 | ||
Status | Click here for more information | Ok | |||
ServerTimestampUtc | DateTime | Click here for more information | CostCard | 2018-02-27T16:18:08.8608287Z | |
CostCard | The complete set of information about a cost card (less any subordinate entities) | ||||
ExpenseDocumentTimestamp | String | This is a Base64 encoded timestamp utilized for expense document locking | |||
Location | The location associatied with the cost card | ||||
Receipts | The receipt(s) associated with the cost card |
Response Usage Example(s)
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <PwsGetExpenseDocumentCostCardResponse xmlns="http://projectorpsa.com/PwsProjectorServices/"> <PwsGetExpenseDocumentCostCardResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId> <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status> <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-02-27T16:18:08.8608287Z</ServerTimestampUtc> <a:CostCard> <a:AdjustedRevenueAmount i:nil="true"/> <a:ApprovalWorkflowStatus>S</a:ApprovalWorkflowStatus> <a:ApprovedByUser i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <a:ApprovedTimestamp i:nil="true"/> <a:ApprovedToInvoiceByUser i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <a:ApprovedToInvoiceTimestamp i:nil="true"/> <a:BilledTimestamp i:nil="true"/> <a:ClientAmount>500</a:ClientAmount> <a:CostCardDetail> <CostCardId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <CostCardUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504614515296</CostCardUid> <ReferenceId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <a:Description>Upgrade</a:Description> <a:DescriptionClearFlag>false</a:DescriptionClearFlag> <a:ExpenseTypeIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:ExpenseTypeId i:nil="true"/> <b:ExpenseTypeName>Travel</b:ExpenseTypeName> <b:ExpenseTypeUid>1152921504606881280</b:ExpenseTypeUid> </a:ExpenseTypeIdentity> <a:IncurredAmount>500</a:IncurredAmount> <a:IncurredDate>2018-02-27T00:00:00Z</a:IncurredDate> <a:IncurredOpsCurrencyIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:OpsCurrencyCode>USD</b:OpsCurrencyCode> <b:OpsCurrencyId i:nil="true"/> </a:IncurredOpsCurrencyIdentity> <a:IncurredVatAmount>0</a:IncurredVatAmount> <a:LocationClearFlag>false</a:LocationClearFlag> <a:LocationIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:LocationId i:nil="true"/> <b:LocationName>USA</b:LocationName> <b:LocationUid>1152921504606855985</b:LocationUid> </a:LocationIdentity> <a:NonBillableFlag>false</a:NonBillableFlag> <a:OverrideClientAmount i:nil="true"/> <a:OverrideClientAmountClearFlag>false</a:OverrideClientAmountClearFlag> <a:PayeeVendorClearFlag>false</a:PayeeVendorClearFlag> <a:PayeeVendorIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:VendorId i:nil="true"/> <b:VendorName>Jack Spratt</b:VendorName> <b:VendorUid>1152921504607055599</b:VendorUid> <b:VendorNumber>Jack Spratt</b:VendorNumber> </a:PayeeVendorIdentity> <a:ProjectIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:ProjectCode>P001395-001</b:ProjectCode> <b:ProjectId i:nil="true"/> <b:ProjectUid>1152921504607412209</b:ProjectUid> </a:ProjectIdentity> <a:ResourceClearFlag>false</a:ResourceClearFlag> <a:ResourceIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:ResourceDisplayName>Jack Spratt</b:ResourceDisplayName> <b:ResourceId i:nil="true"/> <b:ResourceReferenceSystemId>E123</b:ResourceReferenceSystemId> <b:ResourceUid>1152921504607111573</b:ResourceUid> </a:ResourceIdentity> <a:Timestamp>AAAAAA64KoE=</a:Timestamp> <a:TotalAmountDisbursedCurrency>500</a:TotalAmountDisbursedCurrency> <a:Udf1 xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:UdfId i:nil="true"/> <b:UdfName>Attendees</b:UdfName> <b:UdfUid>1152921504606860180</b:UdfUid> <b:BooleanValue i:nil="true"/> <b:DataType>I</b:DataType> <b:DateValue i:nil="true"/> <b:IntegerValue i:nil="true"/> <b:ResourceIdentityValue i:nil="true"/> <b:TextValue i:nil="true"/> <b:UdfTreatment>N</b:UdfTreatment> <b:StoplightValues/> <b:NumericValue i:nil="true"/> <b:RelationValue i:nil="true"/> </a:Udf1> <a:Udf1ClearFlag>false</a:Udf1ClearFlag> <a:Udf2 xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:UdfId i:nil="true"/> <b:UdfName>Purpose</b:UdfName> <b:UdfUid>1152921504606860181</b:UdfUid> <b:BooleanValue i:nil="true"/> <b:DataType>L</b:DataType> <b:DateValue i:nil="true"/> <b:IntegerValue i:nil="true"/> <b:ResourceIdentityValue i:nil="true"/> <b:TextValue i:nil="true"/> <b:UdfTreatment>N</b:UdfTreatment> <b:StoplightValues/> <b:NumericValue i:nil="true"/> <b:RelationValue i:nil="true"/> </a:Udf2> <a:Udf2ClearFlag>false</a:Udf2ClearFlag> <a:Units>1</a:Units> <a:ExternalGroupingIdentifier i:nil="true"/> <a:ExternalGroupingIdentifierClearFlag>false</a:ExternalGroupingIdentifierClearFlag> </a:CostCardDetail> <a:CreatedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:UserDisplayName>Jack Spratt</b:UserDisplayName> <b:UserId i:nil="true"/> <b:UserReferenceSystemId>E123</b:UserReferenceSystemId> <b:UserUid>1152921504607112369</b:UserUid> <b:EmailAddress>jack@revcorp.bb</b:EmailAddress> <b:FirstName>Jack</b:FirstName> <b:LastName>Spratt</b:LastName> <b:MiddleName i:nil="true"/> </a:CreatedByUser> <a:CreatedTimestamp>2018-02-27T16:07:02.41Z</a:CreatedTimestamp> <a:CreditedCostCardIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <a:DisbursedAmountDisbursedCurrency>500</a:DisbursedAmountDisbursedCurrency> <a:DisbursedAmountEngagementCurrency>500</a:DisbursedAmountEngagementCurrency> <a:DocumentCount>0</a:DocumentCount> <a:EngagementCurrency xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:CurrencyCode>USD</b:CurrencyCode> <b:CurrencyId i:nil="true"/> <b:CurrencyUid>1152921504606851838</b:CurrencyUid> </a:EngagementCurrency> <a:ExpenseAmount>0</a:ExpenseAmount> <a:ForReportingOnlyFlag>false</a:ForReportingOnlyFlag> <a:FxRate>1</a:FxRate> <a:FxRateActual>1</a:FxRateActual> <a:InvoiceIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <a:InvoiceWorkflowStatus>N</a:InvoiceWorkflowStatus> <a:InvoicedAmount>0</a:InvoicedAmount> <a:LastUpdatedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:UserDisplayName>Jack Spratt</b:UserDisplayName> <b:UserId i:nil="true"/> <b:UserReferenceSystemId>E123</b:UserReferenceSystemId> <b:UserUid>1152921504607112369</b:UserUid> <b:EmailAddress>jack@revcorp.bb</b:EmailAddress> <b:FirstName>Jack</b:FirstName> <b:LastName>Spratt</b:LastName> <b:MiddleName i:nil="true"/> </a:LastUpdatedByUser> <a:LastUpdatedTimestamp>2018-02-27T16:07:07.77Z</a:LastUpdatedTimestamp> <a:LockedFlag>false</a:LockedFlag> <a:NoteCount>0</a:NoteCount> <a:RejectedByUser i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <a:RejectedReason i:nil="true"/> <a:RejectedTimestamp i:nil="true"/> <a:RevRecAdjustmentAmount i:nil="true"/> <a:RevenueAmount>0</a:RevenueAmount> <a:Status>U</a:Status> <a:SubmittedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:UserDisplayName>Jack Spratt</b:UserDisplayName> <b:UserId i:nil="true"/> <b:UserReferenceSystemId>E123</b:UserReferenceSystemId> <b:UserUid>1152921504607112369</b:UserUid> <b:EmailAddress>jack@revcorp.bb</b:EmailAddress> <b:FirstName>Jack</b:FirstName> <b:LastName>Spratt</b:LastName> <b:MiddleName i:nil="true"/> </a:SubmittedByUser> <a:SubmittedTimestamp>2018-02-27T16:07:07.77Z</a:SubmittedTimestamp> <a:SystemRatePerMileageUnit>0.575</a:SystemRatePerMileageUnit> <a:UnitCost>500</a:UnitCost> <a:UnitPrice>500</a:UnitPrice> <a:VatAmountDisbursedCurrency>0</a:VatAmountDisbursedCurrency> <a:VoucherIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <a:WipAmount i:nil="true"/> <a:ChargeableFlag>true</a:ChargeableFlag> <a:DisbursingCostCenterIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:CostCenterId i:nil="true"/> <b:CostCenterName>Executive Team (USA)</b:CostCenterName> <b:CostCenterNumber>Executive Team (USA)</b:CostCenterNumber> <b:CostCenterUid>1152921504606867363</b:CostCenterUid> </a:DisbursingCostCenterIdentity> <a:EngagementCurrencyDecimalDigits>2</a:EngagementCurrencyDecimalDigits> <a:EngagementTypeBillableFlag>true</a:EngagementTypeBillableFlag> <a:IncurredCurrencyDecimalDigits>2</a:IncurredCurrencyDecimalDigits> <a:ManagementData> <a:AccountingPeriodClosedFlag>false</a:AccountingPeriodClosedFlag> <a:ApprovalWorkflowFlag>true</a:ApprovalWorkflowFlag> <a:ApproverFlag>true</a:ApproverFlag> <a:ApproverToInvoiceFlag>true</a:ApproverToInvoiceFlag> <a:ApproverToPayFlag>true</a:ApproverToPayFlag> <a:ApproversCanRejectApprovedExpensesFlag>false</a:ApproversCanRejectApprovedExpensesFlag> <a:AutoApprovalFlag>false</a:AutoApprovalFlag> <a:AutoApprovalToInvoiceFlag>false</a:AutoApprovalToInvoiceFlag> <a:AutoApprovalToPayFlag>false</a:AutoApprovalToPayFlag> <a:AwsApprovedStatusAllowedFlag>true</a:AwsApprovedStatusAllowedFlag> <a:AwsDraftStatusAllowedFlag>true</a:AwsDraftStatusAllowedFlag> <a:AwsRejectedStatusAllowedFlag>true</a:AwsRejectedStatusAllowedFlag> <a:AwsSubmittedStatusAllowedFlag>false</a:AwsSubmittedStatusAllowedFlag> <a:CanAdjustFlag>true</a:CanAdjustFlag> <a:CanEditFlag>true</a:CanEditFlag> <a:ClientIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:ClientId i:nil="true"/> <b:ClientNumber>PR-PSA</b:ClientNumber> <b:ClientUid>1152921504606961482</b:ClientUid> </a:ClientIdentity> <a:ClientName>Projector PSA</a:ClientName> <a:DisbursedCurrencyDecimalDigits>2</a:DisbursedCurrencyDecimalDigits> <a:DisbursedCurrencyIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:CurrencyCode>USD</b:CurrencyCode> <b:CurrencyId i:nil="true"/> <b:CurrencyUid>1152921504606851838</b:CurrencyUid> </a:DisbursedCurrencyIdentity> <a:DisbursingCostCenterIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:CostCenterId i:nil="true"/> <b:CostCenterName>Executive Team (USA)</b:CostCenterName> <b:CostCenterNumber>Executive Team (USA)</b:CostCenterNumber> <b:CostCenterUid>1152921504606867363</b:CostCenterUid> </a:DisbursingCostCenterIdentity> <a:EditSubmitFlag>true</a:EditSubmitFlag> <a:ExpenseDocumentIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:DocumentNumber>ER00721</b:DocumentNumber> <b:ExpenseDocumentId i:nil="true"/> <b:ExpenseDocumentUid>1152921504607683575</b:ExpenseDocumentUid> </a:ExpenseDocumentIdentity> <a:ExpenseDocumentName>Expense report created 27 Feb 2018</a:ExpenseDocumentName> <a:ExpenseDocumentTimestamp>AAAAAA64Kng=</a:ExpenseDocumentTimestamp> <a:ExpenseDocumentType>E</a:ExpenseDocumentType> <a:ExpenseDocumentVatFlag>false</a:ExpenseDocumentVatFlag> <a:IwsApprovedStatusAllowedFlag>true</a:IwsApprovedStatusAllowedFlag> <a:IwsDraftInvoiceStatusAllowedFlag>false</a:IwsDraftInvoiceStatusAllowedFlag> <a:IwsInvoicedStatusAllowedFlag>false</a:IwsInvoicedStatusAllowedFlag> <a:IwsUnapprovedStatusAllowedFlag>false</a:IwsUnapprovedStatusAllowedFlag> <a:MileageUom>M</a:MileageUom> <a:PwsApprovedStatusAllowedFlag>true</a:PwsApprovedStatusAllowedFlag> <a:PwsPaidStatusAllowedFlag>true</a:PwsPaidStatusAllowedFlag> <a:PwsReceivedStatusAllowedFlag>true</a:PwsReceivedStatusAllowedFlag> <a:PwsTransmittedStatusAllowedFlag>true</a:PwsTransmittedStatusAllowedFlag> <a:PwsUnapprovedStatusAllowedFlag>false</a:PwsUnapprovedStatusAllowedFlag> </a:ManagementData> <a:PaymentVoucherPaymentWorkflowStatus>N</a:PaymentVoucherPaymentWorkflowStatus> <a:ProjectName>New Web Services Project (A)</a:ProjectName> <a:DefaultVatPercentage>0</a:DefaultVatPercentage> </a:CostCard> <a:ExpenseDocumentTimestamp>AAAAAA64Kng=</a:ExpenseDocumentTimestamp> <a:Location xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:LocationId i:nil="true"/> <b:LocationName>USA</b:LocationName> <b:LocationUid>1152921504606855985</b:LocationUid> <b:CurrencyIdentity> <b:CurrencyCode>USD</b:CurrencyCode> <b:CurrencyId i:nil="true"/> <b:CurrencyUid>1152921504606851838</b:CurrencyUid> </b:CurrencyIdentity> <b:InactiveFlag>false</b:InactiveFlag> <b:MileageUom>M</b:MileageUom> <b:OpsCurrencyIdentity> <b:OpsCurrencyCode>USD</b:OpsCurrencyCode> <b:OpsCurrencyId i:nil="true"/> </b:OpsCurrencyIdentity> <b:EnabledForCostcardsFlag>true</b:EnabledForCostcardsFlag> <b:EnabledForProjectsFlag>true</b:EnabledForProjectsFlag> <b:EnabledForResourcesFlag>true</b:EnabledForResourcesFlag> <b:EnabledForTimecardsFlag>true</b:EnabledForTimecardsFlag> </a:Location> <a:Receipts/> </PwsGetExpenseDocumentCostCardResult> </PwsGetExpenseDocumentCostCardResponse> </s:Body> </s:Envelope> |
PwsGetExpenseDocumentCostCard - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
---|---|---|
19004 | ExpenseDocumentNotSpecifiedForRetrieve | No expense document was specified for retrieval. |
19008 | CostCardNotSpecifiedForRetrieve | No cost card was specified for retrieval. |