simPRO connector

Your Silux Chat bot verifies customers against simPRO, then answers questions about their account balance, invoices and support tickets and cases from your live data.

API token Documented-API tested 4 capabilities Read-only

Good to know: Business customers live under /customers/companies/; this looks up individuals.

What your bot can do with simPRO

Account balance

Reads the balance simPRO holds for the verified customer and adds it to their account summary.

Customers ask: “How much do I owe?” · “Is my account up to date?”

Balance

Recognise and verify customers

Finds the customer in simPRO by the email address or mobile number they give, checks their name and one more detail, then sends a one-time code to the contact details simPRO holds. Nothing personal is shared until the code is entered.

Customers ask: “I want to check my account — it’s Jane Smith, jane@example.com”

Record IDNameEmail addressPhone / mobilePostcode

Invoices

Reads a verified customer’s invoices from simPRO — number, date, amount and whether it is paid.

Customers ask: “Is my latest invoice paid?” · “How much was my last bill?”

Invoice numberDateAmountStatusPaid

Support tickets and cases

Reads the verified customer’s tickets, cases or tasks in simPRO — subject, status and when each was last updated.

Customers ask: “Is there any update on my case?” · “Has my request been closed?”

Record IDSubjectStatusLast updated

Set it up

Most businesses finish in under ten minutes. You need to be able to sign in to simPRO as an administrator to create the key.

Step 1 — in simPRO

  1. 1simPRO
  2. 2System
  3. 3Setup
  4. 4API
  5. 5Applications
  6. 6create an API key application (read-only)
  7. 7copy the access token.

Least access: grant only the read permissions named above (customers, orders, invoices, bookings or tickets — whichever this connector uses). Never use an owner or full-admin key where simPRO lets you create a restricted one.

Step 2 — in Silux Chat

  1. 1Open Dashboard → Integrations → Connectors and search for “simPRO”.
  2. 2
    Fill in:
    FieldExampleStored
    simPRO addressyourcompany.simprosuite.comSetting
    Company ID (0 on single-company builds)0Setting
    API key access token (from the key file)••••••••Encrypted
  3. 3Press Connect & test. The platform makes a real, read-only call to simPRO with a made-up customer and shows a tick or a cross for each capability, with simPRO’s exact error if something is refused.
  4. 4If this is your first way of verifying customers it is switched on automatically; otherwise press Use to verify customers. The platform then runs its chained test (verify → code → account → orders → invoices) with the built-in test customer — no real person is contacted.

You create an API or access token in simPRO and paste it into your dashboard. It is sent as a Bearer token on every call, over HTTPS only.

How customer verification works

  1. STEP 1

    Customer asks

    They ask about their own account. The bot asks for their full name and their email or mobile, plus one more detail such as their postcode.

  2. STEP 2

    Found in simPRO

    The customer is looked up in simPRO by email, then mobile. The surname must match exactly and the first name must match or start with the same letter, plus one more detail.

  3. STEP 3

    Code sent

    A 6-digit code goes to the mobile simPRO holds (by text, when your plan has SMS) or otherwise to the email it holds. The chat never chooses where it goes.

  4. STEP 4

    Verified

    The customer types the code. It is valid for 10 minutes and five wrong attempts cancel it. The verified session lasts 30 minutes.

If the details don’t match, the customer is told only that they couldn’t be matched — never which detail was wrong. If simPRO can’t be reached, the bot says it can’t check accounts right now rather than “no account found”. The bot is blocked in code from reading orders, invoices or bookings until verification succeeds. Full details: Customer identity verification & OTP.

What the bot can and cannot see

Can see (after verification)

  • Record ID
  • Name
  • Email address
  • Phone / mobile
  • Postcode
  • Balance
  • Invoice number
  • Date
  • Amount
  • Status
  • Paid
  • Subject
  • Last updated

Only these standard fields are mapped from simPRO’s responses. Everything else in the response is discarded before the bot sees it.

Never sees

  • passwords, security answers or login details
  • records belonging to anyone other than the verified customer
  • anything outside the fields listed alongside

