With the Client API, you can retrieve either a detailed list of Clients or details about a single Client.
Basic Attributes
The following attributes are returned by the API calls in this section.
| Field Name | Description | Data Type |
|---|---|---|
| 1. Id | FW Internal ID of the Client | integer |
| 2. officeID | FW Internal Id of the Office | integer |
| 3. name | Client name | string |
| 4. code | External code for the client (billing code) | string |
| 5. address | Address for a given client | |
| a. addressType | Address identifier (work, payee, invoice, traffic) | string |
| b. line1 | Address line 1 | string |
| c. line2 | Address line 2 | string |
| d. zip | Zip Code | string |
| e. state | State | string |
| f. city | City | string |
| g. country | Country | string |