You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
Version 1
Next »
Overview
This web service retrieves a list of expense reports (PwsExpenseDocument), based upon a list of unique expense document identifiers (PwsExpenseDocumentRef) or resource identifiers (PwsResourceRef)
- PwsGetExpenseReports
- serviceRequest: PwsGetExpenseReportsRq
Request Element(s)
Element | Data Type | Required? | Default | Description | Sample Data |
---|
RequestId | Int32 | false | | Click here for more information. | 1 |
SessionTicket | String | true | | Click here for more information. | Aa/HJL2aAIqnCD1DEazq8Q== |
ExpenseDocumentIdentity | PwsExpenseDocumentRef | One of ExpenseDocumentIdentity or ResourceIdentity is required | | This structure represents the unique key fields associated with identifying an expense document | |
IncludeUnreceivedOnlyFlag | Boolean | false | false | If set to 'true', only expense reports that have been marked as 'received' will be returned | false |
NumberMonths | Int32 | false | 0 | The number of months prior to the current month, the expense report(s) returned by this service must contain at least one cost card within this window | 12 |
ResourceIdentity | PwsResourceRef | See ExpenseDocumentIdentity | | This structure represents the unique key fields associated with identifying a resource | |
Request Usage Example(s)
<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:PwsGetExpenseReports>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>Aa/HJL2aAIqnCD1DEazq8Q==</req:SessionTicket>
<tim:ExpenseDocumentIdentity>
<com:DocumentNumber>ER00721</com:DocumentNumber>
</tim:ExpenseDocumentIdentity>
<tim:IncludeUnreceivedOnlyFlag>false</tim:IncludeUnreceivedOnlyFlag>
<tim:NumberMonths>12</tim:NumberMonths>
<tim:ResourceIdentity>
<com:ResourceReferenceSystemId>E123</com:ResourceReferenceSystemId>
</tim:ResourceIdentity>
</pws:serviceRequest>
</pws:PwsGetExpenseReports>
</soapenv:Body>
</soapenv:Envelope>
- PwsGetExpenseReportsResponse
- PwsGetExpenseReportsResult: PwsGetExpenseReportsRs
Response Elements
Element | Data Type | Description | Sample Data |
---|
Messages | PwsMessage | The web service response status and message. Click here for more information. | |
ResponseId | Int32 | Click here for more information. | 1 |
Status | RequestStatus | Click here for more information. | Ok |
ServerTimestampUtc | DateTime | Click here for more information. | 2018-02-27T19:11:06.216758Z |
ExpenseReports | PwsExpenseDocument | This structure represents the fields associated with an expense report | |
CreateExpenseReportsPermissionFlag | Boolean | If set to 'true', the authenticated user has permission to create expense reports | true |
Response Usage Example(s)
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsGetExpenseReportsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsGetExpenseReportsResult 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-27T19:11:06.216758Z</ServerTimestampUtc>
<a:ExpenseReports>
<a:PwsExpenseDocument>
<DocumentNumber xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">ER00721</DocumentNumber>
<ExpenseDocumentId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<ExpenseDocumentUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607683575</ExpenseDocumentUid>
<a:CashAdvanceReturnAmount>0</a:CashAdvanceReturnAmount>
<a:CostCenterIdentity 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:CostCenterIdentity>
<a:DocumentName>Expense report created 27 Feb 2018 - A</a:DocumentName>
<a:DocumentType>E</a:DocumentType>
<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: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:VendorIdentity 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:VendorIdentity>
<a:VendorInvoiceDate i:nil="true"/>
<a:VendorInvoiceReferenceNumber i:nil="true"/>
<a:Vendor 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>
<b:ExpenseReportPayeeFlag>true</b:ExpenseReportPayeeFlag>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ResourceVendorFlag>true</b:ResourceVendorFlag>
<b:VendorInvoicePayeeFlag>false</b:VendorInvoicePayeeFlag>
<b:SubcontractorInvoicePayeeFlag>true</b:SubcontractorInvoicePayeeFlag>
</a:Vendor>
<a:SubcontractorInvoiceDate i:nil="true"/>
<a:SubcontractorInvoiceReferenceNumber i:nil="true"/>
<a:AllowCloneFlag>true</a:AllowCloneFlag>
<a:AllowDeleteFlag>true</a:AllowDeleteFlag>
<a:Category>S</a:Category>
<a:CompanyPaidAmount>0</a:CompanyPaidAmount>
<a:CostCardCount>2</a:CostCardCount>
<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:01.393Z</a:CreatedTimestamp>
<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:EarliestIncurredDate>2018-02-27T00:00:00Z</a:EarliestIncurredDate>
<a:LatestIncurredDate>2018-02-27T00:00:00Z</a:LatestIncurredDate>
<a:MileageUom>M</a:MileageUom>
<a:PaymentVoucherItems>
<a:PwsPaymentVoucherItem>
<a:Amount>521.75</a:Amount>
<a:EffectiveStatus>S</a:EffectiveStatus>
<a:ItemCount>2</a:ItemCount>
<a:PaymentVoucher i:nil="true"/>
<a:ProjectSummary i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
</a:PwsPaymentVoucherItem>
</a:PaymentVoucherItems>
<a:Projects xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:PwsProjectSummary>
<b:ProjectCode>P001395-001</b:ProjectCode>
<b:ProjectId i:nil="true"/>
<b:ProjectUid>1152921504607412209</b:ProjectUid>
<b:EngagementIdentity>
<b:EngagementCode>E001395</b:EngagementCode>
<b:EngagementId i:nil="true"/>
<b:EngagementUid>1152921504607324698</b:EngagementUid>
</b:EngagementIdentity>
<b:ProjectName>New Web Services Project (A)</b:ProjectName>
</b:PwsProjectSummary>
</a:Projects>
<a:ReimbursementAmount>521.75</a:ReimbursementAmount>
<a:Status>S</a:Status>
<a:TitleIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:DepartmentIdentity>
<b:DepartmentId i:nil="true"/>
<b:DepartmentName>Executive Team</b:DepartmentName>
<b:DepartmentUid>1152921504606854181</b:DepartmentUid>
</b:DepartmentIdentity>
<b:TitleId i:nil="true"/>
<b:TitleName>Level 1</b:TitleName>
<b:TitleUid>1152921504606875471</b:TitleUid>
</a:TitleIdentity>
<a:TotalAmount>521.75</a:TotalAmount>
<a:DisbursedCurrencyDecimalDigits>2</a:DisbursedCurrencyDecimalDigits>
<a:ExpenseDocumentVatFlag>false</a:ExpenseDocumentVatFlag>
<a:ExpenseDocumentLockedFlag>false</a:ExpenseDocumentLockedFlag>
</a:PwsExpenseDocument>
</a:ExpenseReports>
<a:CreateExpenseReportsPermissionFlag>true</a:CreateExpenseReportsPermissionFlag>
</PwsGetExpenseReportsResult>
</PwsGetExpenseReportsResponse>
</s:Body>
</s:Envelope>
PwsGetExpenseReports - Common Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
---|
65168 | SpecifiedResourceDoesNotMatchExpenseReportResource | The resource display name for an expense report mapping item must match the expense report resource. |
65492 | ExpenseDocumentRefInvalid | ExpenseDocumentRef is required |
65494 | ExpenseDocumentNotFound | Expense document not found. |