producers
Get v3producers contracts
Returns master data of the contract
GET
/
v3
/
producers
/
{userID}
/
contracts
/
{contractID}
/
cURL
curl --request GET \
--url https://api.lumenaza.de/v3/producers/{userID}/contracts/{contractID}/import requests
url = "https://api.lumenaza.de/v3/producers/{userID}/contracts/{contractID}/"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.lumenaza.de/v3/producers/{userID}/contracts/{contractID}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lumenaza.de/v3/producers/{userID}/contracts/{contractID}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.lumenaza.de/v3/producers/{userID}/contracts/{contractID}/"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.lumenaza.de/v3/producers/{userID}/contracts/{contractID}/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lumenaza.de/v3/producers/{userID}/contracts/{contractID}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"saas_contract_id": "<string>",
"meter_id": [
"<string>"
],
"preferred_delivery_start": "2023-12-25",
"previous_provider": "<string>",
"subscription_reason": "<string>",
"reg_status": "in_revocation_period",
"order_date": "2023-12-25",
"market_location": "<string>",
"sepa_reference": "<string>",
"tax_number": "<string>",
"network_provider": {
"mpid": "<string>",
"company_name": "<string>"
},
"meter_operator": {
"mpid": "<string>",
"company_name": "<string>"
},
"is_business": true,
"email": "jsmith@example.com",
"salespartner_id": "<string>",
"third_party_salespartner": "<string>",
"saas_customer_id": "<string>",
"username": "<string>",
"delivery_end": "2023-12-25",
"delivery_start": "2023-12-25",
"deliv_status": "<string>",
"contract_parameters": "<unknown>",
"tariff_type": [
"<string>"
],
"timeseries_category": "<string>",
"deliv_address_street": "<string>",
"deliv_address_house_number": "<string>",
"deliv_address_zipcode": "<string>",
"deliv_address_city": "<string>",
"deliv_address_addition": "<string>",
"annual_consumption": 123,
"status_info": "<string>",
"contract_termination_date": "2023-12-25",
"bank_data_first_name": "<string>",
"bank_data_last_name": "<string>",
"bank_data_iban": "<string>",
"bank_data_bic": "<string>",
"payment_method": "credit_card_display_only",
"sepa_date": "2023-12-25",
"bill_address_street": "<string>",
"bill_address_house_number": "<string>",
"bill_address_zipcode": "<string>",
"bill_address_city": "<string>",
"bill_address_addition": "<string>",
"custom_name": "<string>",
"redispatch_included": true,
"first_name": "<string>",
"last_name": "<string>",
"company_name": "<string>",
"telephone": "<string>",
"accounting_email": "jsmith@example.com",
"is_small_business": true,
"salutation": "Frau",
"name_title": "Dr.",
"masked_credit_card": "<string>",
"credit_card_validity_date": "2023-12-25",
"bill_address_post_box": "<string>",
"contract_termination_reason": "E01",
"is_consumer": true,
"planned_annual_production": 123
}{
"detail": "<string>"
}Response
Serializer for the fully assembled producer contract response.
in_revocation_period- in Widerrufsfristopen_join_private- neue Quartier-Vertragsbeziehungopen_join- neue Vertragsbeziehungpending_join- Kündigung versandtopen_subscribe- Wechsel akzeptiertpending_subscribe- in Anmeldungclosed_join_incomplete- Vertrag angemeldet (Daten unvollständig)closed_join- Vertrag angemeldetclosed_join_private- Quartier-Vertrag angemeldeton_hold- Prozess angehaltenrevoked- Vertrag widerrufenawaiting_meter_installation- in Erwartung des Zählereinbausclosed_leave- Vertrag abgemeldetopen_unsubscribe- Kündigung durch uns akzeptiertpending_unsubscribe- in Abmeldungunsubscribe_received- Abmeldung erhaltenunsubscribe_rejected- Abmeldung abgelehntopen_leave- Kunde hat Vertrag gekündigtpending_move- Umzug mitgeteiltaccounting_only- Vertrag zur Bilanzierungunpaused- Vertrag wiederaufgenommen
Available options:
in_revocation_period, open_join_private, open_join, pending_join, open_subscribe, pending_subscribe, closed_join_incomplete, closed_join, closed_join_private, on_hold, revoked, awaiting_meter_installation, closed_leave, open_unsubscribe, pending_unsubscribe, unsubscribe_received, unsubscribe_rejected, open_leave, pending_move, accounting_only, unpaused The compact market-partner object returned in contract detail payloads.
Show child attributes
Show child attributes
The compact market-partner object returned in contract detail payloads.
Show child attributes
Show child attributes
Maximum string length:
254Maximum string length:
70Maximum string length:
35Maximum string length:
17Maximum string length:
35Maximum string length:
50Maximum string length:
128Maximum string length:
128Maximum string length:
34Maximum string length:
11credit_card_display_only- Kreditkarte (nur Anzeige)direct_debit- SEPA Einzugsermächtigungbank_transfer- Überweisungcredit_card- Kreditkarteno_payment_method- Keine Zahlmethode
Available options:
credit_card_display_only, direct_debit, bank_transfer, credit_card, no_payment_method Maximum string length:
70Maximum string length:
35Maximum string length:
17Maximum string length:
35Maximum string length:
50Maximum string length:
100Maximum string length:
255Maximum string length:
255Maximum string length:
256Maximum string length:
32Maximum string length:
254Frau- FrauHerr- HerrEheleute- EheleuteDivers- Divers
Available options:
Frau, Herr, Eheleute, Divers - `` - Titel
Dr.- Dr.Prof.- Prof.Prof. Dr.- Prof. Dr.
Available options:
Dr., Prof., Prof. Dr. Make sure that no more than 4 trailing digits are included! The rest of the space may be used for decorative purpose.
Maximum string length:
16Commonly notated as MM/YY on a payment card; Please find the last day of that month.
Maximum string length:
64contract_termination_reason
Kündigungsgrund · enum<string>Kündigungsgrund · enum<string>Kündigungsgrund · any
E01- Einzug-/Auszug (Umzug) (E01)E03- Wechsel (E03)ZT4- Ende wegen Kündigung durch LF (ZT4)ZT5- Ende wegen Kündigung durch Kunde/LFN (ZT5)Z33- Auszug/Stilllegung (Z33)Z41- Ende der ESV ohne Folgelieferung (Z41)ZG9- Aufhebung einer zukünftigen Zuordnung wegen Auszug des Kunden (ZG9)ZH1- Aufhebung einer zukünftigen Zuordnung wegen Stilllegung (ZH1)ZH2- Aufhebung einer zukünftigen Zuordnung wegen aufgehobenem Vertragsverhältnis (ZH2)
Available options:
E01, E03, ZT4, ZT5, Z33, Z41, ZG9, ZH1, ZH2 ⌘I
cURL
curl --request GET \
--url https://api.lumenaza.de/v3/producers/{userID}/contracts/{contractID}/import requests
url = "https://api.lumenaza.de/v3/producers/{userID}/contracts/{contractID}/"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.lumenaza.de/v3/producers/{userID}/contracts/{contractID}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lumenaza.de/v3/producers/{userID}/contracts/{contractID}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.lumenaza.de/v3/producers/{userID}/contracts/{contractID}/"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.lumenaza.de/v3/producers/{userID}/contracts/{contractID}/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lumenaza.de/v3/producers/{userID}/contracts/{contractID}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"saas_contract_id": "<string>",
"meter_id": [
"<string>"
],
"preferred_delivery_start": "2023-12-25",
"previous_provider": "<string>",
"subscription_reason": "<string>",
"reg_status": "in_revocation_period",
"order_date": "2023-12-25",
"market_location": "<string>",
"sepa_reference": "<string>",
"tax_number": "<string>",
"network_provider": {
"mpid": "<string>",
"company_name": "<string>"
},
"meter_operator": {
"mpid": "<string>",
"company_name": "<string>"
},
"is_business": true,
"email": "jsmith@example.com",
"salespartner_id": "<string>",
"third_party_salespartner": "<string>",
"saas_customer_id": "<string>",
"username": "<string>",
"delivery_end": "2023-12-25",
"delivery_start": "2023-12-25",
"deliv_status": "<string>",
"contract_parameters": "<unknown>",
"tariff_type": [
"<string>"
],
"timeseries_category": "<string>",
"deliv_address_street": "<string>",
"deliv_address_house_number": "<string>",
"deliv_address_zipcode": "<string>",
"deliv_address_city": "<string>",
"deliv_address_addition": "<string>",
"annual_consumption": 123,
"status_info": "<string>",
"contract_termination_date": "2023-12-25",
"bank_data_first_name": "<string>",
"bank_data_last_name": "<string>",
"bank_data_iban": "<string>",
"bank_data_bic": "<string>",
"payment_method": "credit_card_display_only",
"sepa_date": "2023-12-25",
"bill_address_street": "<string>",
"bill_address_house_number": "<string>",
"bill_address_zipcode": "<string>",
"bill_address_city": "<string>",
"bill_address_addition": "<string>",
"custom_name": "<string>",
"redispatch_included": true,
"first_name": "<string>",
"last_name": "<string>",
"company_name": "<string>",
"telephone": "<string>",
"accounting_email": "jsmith@example.com",
"is_small_business": true,
"salutation": "Frau",
"name_title": "Dr.",
"masked_credit_card": "<string>",
"credit_card_validity_date": "2023-12-25",
"bill_address_post_box": "<string>",
"contract_termination_reason": "E01",
"is_consumer": true,
"planned_annual_production": 123
}{
"detail": "<string>"
}
