...
| Panel | ||
|---|---|---|
| ||
|
Request Element(s)
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 |
false
No | Click here for more information. | 1 | |
SessionTicket | String |
true
Yes | Click here for more information. | Aa/HJL2aAIqnCD1DEazq8Q== | |
ExpenseDocumentIdentity |
One of ExpenseDocumentIdentity or ResourceIdentity is required
Yes | This structure represents the unique key fields associated with identifying an expense document |
IncludeUnreceivedOnlyFlag | Boolean |
No | false | If set to 'true', only expense reports that have been marked as 'received' will be returned | false |
NumberMonths | Int32 |
No | 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 |
No |
This structure represents the unique key fields associated with identifying the resource. If a ResourceIdentity is not specified, the authenticated resource identity will be used. If the resource |
identity is supplied and, it differs from the authenticated user, the authenticated user must have permission to view the specified resource's expense documents, otherwise the service will fail. |
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: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> |
...
| 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. | 2018-02-27T19:11:06.216758Z |
ExpenseReports | 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)
...
- For all errors and warnings please refer to the Complete List of 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. |