Security

  • Keys encrypted at rest

    Credentials are stored encrypted, shown only masked after saving, and destroyed — not just hidden — when you disconnect.

  • Read-only look-ups

    Every capability is a look-up. The connector cannot create, change or delete anything in simPRO.

  • HTTPS only

    Calls go to the vendor’s HTTPS address, redirects are not followed, and private network addresses are refused.

  • Injection-safe

    Values a customer types are cleaned before they are placed in simPRO’s search, and URL-encoded in addresses.

  • Other customers filtered out

    A row that names a different customer’s email is dropped, whatever the vendor’s search returned.

  • Checked daily

    Connections are re-tested every day, and the owner is emailed if a working connection starts failing.

More: Security & data protection.

Technical details

For developers and IT teams: the simPRO endpoints this connector reads, relative to https://{build}/api/v1.0/companies/{company_id}. Values in braces come from the settings you enter.

CapabilityRequestStandard fields returned
Recognise and verify customersGET/customers/individuals/id, name, email, phone, postcode
Account balanceGET/customers/individuals/{customer_id}balance
InvoicesGET/invoices/invoice, date, amount, status, paid
Support tickets and casesGET/jobs/id, subject, status, updated

Test level: Documented-API tested. Each capability is run automatically against simPRO’s documented example responses and must produce the standard fields; your own connection is then tested with a real call when you connect. The bot receives these through the standard Account Connect endpoints, exactly as if you had built them yourself.

Troubleshooting

What you seeLikely cause and fix
“the vendor refused the credentials (401)” or (403)The key was revoked, has expired or was copied incompletely, or it lacks a read permission this connector needs. Create a fresh read-only key in simPRO and reconnect.
“That simPRO address doesn’t look right”Enter it in the form shown, e.g. yourcompany.simprosuite.com — without https:// or a trailing slash.
Customers are “not matched” although they existCustomers are looked up by email or mobile, not postcode. Check the customer’s email or mobile is saved on their simPRO record, and that the surname matches.
A capability shows a cross but others workThat permission wasn’t granted in simPRO, or your simPRO plan doesn’t include that part of the API. Grant it and press Test.
“the vendor kept rate-limiting the request”simPRO returned “too many requests” three times in a row. The platform already waits and retries automatically (up to 10 seconds, as simPRO asks); if it persists, ask simPRO about your API quota.
Results are empty for a verified customerThe records exist under a different email or customer record in simPRO, or none are recent. Check the customer’s record in simPRO directly.

Full error reference: Troubleshooting & error reference.

Frequently asked questions

Is the simPRO connection read-only?

Yes. Every request Silux Chat makes to simPRO is a look-up; none creates, changes or deletes anything in simPRO. Give the key or sign-in read-only permissions wherever simPRO offers them.

Do I need a developer to connect simPRO?

No. You paste the details listed in the set-up steps in Dashboard → Integrations → Connectors and press “Connect & test”. The platform makes a real call to simPRO straight away and shows exactly which features work.

How does the bot know it is really my customer?

It finds the customer in simPRO by the email or mobile they give, checks their name and one more detail, then sends a one-time code to the mobile or email held in simPRO — never to one typed in the chat. The code lasts 10 minutes, five wrong attempts cancel it, and a verified session lasts 30 minutes.

What happens if my simPRO key is revoked or expires?

The bot tells customers it can’t check their account right now — it never pretends there are “no orders”. Connections are re-tested daily and the account owner is emailed when a working connection starts failing. Reconnect it in Dashboard → Integrations → Connectors.

How has the simPRO connector been tested?

It is Documented-API tested: every capability is run automatically against simPRO’s documented example responses and must produce the standard fields. When you connect, it is tested again with a real call to your own simPRO account before your bot uses it.

Other field service connectors

Need help with your integration?

Our integration team can review your endpoints, help you choose the right connector and check a test run with you. Tell us which system you use and what you would like the bot to answer.

support@siluxcall.co.uk