ZOEY API

The common use is a support ticket or chat from one of your customers: the agent finds the customer’s ZOEY account, reads its services with the network and supplier behind each line, its invoices, charges and outstanding balance, and answers the question or routes the fault. When the customer confirms a change, such as a bolt-on, a cease or a contact update, the agent makes it in ZOEY and notes what ZOEY now shows.

Automatically enabled when you configure ZOEY permissions in your agent workflow.

What It Does

Find an account by company name, billing email, a contact’s email or phone, or a line’s number
Read accounts with their billing contact, status, credit terms and outstanding balance, their cost centres (sites) and contacts
Read each service’s number, SIM, product type, network, supplier, tariff, bolt-ons, bars and contract dates
Read invoices with their lines, draft invoices, manual invoices, credit notes, and the charges on each service
Connect a service, change its tariff, number, bolt-ons or bars, estimate the early termination charge and cease it
Add and change service charges, contacts, cost centres and accounts
Read and change the product catalogue (tariffs, bolt-ons, bundles, fixed charges, rate cards, rates, extra fields), create customer portal logins, and read and change commissions

Permission Groups

Group	Covers
Accounts, Cost Centres and Contacts	Accounts, their sites and contacts; adding and changing them, closing and reopening an account
Services	Services with their network, supplier, tariff, bolt-ons, bars and contract; connecting, changing and disconnecting them
Invoices, Charges and Billing Terms	Invoices and their lines, manual invoices, credit notes and service charges; adding and changing charges. Read / Write also lets other writes set a price override, a disconnection or early termination charge, a balance or payment terms
Product Catalogue	Tariffs, bolt-ons, bundles, fixed charges, rate cards, rates, networks, product types, extra fields and dealers; changing them
Customer Portal Logins	Creating a customer portal login (write only)
Commissions	Commission agents and rules

Access Profiles

Profile	What runs on its own	What asks a technician
Read Only	Every read	No write is allowed; portal logins stay off
Helpdesk	Reads	Every change to accounts, contacts and services. Charges and the catalogue stay read only; portal logins and commissions stay off
IT Admin	Every read, and changes to accounts, contacts and services	Charges and prices, catalogue changes and portal logins. Commissions stay read only
Full Automation	Every read and write	Only the writes that always ask (below)

Safety Controls

Control	Behavior
Always ask	Closing an account and porting a number out to another network always need a technician’s approval, whatever the profile
Prices need billing access	A write that sets a price override, a disconnection or early termination charge, a balance or payment terms needs Read / Write on Invoices, Charges and Billing Terms as well as its own group, and asks a technician when either group does
Ticket scope	On a ticket, the agent reaches only the ZOEY account mapped to the ticket’s company, by a name match or one you confirmed. A call goes out only after ZOEY’s own records show that every cost centre, contact, service, charge or invoice it names belongs to that account, and lists keep only that account’s rows. Lists of every account, new accounts, the commission rules and catalogue changes are for runs with no ticket company, such as a chat or a scheduled check. The product catalogue is readable on any run
Files	Neo does not download invoice, manual invoice or credit note PDFs; the JSON records and the invoice’s lines carry the same amounts
Roaming notifications	Neo does not send roaming notifications, the feed a mobile network sends when a SIM roams, because ZOEY texts and emails the customer for each one

Getting started

Core

Triggered & Scheduled Agents

Chat Agents

Integrations

Product

Workflows

Customizing Neo

What It Does

Permission Groups

Access Profiles

Safety Controls

​What It Does

​Permission Groups

​Access Profiles

​Safety Controls

What It Does

Permission Groups

Access Profiles

Safety Controls