> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# CentralReach API

> Create, update and deactivate employee accounts in your clients' CentralReach practices, set their labels and custom fields, and assign tasks; schedules, files, patient records, billing and payroll when you turn them on

The common use is staff onboarding and offboarding at an ABA practice: after the agent creates the new hire's Microsoft 365 account, it creates their CentralReach employee account; when someone leaves, it deactivates them with a termination date.

<Info>
  Automatically enabled when you configure CentralReach permissions in your agent workflow. CentralReach is connected per client, so the agent calls the CentralReach organization of the ticket's company.
</Info>

## What it does

* Find an employee by name, email or the id from the practice's HR or payroll system
* Create an employee, update their record, and deactivate them with a termination date
* Convert a generic contact to an employee
* Read and set an employee's claim settings and identifiers, such as an NPI number
* Read and set a contact's labels and custom field values
* Read, create and assign tasks, one at a time or for many employees at once
* Read a provider's or client's appointments, cancel an appointment, and set employee and client availability
* Read, create, label and delete files on a contact's record
* Read and update client (patient) records and payors, and read their authorizations
* Read billing entries, balances and payments, record or void a payment, and read service codes
* Read payroll settings, an employee's pay settings and timesheets

Neo replaces the value of the social security number field (`ssn`) in every CentralReach answer, so the agent never reads a stored SSN, and it refuses a request that sets that field: a person enters an SSN in CentralReach. Neo also refuses an employee or client update that does not say whether the person stays active, because CentralReach deactivates a contact when it does not recognize that value.

## How the agent handles a new hire

The agent reads the ticket for the new hire's name, work email, date of birth, hire date and the id the practice's HR or payroll system gives them. It looks the person up first, then creates the employee with the employee contact form your instructions name. When the ticket is missing a value CentralReach requires, the agent asks for it. It then adds the labels and custom field values your instructions give for the role.

## Writes that always ask a technician

Three writes wait for a technician's approval under every access profile, Full Automation included, whatever the group's own approval setting:

* Recording a payment against a billing entry
* Voiding a payment
* Deleting a file

A payment moves the practice's money, and a deleted file can be a patient's medical record, so no setting lets an agent make these on its own.

## Permission groups

| Group | Access levels | Covers |
| - | - | - |
| Employees | Disabled, Read Only, Read / Write | Staff records: create, update, deactivate, convert to employee; addresses, claim settings, appointment types |
| Contact Labels & Custom Fields | Disabled, Read Only, Read / Write | Contact labels and custom fields of any contact, employee or client |
| Tasks | Disabled, Read Only, Read / Write | Tasks, task templates and task labels |
| Schedules & Availability | Disabled, Read Only, Read / Write | Appointments by provider or client, cancelling one, unconverted services, employee and client availability |
| Files | Disabled, Read Only, Read / Write | A contact's files and file labels; deleting a file always asks a technician |
| Clients (Patients) | Disabled, Read Only, Read / Write | Client records, addresses, payors, accepted insurances, authorizations |
| Billing & Payments | Disabled, Read Only, Read / Write | Billing entries and balances, payments, billing labels, service codes; recording or voiding a payment always asks a technician |
| Payroll | Disabled, Read Only | Payroll settings, an employee's pay settings, timesheets |

## Access profiles

| Profile | What runs on its own | What asks a technician |
| - | - | - |
| **Read Only** | Reads of employees | No write is allowed |
| **Helpdesk** | Reads of employees | Creating, changing or deactivating an employee |
| **IT Admin** | Every read and write in Employees | Nothing |
| **Full Automation** | Every other supported call, in every group | Recording or voiding a payment, and deleting a file |

Read Only, Helpdesk and IT Admin turn on Employees alone. Every other group can reach patient health information or staff pay: labels, custom fields and tasks take any contact, a client's included. Turn a group on by hand for an agent that needs it, such as Contact Labels & Custom Fields for an onboarding agent that sets a new hire's labels.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.