GET /customers/{id}
Retrieves the customer for the given customer ID.
Roles that can access this endpoint are Users.
Parameters
name |
description |
type |
default |
type |
id |
ID for the RowCustomer 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
|
Result
RowCustomer
of type:
application/xml
application/json
a RowCustomer object
Additional attributes:
__pastDue
This value is a calculated field, representing the past due balance for the customer.
Child Elements:
RowSalesperson
This element represent the salesperson associated with the customer, by the customer.salesperson_id
field.
The element contains a __name
attribute with the value salesperson
.
RowContact
These elements represent the contacts associated with the customer.
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 customer.
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