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

# Choose your reporting data

> Map business questions to resources, summaries, and the right row grain.

Use detailed resources to build your own reporting store and summaries for the API’s supported financial groupings. The same records can answer different questions depending on the date and amount basis you choose.

| Business question                               | Start with                                       | Read next                                            |
| ----------------------------------------------- | ------------------------------------------------ | ---------------------------------------------------- |
| How much work did we complete?                  | Jobs, appointments, assignments                  | [Work and customers](/work-and-customers)            |
| What did we bill, collect, or remain owed?      | Invoice activity, collections, receivables aging | [Revenue, collections, and AR](/financial-reporting) |
| Which members participated in profitable work?  | Technician participation profitability           | [Technician performance](/technician-performance)    |
| Who has recorded sold or earned credit?         | Revenue attributions                             | [Technician performance](/technician-performance)    |
| What is our current lead and proposal pipeline? | Job leads and estimates                          | [Leads and estimates](/leads-and-estimates)          |
| What time was recorded and payable?             | Time entries and timesheets                      | [Time reporting](/time-reporting)                    |
| What equipment and captured forms do we have?   | Equipment and form responses                     | [Equipment and forms](/equipment-and-forms)          |

## Available reads

Available reads cover company context, operational records and reference catalogs, installed equipment, captured form responses, job leads, complete estimates, time entries, configured-period timesheets, invoice/payment/refund details, recorded job financials, saved revenue attribution, and six financial summaries.

| Read                                                                                 | Use                                                                                                                   |
| ------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- |
| `GET /company`                                                                       | Identify the company and reporting timezone.                                                                          |
| `GET /job-leads` and `/job-leads/{id}`                                               | Read submitted requests, captured contact/address values, intake source text, and recorded conversion links.          |
| `GET /estimates` and `/estimates/{id}`                                               | Read proposals with complete options, lines, discounts, recorded totals, acceptance state, and resulting invoice IDs. |
| `GET /equipment` and `/equipment/{id}`                                               | Read installed items, recorded condition/lifecycle/warranty information, and location/HVAC-system grouping.           |
| `GET /form-responses` and `/form-responses/{id}`                                     | Read captured visit questions and answers, including incomplete forms, with original job/appointment relationships.   |
| `GET /time-entries` and `/time-entries/{id}`                                         | Read effective corrected work intervals, activity/payable state, elapsed minutes, and work/member links.              |
| `GET /timesheets?period_date=...` and `/timesheets/{team_member_id}?period_date=...` | Read current configured-period payable totals and complete daily values for every company member.                     |
| `GET /invoices` and `/invoices/{invoice_id}`                                         | Read invoices with complete lines, discounts, tax, amounts, and payment applications.                                 |
| `GET /payments` and `/payments/{payment_id}`                                         | Read each payment once with all amounts allocated to invoices.                                                        |
| `GET /refunds` and `/refunds/{refund_id}`                                            | Read refunds independently using their own dates.                                                                     |
| `GET /reports/invoice-activity`                                                      | Sum issued invoice activity by period and an optional business dimension.                                             |
| `GET /reports/collections`                                                           | Sum received payments and successful refunds by their occurrence dates.                                               |
| `GET /reports/receivables-aging`                                                     | Read current signed account balances and aging buckets.                                                               |
| `GET /revenue-attributions` and `/revenue-attributions/{id}`                         | Read each job’s complete saved sold and earned credits, including empty arrays.                                       |
| `GET /reports/revenue-attribution`                                                   | Read separate saved sold/earned amounts and counts by credited member and work-completion date.                       |
| `GET /job-financials` and `/job-financials/{id}`                                     | Read complete saved costs, costing revenue, current costing state and participants using the job ID.                  |
| `GET /reports/job-profitability`                                                     | Sum recorded job revenue, costs and gross profit by the costing report date and optional business dimension.          |
| `GET /reports/technician-participation-profitability`                                | Read each assigned member's full-job participation totals; member rows overlap.                                       |

Operational collections also have a detail read at the collection path followed by `/{id}`.

| Operational collection | Business meaning and additional filters                                                                                                                                                                                                                                                     |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `/team-members`        | Current company membership, identity, business roles, active state, and dated business-unit assignments. Filter `role` and `active`.                                                                                                                                                        |
| `/accounts`            | Customers, recorded `customer_since`, mailing address, manager, service restriction, complete contact/location associations, tags, and acquisition sources. Filter `type`, `archived`, `contact_id`, and `location_id`.                                                                     |
| `/contacts`            | People with recorded email/phone channels and complete account associations. Filter `account_id`.                                                                                                                                                                                           |
| `/locations`           | Service places, address and property data, and complete account associations. Filter `account_id` and exact `property_type`.                                                                                                                                                                |
| `/jobs`                | Work and opportunities with dimensions, current lifecycle/status, outcomes, creator, tags, sources, and separate completion/closure times. Filter `account_id`, `location_id`, `business_unit_id`, `job_type_id`, `job_class`, `status_id`, `stage`, `created_by_id`, and `team_member_id`. |
| `/job-appointments`    | Visit windows, recorded creator, confirmation, and cancellation. Filter `job_id`, `created_by_id`, `confirmed`, and `canceled`.                                                                                                                                                             |
| `/job-assignments`     | A member assigned to a visit, scheduled span, and execution status. Filter `job_id`, `appointment_id`, `team_member_id`, and repeated `status`.                                                                                                                                             |
| `/business-units`      | Company units for segmentation.                                                                                                                                                                                                                                                             |
| `/job-types`           | Configured job types, class, lifecycle, default business unit, duration, and opportunity flag. Filter `archived`, `job_class`, and `lifecycle_id`.                                                                                                                                          |
| `/job-classes`         | Existing class codes and display names. Only `ids`, `limit`, and `cursor` filters.                                                                                                                                                                                                          |
| `/job-lifecycles`      | Configured workflows and their complete ordered statuses. Filter `archived`.                                                                                                                                                                                                                |
| `/lead-sources`        | Configured company source names and their canonical source identity. Filter `archived`.                                                                                                                                                                                                     |
| `/tags`                | Company labels used on accounts and jobs.                                                                                                                                                                                                                                                   |
