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.
Note: Users invited through the API must already have a Nectar account. If you provide email addresses of users who don’t exist in the system, the request will fail with a 400 error.
Team Members: All members of your team will automatically be added to the new company as admins.
Beta Features:
isDemandEnabled: Enable tracking of electricity demand meters for advanced usage analytics.
Date when data collection for the company begins. This is the date from which Nectar will pull historical data. Similar fields at the site and workflow level can override this date. Defaults to January 1st of the previous year.
Fraction used to estimate sewer usage from water usage for implied metering. If a sewage chargeis found in the data without water usage, this fraction is used to estimate the waste water usage that corresponds to the sewage charge. Defaults to 1.0.
[BETA] Enable tracking of electricity demand meters. When enabled, bills will be processed to extract demand usage data in addition to standard consumption data.
Indicates if basic identifier name mapping is enabled for the company, in which case, meter identifiers will be labeled with a limited set of identifier types. When disabled (by default), the full range of identifier types is used for labeling.
List of email addresses of users to set as company admins. If provided, these users will be added as admins along with the authenticated user. If not provided, only the authenticated user will be set as admin.
Minimum string length: 1
Response
Serializer for externally available fields of a Company object including related sites.
[BETA] Enable tracking of electricity demand meters. When enabled, bills will be processed to extract demand usage data in addition to standard consumption data.
Date when data collection for the company begins. This is the date from which Nectar will pull historical data. Similar fields at the site and workflow level can override this date. Defaults to January 1st of the previous year.
Fraction used to estimate sewer usage from water usage for implied metering. If a sewage chargeis found in the data without water usage, this fraction is used to estimate the waste water usage that corresponds to the sewage charge. Defaults to 1.0.
Indicates if basic identifier name mapping is enabled for the company, in which case, meter identifiers will be labeled with a limited set of identifier types. When disabled (by default), the full range of identifier types is used for labeling.
Indicates if a lower accuracy, fast pass mode is forced for the company. When enabled, all bills will bypass checksum validation and go directly to submission. This provides faster processing but lower accuracy.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Nectar Knowledge Base","colors":{"primary":"#092A54","light":"#3B82F6","dark":"#092A54"},"logo":{"light":"https://mintcdn.com/nectar/XTv6xdiQoWsCyg3G/logo/light.svg?fit=max\u0026auto=format\u0026n=XTv6xdiQoWsCyg3G\u0026q=85\u0026s=8b28e329f1aad1d1fbf3022d179cd34e","dark":"https://mintcdn.com/nectar/XTv6xdiQoWsCyg3G/logo/dark.svg?fit=max\u0026auto=format\u0026n=XTv6xdiQoWsCyg3G\u0026q=85\u0026s=12755083e4efe9b6e55b2f5bd4a71673"},"favicon":"https://mintcdn.com/nectar/XTv6xdiQoWsCyg3G/favicon.svg?fit=max\u0026auto=format\u0026n=XTv6xdiQoWsCyg3G\u0026q=85\u0026s=0442a8655f01c969dbb6dfb7a187d797","navbar":{"links":[{"href":"mailto:support@nectarclimate.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dash.nectarclimate.com"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/nectarclimate"}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Dashboard","icon":"gauge","href":"https://dash.nectarclimate.com"},{"anchor":"Support","icon":"envelope","href":"mailto:support@nectarclimate.com"},{"anchor":"Status","icon":"signal","href":"https://stats.uptimerobot.com/rICwZ0oMLI"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nectar","hasAudioNarration":false,"actualSubdomain":"nectar","customDomains":["nectarclimate.com"],"gitSource":{"type":"github","owner":"project-pairly","repo":"nectar","deployBranch":"production","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad6d384536dd68dd9ccfac8","collectionId":"ff45001c-a2bb-4acf-a3b6-e7a83bf9339a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad6d384536dd68dd9ccfac8"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adff6624c95040b1f492aac","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":191},{"language":"default","tag":"Knowledge Base","count":153},{"language":"default","tag":"Data Input","count":58},{"language":"default","tag":"Utility-Specific MFA Guides","count":44},{"language":"default","tag":"Connections","count":27},{"language":"default","tag":"Usage Data","count":24},{"language":"default","tag":"Webhook Payloads","count":24},{"language":"default","tag":"Developer Guide","count":18},{"language":"default","tag":"Sites","count":18},{"language":"default","tag":"Meters","count":18}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/v2-0/companies/create-company","slug":"/api-reference/v2-0/companies/create-company","pageMetadata":{"title":"Create Company","description":"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. \n\n**Note:** Users invited through the API must already have a Nectar account. If you provide email addresses of users who don't exist in the system, the request will fail with a 400 error.\n\n**Team Members:** All members of your team will automatically be added to the new company as admins.\n\n**Beta Features:**\n- `isDemandEnabled`: Enable tracking of electricity demand meters for advanced usage analytics.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json post /company","href":"/api-reference/v2-0/companies/create-company","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"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.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Note:\"\n }), \" Users invited through the API must already have a Nectar account. If you provide email addresses of users who don’t exist in the system, the request will fail with a 400 error.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Team Members:\"\n }), \" All members of your team will automatically be added to the new company as admins.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Beta Features:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"isDemandEnabled\"\n }), \": Enable tracking of electricity demand meters for advanced usage analytics.\"]\n }), \"\\n\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Company","description":"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. \n\n**Note:** Users invited through the API must already have a Nectar account. If you provide email addresses of users who don't exist in the system, the request will fail with a 400 error.\n\n**Team Members:** All members of your team will automatically be added to the new company as admins.\n\n**Beta Features:**\n- `isDemandEnabled`: Enable tracking of electricity demand meters for advanced usage analytics.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json post /company","href":"/api-reference/v2-0/companies/create-company","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"company_create","description":"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. \n\n**Note:** Users invited through the API must already have a Nectar account. If you provide email addresses of users who don't exist in the system, the request will fail with a 400 error.\n\n**Team Members:** All members of your team will automatically be added to the new company as admins.\n\n**Beta Features:**\n- `isDemandEnabled`: Enable tracking of electricity demand meters for advanced usage analytics.","summary":"Create Company","tags":["Companies"],"requestBody":"133f0eac-729e-40eb-a31f-35f04a77a8e1","security":["ac1865a7-1b9f-4828-adc9-954dfd7ea0f4"],"responses":{"201":"5a09e6ab-d3ad-449f-9135-3ead12ccb495","400":"ae5e6776-30ab-4670-a7f3-0393807182d8"},"method":"post","type":"path","servers":["7ff90826-cc44-4842-930d-97d79ccb01c7"],"path":"/company","baseUrlOptions":["https://external.nectarclimate.com/v2"],"title":"Create Company","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Serializer for creating a new Company object.","properties":{"name":{"type":"string","minLength":1,"description":"Name of the company.","maxLength":200,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"externalId":{"oneOf":[{"type":"string","description":"External identifier for the company. Used to associate company in Nectar with company within your database.","uniqueKey":"externalId.oneOf.0","typeLabel":"string"},{"type":"null","description":"External identifier for the company. Used to associate company in Nectar with company within your database.","uniqueKey":"externalId.oneOf.1","typeLabel":"null"}],"uniqueKey":"externalId","typeLabel":"string | null"},"dataCollectionStartDate":{"type":"string","format":"date","description":"Date when data collection for the company begins. This is the date from which Nectar will pull historical data. Similar fields at the site and workflow level can override this date. Defaults to January 1st of the previous year.","uniqueKey":"dataCollectionStartDate","typeLabel":"string\u003cdate>"},"isImpliedMeteringEnabled":{"type":"boolean","description":"Indicates if implied metering is enabled for the company. Defaults to False.","uniqueKey":"isImpliedMeteringEnabled","typeLabel":"boolean"},"impliedMeteringFraction":{"type":"string","format":"decimal","pattern":"^-?\\d{0,1}(?:\\.\\d{0,2})?$","description":"Fraction used to estimate sewer usage from water usage for implied metering. If a sewage chargeis found in the data without water usage, this fraction is used to estimate the waste water usage that corresponds to the sewage charge. Defaults to 1.0.","uniqueKey":"impliedMeteringFraction","typeLabel":"string\u003cdecimal>"},"isDemandEnabled":{"type":"boolean","default":false,"description":"[BETA] Enable tracking of electricity demand meters. When enabled, bills will be processed to extract demand usage data in addition to standard consumption data.","uniqueKey":"isDemandEnabled","typeLabel":"boolean"},"isBasicIdentifierMappingEnabled":{"type":"boolean","description":"Indicates if basic identifier name mapping is enabled for the company, in which case, meter identifiers will be labeled with a limited set of identifier types. When disabled (by default), the full range of identifier types is used for labeling.","uniqueKey":"isBasicIdentifierMappingEnabled","typeLabel":"boolean"},"isLowAccuracyModeEnabled":{"type":"boolean","default":false,"description":"Enable faster bill processing. When this is on, bills are processed more quickly, but with lower accuracy.","uniqueKey":"isLowAccuracyModeEnabled","typeLabel":"boolean"},"users":{"type":"array","items":{"type":"string","format":"email","minLength":1,"uniqueKey":"users.items.[INDEX]","typeLabel":"string\u003cemail>"},"description":"List of email addresses of users to set as company admins. If provided, these users will be added as admins along with the authenticated user. If not provided, only the authenticated user will be set as admin.","uniqueKey":"users","typeLabel":"string\u003cemail>[]"}},"required":["name"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","externalId":"\u003cstring>","dataCollectionStartDate":"2023-12-25","isImpliedMeteringEnabled":true,"impliedMeteringFraction":"\u003cstring>","isDemandEnabled":false,"isBasicIdentifierMappingEnabled":true,"isLowAccuracyModeEnabled":false,"users":["jsmith@example.com"]}}},"exampleType":"generated"},"application/x-www-form-urlencoded":{"schema":{"type":"object","description":"Serializer for creating a new Company object.","properties":{"name":{"type":"string","minLength":1,"description":"Name of the company.","maxLength":200,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"externalId":{"oneOf":[{"type":"string","description":"External identifier for the company. Used to associate company in Nectar with company within your database.","uniqueKey":"externalId.oneOf.0","typeLabel":"string"},{"type":"null","description":"External identifier for the company. Used to associate company in Nectar with company within your database.","uniqueKey":"externalId.oneOf.1","typeLabel":"null"}],"uniqueKey":"externalId","typeLabel":"string | null"},"dataCollectionStartDate":{"type":"string","format":"date","description":"Date when data collection for the company begins. This is the date from which Nectar will pull historical data. Similar fields at the site and workflow level can override this date. Defaults to January 1st of the previous year.","uniqueKey":"dataCollectionStartDate","typeLabel":"string\u003cdate>"},"isImpliedMeteringEnabled":{"type":"boolean","description":"Indicates if implied metering is enabled for the company. Defaults to False.","uniqueKey":"isImpliedMeteringEnabled","typeLabel":"boolean"},"impliedMeteringFraction":{"type":"string","format":"decimal","pattern":"^-?\\d{0,1}(?:\\.\\d{0,2})?$","description":"Fraction used to estimate sewer usage from water usage for implied metering. If a sewage chargeis found in the data without water usage, this fraction is used to estimate the waste water usage that corresponds to the sewage charge. Defaults to 1.0.","uniqueKey":"impliedMeteringFraction","typeLabel":"string\u003cdecimal>"},"isDemandEnabled":{"type":"boolean","default":false,"description":"[BETA] Enable tracking of electricity demand meters. When enabled, bills will be processed to extract demand usage data in addition to standard consumption data.","uniqueKey":"isDemandEnabled","typeLabel":"boolean"},"isBasicIdentifierMappingEnabled":{"type":"boolean","description":"Indicates if basic identifier name mapping is enabled for the company, in which case, meter identifiers will be labeled with a limited set of identifier types. When disabled (by default), the full range of identifier types is used for labeling.","uniqueKey":"isBasicIdentifierMappingEnabled","typeLabel":"boolean"},"isLowAccuracyModeEnabled":{"type":"boolean","default":false,"description":"Enable faster bill processing. When this is on, bills are processed more quickly, but with lower accuracy.","uniqueKey":"isLowAccuracyModeEnabled","typeLabel":"boolean"},"users":{"type":"array","items":{"type":"string","format":"email","minLength":1,"uniqueKey":"users.items.[INDEX]","typeLabel":"string\u003cemail>"},"description":"List of email addresses of users to set as company admins. If provided, these users will be added as admins along with the authenticated user. If not provided, only the authenticated user will be set as admin.","uniqueKey":"users","typeLabel":"string\u003cemail>[]"}},"required":["name"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","externalId":"\u003cstring>","dataCollectionStartDate":"2023-12-25","isImpliedMeteringEnabled":true,"impliedMeteringFraction":"\u003cstring>","isDemandEnabled":false,"isBasicIdentifierMappingEnabled":true,"isLowAccuracyModeEnabled":false,"users":["jsmith@example.com"]}}},"exampleType":"generated"},"multipart/form-data":{"schema":{"type":"object","description":"Serializer for creating a new Company object.","properties":{"name":{"type":"string","minLength":1,"description":"Name of the company.","maxLength":200,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"externalId":{"oneOf":[{"type":"string","description":"External identifier for the company. Used to associate company in Nectar with company within your database.","uniqueKey":"externalId.oneOf.0","typeLabel":"string"},{"type":"null","description":"External identifier for the company. Used to associate company in Nectar with company within your database.","uniqueKey":"externalId.oneOf.1","typeLabel":"null"}],"uniqueKey":"externalId","typeLabel":"string | null"},"dataCollectionStartDate":{"type":"string","format":"date","description":"Date when data collection for the company begins. This is the date from which Nectar will pull historical data. Similar fields at the site and workflow level can override this date. Defaults to January 1st of the previous year.","uniqueKey":"dataCollectionStartDate","typeLabel":"string\u003cdate>"},"isImpliedMeteringEnabled":{"type":"boolean","description":"Indicates if implied metering is enabled for the company. Defaults to False.","uniqueKey":"isImpliedMeteringEnabled","typeLabel":"boolean"},"impliedMeteringFraction":{"type":"string","format":"decimal","pattern":"^-?\\d{0,1}(?:\\.\\d{0,2})?$","description":"Fraction used to estimate sewer usage from water usage for implied metering. If a sewage chargeis found in the data without water usage, this fraction is used to estimate the waste water usage that corresponds to the sewage charge. Defaults to 1.0.","uniqueKey":"impliedMeteringFraction","typeLabel":"string\u003cdecimal>"},"isDemandEnabled":{"type":"boolean","default":false,"description":"[BETA] Enable tracking of electricity demand meters. When enabled, bills will be processed to extract demand usage data in addition to standard consumption data.","uniqueKey":"isDemandEnabled","typeLabel":"boolean"},"isBasicIdentifierMappingEnabled":{"type":"boolean","description":"Indicates if basic identifier name mapping is enabled for the company, in which case, meter identifiers will be labeled with a limited set of identifier types. When disabled (by default), the full range of identifier types is used for labeling.","uniqueKey":"isBasicIdentifierMappingEnabled","typeLabel":"boolean"},"isLowAccuracyModeEnabled":{"type":"boolean","default":false,"description":"Enable faster bill processing. When this is on, bills are processed more quickly, but with lower accuracy.","uniqueKey":"isLowAccuracyModeEnabled","typeLabel":"boolean"},"users":{"type":"array","items":{"type":"string","format":"email","minLength":1,"uniqueKey":"users.items.[INDEX]","typeLabel":"string\u003cemail>"},"description":"List of email addresses of users to set as company admins. If provided, these users will be added as admins along with the authenticated user. If not provided, only the authenticated user will be set as admin.","uniqueKey":"users","typeLabel":"string\u003cemail>[]"}},"required":["name"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","externalId":"\u003cstring>","dataCollectionStartDate":"2023-12-25","isImpliedMeteringEnabled":true,"impliedMeteringFraction":"\u003cstring>","isDemandEnabled":false,"isBasicIdentifierMappingEnabled":true,"isLowAccuracyModeEnabled":false,"users":["jsmith@example.com"]}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"5a09e6ab-d3ad-449f-9135-3ead12ccb495":{"content":{"application/json":{"schema":{"type":"object","description":"Serializer for externally available fields of a Company object including related sites.","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the company.","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Name of the company.","maxLength":200,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"isDemandEnabled":{"type":"boolean","description":"[BETA] Enable tracking of electricity demand meters. When enabled, bills will be processed to extract demand usage data in addition to standard consumption data.","isRequired":true,"uniqueKey":"isDemandEnabled","typeLabel":"boolean"},"sites":{"type":"array","items":{"type":"object","description":"A site associated with a company.\n\nRegular sites require a street address; a non-empty dummySiteReason marks a placeholder where address is optional.","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the site.","isRequired":true,"uniqueKey":"sites.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Name of the site.","maxLength":255,"isRequired":true,"uniqueKey":"sites.items.[INDEX].name","typeLabel":"string"},"dataCollectionStopDate":{"oneOf":[{"type":"string","format":"date","description":"Date when data collection for this site was stopped. A non-null value indicates the site has been soft-deleted/archived.","isRequired":true,"uniqueKey":"sites.items.[INDEX].dataCollectionStopDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"Date when data collection for this site was stopped. A non-null value indicates the site has been soft-deleted/archived.","isRequired":true,"uniqueKey":"sites.items.[INDEX].dataCollectionStopDate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.items.[INDEX].dataCollectionStopDate","typeLabel":"string\u003cdate> | null"},"externalId":{"oneOf":[{"type":"string","description":"ID of the site on external platforms used during exports. Used to associate site in Nectar with site within your database.","uniqueKey":"sites.items.[INDEX].externalId.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the site on external platforms used during exports. Used to associate site in Nectar with site within your database.","uniqueKey":"sites.items.[INDEX].externalId.oneOf.1","typeLabel":"null"}],"uniqueKey":"sites.items.[INDEX].externalId","typeLabel":"string | null"},"address":{"type":"string","description":"Address of the site.","maxLength":255,"uniqueKey":"sites.items.[INDEX].address","typeLabel":"string"},"path":{"type":"array","items":{"type":"string","maxLength":100,"uniqueKey":"sites.items.[INDEX].path.items.[INDEX]","typeLabel":"string"},"description":"List of location tags in increasing specificity used to filter sites. Filters must be entered from more general to more specific. E.g. ['US', 'CA', 'ON']","maxItems":10,"uniqueKey":"sites.items.[INDEX].path","typeLabel":"string[]"},"occupancyPercent":{"oneOf":[{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,4})?$","description":"Occupancy percent, must be a number from 0 to 100. Usage for the site will be multiplied by this value for specified accounts.","uniqueKey":"sites.items.[INDEX].occupancyPercent.oneOf.0","typeLabel":"string\u003cdecimal>"},{"type":"null","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,4})?$","description":"Occupancy percent, must be a number from 0 to 100. Usage for the site will be multiplied by this value for specified accounts.","uniqueKey":"sites.items.[INDEX].occupancyPercent.oneOf.1","typeLabel":"null"}],"uniqueKey":"sites.items.[INDEX].occupancyPercent","typeLabel":"string\u003cdecimal> | null"},"occupancyApplicationMode":{"type":"string","description":"Controls how occupancy percent is applied to usage data. ALL applies to all data on this site regardless of account settings. PER_ACCOUNT applies only to accounts with the occupancy override enabled. DISABLED means occupancy is never applied regardless of account settings. PER_CONNECTION is a deprecated alias for PER_ACCOUNT; reads still return it and writes still accept it.\n\n* `DISABLED` - Disabled\n* `ALL` - All\n* `PER_ACCOUNT` - Per Account\n* `PER_CONNECTION` - Per Connection (deprecated alias for Per Account)","enum":["DISABLED","ALL","PER_ACCOUNT","PER_CONNECTION"],"uniqueKey":"sites.items.[INDEX].occupancyApplicationMode","typeLabel":"enum\u003cstring>"},"dummySiteReason":{"oneOf":[{"type":"string","description":"If set, this site is a placeholder and a street address is not required. The value describes why (for example API testing, a catch-all, or a multi-address bundle). Omit or null for a regular site. Clearing it on update requires a confirmed street address.","uniqueKey":"sites.items.[INDEX].dummySiteReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"If set, this site is a placeholder and a street address is not required. The value describes why (for example API testing, a catch-all, or a multi-address bundle). Omit or null for a regular site. Clearing it on update requires a confirmed street address.","uniqueKey":"sites.items.[INDEX].dummySiteReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"sites.items.[INDEX].dummySiteReason","typeLabel":"string | null"}},"required":["dataCollectionStopDate","id","name"],"uniqueKey":"sites.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"sites","typeLabel":"object[]"},"users":{"type":"array","items":{"type":"string","uniqueKey":"users.items.[INDEX]","typeLabel":"string"},"description":"List of user email addresses associated with the company.","isRequired":true,"uniqueKey":"users","typeLabel":"string[]"},"externalId":{"oneOf":[{"type":"string","description":"External identifier for the company. Used to associate company in Nectar with company within your database.","uniqueKey":"externalId.oneOf.0","typeLabel":"string"},{"type":"null","description":"External identifier for the company. Used to associate company in Nectar with company within your database.","uniqueKey":"externalId.oneOf.1","typeLabel":"null"}],"uniqueKey":"externalId","typeLabel":"string | null"},"dataCollectionStartDate":{"type":"string","format":"date","description":"Date when data collection for the company begins. This is the date from which Nectar will pull historical data. Similar fields at the site and workflow level can override this date. Defaults to January 1st of the previous year.","uniqueKey":"dataCollectionStartDate","typeLabel":"string\u003cdate>"},"isImpliedMeteringEnabled":{"type":"boolean","description":"Indicates if implied metering is enabled for the company. Defaults to False.","uniqueKey":"isImpliedMeteringEnabled","typeLabel":"boolean"},"impliedMeteringFraction":{"type":"string","format":"decimal","pattern":"^-?\\d{0,1}(?:\\.\\d{0,2})?$","description":"Fraction used to estimate sewer usage from water usage for implied metering. If a sewage chargeis found in the data without water usage, this fraction is used to estimate the waste water usage that corresponds to the sewage charge. Defaults to 1.0.","uniqueKey":"impliedMeteringFraction","typeLabel":"string\u003cdecimal>"},"isBasicIdentifierMappingEnabled":{"type":"boolean","description":"Indicates if basic identifier name mapping is enabled for the company, in which case, meter identifiers will be labeled with a limited set of identifier types. When disabled (by default), the full range of identifier types is used for labeling.","uniqueKey":"isBasicIdentifierMappingEnabled","typeLabel":"boolean"},"isLowAccuracyModeEnabled":{"type":"boolean","description":"Indicates if a lower accuracy, fast pass mode is forced for the company. When enabled, all bills will bypass checksum validation and go directly to submission. This provides faster processing but lower accuracy.","uniqueKey":"isLowAccuracyModeEnabled","typeLabel":"boolean"}},"required":["id","isDemandEnabled","name","sites","users"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","isDemandEnabled":true,"sites":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","dataCollectionStopDate":"2023-12-25","externalId":"\u003cstring>","address":"\u003cstring>","path":["\u003cstring>"],"occupancyPercent":"\u003cstring>","occupancyApplicationMode":"DISABLED","dummySiteReason":"\u003cstring>"}],"users":["\u003cstring>"],"externalId":"\u003cstring>","dataCollectionStartDate":"2023-12-25","isImpliedMeteringEnabled":true,"impliedMeteringFraction":"\u003cstring>","isBasicIdentifierMappingEnabled":true,"isLowAccuracyModeEnabled":true}}},"exampleType":"generated"}},"description":"","exampleType":"generated"},"ae5e6776-30ab-4670-a7f3-0393807182d8":{"content":{"application/json":{"schema":{"type":"object","description":"Serializer for error responses.","properties":{"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>","error":"\u003cstring>"}}},"exampleType":"generated"}},"description":"","exampleType":"generated"}},"security":{"ac1865a7-1b9f-4828-adc9-954dfd7ea0f4":{"ExternalAuthentication":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[]}}},"servers":{"7ff90826-cc44-4842-930d-97d79ccb01c7":{"url":"https://external.nectarclimate.com/v2","description":"Nectar API Server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[]},"schema":{"title":"X-API-KEY","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ExternalAuthentication","name":"X-API-KEY"}],"title":"ExternalAuthentication"}]},"originalFileLocation":"api-reference/openapi-v2.json"},"subdomain":"nectar","siteName":"Nectar Knowledge Base","title":"Create Company - Nectar Knowledge Base","navMaps":{"firstHrefInVersion":{"v2.2":{"href":"/api-reference/v2-2/companies/create-company","matchLevel":1},"v2.1":{"href":"/api-reference/v2-1/companies/create-company","matchLevel":1},"v2.0":{"href":"/api-reference/v2-0/companies/create-company","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-09-29T02:18:56.221Z","originalFileLocation":"api-reference/v2-0/companies/create-company.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"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. Note: Users invited through the API must already have a Nectar account. If you provide email addresses of users who don\u0026#x27;t exist in the system, the request will fail with a 400 error. Team Members: All members of your team will automatically be added to the new company as admins. Beta Features: - isDemandEnabled: Enable tracking of electricity demand meters for advanced usage analytics.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Nectar Knowledge Base\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/nectar/gZW-eyAyHdprqGVs/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/nectar/gZW-eyAyHdprqGVs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/nectar/gZW-eyAyHdprqGVs/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/nectar/gZW-eyAyHdprqGVs/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/nectar/gZW-eyAyHdprqGVs/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/nectar/gZW-eyAyHdprqGVs/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/nectar/gZW-eyAyHdprqGVs/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/nectar/gZW-eyAyHdprqGVs/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/nectar/gZW-eyAyHdprqGVs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Company - Nectar Knowledge Base\">\u003cmeta data-mint-head property=\"og:description\" content=\"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. Note: Users invited through the API must already have a Nectar account. If you provide email addresses of users who don\u0026#x27;t exist in the system, the request will fail with a 400 error. Team Members: All members of your team will automatically be added to the new company as admins. Beta Features: - isDemandEnabled: Enable tracking of electricity demand meters for advanced usage analytics.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Nectar Knowledge Base\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://nectarclimate.com/docs/api-reference/v2-0/companies/create-company\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://nectar.mintlify.app/_mintlify/api/og/v2?division=Companies\u0026amp;title=Create+Company\u0026amp;description=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\u0026amp;theme=d6f36af3d51813e1674f4062\u0026amp;signature=49076bf6ac0bf08e31bcc40ce419b47bd80fa35816312f693ce842619d504ca5\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create Company - Nectar Knowledge Base\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"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. Note: Users invited through the API must already have a Nectar account. If you provide email addresses of users who don\u0026#x27;t exist in the system, the request will fail with a 400 error. Team Members: All members of your team will automatically be added to the new company as admins. Beta Features: - isDemandEnabled: Enable tracking of electricity demand meters for advanced usage analytics.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nectar.mintlify.app/_mintlify/api/og/v2?division=Companies\u0026amp;title=Create+Company\u0026amp;description=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\u0026amp;theme=d6f36af3d51813e1674f4062\u0026amp;signature=49076bf6ac0bf08e31bcc40ce419b47bd80fa35816312f693ce842619d504ca5\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/nectar/gZW-eyAyHdprqGVs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Nectar Knowledge Base\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#092A54\">\u003clink data-mint-head rel=\"canonical\" href=\"https://nectarclimate.com/docs/api-reference/v2-0/companies/create-company\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/v2-0/companies/create-company.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://nectarclimate.com/#organization\",\"name\":\"Nectar Knowledge Base\",\"url\":\"https://nectarclimate.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/nectar/XTv6xdiQoWsCyg3G/logo/light.svg?fit=max\u0026auto=format\u0026n=XTv6xdiQoWsCyg3G\u0026q=85\u0026s=8b28e329f1aad1d1fbf3022d179cd34e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://nectarclimate.com/docs#website\",\"name\":\"Nectar Knowledge Base\",\"url\":\"https://nectarclimate.com/docs\",\"publisher\":{\"@id\":\"https://nectarclimate.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://nectarclimate.com/docs/api-reference/v2-0/companies/create-company#webpage\",\"url\":\"https://nectarclimate.com/docs/api-reference/v2-0/companies/create-company\",\"name\":\"Create Company\",\"description\":\"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. Note: Users invited through the API must already have a Nectar account. If you provide email addresses of users who don't exist in the system, the request will fail with a 400 error. Team Members: All members of your team will automatically be added to the new company as admins. Beta Features: - isDemandEnabled: Enable tracking of electricity demand meters for advanced usage analytics.\",\"dateModified\":\"2026-09-29T02:18:56.221Z\",\"isPartOf\":{\"@id\":\"https://nectarclimate.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://nectarclimate.com/docs/api-reference/v2-0/companies/create-company#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://nectarclimate.com/docs/api-reference/v2-0/companies/create-company#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Companies\",\"item\":\"https://nectarclimate.com/docs/api-reference/v2-0/companies/retrieve-companies\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Company\",\"item\":\"https://nectarclimate.com/docs/api-reference/v2-0/companies/create-company\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://nectarclimate.com/docs/api-reference/v2-0/companies/create-company#apireference\",\"headline\":\"Create Company\",\"name\":\"Create Company\",\"description\":\"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. Note: Users invited through the API must already have a Nectar account. If you provide email addresses of users who don't exist in the system, the request will fail with a 400 error. Team Members: All members of your team will automatically be added to the new company as admins. Beta Features: - isDemandEnabled: Enable tracking of electricity demand meters for advanced usage analytics.\",\"url\":\"https://nectarclimate.com/docs/api-reference/v2-0/companies/create-company\",\"mainEntityOfPage\":{\"@id\":\"https://nectarclimate.com/docs/api-reference/v2-0/companies/create-company#webpage\"},\"dateModified\":\"2026-09-29T02:18:56.221Z\",\"publisher\":{\"@id\":\"https://nectarclimate.com/#organization\"},\"isPartOf\":{\"@id\":\"https://nectarclimate.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Nectar Knowledge Base\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Nectar Knowledge Base","nav":{"global":{"anchors":[{"anchor":"Dashboard","icon":"gauge","href":"https://dash.nectarclimate.com"},{"anchor":"Support","icon":"envelope","href":"mailto:support@nectarclimate.com"},{"anchor":"Status","icon":"signal","href":"https://stats.uptimerobot.com/rICwZ0oMLI"}]},"tabs":[{"tab":"Knowledge Base","pages":[{"title":"Knowledge Base","href":""}]},{"tab":"Developer Guide","pages":[{"title":"Developer Guide","href":"/developer-guide/for-developers"}]},{"tab":"API Reference","versions":[{"version":"v2.2","pages":[{"title":"v2.2","href":"/api-reference/v2-2/companies/create-company"}]},{"version":"v2.1","pages":[{"title":"v2.1","href":"/api-reference/v2-1/companies/create-company"}]},{"version":"v2.0","groups":[{"group":"Accounts","pages":[{"title":"Update an account","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json patch /account/{account_id}","href":"/api-reference/v2-0/accounts/update-an-account"},{"title":"Bulk update accounts for a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json patch /account/bulk","href":"/api-reference/v2-0/accounts/bulk-update-accounts-for-a-company"}]},{"group":"Companies","pages":[{"title":"Retrieve Companies","description":"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.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /company","href":"/api-reference/v2-0/companies/retrieve-companies"},{"title":"Create Company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json post /company","href":"/api-reference/v2-0/companies/create-company"},{"title":"Get Company Details","description":"Fetch the details of a specific company by its ID.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /company/{company_id}","href":"/api-reference/v2-0/companies/get-company-details"},{"title":"Delete Company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json delete /company/{company_id}","href":"/api-reference/v2-0/companies/delete-company"},{"title":"Update Company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json patch /company/{company_id}","href":"/api-reference/v2-0/companies/update-company"}]},{"group":"Webhook Portal","pages":[{"title":"Get Webhook Settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /configure_webhook","href":"/api-reference/v2-0/webhook-portal/get-webhook-settings"},{"title":"Webhook Portal","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json post /configure_webhook","href":"/api-reference/v2-0/webhook-portal/webhook-portal"},{"title":"Update Webhook Settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json patch /configure_webhook","href":"/api-reference/v2-0/webhook-portal/update-webhook-settings"}]},{"group":"Connections","pages":[{"title":"Create Magic Link for Updating a Utility Account Connection","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.json get /connection/{connection_id}","href":"/api-reference/v2-0/connections/create-magic-link-for-updating-a-utility-account-connection"},{"title":"Get an Utility Account Connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /connection/{connection_id}/details","href":"/api-reference/v2-0/connections/get-an-utility-account-connection"},{"title":"Update an Utility Account Connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json patch /connection/{connection_id}/details","href":"/api-reference/v2-0/connections/update-an-utility-account-connection"},{"title":"Confirm a utility account connection for a company.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json patch /connection/{connection_id}/status","href":"/api-reference/v2-0/connections/confirm-a-utility-account-connection-for-a-company"},{"title":"Get Company Utility Account Connections","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /connection/company/{company_id}","href":"/api-reference/v2-0/connections/get-company-utility-account-connections"},{"title":"Create Basic Utility Account Connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json post /connection/company/{company_id}","href":"/api-reference/v2-0/connections/create-basic-utility-account-connection"},{"title":"Create Magic Link for Creating a Utility Account Connection","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.json get /connection/company/{company_id}/link","href":"/api-reference/v2-0/connections/create-magic-link-for-creating-a-utility-account-connection"},{"title":"Create Magic Link with Prefilled Data for Creating a Utility Account Connection","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.json post /connection/company/{company_id}/link","href":"/api-reference/v2-0/connections/create-magic-link-with-prefilled-data-for-creating-a-utility-account-connection"},{"title":"Search Utility Providers","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /datasource","href":"/api-reference/v2-0/connections/search-utility-providers"}]},{"group":"Documents","pages":[{"title":"Get Document Details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /document/{document_id}","href":"/api-reference/v2-0/documents/get-document-details"},{"title":"Update Document Details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json patch /document/{document_id}","href":"/api-reference/v2-0/documents/update-document-details"},{"title":"Get Demand Meters by Document","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /document/{document_id}/demandmeters","href":"/api-reference/v2-0/documents/get-demand-meters-by-document"},{"title":"Get Documents by Company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /document/company/{company_id}","href":"/api-reference/v2-0/documents/get-documents-by-company"},{"title":"Get Documents by Connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /document/connection/{connection_id}","href":"/api-reference/v2-0/documents/get-documents-by-connection"},{"title":"Get Documents by Site","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /document/site/{site_id}","href":"/api-reference/v2-0/documents/get-documents-by-site"}]},{"group":"Intervals","pages":[{"title":"Get Intervals by Connection (BETA)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /interval/connection/{connection_id}","href":"/api-reference/v2-0/intervals/get-intervals-by-connection-beta"}]},{"group":"Invitations","pages":[{"title":"Get Invitation Detail","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /invitation/{invitation_id}","href":"/api-reference/v2-0/invitations/get-invitation-detail"},{"title":"Revoke Invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json post /invitation/{invitation_id}/revoke","href":"/api-reference/v2-0/invitations/revoke-invitation"},{"title":"List Invitations by Company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /invitation/company/{company_id}","href":"/api-reference/v2-0/invitations/list-invitations-by-company"},{"title":"Create Connection Invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json post /invitation/company/{company_id}","href":"/api-reference/v2-0/invitations/create-connection-invitation"},{"title":"Create Reconnect Invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json post /invitation/connection/{connection_id}","href":"/api-reference/v2-0/invitations/create-reconnect-invitation"}]},{"group":"Jobs","pages":[{"title":"Get Job Status Details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /job/{job_id}","href":"/api-reference/v2-0/jobs/get-job-status-details"},{"title":"Submit Job via Single Document Upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json post /job/company/{company_id}","href":"/api-reference/v2-0/jobs/submit-job-via-single-document-upload"},{"title":"Submit Job via Bulk Document Upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json post /job/company/{company_id}/bulk","href":"/api-reference/v2-0/jobs/submit-job-via-bulk-document-upload"}]},{"group":"Meters","pages":[{"title":"Get Meter Details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /meter/{meter_id}","href":"/api-reference/v2-0/meters/get-meter-details"},{"title":"Update Meter Details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json patch /meter/{meter_id}","href":"/api-reference/v2-0/meters/update-meter-details"},{"title":"Get Meters by Company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /meter/company/{company_id}","href":"/api-reference/v2-0/meters/get-meters-by-company"},{"title":"Get Meters by Connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /meter/connection/{connection_id}","href":"/api-reference/v2-0/meters/get-meters-by-connection"},{"title":"Get Meters by Document","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /meter/document/{document_id}","href":"/api-reference/v2-0/meters/get-meters-by-document"},{"title":"Get Meters by Site","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /meter/site/{site_id}","href":"/api-reference/v2-0/meters/get-meters-by-site"}]},{"group":"Ping","pages":[{"title":"Ping Test Endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /ping","href":"/api-reference/v2-0/ping/ping-test-endpoint"}]},{"group":"Sites","pages":[{"title":"Get Site Details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /site/{site_id}","href":"/api-reference/v2-0/sites/get-site-details"},{"title":"Delete Site","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json delete /site/{site_id}","href":"/api-reference/v2-0/sites/delete-site"},{"title":"Update Site","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json patch /site/{site_id}","href":"/api-reference/v2-0/sites/update-site"},{"title":"Get Sites by Company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /site/company/{company_id}","href":"/api-reference/v2-0/sites/get-sites-by-company"},{"title":"Create Site","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json post /site/company/{company_id}","href":"/api-reference/v2-0/sites/create-site"}]},{"group":"Team","pages":[{"title":"Get Team and Billing Information","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /team","href":"/api-reference/v2-0/team/get-team-and-billing-information"},{"title":"Update Team and Billing Information","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json patch /team","href":"/api-reference/v2-0/team/update-team-and-billing-information"}]},{"group":"Usage Data","pages":[{"title":"Get Usage Data Details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /usage/{msud_id}","href":"/api-reference/v2-0/usage-data/get-usage-data-details"},{"title":"Delete Usage Data","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json delete /usage/{msud_id}","href":"/api-reference/v2-0/usage-data/delete-usage-data"},{"title":"Update Usage Data","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json patch /usage/{msud_id}","href":"/api-reference/v2-0/usage-data/update-usage-data"},{"title":"Get Usage Data by Company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /usage/company/{company_id}","href":"/api-reference/v2-0/usage-data/get-usage-data-by-company"},{"title":"Get Usage Data by Utility Connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /usage/connection/{connection_id}","href":"/api-reference/v2-0/usage-data/get-usage-data-by-utility-connection"},{"title":"Get Usage Data by Document","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /usage/document/{document_id}","href":"/api-reference/v2-0/usage-data/get-usage-data-by-document"},{"title":"Get Usage Data by Meter","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /usage/meter/{meter_id}","href":"/api-reference/v2-0/usage-data/get-usage-data-by-meter"},{"title":"Get Usage Data by Site","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /usage/site/{site_id}","href":"/api-reference/v2-0/usage-data/get-usage-data-by-site"}]},{"group":"Webhook Payloads","pages":[{"title":"Webhook for utility account connection creation v2","version":null,"deprecated":null,"openapi":"/api-reference/openapi-v2.json webhook connection.created.v2","href":"/api-reference/v2-0/webhook-payloads/webhook-for-utility-account-connection-creation-v2"},{"title":"Webhook for updates to an existing utility account connection v2","version":null,"deprecated":null,"openapi":"/api-reference/openapi-v2.json webhook connection.updated.v2","href":"/api-reference/v2-0/webhook-payloads/webhook-for-updates-to-an-existing-utility-account-connection-v2"},{"title":"Webhook for connection status changes v2","version":null,"deprecated":null,"openapi":"/api-reference/openapi-v2.json webhook connection.validated.v2","href":"/api-reference/v2-0/webhook-payloads/webhook-for-connection-status-changes-v2"},{"title":"Webhook for new document availability v2","version":null,"deprecated":null,"openapi":"/api-reference/openapi-v2.json webhook document.created.v2","href":"/api-reference/v2-0/webhook-payloads/webhook-for-new-document-availability-v2"},{"title":"Webhook for document update v2","version":null,"deprecated":null,"openapi":"/api-reference/openapi-v2.json webhook document.updated.v2","href":"/api-reference/v2-0/webhook-payloads/webhook-for-document-update-v2"},{"title":"Webhook for document deletion v2","version":null,"deprecated":null,"openapi":"/api-reference/openapi-v2.json webhook document.deleted.v2","href":"/api-reference/v2-0/webhook-payloads/webhook-for-document-deletion-v2"},{"title":"Webhook for synced interval data","version":null,"deprecated":null,"openapi":"/api-reference/openapi-v2.json webhook intervals.synced","href":"/api-reference/v2-0/webhook-payloads/webhook-for-synced-interval-data"},{"title":"Webhook for document upload job completion","version":null,"deprecated":null,"openapi":"/api-reference/openapi-v2.json webhook job.completed.v2","href":"/api-reference/v2-0/webhook-payloads/webhook-for-document-upload-job-completion"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Create Company - Nectar Knowledge Base","buildId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","deploymentId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bg4Z7D_G.js","utils-Biz734EK.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C6F9YHs6.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BoJjY_VP.js","snippetPresets-CnZ-mOFh.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-DC_SB2pp.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BYKtOiIP.js","shallow-COAac_UD.js","getApiPlaygroundDisplay-BV4Viqi2.js","CodeSnippet-DDgW-JXl.js","CodeSnippets-CP1LpNhG.js","Page-BeiUfucV.js","getPastedJson-Cvgvbfmv.js","icon-D-H368xH.js","MethodPill-CXSxH1VW.js","DuplicateIcon-JcbBzF1x.js","createIcon-BDt_aHZM.js","DynamicMarkdown-DO1Fz7ar.js","SectionHeading-mwKBArs3.js","axios-vUo_bRtp.js","Markdown-C3KUTGJN.js","clsx-C6CAjViH.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C3vb5JQZ.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C8Hisf3g.js"]}