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 NameDescriptionData Type
1. IdFW Internal ID of the Clientinteger
2. officeIDFW Internal Id of the Officeinteger
3. nameClient namestring
4. codeExternal code for the client
(billing code)
5. addressAddress for a given client
a. addressTypeAddress identifier
(work, payee, invoice, traffic)
b. line1Address line 1string
c. line2Address line 2string
d. zipZip Codestring
e. stateStatestring
f. cityCitystring
g. countryCountrystring