user_documents
Retrieve Contract Details
Returns detailed information for invoices.
GET
/
v3
/
user_documents
/
{userID}
/
contracts
/
{contractID}
/
Retrieve Contract Details
curl --request GET \
--url https://api.lumenaza.de/v3/user_documents/{userID}/contracts/{contractID}/import requests
url = "https://api.lumenaza.de/v3/user_documents/{userID}/contracts/{contractID}/"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.lumenaza.de/v3/user_documents/{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/user_documents/{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/user_documents/{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/user_documents/{userID}/contracts/{contractID}/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lumenaza.de/v3/user_documents/{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[
{
"inv_type": "Abschlagsneuberechnung",
"doc_url": "<string>",
"period_end_bill_date": "2023-12-25",
"period_start_bill_date": "2023-12-25",
"invoice_amount_gross": 123,
"invoice_amount_net": 123,
"transfer_amount": 123,
"is_cancellation": true,
"energy_amount": 123,
"payment_method": "<string>",
"payment_status": "<string>",
"due_date": "2023-12-25",
"paid_amount": 123,
"dunning_level": 123,
"inv_number": "<string>",
"inv_date": "2023-12-25"
}
]Response
200 - application/json
Abschlagsneuberechnung- AbschlagsneuberechnungEndabrechnung- EndabrechnungNeue_Endabrechnung- Neue_EndabrechnungStorno_Endabrechnung- Storno_EndabrechnungEinspeisung- EinspeisungStorno_Einspeisung- Storno_EinspeisungJahresrechnung- JahresrechnungNeue_Jahresrechnung- Neue_JahresrechnungStorno_Jahresrechnung- Storno_JahresrechnungMonatsrechnung- MonatsrechnungStorno_Monatsrechnung- Storno_MonatsrechnungAbschlagszahlung- AbschlagszahlungStorno_Abschlagszahlung- Storno_AbschlagszahlungAuftragsbestätigung- AuftragsbestätigungGutschrift- GutschriftKorrektur- KorrekturKorrekturrechnung- KorrekturrechnungLieferbestätigung- LieferbestätigungSalespartner- SalespartnerStornierung- StornierungZaehlerrechnung- ZaehlerrechnungProduktwechsel- ProduktwechselProduktschlussrechnung- ProduktschlussrechnungStorno_Produktschlussrechnung- Storno_ProduktschlussrechnungVermarktungskosten_Abrechnung- Vermarktungskosten_AbrechnungStrono_Vermarktungskosten_Abrechnung- Strono_Vermarktungskosten_AbrechnungBeschaffungskosten_Abrechnung- Beschaffungskosten_AbrechnungStorno_Beschaffungskosten_Abrechnung- Storno_Beschaffungskosten_AbrechnungAusgleichsrechnung- AusgleichsrechnungStorno_Ausgleichsrechnung- Storno_AusgleichsrechnungJahresübersicht- Jahresübersichtdelivery_confirmation_consumer- delivery_confirmation_consumerPreisänderung- PreisänderungZwischenabrechnung- ZwischenabrechnungKorrektur-Jahresrechnung- Korrektur-JahresrechnungStorno_AbsRechnung- Storno_AbsRechnung
Available options:
Abschlagsneuberechnung, Endabrechnung, Neue_Endabrechnung, Storno_Endabrechnung, Einspeisung, Storno_Einspeisung, Jahresrechnung, Neue_Jahresrechnung, Storno_Jahresrechnung, Monatsrechnung, Storno_Monatsrechnung, Abschlagszahlung, Storno_Abschlagszahlung, Auftragsbestätigung, Gutschrift, Korrektur, Korrekturrechnung, Lieferbestätigung, Salespartner, Stornierung, Zaehlerrechnung, Produktwechsel, Produktschlussrechnung, Storno_Produktschlussrechnung, Vermarktungskosten_Abrechnung, Strono_Vermarktungskosten_Abrechnung, Beschaffungskosten_Abrechnung, Storno_Beschaffungskosten_Abrechnung, Ausgleichsrechnung, Storno_Ausgleichsrechnung, Jahresübersicht, delivery_confirmation_consumer, Preisänderung, Zwischenabrechnung, Korrektur-Jahresrechnung, Storno_AbsRechnung Maximum string length:
200Last day of the invoice billing period, if the document has one.
First day of the invoice billing period, if the document has one.
Gross invoice amount in euros; null for cancelled invoices.
Net invoice amount in euros; null for cancelled invoices.
Amount paid to or collected from the user in euros.
Whether this invoice cancels another invoice.
Billed energy in kWh, if applicable to the document.
Payment method, if available for the contract.
Payment status, if OPOS handling is enabled.
Date on which payment is due, if applicable.
Amount already paid in euros, if OPOS handling is enabled.
Current dunning level; 0 means no dunning.
Maximum string length:
30⌘I
Retrieve Contract Details
curl --request GET \
--url https://api.lumenaza.de/v3/user_documents/{userID}/contracts/{contractID}/import requests
url = "https://api.lumenaza.de/v3/user_documents/{userID}/contracts/{contractID}/"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.lumenaza.de/v3/user_documents/{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/user_documents/{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/user_documents/{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/user_documents/{userID}/contracts/{contractID}/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lumenaza.de/v3/user_documents/{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[
{
"inv_type": "Abschlagsneuberechnung",
"doc_url": "<string>",
"period_end_bill_date": "2023-12-25",
"period_start_bill_date": "2023-12-25",
"invoice_amount_gross": 123,
"invoice_amount_net": 123,
"transfer_amount": 123,
"is_cancellation": true,
"energy_amount": 123,
"payment_method": "<string>",
"payment_status": "<string>",
"due_date": "2023-12-25",
"paid_amount": 123,
"dunning_level": 123,
"inv_number": "<string>",
"inv_date": "2023-12-25"
}
]