# Nectar Knowledge Base

- [Nectar](https://nectarclimate.com/docs/index.md): The complete guide to Nectar's utility data automation platform and API.
- [Getting started](https://nectarclimate.com/docs/platform/getting-started.md): Learn what Nectar does, how it organizes your utility data, and how to find your way around the platform.
- [Agent](https://nectarclimate.com/docs/platform/agent.md): Ask questions, investigate your data, and approve Agent actions.
- [For developers](https://nectarclimate.com/docs/platform/for-developers.md): Start here if you are integrating Nectar into your product or data platform.
- [Get Started FAQ](https://nectarclimate.com/docs/platform/getting-started-faq.md): Troubleshooting and FAQs for onboarding, access, and first-time setup.
- [Dashboard](https://nectarclimate.com/docs/platform/dashboard.md): Your home screen showing key numbers, favorites, quick links, and recent bills.
- [Support tickets](https://nectarclimate.com/docs/platform/support.md): View and reply to your support tickets without leaving Nectar.
- [Glossary](https://nectarclimate.com/docs/platform/glossary.md): In-depth definitions for every term, field, and concept in the Nectar platform — organized by domain and searchable.
- [Methodology overview](https://nectarclimate.com/docs/platform/methodology/overview.md): Learn how Nectar transforms your utility bills into clear, actionable insights.
- [Key concepts](https://nectarclimate.com/docs/platform/methodology/key-concepts.md): Understand the building blocks of your utility data: sites, meters, accounts, and bills.
- [Monthly data calculation](https://nectarclimate.com/docs/platform/methodology/calendarization.md): How Nectar converts your billing period data into clean calendar month data for reporting.
- [Cost allocation](https://nectarclimate.com/docs/platform/methodology/cost-attribution.md): How Nectar distributes charges across meters and sites when a bill covers multiple services.
- [Units and conversions](https://nectarclimate.com/docs/platform/methodology/units.md): How Nectar normalizes usage units across your portfolio for consistent reporting.
- [Occupancy adjustment](https://nectarclimate.com/docs/platform/methodology/occupancy.md): Adjust usage data for shared buildings by applying an occupancy percentage to your sites.
- [Waste tracking](https://nectarclimate.com/docs/platform/methodology/waste-tracking.md): Set up, monitor, and analyze waste data — from hauler invoices to waste stream analytics.
- [Special situations](https://nectarclimate.com/docs/platform/methodology/edge-cases.md): How Nectar handles revised bills, solar credits, sewer estimates, and other common complexities.
- [Methodology FAQ](https://nectarclimate.com/docs/platform/methodology/faq.md): Common questions about calendarization, cost attribution, and complex billing scenarios.
- [Data Input](https://nectarclimate.com/docs/platform/data-input/overview.md): Three ways to bring utility data into Nectar: connections, uploads, and manual entry.
- [Connections](https://nectarclimate.com/docs/platform/data-input/connections.md): Connect utility accounts to automatically collect bills and usage data on an ongoing basis.
- [Connect a utility account](https://nectarclimate.com/docs/platform/data-input/connection-wizard.md): Step-by-step guide to connecting an online utility portal to Nectar.
- [Email connections](https://nectarclimate.com/docs/platform/data-input/email-connections.md): Set up email-based bill collection to automatically process forwarded utility bills.
- [Switching between email and online connections](https://nectarclimate.com/docs/platform/data-input/consolidating-connections.md): Consolidate bills and history when the same utility account moves from emailed forwarding to an online portal connection, or back.
- [Reconnecting a connection](https://nectarclimate.com/docs/platform/data-input/reconnecting.md): How to update credentials or reconnect a failed utility connection.
- [Multi-factor authentication (MFA)](https://nectarclimate.com/docs/platform/data-input/mfa.md): How Nectar handles utility portals that require multi-factor authentication — options, triage flow, and utility-specific guides.
- [Uploading documents](https://nectarclimate.com/docs/platform/data-input/uploads.md): Upload PDF or image utility bills for AI-powered processing, preview originals, and reprocess documents with feedback.
- [Upload job details](https://nectarclimate.com/docs/platform/data-input/upload-detail.md): Review documents in an upload job, preview originals, and reprocess with feedback.
- [Manual bill entry](https://nectarclimate.com/docs/platform/data-input/manual-entry.md): Manually enter utility bill data when you don't have a PDF or connection.
- [Invitations](https://nectarclimate.com/docs/platform/data-input/invitations.md): Send a secure link so the account owner can create a new connection — or reconnect an existing one — without needing a Nectar login.
- [Magic links (deprecated)](https://nectarclimate.com/docs/platform/data-input/magic-links.md): Magic links have been replaced by Invitations. Existing links continue to work, but all new sharing should use Invitations.
- [Troubleshooting data input](https://nectarclimate.com/docs/platform/data-input/troubleshooting.md): Common issues with connections and uploads, and how to resolve them quickly.
- [Data Input FAQ](https://nectarclimate.com/docs/platform/data-input/faq.md): Troubleshooting connections, uploads, reprocessing, manual entry, and invitations.
- [PG&E (Pacific Gas and Electric)](https://nectarclimate.com/docs/platform/data-input/utilities/pge.md): How to connect PG&E accounts to Nectar. Email forwarding is not supported — add Nectar as an authorized user instead.
- [Con Edison](https://nectarclimate.com/docs/platform/data-input/utilities/con-edison.md): How to connect Con Edison accounts to Nectar using security questions.
- [Orange and Rockland](https://nectarclimate.com/docs/platform/data-input/utilities/orange-and-rockland.md): How to connect Orange and Rockland (O&R) accounts to Nectar using security questions.
- [Duke Energy](https://nectarclimate.com/docs/platform/data-input/utilities/duke-energy.md): How to connect Duke Energy accounts to Nectar using email MFA forwarding.
- [Washington Gas](https://nectarclimate.com/docs/platform/data-input/utilities/washington-gas.md): How to connect Washington Gas accounts to Nectar using email MFA forwarding.
- [Southwest Gas](https://nectarclimate.com/docs/platform/data-input/utilities/southwest-gas.md): How to connect Southwest Gas accounts to Nectar using email MFA forwarding.
- [PECO Energy](https://nectarclimate.com/docs/platform/data-input/utilities/peco.md): How to connect PECO Energy accounts to Nectar. PECO uses Exelon platform authentication — no MFA configuration required.
- [PEPCO](https://nectarclimate.com/docs/platform/data-input/utilities/pepco.md): How to connect PEPCO accounts to Nectar. PEPCO uses Exelon platform authentication — no MFA configuration required.
- [Baltimore Gas and Electric (BGE)](https://nectarclimate.com/docs/platform/data-input/utilities/bge.md): How to connect BGE accounts to Nectar. BGE uses Exelon platform authentication — no MFA configuration required.
- [Delmarva Power](https://nectarclimate.com/docs/platform/data-input/utilities/delmarva-power.md): How to connect Delmarva Power accounts to Nectar. Delmarva uses Exelon platform authentication — no MFA configuration required.
- [Atlantic City Electric](https://nectarclimate.com/docs/platform/data-input/utilities/atlantic-city-electric.md): How to connect Atlantic City Electric accounts to Nectar. ACE uses Exelon platform authentication — no MFA configuration required.
- [Potomac Edison](https://nectarclimate.com/docs/platform/data-input/utilities/potomac-edison.md): How to connect Potomac Edison accounts to Nectar. MFA is optional — we recommend disabling it.
- [San Diego Gas & Electric (SDG&E)](https://nectarclimate.com/docs/platform/data-input/utilities/sdge.md): How to connect SDG&E accounts to Nectar using email MFA forwarding.
- [PSE&G (Public Service Electric and Gas)](https://nectarclimate.com/docs/platform/data-input/utilities/pseg-nj.md): How to connect PSE&G accounts to Nectar using email MFA forwarding.
- [Enbridge Gas](https://nectarclimate.com/docs/platform/data-input/utilities/enbridge.md): How to connect Enbridge Gas accounts to Nectar. Enbridge requires authenticator-app MFA — use security questions if available, or email forwarding.
- [EWEB (Eugene Water & Electric Board)](https://nectarclimate.com/docs/platform/data-input/utilities/eweb.md): How to connect EWEB accounts to Nectar using email MFA forwarding.
- [HRSD (Hampton Roads Sanitation District)](https://nectarclimate.com/docs/platform/data-input/utilities/hrsd.md): How to connect HRSD accounts to Nectar using email MFA forwarding.
- [Elizabethtown Gas](https://nectarclimate.com/docs/platform/data-input/utilities/elizabethtown-gas.md): How to connect Elizabethtown Gas accounts to Nectar using email MFA forwarding.
- [City of Kitchener Utilities](https://nectarclimate.com/docs/platform/data-input/utilities/city-of-kitchener.md): How to connect City of Kitchener utility accounts to Nectar using email MFA forwarding.
- [Centerpoint Energy](https://nectarclimate.com/docs/platform/data-input/utilities/centerpoint-energy.md): How to connect CenterPoint Energy accounts to Nectar using email MFA forwarding.
- [Florida Power & Light](https://nectarclimate.com/docs/platform/data-input/utilities/florida-power-and-light.md): How to connect Florida Power & Light (FPL) accounts to Nectar using email MFA forwarding.
- [Xcel Energy](https://nectarclimate.com/docs/platform/data-input/utilities/xcel-energy.md): How to connect Xcel Energy accounts to Nectar using email MFA forwarding.
- [Aquarion Water Company](https://nectarclimate.com/docs/platform/data-input/utilities/aquarion.md): How to connect Aquarion Water Company accounts to Nectar using email MFA forwarding.
- [Constellation](https://nectarclimate.com/docs/platform/data-input/utilities/constellation.md): How to connect Constellation accounts to Nectar using email MFA forwarding.
- [Summit Utilities](https://nectarclimate.com/docs/platform/data-input/utilities/summit-utilities.md): How to connect Summit Utilities accounts to Nectar using email MFA forwarding.
- [Sites](https://nectarclimate.com/docs/platform/sites/overview.md): Organize your buildings and locations, track data completeness, and compare performance across your portfolio.
- [Site comparison](https://nectarclimate.com/docs/platform/sites/compare.md): Compare consumption and cost trends for two groups of sites side by side.
- [Sites FAQ](https://nectarclimate.com/docs/platform/sites/faq.md): Troubleshooting site setup, views, analytics visibility, and site-level data.
- [Data Inventory](https://nectarclimate.com/docs/platform/data-inventory/overview.md): Browse and manage all your utility bills, accounts, and meters in one place.
- [Bills](https://nectarclimate.com/docs/platform/data-inventory/bills.md): View, filter, and manage processed utility bills.
- [Bill detail](https://nectarclimate.com/docs/platform/data-inventory/bill-detail.md): View and edit a single utility bill's charges, usage data, and metadata.
- [Accounts](https://nectarclimate.com/docs/platform/data-inventory/accounts.md): View and manage utility accounts across your sites.
- [Account detail](https://nectarclimate.com/docs/platform/data-inventory/account-detail.md): View account information, manage tracking, and browse associated meters and bills.
- [Meters](https://nectarclimate.com/docs/platform/data-inventory/meters.md): View and manage utility meters across your sites.
- [Meter detail](https://nectarclimate.com/docs/platform/data-inventory/meter-detail.md): View meter usage history, manage identifiers, clone meters, and reassign site from the meters list.
- [Usage data](https://nectarclimate.com/docs/platform/data-inventory/usage-data.md): Understand consumption records, occupancy adjustments, and how edits affect your reports.
- [Data Inventory FAQ](https://nectarclimate.com/docs/platform/data-inventory/faq.md): Troubleshooting bills, accounts, meters, and record-level data issues.
- [Data Quality](https://nectarclimate.com/docs/platform/data-quality/overview.md): Monitor data issues and track completeness across your utility portfolio.
- [Issues](https://nectarclimate.com/docs/platform/data-quality/issues.md): Triage and resolve data quality issues across your portfolio.
- [Savings](https://nectarclimate.com/docs/platform/data-quality/savings.md): Review estimated bill savings and configure detection for your company.
- [Data completeness](https://nectarclimate.com/docs/platform/data-quality/completeness.md): Visualize coverage gaps and track data completeness across sites, accounts, and meters.
- [Usage estimation](https://nectarclimate.com/docs/platform/data-quality/usage-estimation.md): Optional site-level usage fills for coverage and analytics when bills are missing.
- [Usage estimation rules](https://nectarclimate.com/docs/platform/settings/usage-estimation-rules.md): Configure site-level usage fills, daily refresh, and manual reruns.
- [Filling data gaps](https://nectarclimate.com/docs/platform/data-quality/filling-data-gaps.md): How to diagnose missing months on Completeness and choose the right fix.
- [Anomalies](https://nectarclimate.com/docs/platform/data-quality/anomalies.md): Automatically surface unusual usage, cost, unit-price, late-fee, and post-archive billing patterns.
- [Data Quality FAQ](https://nectarclimate.com/docs/platform/data-quality/faq.md): Troubleshooting anomalies, missing periods, and quality issue workflows.
- [Data Export](https://nectarclimate.com/docs/platform/data-export/overview.md): Export utility data in various formats or push directly to third-party platforms.
- [Quick export](https://nectarclimate.com/docs/platform/data-export/quick-export.md): Export usage or cost data as xlsx or csv files.
- [Integrations](https://nectarclimate.com/docs/platform/data-export/integrations.md): Connect Nectar to third-party platforms for automated data delivery.
- [Running an integration export](https://nectarclimate.com/docs/platform/data-export/integration-export.md): Configure and execute an export to a connected third-party platform.
- [Energy Star](https://nectarclimate.com/docs/platform/data-export/integrations/energy-star.md): EPA Energy Star Portfolio Manager integration for building energy benchmarking.
- [Metrio](https://nectarclimate.com/docs/platform/data-export/integrations/metrio.md): Metrio integration for ESG performance management and carbon accounting.
- [Watershed](https://nectarclimate.com/docs/platform/data-export/integrations/watershed.md): Watershed integration for carbon accounting and climate program management.
- [Sinai](https://nectarclimate.com/docs/platform/data-export/integrations/sinai.md): Sinai integration for decarbonization intelligence and emissions tracking.
- [Unravel Carbon](https://nectarclimate.com/docs/platform/data-export/integrations/unravel.md): Unravel Carbon integration for supply chain sustainability and carbon footprint tracking.
- [Sphera](https://nectarclimate.com/docs/platform/data-export/integrations/sphera.md): Sphera integration for integrated sustainability and risk management.
- [Export history](https://nectarclimate.com/docs/platform/data-export/export-history.md): View and re-download past data exports.
- [Data Export FAQ](https://nectarclimate.com/docs/platform/data-export/faq.md): Troubleshooting quick exports, integration exports, and delivery discrepancies.
- [Bill Pay](https://nectarclimate.com/docs/platform/bill-pay/overview.md): Automate how utility bills flow to your accounts payable team or ERP system.
- [Rules](https://nectarclimate.com/docs/platform/bill-pay/rules.md): Configure routing and GL coding rules that automatically process incoming bills.
- [Destinations](https://nectarclimate.com/docs/platform/bill-pay/destinations.md): Set up email addresses and ERP integrations where bills are delivered.
- [ERP integrations](https://nectarclimate.com/docs/platform/bill-pay/erp-integrations/overview.md): Connect Bill Pay to SAP, Oracle, Workday, NetSuite, or QuickBooks Online.
- [SAP S/4HANA](https://nectarclimate.com/docs/platform/bill-pay/erp-integrations/sap-s4hana.md): Connect Bill Pay to SAP S/4HANA Cloud or on-premise for automated AP posting.
- [Oracle Fusion](https://nectarclimate.com/docs/platform/bill-pay/erp-integrations/oracle-fusion.md): Connect Bill Pay to Oracle Fusion Cloud Financials for automated AP posting.
- [Workday Financials](https://nectarclimate.com/docs/platform/bill-pay/erp-integrations/workday-financials.md): Connect Bill Pay to Workday Financials for automated AP posting.
- [NetSuite](https://nectarclimate.com/docs/platform/bill-pay/erp-integrations/netsuite.md): Connect Bill Pay to NetSuite for automated AP posting.
- [QuickBooks Online](https://nectarclimate.com/docs/platform/bill-pay/erp-integrations/quickbooks-online.md): Connect Bill Pay to QuickBooks Online for automated AP posting.
- [Bill audit](https://nectarclimate.com/docs/platform/bill-pay/decisions.md): Audit trail of routing decisions, GL coding, and ERP delivery for every bill.
- [Funding Overview](https://nectarclimate.com/docs/platform/bill-pay/funding.md): Track the bill payment lifecycle from review through delivery or payment.
- [Bill Pay FAQ](https://nectarclimate.com/docs/platform/bill-pay/faq.md): Common questions about bill pay routing, destinations, and the payment lifecycle.
- [Cost Management](https://nectarclimate.com/docs/platform/cost-management/overview.md): Review portfolio cost, compare accounts, browse line items, and manage budgets.
- [Analytics](https://nectarclimate.com/docs/platform/analytics/overview.md): Visualize utility consumption and trends across your portfolio.
- [Custom dashboards](https://nectarclimate.com/docs/platform/analytics/custom-dashboards.md): Build your own dashboards from the data Nectar already tracks — pick the numbers, charts, filters, and time windows that matter to you, then save and share them.
- [Consumption analytics](https://nectarclimate.com/docs/platform/analytics/consumption.md): Aggregate consumption across all utility types with filtering and date presets.
- [Usage estimation](https://nectarclimate.com/docs/platform/data-quality/usage-estimation.md): Optional site-level usage fills for coverage and analytics when bills are missing.
- [EUI & Intensity](https://nectarclimate.com/docs/platform/analytics/intensity.md): Rank sites by energy use per square foot and spot the outliers in your portfolio.
- [Electricity analytics](https://nectarclimate.com/docs/platform/analytics/electricity.md): Detailed electricity consumption and cost analysis.
- [Gas analytics](https://nectarclimate.com/docs/platform/analytics/gas.md): Detailed gas consumption and cost analysis.
- [Water analytics](https://nectarclimate.com/docs/platform/analytics/water.md): Detailed water consumption and cost analysis.
- [Waste analytics](https://nectarclimate.com/docs/platform/analytics/waste.md): Waste data analysis by stream and material.
- [Fuel analytics](https://nectarclimate.com/docs/platform/analytics/fuel.md): Detailed fuel consumption and cost analysis.
- [Analytics FAQ](https://nectarclimate.com/docs/platform/analytics/faq.md): Troubleshooting charts, filters, exports, and analytics data visibility.
- [Settings](https://nectarclimate.com/docs/platform/settings/overview.md): Configure your personal, company, and organization settings.
- [Personal settings](https://nectarclimate.com/docs/platform/settings/personal-settings.md): Manage your profile, display preferences, notifications, and company membership.
- [Company settings](https://nectarclimate.com/docs/platform/settings/company-settings.md): Configure company details, sites, data collection, quality rules, and member access.
- [Custom variables](https://nectarclimate.com/docs/platform/settings/custom-variables.md): Define monthly metrics and fixed site attributes for intensity analytics and portfolio filtering.
- [Data collection settings](https://nectarclimate.com/docs/platform/settings/data-collection.md): Company-level controls for data collection and cost tracking, plus Data Quality settings for bill issues and anomaly detection.
- [Usage estimation rules](https://nectarclimate.com/docs/platform/settings/usage-estimation-rules.md): Configure site-level usage fills, daily refresh, and manual reruns.
- [Organization settings](https://nectarclimate.com/docs/platform/settings/organization-settings.md): Manage your admin team, billing, developer tools, and cross-company data views.
- [Settings FAQ](https://nectarclimate.com/docs/platform/settings/faq.md): Troubleshooting permissions, API keys, billing, invitations, and personal configuration.
- [How to migrate from another provider](https://nectarclimate.com/docs/platform/onboarding/overview.md): Move from your current utility data workflow to Nectar with guided onboarding, site and connection import, and bill collection.
- [Migrate from ENGIE Impact](https://nectarclimate.com/docs/platform/onboarding/engie.md): Move utility expense and sustainability data from ENGIE workflows into Nectar with a structured onboarding plan.
- [Migrate from Schneider Electric](https://nectarclimate.com/docs/platform/onboarding/schneider-electric.md): Migrate utility billing and meter workflows from Schneider Electric Resource Advisor into Nectar.
- [Migrate from Arcadia / Urjanet](https://nectarclimate.com/docs/platform/onboarding/arcadia-urjanet.md): Migrate normalized utility account and bill datasets from Arcadia/Urjanet into Nectar.
- [Migrate from spreadsheets](https://nectarclimate.com/docs/platform/onboarding/spreadsheets.md): Import sites and connections from spreadsheets, then collect bills through connections, uploads, or invitations.
- [Migrate from IBM Envizi](https://nectarclimate.com/docs/platform/onboarding/envizi.md): Map utility bill analytics datasets from IBM Envizi into Nectar for operational data quality and delivery.
- [Migrate from EnergyCAP](https://nectarclimate.com/docs/platform/onboarding/energycap.md): Migrate utility accounting, account, and meter workflows from EnergyCAP into Nectar.
- [Migrate from Constellation](https://nectarclimate.com/docs/platform/onboarding/constellation.md): Move utility bill management datasets from Constellation workflows into Nectar.
- [Migrate from Conservice](https://nectarclimate.com/docs/platform/onboarding/conservice.md): Migrate utility expense and billing-adjacent datasets from Conservice workflows into Nectar.
- [Migrate from Cass](https://nectarclimate.com/docs/platform/onboarding/cass.md): Migrate utility invoice and cost-allocation datasets from Cass workflows into Nectar.
- [Migrate from energy services companies](https://nectarclimate.com/docs/platform/onboarding/energy-services-companies.md): Consolidate fragmented ESCO workflows into Nectar with a repeatable data model and onboarding process.
- [Premium features](https://nectarclimate.com/docs/platform/premium/overview.md): White-label branding for invitations (premium add-on).
- [White-label](https://nectarclimate.com/docs/platform/premium/white-label.md): Customize the invitation experience with your brand colors, logo, and company name.
- [Premium FAQ](https://nectarclimate.com/docs/platform/premium/faq.md): Troubleshooting premium feature access, enablement, and rollout.
- [Developer guide](https://nectarclimate.com/docs/developer-guide/for-developers.md): Technical onboarding for Nectar API integrations and embedded workflows.
- [Getting started with the API](https://nectarclimate.com/docs/developer-guide/getting-started.md): Authenticate, make your first request, and understand Nectar's data model.
- [Sandbox testing](https://nectarclimate.com/docs/developer-guide/sandbox-testing.md): Test the Nectar API with sandboxed utility accounts and mock data.
- [Connection invitations](https://nectarclimate.com/docs/developer-guide/connection-invitations.md): Create revocable, auditable invitations for external contributors to create or reconnect utility connections — the replacement for magic links.
- [Magic link integration (deprecated)](https://nectarclimate.com/docs/developer-guide/magic-link-integration.md): Magic-link endpoints are deprecated. Use Connection invitations instead.
- [Webhooks](https://nectarclimate.com/docs/developer-guide/webhooks.md): Receive real-time notifications when utility data changes via webhook events.
- [Connection and account statuses](https://nectarclimate.com/docs/developer-guide/connection-statuses.md): Reference guide for all connection and account status values returned by the API.
- [Connection lifecycle](https://nectarclimate.com/docs/developer-guide/connection-lifecycle.md): How connections move through statuses, what each status means for your integration, and what actions to take.
- [MFA integration](https://nectarclimate.com/docs/developer-guide/mfa-integration.md): How to help end customers get data flowing when their utility portal requires multi-factor authentication — ordered from lowest-effort to highest-effort.
- [Document upload](https://nectarclimate.com/docs/developer-guide/document-upload.md): Upload utility bill PDFs and images for processing via the Nectar API.
- [Bill pay lifecycle](https://nectarclimate.com/docs/developer-guide/bill-pay-lifecycle.md): Understand bill pay cycle statuses, state transitions, and how bills move through the payment pipeline.
- [Bill pay rules API](https://nectarclimate.com/docs/developer-guide/bill-pay-rules.md): Create and manage routing rules programmatically using the bill pay API.
- [Pagination](https://nectarclimate.com/docs/developer-guide/pagination.md): How to paginate through list endpoints in the Nectar API.
- [Filtering and query parameters](https://nectarclimate.com/docs/developer-guide/filtering.md): Filter API results by date range, utility type, site, and other criteria.
- [API version differences](https://nectarclimate.com/docs/developer-guide/api-versions.md): What changed between v2.0, v2.1, and v2.2 — and how to migrate.
- [Data model overview](https://nectarclimate.com/docs/developer-guide/data-model/overview.md): Technical guide to Nectar API data structures, processing behavior, and entity relationships.
- [Document processing guide](https://nectarclimate.com/docs/developer-guide/data-model/parsing.md): What Nectar extracts from utility documents and what to expect in API outputs.
- [Meter organization](https://nectarclimate.com/docs/developer-guide/data-model/meter-organization.md): How Nectar organizes meters, accounts, and sites for API consumers.
- [Update an account](https://nectarclimate.com/docs/api-reference/v2-2/accounts/update-an-account.md): Allows an authenticated API user to manage an account for a specific connection. The only supported update is to set the account as tracked or not tracked. All associated meters will be set to the same isTracked status as the account. Optionally, pass in a parameter updateMeters = false to prevent m…
- [Bulk update accounts for a company](https://nectarclimate.com/docs/api-reference/v2-2/accounts/bulk-update-accounts-for-a-company.md): Allows an authenticated API user to bulk update accounts for a company. The only supported update is to set an account as tracked or not tracked. All accounts are updated to the same isTracked status. Either all accounts are updated, or if there is an error, no accounts are updated. All associated m…
- [Retrieve Companies](https://nectarclimate.com/docs/api-reference/v2-2/companies/retrieve-companies.md): Get all companies that your API key is associated with. This endpoint returns detailed information about each company, including its ID, name, external ID, and associated sites.
- [Create Company](https://nectarclimate.com/docs/api-reference/v2-2/companies/create-company.md): Create a new company in the system. The authenticated user will be set as the admin for the newly created company. Additional users can be added during creation via the users field, or added later via the patch request.
- [Get Company Details](https://nectarclimate.com/docs/api-reference/v2-2/companies/get-company-details.md): Fetch the details of a specific company by its ID.
- [Delete Company](https://nectarclimate.com/docs/api-reference/v2-2/companies/delete-company.md): Delete a specific company from the system. This operation is performed asynchronously in a background thread as it can be slow. It will return a 204 status code immediately once the thread is started.
- [Update Company](https://nectarclimate.com/docs/api-reference/v2-2/companies/update-company.md): Update the details of a specific company. You can also update the list of users using the users field. If users is provided, it replaces the current list of users. If users is not provided, the user list remains unchanged. You cannot remove yourself from the company.
- [Get Webhook Settings](https://nectarclimate.com/docs/api-reference/v2-2/webhook-portal/get-webhook-settings.md): Returns the current webhook configuration for your organization. Webhooks must be enabled before events are dispatched.
- [Webhook Portal](https://nectarclimate.com/docs/api-reference/v2-2/webhook-portal/webhook-portal.md): This endpoint returns a URL to access and setup webhooks via SVIX. Use webhooks to have your web application listen to updates to connections, documents, and upload jobs in real time. Read more about consuming endpoints with SVIX here: https://docs.svix.com/receiving/introduction. We recommend using…
- [Update Webhook Settings](https://nectarclimate.com/docs/api-reference/v2-2/webhook-portal/update-webhook-settings.md): Enable or disable webhooks for your organization. When disabled, no webhook events are dispatched and the webhook portal is inaccessible.
- [Create Magic Link for Updating a Utility Account Connection](https://nectarclimate.com/docs/api-reference/v2-2/connections/create-magic-link-for-updating-a-utility-account-connection.md): **Deprecated:** Use `POST /invitation/connection/{connection_id}` instead. This endpoint will be removed in a future API version.
- [Get an Utility Account Connection](https://nectarclimate.com/docs/api-reference/v2-2/connections/get-an-utility-account-connection.md): Get an existing utility account connection for a company.
- [Update an Utility Account Connection](https://nectarclimate.com/docs/api-reference/v2-2/connections/update-an-utility-account-connection.md): Update an existing utility account connection for a company.
- [Confirm a utility account connection for a company.](https://nectarclimate.com/docs/api-reference/v2-2/connections/confirm-a-utility-account-connection-for-a-company.md): Confirm a utility account connection for a company. This action will set the connection status to CONNECTED. Passing false into this endpoint will not change any statuses.
- [Get Company Utility Account Connections](https://nectarclimate.com/docs/api-reference/v2-2/connections/get-company-utility-account-connections.md): Retrieve all utility account connections for a company by ID. Requires company access permission. Results are paginated (100 per page by default). Returns connection details including ID, account number, and status. Optional filters: `connectionOwnerEmail`, `status`, and `sites`. Each connection has…
- [Create Basic Utility Account Connection](https://nectarclimate.com/docs/api-reference/v2-2/connections/create-basic-utility-account-connection.md): Create a basic utility account connection for a company. Supports username/password authentication and optionally security questions. Connections requiring MFA must use magic links. Requires company access and a list of sites in the request body.
- [Create Magic Link for Creating a Utility Account Connection](https://nectarclimate.com/docs/api-reference/v2-2/connections/create-magic-link-for-creating-a-utility-account-connection.md): **Deprecated:** Use `POST /invitation/company/{company_id}` instead. This endpoint will be removed in a future API version.
- [Create Magic Link with Prefilled Data for Creating a Utility Account Connection](https://nectarclimate.com/docs/api-reference/v2-2/connections/create-magic-link-with-prefilled-data-for-creating-a-utility-account-connection.md): **Deprecated:** Use `POST /invitation/company/{company_id}` with the `prefill` field instead. This endpoint will be removed in a future API version.
- [Search Utility Providers](https://nectarclimate.com/docs/api-reference/v2-2/connections/search-utility-providers.md): Returns a paginated list of utility providers in the Nectar catalog. Supports case-insensitive substring search on name and URL. Use the returned ID as ``prefill.datasourceId`` when creating a connection invitation.
- [Get Document Details](https://nectarclimate.com/docs/api-reference/v2-2/documents/get-document-details.md): Retrieve detailed information about a specific document by its document ID. Users must have access to the company that owns the document to retrieve this data. Response includes document usage data, demand meters, associated site information, presigned S3 URL to view the document, audit trail URL to…
- [Update Document Details](https://nectarclimate.com/docs/api-reference/v2-2/documents/update-document-details.md): Update specific fields of a document by its document ID. Users must have access to the document to update it. Returns the updated document details.
- [Get Documents by Company](https://nectarclimate.com/docs/api-reference/v2-2/documents/get-documents-by-company.md): Retrieve documents for a specified company. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE' (default), or 'USAGE_PERIOD'. Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start. Filter by…
- [Get Documents by Connection](https://nectarclimate.com/docs/api-reference/v2-2/documents/get-documents-by-connection.md): Retrieve documents for a specified connection. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE' (default), or 'USAGE_PERIOD'. Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start. Filter…
- [Get Documents by Site](https://nectarclimate.com/docs/api-reference/v2-2/documents/get-documents-by-site.md): Retrieve documents for a specified site. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE' (default), or 'USAGE_PERIOD'. Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start. Filter by 'is…
- [Get Intervals by Connection (BETA)](https://nectarclimate.com/docs/api-reference/v2-2/intervals/get-intervals-by-connection-beta.md): Retrieve interval data associated with a specified utility connection. The data is paginated, with default of 100 entries per page. Users must have access to the connection to retrieve this data.
- [Get Invitation Detail](https://nectarclimate.com/docs/api-reference/v2-2/invitations/get-invitation-detail.md): Returns full invitation details including the audit event log. Only returns CREATE_CONNECTION and EDIT_CONNECTION invitation types.
- [Revoke Invitation](https://nectarclimate.com/docs/api-reference/v2-2/invitations/revoke-invitation.md): Revokes an active invitation, immediately invalidating the invitation link. Revoking an already-revoked invitation returns 200 (idempotent).
- [List Invitations by Company](https://nectarclimate.com/docs/api-reference/v2-2/invitations/list-invitations-by-company.md): Returns a paginated list of connection invitations for the specified company, filtered to CREATE_CONNECTION and EDIT_CONNECTION types. Supports filtering by status and invitation type.
- [Create Connection Invitation](https://nectarclimate.com/docs/api-reference/v2-2/invitations/create-connection-invitation.md): Create an invitation that lets an external contributor connect a new utility account to the specified company. The response includes an `invitationUrl` to send to the contributor. Supports optional email restrictions, expiration, usage limits, and pre-filled form data.
- [Create Reconnect Invitation](https://nectarclimate.com/docs/api-reference/v2-2/invitations/create-reconnect-invitation.md): Create an invitation that lets a contributor update credentials on an existing utility account connection. The response includes an `invitationUrl` to send to the contributor.
- [Get Job Status Details](https://nectarclimate.com/docs/api-reference/v2-2/jobs/get-job-status-details.md): Gets the status and details of a document processing job given a job id. When you submit documents through our API, each submission creates a job that can be tracked. The job status will always be one of 'PENDING', 'COMPLETED', or 'FAILED'. COMPLETED includes jobs that finished without creating new…
- [Submit Job via Single Document Upload](https://nectarclimate.com/docs/api-reference/v2-2/jobs/submit-job-via-single-document-upload.md): Submits a document to Nectar for processing and creates a job to track its progress. The company must be active to submit a job. Each document submission is tracked as a job with an id that can be used to check processing status. This endpoint returns the jobId immediately while processing continues…
- [Submit Job via Bulk Document Upload](https://nectarclimate.com/docs/api-reference/v2-2/jobs/submit-job-via-bulk-document-upload.md): Submit multiple documents using signed S3 URLs for processing as a single job. The company must be active to submit a job. The size limit of each individual document is **25MB**, and the page limit for PDF files is **800**. Returns a job ID that can be used to track the status of all submitted docum…
- [Get Meter Details](https://nectarclimate.com/docs/api-reference/v2-2/meters/get-meter-details.md): Fetch the details of a specific meter by its ID.
- [Update Meter Details](https://nectarclimate.com/docs/api-reference/v2-2/meters/update-meter-details.md): Update the details of a specific meter by its ID. Changing the identifier list will delete all existing identifiers and create new ones from the list.
- [Get Meters by Company](https://nectarclimate.com/docs/api-reference/v2-2/meters/get-meters-by-company.md): Retrieve all meters associated with a specified company. The data is paginated, with default of 100 entries per page. Users must have access to the company to retrieve this data.
- [Get Meters by Connection](https://nectarclimate.com/docs/api-reference/v2-2/meters/get-meters-by-connection.md): Retrieve all meters associated with a specified utility account connection. The data is paginated, with default of 100 entries per page. Users must have access to the connection to retrieve this data.
- [Get Meters by Document](https://nectarclimate.com/docs/api-reference/v2-2/meters/get-meters-by-document.md): Retrieve all meters associated with a specified document. The data is paginated, with default of 100 entries per page. Users must have access to the document to retrieve this data.
- [Get Meters by Site](https://nectarclimate.com/docs/api-reference/v2-2/meters/get-meters-by-site.md): Retrieve all meters associated with a specified site. The data is paginated, with default of 100 entries per page. Users must have access to the site to retrieve this data.
- [Ping Test Endpoint](https://nectarclimate.com/docs/api-reference/v2-2/ping/ping-test-endpoint.md): This endpoint allows users to test the server availability for v2.2 endpoints. Upon successful authentication, it returns a 'pong v2.2' message, indicating that the server is running and the user's authentication credentials are valid.
- [Get Site Details](https://nectarclimate.com/docs/api-reference/v2-2/sites/get-site-details.md): Fetch the details of a specific site by its ID.
- [Delete Site](https://nectarclimate.com/docs/api-reference/v2-2/sites/delete-site.md): Stops data collection for a specific site. This soft-deletes the site. No data will be collected for this site further.
- [Update Site](https://nectarclimate.com/docs/api-reference/v2-2/sites/update-site.md): Update the details of a specific site.
- [Get Sites by Company](https://nectarclimate.com/docs/api-reference/v2-2/sites/get-sites-by-company.md): Fetch a list of all sites associated with a specified company.
- [Create Site](https://nectarclimate.com/docs/api-reference/v2-2/sites/create-site.md): Create a new site for a specified company.
- [Get Team and Billing Information](https://nectarclimate.com/docs/api-reference/v2-2/team/get-team-and-billing-information.md): Get the team information for the authenticated user. This returns the team name, a list of team member email addresses, and comprehensive billing information including Stripe billing summaries, and a signed link to the Stripe customer billing portal.
- [Update Team and Billing Information](https://nectarclimate.com/docs/api-reference/v2-2/team/update-team-and-billing-information.md): Update the team members for the authenticated user's billing profile. This replaces the current list of team members with the provided list. The authenticated user will always remain in the team.
- [Get Usage Data Details](https://nectarclimate.com/docs/api-reference/v2-2/usage-data/get-usage-data-details.md): Fetch the details of a specific usage data entry by its ID.
- [Delete Usage Data](https://nectarclimate.com/docs/api-reference/v2-2/usage-data/delete-usage-data.md): Delete a specific usage data entry by its ID.
- [Update Usage Data](https://nectarclimate.com/docs/api-reference/v2-2/usage-data/update-usage-data.md): Update a specific usage data entry by its ID. Updates to the meter and identifiers will also be reflected.
- [Get Usage Data by Company](https://nectarclimate.com/docs/api-reference/v2-2/usage-data/get-usage-data-by-company.md): Retrieve usage data for a specified company. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE' (default), or 'USAGE_PERIOD'. Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start. Filter by…
- [Get Usage Data by Utility Connection](https://nectarclimate.com/docs/api-reference/v2-2/usage-data/get-usage-data-by-utility-connection.md): Retrieve usage data for a specified utility connection. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE' (default), or 'USAGE_PERIOD'. Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start…
- [Get Usage Data by Document](https://nectarclimate.com/docs/api-reference/v2-2/usage-data/get-usage-data-by-document.md): Retrieve usage data for a specific document. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE', or 'USAGE_PERIOD' (default). Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start. Filter by…
- [Get Usage Data by Meter](https://nectarclimate.com/docs/api-reference/v2-2/usage-data/get-usage-data-by-meter.md): Retrieve usage data for a specified meter. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE' (default), or 'USAGE_PERIOD'. Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start. Filter by d…
- [Get Usage Data by Site](https://nectarclimate.com/docs/api-reference/v2-2/usage-data/get-usage-data-by-site.md): Retrieve usage data for a specified site. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE' (default), or 'USAGE_PERIOD'. Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start. Filter by da…
- [Webhook for utility account connection creation v2](https://nectarclimate.com/docs/api-reference/v2-2/webhook-payloads/webhook-for-utility-account-connection-creation-v2.md): Fires when a new connection is created via the API, magic link, or the platform. The payload contains the full connection state at the time of creation.
- [Webhook for updates to an existing utility account connection v2](https://nectarclimate.com/docs/api-reference/v2-2/webhook-payloads/webhook-for-updates-to-an-existing-utility-account-connection-v2.md): Fires when any field on a connection changes — status transitions, credential updates, account additions or removals, site reassignments, or other detail changes. Timestamp-only updates do not trigger this event. The payload includes `protectedChanges` (sensitive fields that changed) and `old` (prev…
- [Webhook for connection status changes v2](https://nectarclimate.com/docs/api-reference/v2-2/webhook-payloads/webhook-for-connection-status-changes-v2.md): Fires when a connection's status transitions — including initial validation, credential errors, provider outages, and recovery. A single change can produce both this event and `connection.updated.v2`.
- [Webhook for new document availability v2](https://nectarclimate.com/docs/api-reference/v2-2/webhook-payloads/webhook-for-new-document-availability-v2.md): Fires when a new document (utility bill) is processed and available. Triggers include bills scraped from utility providers and bills uploaded via document upload.
- [Webhook for document update v2](https://nectarclimate.com/docs/api-reference/v2-2/webhook-payloads/webhook-for-document-update-v2.md): Fires when an existing document is reprocessed or updated and its data changes. Common triggers include bill corrections, meter assignment changes, and usage data updates. No-op updates that do not change document data are ignored. The payload includes `old` with previous field values.
- [Webhook for document deletion v2](https://nectarclimate.com/docs/api-reference/v2-2/webhook-payloads/webhook-for-document-deletion-v2.md): Fires when a document is deleted via the API or the platform. The payload contains the full document state at the time of deletion.
- [Webhook for synced interval data](https://nectarclimate.com/docs/api-reference/v2-2/webhook-payloads/webhook-for-synced-interval-data.md): Fires after interval data is inserted or updated for a meter. The payload contains the affected meter, account, time range, and row counts.
- [Webhook for document upload job completion](https://nectarclimate.com/docs/api-reference/v2-2/webhook-payloads/webhook-for-document-upload-job-completion.md): Fires when a document upload job finishes processing, including jobs that created no new documents (duplicates, non-utility files, password-protected files, or processing errors). The payload matches the job status endpoint. Failed jobs also fire this event with status FAILED.
- [Update an account](https://nectarclimate.com/docs/api-reference/v2-1/accounts/update-an-account.md): Allows an authenticated API user to manage an account for a specific connection. The only supported update is to set the account as tracked or not tracked. All associated meters will be set to the same isTracked status as the account. Optionally, pass in a parameter updateMeters = false to prevent m…
- [Bulk update accounts for a company](https://nectarclimate.com/docs/api-reference/v2-1/accounts/bulk-update-accounts-for-a-company.md): Allows an authenticated API user to bulk update accounts for a company. The only supported update is to set an account as tracked or not tracked. All accounts are updated to the same isTracked status. Either all accounts are updated, or if there is an error, no accounts are updated. All associated m…
- [Retrieve Companies](https://nectarclimate.com/docs/api-reference/v2-1/companies/retrieve-companies.md): Get all companies that your API key is associated with. This endpoint returns detailed information about each company, including its ID, name, external ID, and associated sites.
- [Create Company](https://nectarclimate.com/docs/api-reference/v2-1/companies/create-company.md): Create a new company in the system. The authenticated user will be set as the admin for the newly created company. Additional users can be added during creation via the users field, or added later via the patch request.
- [Get Company Details](https://nectarclimate.com/docs/api-reference/v2-1/companies/get-company-details.md): Fetch the details of a specific company by its ID.
- [Delete Company](https://nectarclimate.com/docs/api-reference/v2-1/companies/delete-company.md): Delete a specific company from the system. This operation is performed asynchronously in a background thread as it can be slow. It will return a 204 status code immediately once the thread is started.
- [Update Company](https://nectarclimate.com/docs/api-reference/v2-1/companies/update-company.md): Update the details of a specific company. You can also update the list of users using the users field. If users is provided, it replaces the current list of users. If users is not provided, the user list remains unchanged. You cannot remove yourself from the company.
- [Get Webhook Settings](https://nectarclimate.com/docs/api-reference/v2-1/webhook-portal/get-webhook-settings.md): Returns the current webhook configuration for your organization. Webhooks must be enabled before events are dispatched.
- [Webhook Portal](https://nectarclimate.com/docs/api-reference/v2-1/webhook-portal/webhook-portal.md): This endpoint returns a URL to access and setup webhooks via SVIX. Use webhooks to have your web application listen to updates to connections, documents, and upload jobs in real time. Read more about consuming endpoints with SVIX here: https://docs.svix.com/receiving/introduction. We recommend using…
- [Update Webhook Settings](https://nectarclimate.com/docs/api-reference/v2-1/webhook-portal/update-webhook-settings.md): Enable or disable webhooks for your organization. When disabled, no webhook events are dispatched and the webhook portal is inaccessible.
- [Create Magic Link for Updating a Utility Account Connection](https://nectarclimate.com/docs/api-reference/v2-1/connections/create-magic-link-for-updating-a-utility-account-connection.md): **Deprecated:** Use `POST /invitation/connection/{connection_id}` instead. This endpoint will be removed in a future API version.
- [Get an Utility Account Connection](https://nectarclimate.com/docs/api-reference/v2-1/connections/get-an-utility-account-connection.md): Get an existing utility account connection for a company.
- [Update an Utility Account Connection](https://nectarclimate.com/docs/api-reference/v2-1/connections/update-an-utility-account-connection.md): Update an existing utility account connection for a company.
- [Confirm a utility account connection for a company.](https://nectarclimate.com/docs/api-reference/v2-1/connections/confirm-a-utility-account-connection-for-a-company.md): Confirm a utility account connection for a company. This action will set the connection status to CONNECTED. Passing false into this endpoint will not change any statuses.
- [Get Company Utility Account Connections](https://nectarclimate.com/docs/api-reference/v2-1/connections/get-company-utility-account-connections.md): Retrieve all utility account connections for a company by ID. Requires company access permission. Returns connection details including ID, account number, and status. Optional filters: `connectionOwnerEmail`, `status`, and `sites`. Each connection has a unique secret key and company ID for secure ac…
- [Create Basic Utility Account Connection](https://nectarclimate.com/docs/api-reference/v2-1/connections/create-basic-utility-account-connection.md): Create a basic utility account connection for a company. Supports username/password authentication and optionally security questions. Connections requiring MFA must use magic links. Requires company access and a list of sites in the request body.
- [Create Magic Link for Creating a Utility Account Connection](https://nectarclimate.com/docs/api-reference/v2-1/connections/create-magic-link-for-creating-a-utility-account-connection.md): **Deprecated:** Use `POST /invitation/company/{company_id}` instead. This endpoint will be removed in a future API version.
- [Create Magic Link with Prefilled Data for Creating a Utility Account Connection](https://nectarclimate.com/docs/api-reference/v2-1/connections/create-magic-link-with-prefilled-data-for-creating-a-utility-account-connection.md): **Deprecated:** Use `POST /invitation/company/{company_id}` with the `prefill` field instead. This endpoint will be removed in a future API version.
- [Search Utility Providers](https://nectarclimate.com/docs/api-reference/v2-1/connections/search-utility-providers.md): Returns a paginated list of utility providers in the Nectar catalog. Supports case-insensitive substring search on name and URL. Use the returned ID as ``prefill.datasourceId`` when creating a connection invitation.
- [Get Document Details](https://nectarclimate.com/docs/api-reference/v2-1/documents/get-document-details.md): Retrieve detailed information about a specific document by its document ID. Users must have access to the company that owns the document to retrieve this data. Response includes document usage data, associated site information, presigned S3 URL to view the document, audit trail URL to view the edit…
- [Update Document Details](https://nectarclimate.com/docs/api-reference/v2-1/documents/update-document-details.md): Update specific fields of a document by its document ID. Users must have access to the document to update it. This endpoint allows updating bill dates, invoice ID, and various charge and balance fields. Returns the updated document details.
- [Get Demand Meters by Document](https://nectarclimate.com/docs/api-reference/v2-1/documents/get-demand-meters-by-document.md): DEPRECATED: This endpoint is now deprecated. Please refer to v2.2 for detailed demand information.
- [Get Documents by Company](https://nectarclimate.com/docs/api-reference/v2-1/documents/get-documents-by-company.md): Retrieve documents for a specified company. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE' (default), or 'USAGE_PERIOD'. Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start. Filter by…
- [Get Documents by Connection](https://nectarclimate.com/docs/api-reference/v2-1/documents/get-documents-by-connection.md): Retrieve documents for a specified connection. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE' (default), or 'USAGE_PERIOD'. Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start. Filter…
- [Get Documents by Site](https://nectarclimate.com/docs/api-reference/v2-1/documents/get-documents-by-site.md): Retrieve documents for a specified site. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE' (default), or 'USAGE_PERIOD'. Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start. Filter by 'is…
- [Get Intervals by Connection (BETA)](https://nectarclimate.com/docs/api-reference/v2-1/intervals/get-intervals-by-connection-beta.md): Retrieve interval data associated with a specified utility connection. The data is paginated, with default of 100 entries per page. Users must have access to the connection to retrieve this data.
- [Get Invitation Detail](https://nectarclimate.com/docs/api-reference/v2-1/invitations/get-invitation-detail.md): Returns full invitation details including the audit event log. Only returns CREATE_CONNECTION and EDIT_CONNECTION invitation types.
- [Revoke Invitation](https://nectarclimate.com/docs/api-reference/v2-1/invitations/revoke-invitation.md): Revokes an active invitation, immediately invalidating the invitation link. Revoking an already-revoked invitation returns 200 (idempotent).
- [List Invitations by Company](https://nectarclimate.com/docs/api-reference/v2-1/invitations/list-invitations-by-company.md): Returns a paginated list of connection invitations for the specified company, filtered to CREATE_CONNECTION and EDIT_CONNECTION types. Supports filtering by status and invitation type.
- [Create Connection Invitation](https://nectarclimate.com/docs/api-reference/v2-1/invitations/create-connection-invitation.md): Create an invitation that lets an external contributor connect a new utility account to the specified company. The response includes an `invitationUrl` to send to the contributor. Supports optional email restrictions, expiration, usage limits, and pre-filled form data.
- [Create Reconnect Invitation](https://nectarclimate.com/docs/api-reference/v2-1/invitations/create-reconnect-invitation.md): Create an invitation that lets a contributor update credentials on an existing utility account connection. The response includes an `invitationUrl` to send to the contributor.
- [Get Job Status Details](https://nectarclimate.com/docs/api-reference/v2-1/jobs/get-job-status-details.md): Gets the status and details of a document processing job given a job id. When you submit documents through our API, each submission creates a job that can be tracked. The job status will always be one of 'PENDING', 'COMPLETED', or 'FAILED'. COMPLETED includes jobs that finished without creating new…
- [Submit Job via Single Document Upload](https://nectarclimate.com/docs/api-reference/v2-1/jobs/submit-job-via-single-document-upload.md): Submits a document to Nectar for processing and creates a job to track its progress. The company must be active to submit a job. Each document submission is tracked as a job with an id that can be used to check processing status. This endpoint returns the jobId immediately while processing continues…
- [Submit Job via Bulk Document Upload](https://nectarclimate.com/docs/api-reference/v2-1/jobs/submit-job-via-bulk-document-upload.md): Submit multiple documents using signed S3 URLs for processing as a single job. The company must be active to submit a job. The size limit of each individual document is **25MB**, and the page limit for PDF files is **800**. Returns a job ID that can be used to track the status of all submitted docum…
- [Get Meter Details](https://nectarclimate.com/docs/api-reference/v2-1/meters/get-meter-details.md): Fetch the details of a specific meter by its ID.
- [Update Meter Details](https://nectarclimate.com/docs/api-reference/v2-1/meters/update-meter-details.md): Update the details of a specific meter by its ID. Changing the identifier list will delete all existing identifiers and create new ones from the list.
- [Get Meters by Company](https://nectarclimate.com/docs/api-reference/v2-1/meters/get-meters-by-company.md): Retrieve all meters associated with a specified company. The data is paginated, with default of 100 entries per page. Users must have access to the company to retrieve this data.
- [Get Meters by Connection](https://nectarclimate.com/docs/api-reference/v2-1/meters/get-meters-by-connection.md): Retrieve all meters associated with a specified utility account connection. The data is paginated, with default of 100 entries per page. Users must have access to the connection to retrieve this data.
- [Get Meters by Document](https://nectarclimate.com/docs/api-reference/v2-1/meters/get-meters-by-document.md): Retrieve all meters associated with a specified document. The data is paginated, with default of 100 entries per page. Users must have access to the document to retrieve this data.
- [Get Meters by Site](https://nectarclimate.com/docs/api-reference/v2-1/meters/get-meters-by-site.md): Retrieve all meters associated with a specified site. The data is paginated, with default of 100 entries per page. Users must have access to the site to retrieve this data.
- [Ping Test Endpoint](https://nectarclimate.com/docs/api-reference/v2-1/ping/ping-test-endpoint.md): This endpoint allows users to test the server availability for v2.1 endpoints. Upon successful authentication, it returns a 'pong v2.1' message, indicating that the server is running and the user's authentication credentials are valid.
- [Get Site Details](https://nectarclimate.com/docs/api-reference/v2-1/sites/get-site-details.md): Fetch the details of a specific site by its ID.
- [Delete Site](https://nectarclimate.com/docs/api-reference/v2-1/sites/delete-site.md): Stops data collection for a specific site. This soft-deletes the site. No data will be collected for this site further.
- [Update Site](https://nectarclimate.com/docs/api-reference/v2-1/sites/update-site.md): Update the details of a specific site.
- [Get Sites by Company](https://nectarclimate.com/docs/api-reference/v2-1/sites/get-sites-by-company.md): Fetch a list of all sites associated with a specified company.
- [Create Site](https://nectarclimate.com/docs/api-reference/v2-1/sites/create-site.md): Create a new site for a specified company.
- [Get Team and Billing Information](https://nectarclimate.com/docs/api-reference/v2-1/team/get-team-and-billing-information.md): Get the team information for the authenticated user. This returns the team name, a list of team member email addresses, and comprehensive billing information including Stripe billing summaries, and a signed link to the Stripe customer billing portal.
- [Update Team and Billing Information](https://nectarclimate.com/docs/api-reference/v2-1/team/update-team-and-billing-information.md): Update the team members for the authenticated user's billing profile. This replaces the current list of team members with the provided list. The authenticated user will always remain in the team.
- [Get Usage Data Details](https://nectarclimate.com/docs/api-reference/v2-1/usage-data/get-usage-data-details.md): Fetch the details of a specific usage data entry by its ID. Demand usage data cannot be retrieved through this endpoint.
- [Delete Usage Data](https://nectarclimate.com/docs/api-reference/v2-1/usage-data/delete-usage-data.md): Delete a specific usage data entry by its ID. Demand usage data cannot be deleted through this endpoint.
- [Update Usage Data](https://nectarclimate.com/docs/api-reference/v2-1/usage-data/update-usage-data.md): Update a specific usage data entry by its ID. Updates to the meter and identifiers will also be reflected. Demand usage data cannot be updated through this endpoint.
- [Get Usage Data by Company](https://nectarclimate.com/docs/api-reference/v2-1/usage-data/get-usage-data-by-company.md): Retrieve usage data for a specified company. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE' (default), or 'USAGE_PERIOD'. Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start. Filter by…
- [Get Usage Data by Utility Connection](https://nectarclimate.com/docs/api-reference/v2-1/usage-data/get-usage-data-by-utility-connection.md): Retrieve usage data for a specified utility connection. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE' (default), or 'USAGE_PERIOD'. Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start…
- [Get Usage Data by Document](https://nectarclimate.com/docs/api-reference/v2-1/usage-data/get-usage-data-by-document.md): Retrieve usage data for a specific document. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE', or 'USAGE_PERIOD' (default). Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start. Filter by…
- [Get Usage Data by Meter](https://nectarclimate.com/docs/api-reference/v2-1/usage-data/get-usage-data-by-meter.md): Retrieve usage data for a specified meter. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE' (default), or 'USAGE_PERIOD'. Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start. Filter by d…
- [Get Usage Data by Site](https://nectarclimate.com/docs/api-reference/v2-1/usage-data/get-usage-data-by-site.md): Retrieve usage data for a specified site. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE' (default), or 'USAGE_PERIOD'. Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start. Filter by da…
- [Webhook for utility account connection creation v2](https://nectarclimate.com/docs/api-reference/v2-1/webhook-payloads/webhook-for-utility-account-connection-creation-v2.md): Fires when a new connection is created via the API, magic link, or the platform. The payload contains the full connection state at the time of creation.
- [Webhook for updates to an existing utility account connection v2](https://nectarclimate.com/docs/api-reference/v2-1/webhook-payloads/webhook-for-updates-to-an-existing-utility-account-connection-v2.md): Fires when any field on a connection changes — status transitions, credential updates, account additions or removals, site reassignments, or other detail changes. Timestamp-only updates do not trigger this event. The payload includes `protectedChanges` (sensitive fields that changed) and `old` (prev…
- [Webhook for connection status changes v2](https://nectarclimate.com/docs/api-reference/v2-1/webhook-payloads/webhook-for-connection-status-changes-v2.md): Fires when a connection's status transitions — including initial validation, credential errors, provider outages, and recovery. A single change can produce both this event and `connection.updated.v2`.
- [Webhook for new document availability v2](https://nectarclimate.com/docs/api-reference/v2-1/webhook-payloads/webhook-for-new-document-availability-v2.md): Fires when a new document (utility bill) is processed and available. Triggers include bills scraped from utility providers and bills uploaded via document upload.
- [Webhook for document update v2](https://nectarclimate.com/docs/api-reference/v2-1/webhook-payloads/webhook-for-document-update-v2.md): Fires when an existing document is reprocessed or updated and its data changes. Common triggers include bill corrections, meter assignment changes, and usage data updates. No-op updates that do not change document data are ignored. The payload includes `old` with previous field values.
- [Webhook for document deletion v2](https://nectarclimate.com/docs/api-reference/v2-1/webhook-payloads/webhook-for-document-deletion-v2.md): Fires when a document is deleted via the API or the platform. The payload contains the full document state at the time of deletion.
- [Webhook for synced interval data](https://nectarclimate.com/docs/api-reference/v2-1/webhook-payloads/webhook-for-synced-interval-data.md): Fires after interval data is inserted or updated for a meter. The payload contains the affected meter, account, time range, and row counts.
- [Webhook for document upload job completion](https://nectarclimate.com/docs/api-reference/v2-1/webhook-payloads/webhook-for-document-upload-job-completion.md): Fires when a document upload job finishes processing, including jobs that created no new documents (duplicates, non-utility files, password-protected files, or processing errors). The payload matches the job status endpoint. Failed jobs also fire this event with status FAILED.
- [Update an account](https://nectarclimate.com/docs/api-reference/v2-0/accounts/update-an-account.md): Allows an authenticated API user to manage an account for a specific connection. The only supported update is to set the account as tracked or not tracked. All associated meters will be set to the same isTracked status as the account. Optionally, pass in a parameter updateMeters = false to prevent m…
- [Bulk update accounts for a company](https://nectarclimate.com/docs/api-reference/v2-0/accounts/bulk-update-accounts-for-a-company.md): Allows an authenticated API user to bulk update accounts for a company. The only supported update is to set an account as tracked or not tracked. All accounts are updated to the same isTracked status. Either all accounts are updated, or if there is an error, no accounts are updated. All associated m…
- [Retrieve Companies](https://nectarclimate.com/docs/api-reference/v2-0/companies/retrieve-companies.md): Get all companies that your API key is associated with. This endpoint returns detailed information about each company, including its ID, name, external ID, and associated sites.
- [Create Company](https://nectarclimate.com/docs/api-reference/v2-0/companies/create-company.md): Create a new company in the system. The authenticated user will be set as the admin for the newly created company. Additional users can be added during creation via the users field, or added later via the patch request.
- [Get Company Details](https://nectarclimate.com/docs/api-reference/v2-0/companies/get-company-details.md): Fetch the details of a specific company by its ID.
- [Delete Company](https://nectarclimate.com/docs/api-reference/v2-0/companies/delete-company.md): Delete a specific company from the system. This operation is performed asynchronously in a background thread as it can be slow. It will return a 204 status code immediately once the thread is started.
- [Update Company](https://nectarclimate.com/docs/api-reference/v2-0/companies/update-company.md): Update the details of a specific company. You can also update the list of users using the users field. If users is provided, it replaces the current list of users. If users is not provided, the user list remains unchanged. You cannot remove yourself from the company.
- [Get Webhook Settings](https://nectarclimate.com/docs/api-reference/v2-0/webhook-portal/get-webhook-settings.md): Returns the current webhook configuration for your organization. Webhooks must be enabled before events are dispatched.
- [Webhook Portal](https://nectarclimate.com/docs/api-reference/v2-0/webhook-portal/webhook-portal.md): This endpoint returns a URL to access and setup webhooks via SVIX. Use webhooks to have your web application listen to updates to connections, documents, and upload jobs in real time. Read more about consuming endpoints with SVIX here: https://docs.svix.com/receiving/introduction. We recommend using…
- [Update Webhook Settings](https://nectarclimate.com/docs/api-reference/v2-0/webhook-portal/update-webhook-settings.md): Enable or disable webhooks for your organization. When disabled, no webhook events are dispatched and the webhook portal is inaccessible.
- [Create Magic Link for Updating a Utility Account Connection](https://nectarclimate.com/docs/api-reference/v2-0/connections/create-magic-link-for-updating-a-utility-account-connection.md): **Deprecated:** Use `POST /invitation/connection/{connection_id}` instead. This endpoint will be removed in a future API version.
- [Get an Utility Account Connection](https://nectarclimate.com/docs/api-reference/v2-0/connections/get-an-utility-account-connection.md): Get an existing utility account connection for a company.
- [Update an Utility Account Connection](https://nectarclimate.com/docs/api-reference/v2-0/connections/update-an-utility-account-connection.md): Update an existing utility account connection for a company.
- [Confirm a utility account connection for a company.](https://nectarclimate.com/docs/api-reference/v2-0/connections/confirm-a-utility-account-connection-for-a-company.md): Confirm a utility account connection for a company. This action will set the connection status to CONNECTED. Passing false into this endpoint will not change any statuses.
- [Get Company Utility Account Connections](https://nectarclimate.com/docs/api-reference/v2-0/connections/get-company-utility-account-connections.md): Retrieve all utility account connections for a company by ID. Requires company access permission. Returns connection details including ID, account number, and status. Optional filters: `connectionOwnerEmail`, `status`, and `sites`. Each connection has a unique secret key and company ID for secure ac…
- [Create Basic Utility Account Connection](https://nectarclimate.com/docs/api-reference/v2-0/connections/create-basic-utility-account-connection.md): Create a basic utility account connection for a company. Supports username/password authentication and optionally security questions. Connections requiring MFA must use magic links. Requires company access and a list of sites in the request body.
- [Create Magic Link for Creating a Utility Account Connection](https://nectarclimate.com/docs/api-reference/v2-0/connections/create-magic-link-for-creating-a-utility-account-connection.md): **Deprecated:** Use `POST /invitation/company/{company_id}` instead. This endpoint will be removed in a future API version.
- [Create Magic Link with Prefilled Data for Creating a Utility Account Connection](https://nectarclimate.com/docs/api-reference/v2-0/connections/create-magic-link-with-prefilled-data-for-creating-a-utility-account-connection.md): **Deprecated:** Use `POST /invitation/company/{company_id}` with the `prefill` field instead. This endpoint will be removed in a future API version.
- [Search Utility Providers](https://nectarclimate.com/docs/api-reference/v2-0/connections/search-utility-providers.md): Returns a paginated list of utility providers in the Nectar catalog. Supports case-insensitive substring search on name and URL. Use the returned ID as ``prefill.datasourceId`` when creating a connection invitation.
- [Get Document Details](https://nectarclimate.com/docs/api-reference/v2-0/documents/get-document-details.md): Retrieve detailed information about a specific document by its document ID. Users must have access to the company that owns the document to retrieve this data. Response includes document usage data, associated site information, presigned S3 URL to view the document, audit trail URL to view the edit…
- [Update Document Details](https://nectarclimate.com/docs/api-reference/v2-0/documents/update-document-details.md): Update specific fields of a document by its document ID. Users must have access to the document to update it. This endpoint allows updating bill dates, invoice ID, and various charge and balance fields. Returns the updated document details.
- [Get Demand Meters by Document](https://nectarclimate.com/docs/api-reference/v2-0/documents/get-demand-meters-by-document.md): DEPRECATED: This endpoint is now deprecated. Please refer to v2.2 for detailed demand information.
- [Get Documents by Company](https://nectarclimate.com/docs/api-reference/v2-0/documents/get-documents-by-company.md): Retrieve documents for a specified company. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE' (default), or 'USAGE_PERIOD'. Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start. Filter by…
- [Get Documents by Connection](https://nectarclimate.com/docs/api-reference/v2-0/documents/get-documents-by-connection.md): Retrieve documents for a specified connection. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE' (default), or 'USAGE_PERIOD'. Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start. Filter…
- [Get Documents by Site](https://nectarclimate.com/docs/api-reference/v2-0/documents/get-documents-by-site.md): Retrieve documents for a specified site. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE' (default), or 'USAGE_PERIOD'. Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start. Filter by 'is…
- [Get Intervals by Connection (BETA)](https://nectarclimate.com/docs/api-reference/v2-0/intervals/get-intervals-by-connection-beta.md): Retrieve interval data associated with a specified utility connection. The data is paginated, with default of 100 entries per page. Users must have access to the connection to retrieve this data.
- [Get Invitation Detail](https://nectarclimate.com/docs/api-reference/v2-0/invitations/get-invitation-detail.md): Returns full invitation details including the audit event log. Only returns CREATE_CONNECTION and EDIT_CONNECTION invitation types.
- [Revoke Invitation](https://nectarclimate.com/docs/api-reference/v2-0/invitations/revoke-invitation.md): Revokes an active invitation, immediately invalidating the invitation link. Revoking an already-revoked invitation returns 200 (idempotent).
- [List Invitations by Company](https://nectarclimate.com/docs/api-reference/v2-0/invitations/list-invitations-by-company.md): Returns a paginated list of connection invitations for the specified company, filtered to CREATE_CONNECTION and EDIT_CONNECTION types. Supports filtering by status and invitation type.
- [Create Connection Invitation](https://nectarclimate.com/docs/api-reference/v2-0/invitations/create-connection-invitation.md): Create an invitation that lets an external contributor connect a new utility account to the specified company. The response includes an `invitationUrl` to send to the contributor. Supports optional email restrictions, expiration, usage limits, and pre-filled form data.
- [Create Reconnect Invitation](https://nectarclimate.com/docs/api-reference/v2-0/invitations/create-reconnect-invitation.md): Create an invitation that lets a contributor update credentials on an existing utility account connection. The response includes an `invitationUrl` to send to the contributor.
- [Get Job Status Details](https://nectarclimate.com/docs/api-reference/v2-0/jobs/get-job-status-details.md): Gets the status and details of a document processing job given a job id. When you submit documents through our API, each submission creates a job that can be tracked. The job status will always be one of 'PENDING', 'COMPLETED', or 'FAILED'. COMPLETED includes jobs that finished without creating new…
- [Submit Job via Single Document Upload](https://nectarclimate.com/docs/api-reference/v2-0/jobs/submit-job-via-single-document-upload.md): Submits a document to Nectar for processing and creates a job to track its progress. The company must be active to submit a job. Each document submission is tracked as a job with an id that can be used to check processing status. This endpoint returns the jobId immediately while processing continues…
- [Submit Job via Bulk Document Upload](https://nectarclimate.com/docs/api-reference/v2-0/jobs/submit-job-via-bulk-document-upload.md): Submit multiple documents using signed S3 URLs for processing as a single job. The company must be active to submit a job. The size limit of each individual document is **25MB**, and the page limit for PDF files is **800**. Returns a job ID that can be used to track the status of all submitted docum…
- [Get Meter Details](https://nectarclimate.com/docs/api-reference/v2-0/meters/get-meter-details.md): Fetch the details of a specific meter by its ID.
- [Update Meter Details](https://nectarclimate.com/docs/api-reference/v2-0/meters/update-meter-details.md): Update the details of a specific meter by its ID. Changing the identifier list will delete all existing identifiers and create new ones from the list.
- [Get Meters by Company](https://nectarclimate.com/docs/api-reference/v2-0/meters/get-meters-by-company.md): Retrieve all meters associated with a specified company. The data is paginated, with default of 100 entries per page. Users must have access to the company to retrieve this data.
- [Get Meters by Connection](https://nectarclimate.com/docs/api-reference/v2-0/meters/get-meters-by-connection.md): Retrieve all meters associated with a specified utility account connection. The data is paginated, with default of 100 entries per page. Users must have access to the connection to retrieve this data.
- [Get Meters by Document](https://nectarclimate.com/docs/api-reference/v2-0/meters/get-meters-by-document.md): Retrieve all meters associated with a specified document. The data is paginated, with default of 100 entries per page. Users must have access to the document to retrieve this data.
- [Get Meters by Site](https://nectarclimate.com/docs/api-reference/v2-0/meters/get-meters-by-site.md): Retrieve all meters associated with a specified site. The data is paginated, with default of 100 entries per page. Users must have access to the site to retrieve this data.
- [Ping Test Endpoint](https://nectarclimate.com/docs/api-reference/v2-0/ping/ping-test-endpoint.md): This endpoint allows users to test the server availability. Upon successful authentication, it returns a 'pong' message, indicating that the server is running and the user's authentication credentials are valid.
- [Get Site Details](https://nectarclimate.com/docs/api-reference/v2-0/sites/get-site-details.md): Fetch the details of a specific site by its ID.
- [Delete Site](https://nectarclimate.com/docs/api-reference/v2-0/sites/delete-site.md): Stops data collection for a specific site. This soft-deletes the site. No data will be collected for this site further.
- [Update Site](https://nectarclimate.com/docs/api-reference/v2-0/sites/update-site.md): Update the details of a specific site.
- [Get Sites by Company](https://nectarclimate.com/docs/api-reference/v2-0/sites/get-sites-by-company.md): Fetch a list of all sites associated with a specified company.
- [Create Site](https://nectarclimate.com/docs/api-reference/v2-0/sites/create-site.md): Create a new site for a specified company.
- [Get Team and Billing Information](https://nectarclimate.com/docs/api-reference/v2-0/team/get-team-and-billing-information.md): Get the team information for the authenticated user. This returns the team name, a list of team member email addresses, and comprehensive billing information including Stripe billing summaries, and a signed link to the Stripe customer billing portal.
- [Update Team and Billing Information](https://nectarclimate.com/docs/api-reference/v2-0/team/update-team-and-billing-information.md): Update the team members for the authenticated user's billing profile. This replaces the current list of team members with the provided list. The authenticated user will always remain in the team.
- [Get Usage Data Details](https://nectarclimate.com/docs/api-reference/v2-0/usage-data/get-usage-data-details.md): Fetch the details of a specific usage data entry by its ID.
- [Delete Usage Data](https://nectarclimate.com/docs/api-reference/v2-0/usage-data/delete-usage-data.md): Delete a specific usage data entry by its ID.
- [Update Usage Data](https://nectarclimate.com/docs/api-reference/v2-0/usage-data/update-usage-data.md): Update a specific usage data entry by its ID. Updates to the meter and identifiers will also be reflected.
- [Get Usage Data by Company](https://nectarclimate.com/docs/api-reference/v2-0/usage-data/get-usage-data-by-company.md): Retrieve usage data for a specified company. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE' (default), or 'USAGE_PERIOD'. Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start. Filter by…
- [Get Usage Data by Utility Connection](https://nectarclimate.com/docs/api-reference/v2-0/usage-data/get-usage-data-by-utility-connection.md): Retrieve usage data for a specified utility connection. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE' (default), or 'USAGE_PERIOD'. Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start…
- [Get Usage Data by Document](https://nectarclimate.com/docs/api-reference/v2-0/usage-data/get-usage-data-by-document.md): Retrieve usage data for a specific document. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE', or 'USAGE_PERIOD' (default). Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start. Filter by…
- [Get Usage Data by Meter](https://nectarclimate.com/docs/api-reference/v2-0/usage-data/get-usage-data-by-meter.md): Retrieve usage data for a specified meter. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE' (default), or 'USAGE_PERIOD'. Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start. Filter by d…
- [Get Usage Data by Site](https://nectarclimate.com/docs/api-reference/v2-0/usage-data/get-usage-data-by-site.md): Retrieve usage data for a specified site. Results are paginated (100 per page). Filter by date types: 'UPDATED_DATE', 'CREATED_DATE', 'BILL_DATE' (default), or 'USAGE_PERIOD'. Date filters return overlapping data; 'CREATED_DATE' and 'UPDATED_DATE' use UTC and are truncated to day start. Filter by da…
- [Webhook for utility account connection creation v2](https://nectarclimate.com/docs/api-reference/v2-0/webhook-payloads/webhook-for-utility-account-connection-creation-v2.md): Fires when a new connection is created via the API, magic link, or the platform. The payload contains the full connection state at the time of creation.
- [Webhook for updates to an existing utility account connection v2](https://nectarclimate.com/docs/api-reference/v2-0/webhook-payloads/webhook-for-updates-to-an-existing-utility-account-connection-v2.md): Fires when any field on a connection changes — status transitions, credential updates, account additions or removals, site reassignments, or other detail changes. Timestamp-only updates do not trigger this event. The payload includes `protectedChanges` (sensitive fields that changed) and `old` (prev…
- [Webhook for connection status changes v2](https://nectarclimate.com/docs/api-reference/v2-0/webhook-payloads/webhook-for-connection-status-changes-v2.md): Fires when a connection's status transitions — including initial validation, credential errors, provider outages, and recovery. A single change can produce both this event and `connection.updated.v2`.
- [Webhook for new document availability v2](https://nectarclimate.com/docs/api-reference/v2-0/webhook-payloads/webhook-for-new-document-availability-v2.md): Fires when a new document (utility bill) is processed and available. Triggers include bills scraped from utility providers and bills uploaded via document upload.
- [Webhook for document update v2](https://nectarclimate.com/docs/api-reference/v2-0/webhook-payloads/webhook-for-document-update-v2.md): Fires when an existing document is reprocessed or updated and its data changes. Common triggers include bill corrections, meter assignment changes, and usage data updates. No-op updates that do not change document data are ignored. The payload includes `old` with previous field values.
- [Webhook for document deletion v2](https://nectarclimate.com/docs/api-reference/v2-0/webhook-payloads/webhook-for-document-deletion-v2.md): Fires when a document is deleted via the API or the platform. The payload contains the full document state at the time of deletion.
- [Webhook for synced interval data](https://nectarclimate.com/docs/api-reference/v2-0/webhook-payloads/webhook-for-synced-interval-data.md): Fires after interval data is inserted or updated for a meter. The payload contains the affected meter, account, time range, and row counts.
- [Webhook for document upload job completion](https://nectarclimate.com/docs/api-reference/v2-0/webhook-payloads/webhook-for-document-upload-job-completion.md): Fires when a document upload job finishes processing, including jobs that created no new documents (duplicates, non-utility files, password-protected files, or processing errors). The payload matches the job status endpoint. Failed jobs also fire this event with status FAILED.
- [Changelog](https://nectarclimate.com/docs/changelog.md): Product updates and announcements for Nectar

## OpenAPI Specs

- [openapi-v2-1](/docs/api-reference/openapi-v2-1.json)
- [openapi-v2-2](/docs/api-reference/openapi-v2-2.json)
- [openapi-v2](/docs/api-reference/openapi-v2.json)
- [openapi](/docs/api-reference/openapi.json)

## Optional

- [Dashboard](https://dash.nectarclimate.com)
- [Support](mailto:support@nectarclimate.com)
- [Status](https://stats.uptimerobot.com/rICwZ0oMLI)