Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.neuro-tech.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoints

MethodPathPurpose
POST/co2-customer/createCreate or update a climate customer profile
GET/co2-customer/profile/reference/{external_reference}Retrieve a profile by external reference
GET/co2-customer/profile/cid/{cid}Retrieve a profile by customer CID

​
Create customer profile

POST /co2-customer/create

​
Request body

{
  "email": "climate@example.com",
  "first_name": "Ada",
  "last_name": "Lovelace",
  "customer_type": "private",
  "accumulation_period": "monthly",
  "external_reference": [
    {
      "reference": "crm-123",
      "name": "CRM"
    }
  ]
}

​
Common fields

FieldTypeRequiredNotes
emailstringyesContact email for the profile
first_namestringnoUsed for private customers
last_namestringnoUsed for private customers
business_namestringnoUsed for company customers
customer_typestringnoprivate or corporate
organization_numberstringnoOrganization identifier
external_referencestring or arraynoA comma-separated string or an array of {reference, name} objects
accumulation_periodstringnodefault, direct, daily, weekly, monthly, quarterly, or yearly
If a matching profile already exists for your company, this request updates the existing profile instead of creating a duplicate.

​
Response shape

{
  "customer_id": "co2_profile_cid",
  "externalReference": [
    {
      "reference": "crm-123",
      "name": "CRM"
    }
  ],
  "first_name": "Ada",
  "last_name": "Lovelace",
  "business_name": null,
  "organization_number": null,
  "email": "climate@example.com",
  "customer_type": "private",
  "price_contract_id": 123,
  "unit_price": 1.25,
  "currency_id": "SEK",
  "unit": "Kg",
  "template_contract_id": 45,
  "accumulation_period": "monthly"
}

​
Retrieve by external reference

GET /co2-customer/profile/reference/{external_reference} Returns the same profile shape shown above.

​
Retrieve by CID

GET /co2-customer/profile/cid/{cid} Returns the same profile shape shown above.