curl "https://api.dcycle.io/v2/suppliers?supplier_type=electricity&country=ES" \
-H "x-api-key: ${DCYCLE_API_KEY}" \
-H "x-organization-id: ${DCYCLE_ORG_ID}"
{
"suppliers": [
{
"id": "5f4e3d2c-1b0a-4f9e-8d7c-6b5a4f3e2d1c",
"name": "Example Energía",
"type": "electricity",
"country": "ES",
"enable": true,
"organization_id": null
}
],
"total": 1
}
List Suppliers (v2)
The energy suppliers your organization can use: the ids for supplier_id on electricity and district heating or cooling invoices
GET
/
v2
/
suppliers
curl "https://api.dcycle.io/v2/suppliers?supplier_type=electricity&country=ES" \
-H "x-api-key: ${DCYCLE_API_KEY}" \
-H "x-organization-id: ${DCYCLE_ORG_ID}"
{
"suppliers": [
{
"id": "5f4e3d2c-1b0a-4f9e-8d7c-6b5a4f3e2d1c",
"name": "Example Energía",
"type": "electricity",
"country": "ES",
"enable": true,
"organization_id": null
}
],
"total": 1
}
← Invoices API
List the suppliers your organization can use: Dcycle’s official suppliers plus the custom ones of your organization
and the organizations above and below it. Use their
Fuels, water, refrigerants and process invoices take no supplier.
id as supplier_id in
electricity,
district heating and
district cooling invoices. Each route only accepts suppliers of
its own type, so filter by supplier_type:
| Invoice route | supplier_type |
|---|---|
POST /v2/invoices/electricity | electricity |
POST /v2/invoices/district-heating | heat_steam |
POST /v2/invoices/district-cooling | cooling |
curl "https://api.dcycle.io/v2/suppliers?supplier_type=electricity&country=ES" \
-H "x-api-key: ${DCYCLE_API_KEY}" \
-H "x-organization-id: ${DCYCLE_ORG_ID}"
{
"suppliers": [
{
"id": "5f4e3d2c-1b0a-4f9e-8d7c-6b5a4f3e2d1c",
"name": "Example Energía",
"type": "electricity",
"country": "ES",
"enable": true,
"organization_id": null
}
],
"total": 1
}
Request
Headers
string
required
Your API key (see Authentication).
string
required
Your organization UUID. It decides which custom suppliers are listed.
Query Parameters
string
electricity, heat_steam, cooling, water or heat. See the table above for the one each invoice route takes.string
ISO 3166-1 alpha-2 country code, e.g.
ES: the supplier’s country.boolean
Only enabled (
true) or disabled (false) suppliers.Response
array[object]
Show supplier
Show supplier
integer
The number of suppliers listed.
Related Endpoints
Create Electricity Invoices (v2)
Uses
supplier_type=electricityCreate District Heating Invoices (v2)
Uses
supplier_type=heat_steamCreate District Cooling Invoices (v2)
Uses
supplier_type=coolingInvoices API
Which route for which consumption
Was this page helpful?