/
PwsGetVendors

PwsGetVendors

Owned by Bettina Borces
Last updated: about 8 hours ago

Overview


This web service retrieves a list of expense report vendors.


Rate Limiting

In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm.  When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate.  Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly.  For more information please visit: Projector Rate Limiting Behavior.


Request Format


PwsGetVendors Request
  • PwsGetVendors
    • serviceRequest: PwsGetVendorsRq

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.

AV795EkfoxzwEpVD7pZJJA==


ExpenseDocumentIdentity

PwsExpenseDocumentRef

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


If 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.

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.

false 

ResourceIdentity

PwsResourceRef

See ExpenseDocumentIdentity


If 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'


Request Usage Example(s)


Example 01 
<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:PwsGetVendors>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AV795EkfoxzwEpVD7pZJJA==</req:SessionTicket>
            <tim:ExpenseDocumentIdentity>
               <com:DocumentNumber>ER00722</com:DocumentNumber>
            </tim:ExpenseDocumentIdentity>
            <tim:IncludeExpenseReportPayeesFlag>true</tim:IncludeExpenseReportPayeesFlag>
            <tim:IncludeInactiveFlag>false</tim:IncludeInactiveFlag>
            <tim:IncludeSubcontractorInvoicePayeesFlag>false</tim:IncludeSubcontractorInvoicePayeesFlag>
            <tim:IncludeVendorInvoicePayeesFlag>false</tim:IncludeVendorInvoicePayeesFlag>
         </pws:serviceRequest>
      </pws:PwsGetVendors>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


PwsGetVendors Response

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-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


Response Usage Example(s)


Example 01 
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetVendorsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetVendorsResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-05T19:49:28.5492052Z</ServerTimestampUtc>
            <a:Vendors xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsVendorSummary>
                  <b:VendorId i:nil="true"/>
                  <b:VendorName>American Executive</b:VendorName>
                  <b:VendorUid>1152921504606942291</b:VendorUid>
                  <b:VendorNumber>American Executive</b:VendorNumber>
                  <b:ExpenseReportPayeeFlag>true</b:ExpenseReportPayeeFlag>
                  <b:InactiveFlag>false</b:InactiveFlag>
                  <b:ResourceVendorFlag>false</b:ResourceVendorFlag>
                  <b:VendorInvoicePayeeFlag>true</b:VendorInvoicePayeeFlag>
                  <b:SubcontractorInvoicePayeeFlag>true</b:SubcontractorInvoicePayeeFlag>
               </b:PwsVendorSummary>
               <b:PwsVendorSummary>
                  <b:VendorId i:nil="true"/>
                  <b:VendorName>Jack Spratt</b:VendorName>
                  <b:VendorUid>1152921504607055599</b:VendorUid>
                  <b:VendorNumber>Jack Spratt</b:VendorNumber>
                  <b:ExpenseReportPayeeFlag>true</b:ExpenseReportPayeeFlag>
                  <b:InactiveFlag>false</b:InactiveFlag>
                  <b:ResourceVendorFlag>true</b:ResourceVendorFlag>
                  <b:VendorInvoicePayeeFlag>false</b:VendorInvoicePayeeFlag>
                  <b:SubcontractorInvoicePayeeFlag>true</b:SubcontractorInvoicePayeeFlag>
               </b:PwsVendorSummary>
            </a:Vendors>
            <a:ExpenseReportVendorIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:VendorId i:nil="true"/>
               <b:VendorName>Jack Spratt</b:VendorName>
               <b:VendorUid>1152921504607055599</b:VendorUid>
               <b:VendorNumber>Jack Spratt</b:VendorNumber>
            </a:ExpenseReportVendorIdentity>
         </PwsGetVendorsResult>
      </PwsGetVendorsResponse>
   </s:Body>
</s:Envelope>

PwsGetVendors - Common Errors and Warnings

ErrorNumber

ErrorCode

ErrorText

57545ResourceNotFoundThe specified resource does not exist.
65494ExpenseDocumentNotFoundExpense document not found.
65731MustSpecifyEitherExpenseDocumentOrResourceWhen searching for expense report vendors, either an expense document or resource must be specified.