Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.


SessionTicket

String

Yes 


Click here for more information.

Ad9/vlTyZRtWnsPuFVHm7w== 

CloneAmountsFlag

Boolean

No 

false

Applies only when clonging cloning an existing expense document.

If set to 'true', the amounts on the specified expense report will be cloned.

Note: If set to 'true', the RetrieveCostCardsFlag must also be set to 'true'

false 

CloneDatesFlag

Boolean

No

false 

Applies only when clonging cloning an existing expense document.

If set to 'true', the dates on the specified expense report will be cloned..

Note: If set to 'true', the RetrieveCostCardsFlag must also be set to 'true'

false

CloneFlag

Boolean

No

false

If set to 'true', the expense document will be cloned.

false 

DelayDays

Int32

No

0

Applies only when clonging cloning an existing expense document.

When cloning an expense report the number specified here indicates the number of days by which the dates associated with cost cards on the expense report should be delayed.

ExcludeCreditCostCardsFlag

Boolean

No

false

If set to 'true', credit cost cards on the expense report will not be returned

true

ExpenseDocumentIdentity

PwsExpenseDocumentRef

Yes


The expense document to be retrieved / cloned. Do not specify when creating a new expense document.


NewDocumentType

String



Applies specifically when creating new expense documents. May be specified when retrieving or cloning existing expense documents, but if specified it must match the existing expense document's type. The possible values are:

"E" for Expense Report

"C" for Subcontractor Invoice

"V" for Vendor Invoice

"S" for Soft Cost Batch 


ResourceIdentity

PwsResourceRef

No


The resource Applies only when creating a new expense report.

Specifies the resource to be associated with the expense report. This value is ignored when retrieving or cloning an existing expense document, or creating a new expense document of any type other than an expense report.  


RetrieveCostCardsFlag

Boolean

No

false

If set to 'true', the cost cards on the expense document will retrieved

true 

RetrieveReceiptsFlag

Boolean

No

false

If set to 'true', the receipts on the expense document will be retrieved

true 

...

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.

Status

RequestStatus

Click here for more information.


ServerTimestampUtc

DateTime

Click here for more information.

2018-02-13T18:25:14.5044325Z

ExpenseDocument

PwsExpenseDocumentElement

The complete set of information about the expense document. When retrieving an existing document, this will refer to the existing document in the system. When cloning or creating a new expense document, this will not refer to any existing document in the system. This will contain an expense document (less any subordinate entities)ExpenseDocumentDetail member of type PwsExpenseDocumentDetail. This structure can be passed back up to PwsSaveExpenseDocument to update an existing document (when this is the response from retrieving an existing document) or create a new expense document (when this is the response from cloning an existing document or creating a new one).


Response Usage Example(s)

...