People and the directory

find_peoplereads only

Find people

Employees matching a name or employee number. Returns ids for the other tools — never guess an employee id. An empty search lists the first page of everybody.

Someone asks: “Find Juan dela Cruz and Maria Santos.”

Input

{
  "search": "dela cruz"
}

What comes back

1 person:
Dela Cruz, Juan (EMP-001) · id 5f1c2a9e-3b7d-4c21-9e4a-1d2f3c4b5a60

Structured content

{
  "people": [
    {
      "employeePublicId": "5f1c2a9e-3b7d-4c21-9e4a-1d2f3c4b5a60",
      "name": "Dela Cruz, Juan",
      "employeeNumber": "EMP-001"
    }
  ]
}

employeereads only

An employee's record

One person's record: names, contact details, their current position and employment, and their salary rates where the caller may see them. Government identifiers and bank details come back only to a caller allowed to see them — do not repeat them unless asked for that field.

Someone asks: “What is Juan's position and when did he start?”

Input

{
  "employeePublicId": "5f1c2a9e-3b7d-4c21-9e4a-1d2f3c4b5a60"
}

What comes back

Dela Cruz, Juan (EMP-001)
Position: Steel Fitter · Project-based · since 2024-03-04
Contact: juan.delacruz@example.com · +63 917 000 0001

Structured content

{
  "employee": {
    "publicId": "5f1c2a9e-3b7d-4c21-9e4a-1d2f3c4b5a60",
    "name": "Dela Cruz, Juan",
    "employeeNumber": "EMP-001"
  },
  "employment": {
    "position": "Steel Fitter",
    "employmentType": "Project-based",
    "startDate": "2024-03-04"
  },
  "rates": null
}

headcountreads only

Headcount

How many employees there are, how many are currently employed, and how many are on payroll.

Takes no input.

Someone asks: “How many people do we have?”

Input

{}

What comes back

214 employee record(s): 198 currently employed, 191 on payroll.

Structured content

{
  "headcount": {
    "total": 214,
    "active": 198,
    "onPayroll": 191
  }
}

find_jobsreads only

Find projects and cost centers

Projects (read as "Customer - Project") and cost centers (by name) that hours may be charged to now. Matches the customer, the project or cost center name, or its code. Returns the ids plan_time_entries takes.

Someone asks: “Which Acme projects can I charge to?”

Input

{
  "search": "acme",
  "kind": "project"
}

What comes back

2 matches:
project · Acme Steel - Bridge retrofit (ALPHA) · id 0c9d8e7f-6a5b-4c3d-9e2f-1a0b9c8d7e6f
project · Acme Steel - Warehouse fit-out (BRAVO) · id 1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e

Structured content

{
  "jobs": [
    {
      "kind": "project",
      "publicId": "0c9d8e7f-6a5b-4c3d-9e2f-1a0b9c8d7e6f",
      "label": "Acme Steel - Bridge retrofit",
      "code": "ALPHA"
    },
    {
      "kind": "project",
      "publicId": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
      "label": "Acme Steel - Warehouse fit-out",
      "code": "BRAVO"
    }
  ]
}

customersreads only

Customers

Customers with their code, contact person and whether they are active or archived.

Someone asks: “Who are our customers?”

Input

{
  "search": "acme"
}

What comes back

1 customer:
Acme Steel Corporation (ACME) · Ana Reyes · ana@acme.test · +63 2 8555 0101 · id 2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e

Structured content

{
  "customers": [
    {
      "publicId": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
      "name": "Acme Steel Corporation",
      "code": "ACME",
      "contactName": "Ana Reyes"
    }
  ]
}

suppliersreads only

Suppliers

Suppliers with what they supply, their contact person and payment terms. The catalogue of items and prices is in the suite itself.

Someone asks: “Which suppliers do we buy steel from?”

Input

{
  "search": "steel"
}

What comes back

1 supplier:
Northgate Steel Supply (NGS) · Structural steel and fabrication · Ben Cruz · terms 30 days net · id 3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f

Structured content

{
  "suppliers": [
    {
      "publicId": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
      "name": "Northgate Steel Supply",
      "code": "NGS",
      "description": "Structural steel and fabrication"
    }
  ]
}