Navigation :

Clients

A client object includes client details and a client project list. The table below describes each parameter and how it maps to the Field Nation Platform.

Client Object

Parameter	Type	Example	Mapping/Notes
id client_id	integer	"id": 188, "client_id": 188	Client ID.
name	string	"name": "Main Street Shipping"	Client title.
active	boolean	"active": true	Active or Deactivated.
manager	object	"manager": {}	Client manager.
logo	string	"logo": "/images/main-street.png"	Logo. Optional.
website	string	"website": ""	Website. Optional.
about	string	"about": "parking garage is 2 blocks down from main street."	Notes. Optional.
print_logo	boolean	"print_logo": false	Show my company's name and logo. If print_logo is set to true, the work order will show the client's name and logo.
policy_procedure	string	"policy_procedure": ""	Default Policies and Procedures. If set, this will replace your company's default policies and procedures for work orders created for this client.
standard_instruction	string	"standard_instruction": ""	Default Standard Instruction. If set, this will replace your company's default standard instruction for work orders created for this client.
address1	string	"address1":"123 Main Street"	Address Line 1.
address2	string	"address2":"Building 4C"	Address Line 2.
city	string	"city":"Phoenix"	City.
state	string	"state":"AZ"	State.
zip	string	"zip":"85001"	Zip.
country	string	"country":"US"	Country. Refer to Country Codes for a list of codes.
location_type	integer	"location_type": 1	Location type. Options 1 = Commercial 2 = Governmental 3 = Residential 4 = Educational 5 = Other
projects	object	"results": []	Projects associated with this client. Client projects are located in the projects > results object.
id	integer	"id": 239	Project id.
name	string	"name": "Monthly Copier Maintenance"	Project Name.
status	string	"status": "active"	Project Status. Options active, completed

Client Examples

Client Object with Projects

Returns the client parameters, work order statistics associated with the client id, and a paginated list of projects associated with the client id.

{
    "id": 188,
    "client_id": 188,
    "name": "Main Street Shipping",
    "actions": [],
    "correlation_id": "b1e5c4f3596bd5640595043b1ac38fc10bc4be36",
    "active": true,
    "print_logo": false,
    "address_1": "123 Main Street",
    "address_2": "",
    "city": "New York",
    "state": "NY",
    "zip": "10001",
    "country": "US",
    "location_type": 1,
    "website": "",
    "policy_procedure": "",
    "standard_instruction": "",
    "about": "parking garage is 2 blocks down from main street.",
    "created": {
        "utc": "2018-11-12 15:16:36"
    },
    "logo": "/images/missing-profile.png",
    "manager": {
        "thumbnail": "/images/missing-profile.png",
        "id": 756,
        "first_name": "API",
        "last_name": "Manager",
        "email": "apimanager@mail.com",
        "phone": "+15551235585"
    },
    "work_order_counts": {
        "all": 1,
        "today": 0,
        "draft": 1,
        "published_routed": 0,
        "assigned": 0,
        "approved_paid": 0,
        "work_done": 0
    },
    "projects": {
        "metadata": {
            "total": 1,
            "pages": 1,
            "per_page": 1,
            "page": 1
        },
        "results": [
            {
                "id": 239,
                "name": "Monthly Copier Maintenance",
                "status": "active"
            }
        ],
        "actions": [
            "add"
        ]
    }
}

Work Order Client Response

You can locate client information in the work order > client object.

"client": { }

Work Order Client Response

Returns the client id and name.

"client": {
    "id": 188,
    "name": "Main Street Shipping"
}