...
| 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 | AQ5WrtOZXd6h2ydAZlgm3g== | |
ExcludeApprovedCardsBefore | DateTime | No |
All approved cards prior to this date (in UTC format) will be excluded from the response | 2018-01-01T00:00:00.000Z | ||||
IncludeApprovedFlag | Boolean | No | false | If set to 'true', approved cost cards will be included in the response | true |
IncludeApprovedToPayFlag | Boolean | No | false | If set to 'true', approved to pay cost cards will be included in the response | true |
IncludeDraftFlag | Boolean | No | false | If set to 'true', draft cost cards will be included in the response | true |
IncludePaidFlag | Boolean | No | false | If set to 'true', paid cost cards will be included in the response | true |
IncludeReceivedFlag | Boolean | No | false | If set to 'true', received cost cards will be included in the response | true |
IncludeRejectedFlag | Boolean | No | false | If set to 'true', rejected cost cards will be included in the response | false |
IncludeSubmittedFlag | Boolean | No | false | If set to 'true', submitted cost cards will be included in the response | true |
IncludeTransmittedFlag | Boolean | No | false | If set to 'true', transmitted cost cards will be included in the response | false |
ResourceIdentity | No |
The resource associated with the cost cards when acting on behalf of another user. If not supplied, the cost cards of the authenticated user will be returned |
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:PwsGetResourceCostCards>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>AQ5WrtOZXd6h2ydAZlgm3g==</req:SessionTicket>
<tim:ExcludeApprovedCardsBefore>2018-01-01T00:00:00.000Z</tim:ExcludeApprovedCardsBefore>
<tim:IncludeApprovedFlag>true</tim:IncludeApprovedFlag>
<tim:IncludeApprovedToPayFlag>true</tim:IncludeApprovedToPayFlag>
<tim:IncludeDraftFlag>true</tim:IncludeDraftFlag>
<tim:IncludePaidFlag>true</tim:IncludePaidFlag>
<tim:IncludeReceivedFlag>true</tim:IncludeReceivedFlag>
<tim:IncludeRejectedFlag>false</tim:IncludeRejectedFlag>
<tim:IncludeSubmittedFlag>true</tim:IncludeSubmittedFlag>
<tim:IncludeTransmittedFlag>false</tim:IncludeTransmittedFlag>
</pws:serviceRequest>
</pws:PwsGetResourceCostCards>
</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-03-20T15:21:03.883377Z |
CostCards |
Detailed information about the cost card |
Invoices |
Detailed information about the invoice associated with the cost card |
Locations |
The location associated with the cost card |
PayeeVendors |
The payee vendor associated with the cost card |
Projects |
The project associated with the cost card |
Receipts |
The receipt and/or receipt notes associated with the cost card |
Vouchers |
The payment vucher associated with the cost card |
Response Usage Example(s)
...
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 50223 | NoPermissionToActOnBehalfOfResource | The specified user does not have permission to act on behalf of this resource. |
| 57545 | ResourceNotFound | The specified resource does not exist. |