Retrieves a List of RowPayees with a full or partial match to the given value.
name | description | type | default | type |
---|---|---|---|---|
q | string for which to search for payees by name or ID | query | String |
a list of RowPayee objects
Additional attributes:
__statusDescr
This value represents the description of the payee status, found in the payee.status
field.__safetyRatingDescr
This value represents the description of the safety rating, found in the drs_payee.safety_rating
field.__brokerAuthStatusDescr
This value represents the description of the broker authority status, found in the drs_payee.broker_auth_status
field.__commonAuthStatusDescr
This value represents the description of the common authority status, found in the drs_payee.common_auth_status
field.__contractAuthStatusDescr
This value represents the description of the contract authority status, found in the drs_payee.contract_auth_status
field.RowDrsPayee
This element represent the drs payee associated with the payee.
The element contains a __name
attribute with the value drsPayee
.RowContact
These elements represent the contacts associated with the payee.
The element contains a __name
attribute with the value contacts
.
*Note this is only returned if the includeContacts
Query Parameter is passed as true.RowComments
These elements represent the comments associated with the payee.
The element contains a __name
attribute with the value comments
.
*Note this is only returned if the includeComments
Query Parameter is passed as true.