Simpro

scheduled_work schedule

What is booked in the diary between two days: one row per job or quote with its name, customer, site, stage and status, the days it is booked, who is booked and the scheduled hours, then the activities (leave, training, meetings) booked beside it. Days are as Simpro wrote them.

from*

string. First day, e.g. 2026-09-28. For this week pass Monday's date.

to

string. Last day, inclusive. Default six days after from.

staff

string. Only bookings for staff whose name contains this.

job_overview jobs

Everything about one job: stage, status, customer, site, manager, dates, totals and profit as Simpro named them; its cost centres with their value and percent complete; the invoices that bill it and whether they are paid; and its diary: visits, hours, who is booked and the next bookings.

job*

string. A Simpro job number such as 2111, or part of the job's name.

customer_overview customers

Everything about one customer: phone, email, address, sites and contacts; jobs counted and totalled by stage, with the open ones listed; open quotes; and what has been invoiced, first and last.

customer*

string. A Simpro customer ID such as 301 (the Customer ID a job or invoice names), or part of the name.

receivables money

What customers owe: every invoice Simpro does not mark paid with a balance left, totalled and aged into buckets overall and per customer, largest debtor first. Owing is Simpro's own BalanceDue. age_by due counts days overdue from the due date, so not_due is its own bucket; issued counts days since the invoice was issued.

age_by

string. Default due.

customer

string. Only customers whose name contains this.

quote_conversion sales

