This web service retrieves a list of cost cards (PwsCostCardElement), based upon multiple criteria fields and/or a resource identifier (PwsResourceRef). In addition to the cost cards present in the response, information about the invoices, locations, payee vendors, projects, receipts and vouchers represented by at least one cost card in the results are included.

Info
Please note that this service will only retrieve cards that are on expense documents of type "Expense Report". Also it will not retrieve per-diem or credit cost cards.

Request Format

Panel

title	PwsGetResourceCostCards Request

PwsGetResourceCostCards
- serviceRequest: PwsGetResourceCostCardsRq
  - RequestId: Int32
  - SessionTicket: String
  - ExcludeApprovedCardsBefore: DateTime
  - IncludeApprovedFlag: Boolean
  - IncludeApprovedToPayFlag: Boolean
  - IncludeDraftFlag: Boolean
  - IncludePaidFlag: Boolean
  - IncludeReceivedFlag: Boolean
  - IncludeRejectedFlag: Boolean
  - IncludeSubmittedFlag: Boolean
  - IncludeTransmittedFlag: Boolean
  - ResourceIdentity: PwsResourceRef
  - ExpenseDocumentType: String(1)
  - IncludeHiddenCostCardsFlag: Boolean

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

	If specified, 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

response.	true
IncludeApprovedToPayFlag	Boolean	No	false	If set to 'true', approved to pay cost cards will be included in the

response

response.	true
IncludeDraftFlag	Boolean	No	false	If set to 'true', draft cost cards will be included in the

response

response.	true
IncludePaidFlag	Boolean	No	false	If set to 'true', paid cost cards will be included in the

response

response.	true
IncludeReceivedFlag	Boolean	No	false	If set to 'true', received cost cards will be included in the

response

response.	true
IncludeRejectedFlag	Boolean	No	false	If set to 'true', rejected cost cards will be included in the

response

response.	false
IncludeSubmittedFlag	Boolean	No	false	If set to 'true', submitted cost cards will be included in the

response

response.	true
IncludeTransmittedFlag	Boolean	No	false	If set to 'true', transmitted cost cards will be included in the

response

response.	false
ResourceIdentity	PwsResourceRef	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

not supplied, the cost cards of the authenticated user will be returned.

ExpenseDocumentType

String(1)

This field indicates the type of the expense document.

"E" - Expense Report

'V" - Vendor Invoice

"S" - Soft Cost Batch

"C" - Subcontractor Invoice

IncludeHiddenCostCardsFlag

Boolean

No

false

If set to "true", the result set will include per diem cost cards and credit cost cards.

Request Usage Example(s)

Code Block

language	xml
title	Example 01
collapse	true

<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

title	PwsGetResourceCostCards Response

PwsGetResourceCostCardsResponse
- PwsGetResourceCostCardsResult: PwsGetResourceCostCardsRs
- - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - CostCards: PwsCostCardElement [???]
  - Invoices: PwsExpenseEntryInvoice [???]
  - Locations: PwsLocationSummary [???]
  - PayeeVendors: PwsVendorSummary [???]
  - Projects: PwsExpenseEntryProject [???]
  - Receipts: PwsReceiptDetail [???]
  - Vouchers: PwsPaymentVoucher [???]

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-03-20T15:21:03.883377Z
CostCards	PwsCostCardElement [

???

]	Detailed information about the cost

card

cards.
Invoices	PwsExpenseEntryInvoice [

???

]	Detailed information about

the invoice

all invoices associated with the returned cost

card

cards.
Locations	PwsLocationSummary [

???

]

The

location

locations associated with the cost

card

cards.
PayeeVendors	PwsVendorSummary [

???

]

The payee

vendor

vendors associated with the cost

card

cards.


Projects	PwsExpenseEntryProject [

???

]

The

project

projects associated with the cost

card

cards.
Receipts	PwsReceiptDetail [

???

]

The

receipt

receipts and/or receipt notes associated with the cost

card

cards.
Vouchers	PwsPaymentVoucher [

???

]	The payment

vucher

vouchers associated with the cost

card

cards.

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.

Versions Compared

Old Version 2

New Version Current

Key

Request Format

Request Elements

Request Usage Example(s)

Response Elements

Response Usage Example(s)

Page Comparison

Versions Compared

Old Version 2

New Version Current

Key

Request Format

Request Elements

Request Usage Example(s)

Response Elements

Response Usage Example(s)