GET /carriers/{id}
Retrieves the Payee for the payee ID
Roles that can access this endpoint are Users.
Parameters
| name |
description |
type |
default |
type |
| id |
ID for the RowPayee to be returned |
path
|
|
String
|
| includeComments |
if related Comment records should be included |
query
|
false |
Boolean
|
| includeContacts |
if related Contact records should be included |
query
|
false |
Boolean
|
| includeQualifications |
if the carrier is qualified at a generic level |
query
|
false |
Boolean
|
Result
RowPayee
of type:
application/xml
application/json
the requested RowPayee object
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.
Child Elements:
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.
Try It Out
Request