Quotes won against lost, by count and by value ex tax, per month issued or per salesperson. Won is a quote a job was converted from (the job's ConvertedFromQuote), whatever the quote's status says; lost is closed and never converted; the rest are open. The win rates count won and lost quotes only.

by

string. Default month.

from

string. First issue date, e.g. 2026-01-01.

to

string. Last issue date, inclusive.

labour staff

Hours worked (timesheets) against hours booked (the diary) per staff member per week, a week named by its Monday. Days are as Simpro wrote them; no rate or cost is read.

from*

string. First day, e.g. 2026-09-21. For last week pass that Monday.

to

string. Last day, inclusive. Default six days after from; at most 92 days.

staff

string. Only staff whose name contains this.

job_profitability money

Estimate against actual per job, or summed per manager or job type: revenue ex tax, invoiced (Simpro's InvoicedValue, which includes tax), materials and resources cost, labour hours and gross profit, as Simpro states them on the job. An actual gross profit on a job with little cost landed reads high; read it beside the actual costs.

group_by

string. Omit for one row per job.

stage

any. Only jobs at this stage or stages: Pending, Progress, Complete, Invoiced, Archived.

from

string. First issue date, e.g. 2026-01-01.

to

string. Last issue date, inclusive.

order

string. Jobs only. Default largest.

limit

integer. Rows to answer. Default 20, at most 50.

activities Activities

Non-billable activity types staff book time to (leave, training, meetings).

Keyed by simpro_id

activity_schedules Activity schedules

Each time an activity was booked into the diary, with the staff member and times.

Keyed by simpro_id

archived_catalogs Archived catalogs

Catalogue items that were archived; same shape as catalogs.

Keyed by simpro_id

asset_types Asset types

Kinds of customer asset serviced (fire extinguisher, RCD, and so on) and their test fields.

Keyed by simpro_id

attachments Attachments

Files on a job or quote: name, folder and size. Metadata only.

Keyed by id · hangs off jobs or quotes by parent_type (job|quote) and parent_id

catalog_groups Catalog groups

The folders catalogue items are grouped into.

Keyed by simpro_id

catalog_inventories Catalog inventories

Stocking rules per part per storage device: bin, minimum and restock level.

Keyed by id · hangs off storage_devices by parent_id

catalog_vendors Catalog vendors

Which vendors a catalogue item is bought from, with their part numbers and prices.

Keyed by id · hangs off catalogs or archived_catalogs by catalog_id

catalogs Catalogs

The parts and materials catalogue: part number, name, cost and sell prices.

Keyed by simpro_id

contacts Contacts

People at customer companies and vendors, as separate contact records.

Keyed by simpro_id

contractor_invoices Contractor invoices

Invoices contractors sent for work on jobs.

Keyed by simpro_id

contractor_jobs Contractor jobs

Work handed to a subcontractor on a job's cost centre, with the agreed amount.

Keyed by simpro_id

contractor_variances Contractor variances

Variances raised against contractor jobs.

Keyed by simpro_id

contractors Contractors

Subcontractors the business uses: name, trade details, banking and personal fields.

Keyed by simpro_id

cost_centers Cost centers

The business's cost centre setup (the categories jobs are costed under), not a job's own.

Keyed by simpro_id

credit_notes Credit notes

Credit notes issued to customers, with the customer, date issued and totals.

Keyed by simpro_id

customer_assets Customer assets

Assets at customer sites that the business services and tests.

Keyed by simpro_id

customer_companies Customer companies

Customers that are companies.

Keyed by simpro_id

customer_contracts Customer contracts

Service contracts with customers: dates, value and terms.

Keyed by simpro_id

customer_individuals Customer individuals

Customers that are people rather than companies.

Keyed by simpro_id

customer_labor_rates Customer labor rates

Which labour rate each customer is charged at.

Keyed by id · hangs off customers by parent_id

customer_memberships Customer memberships

Membership plans a customer holds.

Keyed by id · hangs off customer_companies or customer_individuals by parent_type (customer_company|customer_individual) and parent_id

customer_notes Customer notes

Notes written against customers.

Keyed by simpro_id

customer_payments Customer payments

Payments received from customers. amount is what the payment paid across its invoices (Invoices).

Keyed by simpro_id

customer_reminders Customer reminders

Reminders set against customers.

Keyed by id · hangs off customer_companies or customer_individuals by parent_type (customer_company|customer_individual) and parent_id

device_stocks Device stock

What each storage device holds now: quantity per catalogue item.

Keyed by id · hangs off storage_devices by device_id

employees Employees

Staff as the scheduling and job side sees them, whole: contact, personal, banking and pay fields.

Keyed by simpro_id

form_templates Form templates

Forms attached to a job.

Keyed by id · hangs off jobs by parent_type (job) and parent_id

invoice_notes Invoice notes

Notes written against invoices.

Keyed by id · hangs off invoices by parent_type (invoice) and parent_id

invoice_retainages Invoice retainages

Retention held back on invoices and when it releases.

Keyed by simpro_id

invoices Invoices

Invoices issued to customers: the customer, date issued, totals and the jobs they bill (Jobs).

Keyed by simpro_id

job_cost_centers Job cost centers

A job's cost centres: the sections a job is priced and costed in. Hang off a job.

Keyed by simpro_id · hangs off jobs by parent_id

job_estimates Job estimates

The priced lines on a job cost centre (prebuilds, catalogue items, one-offs), keyed by the cost centre's Simpro ID. The centre's estimate, revised and actual totals are on job_cost_centers.

Keyed by simpro_id · hangs off job_cost_centers by simpro_id

job_labours Job labour

The labour quoted on a job cost centre: each line's labour type and hours (Total.Qty), keyed by the cost centre's Simpro ID.

Keyed by simpro_id · hangs off job_cost_centers by simpro_id

job_notes Job notes

Notes written against jobs.

Keyed by simpro_id

jobs Jobs

Jobs: customer, site, stage, status, manager, totals and dates. The centre of most questions.

Keyed by simpro_id

journals Journals

Accounting journal entries behind stock and money movements. IDs are strings such as IJ0004679.

Keyed by simpro_id

leads Leads

Sales leads before they become quotes.

Keyed by simpro_id

licences Licences

Staff licences and certifications with expiry dates.

Keyed by simpro_id

payable_contacts Payable contacts

Suppliers as the accounts payable side sees them. Banking is held.

Keyed by simpro_id

payable_invoices Payable invoices

Supplier invoices the business has to pay (accounts payable).

Keyed by simpro_id

plant_type_custom_fields Plant type custom fields

Custom fields defined on plant and equipment types.

Keyed by simpro_id

plant_types Plant types

Kinds of plant and equipment the business owns.

Keyed by simpro_id

plants Plants

Plant and equipment items the business owns.

Keyed by simpro_id

prebuild_groups Prebuild groups

The folders prebuilds are grouped into.

Keyed by simpro_id

prebuilds Prebuilds

Prebuilt kits of catalogue items and labour sold as one line.

Keyed by simpro_id

quote_cost_centers Quote cost centers

A quote's cost centres: the sections a quote is priced in. Hang off a quote.

Keyed by simpro_id · hangs off quotes by parent_id

quote_estimates Quote estimates

The priced lines on a quote cost centre, keyed by the cost centre's Simpro ID.

Keyed by simpro_id · hangs off quote_cost_centers by simpro_id

quote_notes Quote notes

Notes written against quotes.

Keyed by id · hangs off quotes by parent_type (quote) and parent_id

quotes Quotes

Quotes: customer, site, status, totals and whether closed. A won quote converts to a job.

Keyed by simpro_id

receivable_contacts Receivable contacts

Customers as the accounts receivable side sees them. Banking is held.

Keyed by simpro_id

receivable_invoices Receivable invoices

Customer invoices as the accounts receivable side sees them, with payment state.

Keyed by simpro_id

receivable_payments Receivable payments

Customer payments as the accounts receivable side sees them, with method and reference. amount is what the payment paid across its invoices (Invoices).

Keyed by simpro_id

recurring_invoice_cost_centers Recurring invoice cost centers

Cost centres on recurring invoices.

Keyed by simpro_id

recurring_invoice_sections Recurring invoice sections

Sections on recurring invoices.

Keyed by simpro_id

recurring_invoices Recurring invoices

Invoices raised on a repeating schedule.

Keyed by simpro_id

recurring_job_cost_centers Recurring job cost centers

Cost centres on recurring jobs.

Keyed by simpro_id

recurring_job_notes Recurring job notes

Notes written against recurring jobs.

Keyed by simpro_id

recurring_job_sections Recurring job sections

Sections on recurring jobs.

Keyed by simpro_id

recurring_jobs Recurring jobs

Jobs that repeat on a schedule (maintenance, servicing).

Keyed by simpro_id

schedules Schedules

The diary: who was booked to be on which job or quote, and when. The plan, not time worked. job_id and quote_id name what it books; scheduled_work reads a date range in one call.

Keyed by simpro_id

setup_rows Setup lists

Simpro's setup lookup lists in one table, told apart by list (teams, zones, payment terms and more).

Keyed by id

site_preferred_technicians Site preferred technicians

Technicians a site prefers, ranked (Preference). simpro_id is the staff member's Simpro ID (Staff).

Keyed by id · hangs off sites by parent_type (site) and parent_id

sites Sites

Sites (addresses) where work is done.

Keyed by simpro_id

staff_members Staff

Every staff record, employees and contractors alike, whole.

Keyed by simpro_id

stock_allocations Stock allocations

Stock committed to a job but not yet issued.

Keyed by simpro_id

stock_items Stock items

Stock on hand per catalogue item.

Keyed by simpro_id

stock_takes Stock takes

Stock takes and their counts.

Keyed by simpro_id

stock_transfers Stock transfers

Stock moved between storage devices.

Keyed by simpro_id

storage_devices Storage devices

Places stock is kept: warehouses, vans, shelves.

Keyed by simpro_id

take_off_template_groups Take off template groups

The folders take-off templates are grouped into.

Keyed by simpro_id

take_off_templates Take off templates

Take-off templates used to build quotes quickly.

Keyed by simpro_id

tasks Tasks

Tasks, wherever they hang: on jobs, quotes, customers or on their own.

Keyed by simpro_id

tax_codes Tax codes

The tax codes and rates set up in Simpro.

Keyed by simpro_id

test_histories Test histories

Results of tests on customer assets.

Keyed by simpro_id

timelines Timelines

The activity history of a job or quote: what happened, when, by whom.

Keyed by id · hangs off jobs or quotes by parent_type (job|quote) and parent_id

timesheet_weeks Timesheet weeks

Every timesheet block of one payroll week, Monday to Sunday, exactly as Simpro answered it.

Keyed by starts_on

timesheet_blocks Timesheets

Time staff booked, one row per block: date, hours, rate and what it was booked to, and its cost.

Keyed by id

vendor_branches Vendor branches

Branches of vendors.

Keyed by simpro_id

vendor_credit_catalogs Vendor credit catalogs

The lines on a vendor credit.

Keyed by id · hangs off vendor_credits by parent_id

vendor_credits Vendor credits

Credits received from vendors.

Keyed by simpro_id

vendor_order_catalogs Vendor order catalogs

The lines on a purchase order.

Keyed by id · hangs off vendor_orders by parent_id

vendor_orders Vendor orders

Purchase orders sent to vendors.

Keyed by simpro_id

vendor_quotes Vendor quotes

Quotes received from vendors.

Keyed by simpro_id

vendor_receipt_catalogs Vendor receipt catalogs

The lines on a vendor receipt.

Keyed by id · hangs off vendor_receipts by parent_id

vendor_receipts Vendor receipts

Goods received from vendors against purchase orders.

Keyed by simpro_id

vendors Vendors

Suppliers, with their banking.

Keyed by simpro_id

work_orders Work orders

Work orders: the instruction to staff to do work on a job or quote.

Keyed by simpro_id