GET api/v1/Client/{Id}
Get a client by id
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Client ID number |
integer |
Required |
Body Parameters
Response Information
Resource Description
Client object
Client| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Database ID for the client. Do not supply this value. It will be generated by the system |
integer | |
| Name |
Client Name from Dynamics |
string |
Required |
| ShortName |
Common Name that is in dynamics but it is how we know the clients |
string |
Required |
| Code |
Client Code for the ID |
string |
Required |
| Active |
Active status of the client |
boolean |
Required |
| ClientTypeId | TClientType | ||
| ParentClient |
Parent Client for the client. Leave empty if one doesn't exist |
string | |
| Description |
Description of the client |
string | |
| ErpId |
ERP ID for the client. From Dynamics |
string | |
| ErpNumber |
ERP Number for the client. From Dynamics |
string | |
| Address1 |
Address information for the client |
string | |
| Address2 |
Address information for the client |
string | |
| City |
City information for the client |
string | |
| State |
State information for the client |
string | |
| Zip |
Zip information for the client |
string | |
|
Email information for the client |
string | ||
| Phone |
Phone information for the client |
string | |
| ClientContracts |
Client Contracts for the client |
Collection of ClientContract | |
| ModifiedDateTime |
Modified datetime for the object. This will be added by the system. |
date | |
| ExecutionTime |
How long the method took in milliseconds. System supplied value. |
integer | |
| TxID |
Transaction ID of the call. Will be added for the response. Not needed in the request. |
string |
Response Formats
application/json, text/json
{
"executionTime": 19,
"txID": "sample string 20"
}
application/xml
Sample not available.
text/xml
Sample not available.