Versions Compared

Key

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

...

This web service retrieves a list of expense report vendors (PwsVendorElement), based upon a list of unique expense document (PwsExpenseDocumentRef) and/or resource (PwsResourceRef) identifiers.

Request Format


Panel
titlePwsGetVendors Request
  • PwsGetVendors
    • serviceRequest: PwsGetVendorsRq

...

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.

AV795EkfoxzwEpVD7pZJJA==


ExpenseDocumentIdentity

PwsExpenseDocumentRef

If "IncludeExpenseReportPayeesFlag" = 'true', one of ExpenseDocumentIdetity or ResourceIdentity is required


The expense document identity associated with the vendorIf specified, the expense document's company and disbursing currency will be used to determine the proper value for ExpenseReportPayeeFlag in PwsVendorSummary. Otherwise, the resource's company and disbursing currency will.

Note: This is only applicable if "IncludeExpenseReportPayeesFlag" = 'true'


IncludeExpenseReportPayeesFlag

Boolean

No 

false 

If set to 'true', vendors that are enabled for expense reports are included in the response.

true

IncludeInactiveFlag

Boolean

No 

false 

If set to 'true', inactive vendors are included in the response response.

false

IncludeSubcontractorInvoicePayeesFlag

Boolean

No 

false 

If set to 'true', vendors that are enabled for subcontractor invoices are included in the response.

false 

IncludeVendorInvoicePayeesFlag

Boolean

No 

false 

If set to 'true', vendors that are enabled for vendor invoices are included in the response response.

false 

ResourceIdentity

PwsResourceRef

See ExpenseDocumentIdentity


The resource identity associated with the vendorIf specified, the resource's company and disbursing currency will be used to determine the proper value for ExpenseReportPayeeFlag in PwsVendorSummary.

Note: This is only applicable if "IncludeExpenseReportPayeesFlag" = '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.

Ok

ServerTimestampUtc

DateTime

Click here for more information.

2018-03-05T19:49:28.5492052Z

Vendors

PwsVendorSummary[]

The vendor summary records that were fetched by the service.


ExpenseReportVendorIdentity

PwsVendorRef

The expense report vendor identity.

Note: This is only applicable if "IncludeExpenseReportPayeesFlag" = 'true' in the request


...