Polter

Neue API

OpenAPI-Schnitstellen Beschreibung:

Legacy API

Polter Entität

id	int	Primäre ID
created_at	string	Erstellungsdatum
updated_at	string	Datum der letzten Aktualisierung.
owner_group	object	Gruppe die den Polter besitzt ( ID und Name )
creator_account	object	User der den Polter erstellt hat ( ID und Name )
buyer	object	Käufer ( ID und Name )
seller_group	object	Gruppe welche als Verkäufer auftritt ( ID und Name )
latitude	float	Breitengrad
longitude	float	Längengrad
images	object	Liste von Bilderrn ( ID, URL und Originale URL ). URLs zeigen auf ein Thumbnail mit maximaler Breite von 600px.
protocol_fm_volume	float	Volume measured by forester in FM
sale_fm_volume	float	Volume the user was soled at. Only set after aggregation is sold. In case of manual factory measurement mapping this can be more precise.
sale_status	int	Verkaufs Status. Mögliche Werte siehe untere Liste.
measurement_type	int	Aufnahmeart. Mögliche Werte siehe untere Liste.
supplier_billing_status	int	Unternehmer Abrechnungs Status. Mögliche Werte siehe untere Liste.
woodlist_number	int	Holzlisten Nummer
sellingunit_number	int	Losnummer
number	int	Polternummer. Eine vollständige Nummer des Polters sollte aus Holzlisten- Los- und Polternummer zusammengesetzt sein.
area	object	Waldort
base_area	object	Revier ( Waldort Entität die auf der Holzliste referenziert ist )
tree_types	object	Liste von Holzarten ( ID, Name und Kurzbezeichnung )
usages	object	Liste von Sorten ( ID, Name und Kurzbezeichnung )
qualities	object	Liste von Qualitäten ( ID, Name und Kurzbezeichnung )
thickness_classes	object	Liste von Stärkeklassen ( ID, Name und Kurzbezeichnung )
avg_length	int	Durchschnittliche Länge in Meter
avg_diameter	int	Durchschnittlicher Durchmesser in CM
cut_identifier	string	Hiebsnummer
class_entries	List of class entries	Dies listet die Zusammensetzung des Polters aufgeteilt auf Sorten, Holzarten und Stärkeklassen. Diese Aufteilung ist nicht in Listing Antworten verfügbar.
volume_entries	List of volume entries	Jeder Polter hat ein Festmeter Volumen. Abhängig vom Aufnahmeverrfahren sind ggf. auch andere Volumeneinheiten verfügbar. Diese Liste ist nicht in Listing Antworten verfügbar.

Verkaufs Status:

1: Der Polter ist noch nicht verkauft und in keinem Verkaufprozess.
2: Der Polter ist einem Kunden angeboten, aber noch nicht verkauft.
3: Der Polter ist verkauft.
4: Der Polter ist als Produkt auf dem TimberTom Brennholz Marktplatz.
5: Der Polter wurde zum Transport bereitgestellt.
6: Der Polter ist Eigenbedarf und wird nicht verkauft.

Vermessungs Arten:

1: Einzelstamm Aufnahme
2: Sektionsvermessung
3: Stichproben Aufnahme
4: Schätzmenge

Unternehmer Abrechnungs Status:

1: Unterrnehmer hinterlegt, aber noch keine Gutschrift erstellt.
2: Unterrnehmer hinterlegt und abgerechnet.
3: Keine Unternehmer hinterlegt.

Polter Auflistung

Auflistungen enthalten keine Detailinfromationen über Polterzusaqmmensetzung oder Messdaten. Wenn Sie Messdaten benötigen müssen die Polter einzelt dafür geladen werden.

Endpunkt	`/inventory/v4/inventory/aggregation/list`
Methode	GET
Scope	`aggregation`
Query Parameter
per_page	Anzahl von Ergebnisse pro Seite ( Max. 100 )	`per_page=50`
page	Aktuelle Seite	`page=1`
aggregation_ids	Listet Polter mit den gegebenen IDs	`aggregation_ids=1,2,3`
woodlist_ids	Listet alle Polter die in den gegebenen Holzlisten sind ( Liste von IDs )	`woodlist_ids=4,5`
woodlist_numbers	Listet alle Polter die in den gegebenen Holzlisten sind ( Liste von Holzlisten-Nummern )	`woodlist_numbers=543,9876`
owner_group_ids	Listet alle Polter die einem gegebenen Waldbesitzer gehören ( Liste von IDs )	`owner_group_ids=87`
search_number	Suche nach Poltern deren Kombination aus Holzlistennummer, Losnummer und Polternummer eine Teilübereinstimmung mit der Suchnummer hat	`search_number=54391`
polygon_points	Polygon definiert durch ein Tupel von Längengrad und Breitengrad ( Liste muss mit gleichem Tupel enden wie es beginnt um ein abgeschlossenes Polygon zu bilden )	`polygon_points=8.771377,47.905267,...`
created_start_time	Zeige Polter die an, oder nach diesem Datum erstellt wurden	`created_start_time=2024-05-02`
created_end_time	Zeige Polter die an, oder bevor diesem Datum erstellt wurden	`created_end_time=2024-05-03`
updated_start_time	Zeige Polter die an, oder nach diesem Datum bearbietet wurden	`updated_start_time=2024-05-02`
updated_end_time	Zeige Polter die an, oder bevor diesem Datum bearbietet wurden	`updated_end_time=2024-05-03`
cut_identifier	Zeigt Polter an die über Holzliste mit dieser Hiebsnummer verknüpft sind	`cut_identifier=ABC-123`
sort_field	Sortierkriterium	`sort_field=id` `sort_field=number` `sort_field=created_at` `sort_field=updated_at` `sort_field=sellingunit_number` `sort_field=woodlist_number` `sort_field=protocol_fm_volume` `sort_field=offer_number` `sort_field=invoice_number` `sort_field=sale_fm_volume`
sort_order	Sortierreihenfolge	`sort_order=asc` `sort_order=desc`

Beispiel Antworten für /inventory/v4/inventory/aggregation/list?per_page=2:

{
	"count": 432,
	"entries": [
		{
			"id": 1,
			"created_at": "2023-04-21T12:25:29Z",
			"updated_at": "2024-02-20T15:30:12Z",
			"revision": 1,
			"owner_group": {
				"id": 15,
				"name": "Test Forstbetrieb"
			},
			"area": {
				"id": 0,
				"name": "",
				"number": 0,
				"short_name": "",
				"full_name": ""
			},
			"buyer": {
				"id": 32,
				"name": "Beispielabnehmer"
			},
			"creator_account": {
				"id": 14,
				"name": "Max Mustermann"
			},
			"selling_type": {
				"id": 0,
				"name": "",
				"short_name": ""
			},
			"sellingunit_number": 1,
			"woodlist_id": 1,
			"woodlist_number": 6002,
			"woodlist_name": "Testliste Mustermann",
			"business_area": {
				"id": 5,
				"name": "Eigenverkauf"
			},
			"base_area": {
				"id": 22,
				"name": "Testrevier",
				"number": 106,
				"short_name": "VI",
				"full_name": "VI Testrevier"
			},
			"seller_group": {
				"id": 15,
				"name": "Test Forstbetrieb"
			},
			"images": [],
			"image_ids": [],
			"image_urls": [],
			"bark_reduction_type": 0,
			"number": 1,
			"latitude": 52.523834,
			"longitude": 13.349258,
			"storage_location": "",
			"note": "",
			"avg_length": 3,
			"avg_diameter": 50,
			"protocol_quantity": 1,
			"protocol_fm_volume": 0.5890486,
			"sale_fm_volume": 0.5890486,
			"sale_status": 3,
			"measurement_type": 1,
			"contractor_status": 2,
			"offer": {
				"id": 0,
				"number": ""
			},
			"invoice": {
				"id": 348,
				"number": "24-13"
			},
			"product_id": 0,
			"log_entries": [],
			"sample_entries": [],
			"section_entries": [],
			"estimation_entries": [],
			"tree_types": [
				{
					"id": 174,
					"full_name": "Sonstiges Weichlaubholz",
					"short_name": "SLWB"
				}
			],
			"usages": [
				{
					"id": 1,
					"full_name": "Stammholz lang",
					"short_name": "ST"
				}
			],
			"qualities": [],
			"thickness_classes": [
				{
					"id": 9,
					"full_name": "",
					"short_name": "5"
				}
			],
			"calamities": [],
			"calamity_entries": [],
			"contractor_entries": [],
			"class_entries": [],
			"volume_entries": []
		},
		{
			"id": 2,
			"created_at": "2023-04-21T12:30:21Z",
			"updated_at": "2024-02-20T15:30:12Z",
			"revision": 5,
			"owner_group": {
				"id": 15,
				"name": "Test Forstbetrieb"
			},
			"area": {
				"id": 0,
				"name": "",
				"number": 0,
				"short_name": "",
				"full_name": ""
			},
			"buyer": {
				"id": 32,
				"name": "Beispielabnehmer"
			},
			"creator_account": {
				"id": 14,
				"name": "Max Mustermann"
			},
			"selling_type": {
				"id": 0,
				"name": "",
				"short_name": ""
			},
			"sellingunit_number": 1,
			"woodlist_id": 1,
			"woodlist_number": 6002,
			"woodlist_name": "Testliste Mustermann",
			"business_area": {
				"id": 5,
				"name": "Eigenverkauf"
			},
			"base_area": {
				"id": 22,
				"name": "Testrevier",
				"number": 106,
				"short_name": "VI",
				"full_name": "VI Testrevier"
			},
			"seller_group": {
				"id": 15,
				"name": "Test Forstbetrieb"
			},
			"images": [],
			"image_ids": [],
			"image_urls": [],
			"bark_reduction_type": 1,
			"number": 2,
			"latitude": 52.271748,
			"longitude": 10.908107,
			"storage_location": "",
			"note": "",
			"avg_length": 4,
			"avg_diameter": 40,
			"protocol_quantity": 1,
			"protocol_fm_volume": 0.454,
			"sale_fm_volume": 0.454,
			"sale_status": 3,
			"measurement_type": 1,
			"contractor_status": 2,
			"offer": {
				"id": 1,
				"number": ""
			},
			"invoice": {
				"id": 348,
				"number": "24-13"
			},
			"product_id": 0,
			"log_entries": [],
			"sample_entries": [],
			"section_entries": [],
			"estimation_entries": [],
			"tree_types": [
				{
					"id": 174,
					"full_name": "Sonstiges Weichlaubholz",
					"short_name": "SLWB"
				}
			],
			"usages": [
				{
					"id": 1,
					"full_name": "Stammholz lang",
					"short_name": "ST"
				}
			],
			"qualities": [],
			"thickness_classes": [
				{
					"id": 7,
					"full_name": "",
					"short_name": "3b"
				}
			],
			"calamities": [
				{
					"id": 33,
					"full_name": "Folgehieb",
					"short_name": "F"
				}
			],
			"calamity_entries": [],
			"contractor_entries": [],
			"class_entries": [],
			"volume_entries": []
		}
	]
}

Einzelnen Polter laden

Endpunkt	`/inventory/v4/inventory/aggregation/:ID`
Methode	GET
Scope	`aggregation`

Beispiel Antwort für: /inventory/v4/inventory/aggregation/123

{
	"id": 123,
	"created_at": "2024-02-21T09:34:13Z",
	"updated_at": "2024-02-21T09:34:13Z",
	"revision": 0,
	"owner_group": {
		"id": 15,
		"name": "Test Forstbetrieb"
	},
	"area": {
		"id": 142,
		"name": "705",
		"number": 0,
		"short_name": "",
		"full_name": " | 705"
	},
	"buyer": {
		"id": 0,
		"name": ""
	},
	"creator_account": {
		"id": 26,
		"name": "Marry Mustermann"
	},
	"selling_type": {
		"id": 0,
		"name": "",
		"short_name": ""
	},
	"sellingunit_number": 6,
	"woodlist_id": 112,
	"woodlist_number": 410149,
	"woodlist_name": "",
	"business_area": {
		"id": 5,
		"name": "Eigenverkauf"
	},
	"base_area": {
		"id": 72,
		"name": "Beispielrevier",
		"number": 114,
		"short_name": "I",
		"full_name": "I Beispielrevier"
	},
	"seller_group": {
		"id": 15,
		"name": "Test Forstbetrieb"
	},
	"images": [],
	"image_ids": [],
	"image_urls": [],
	"bark_reduction_type": 1,
	"number": 1,
	"latitude": 47.74038,
	"longitude": 9.15293,
	"storage_location": "",
	"note": "",
	"avg_length": 0,
	"avg_diameter": 0,
	"protocol_quantity": 0,
	"protocol_fm_volume": 8.611,
	"sale_fm_volume": 0,
	"sale_status": 1,
	"measurement_type": 4,
	"contractor_status": 1,
	"offer": {
		"id": 0,
		"number": ""
	},
	"invoice": {
		"id": 0,
		"number": ""
	},
	"product_id": 0,
	"log_entries": [],
	"sample_entries": [],
	"section_entries": [],
	"estimation_entries": [
		{
			"id": 2746,
			"tree_type_id": 6,
			"usage_id": 3,
			"quality_id": 17,
			"usage_type_id": 0,
			"thickness_class_id": 0,
			"quantity": 0,
			"volume_unit_id": 4,
			"conversion_factor": 0.48,
			"volume": 17.94,
			"fm_volume": 8.611
		}
	],
	"tree_types": [
		{
			"id": 6,
			"full_name": "Fichte",
			"short_name": "FI"
		}
	],
	"usages": [
		{
			"id": 3,
			"full_name": "Industrieholz lang",
			"short_name": "IL"
		}
	],
	"qualities": [
		{
			"id": 17,
			"full_name": "B",
			"short_name": "B"
		}
	],
	"thickness_classes": [],
	"calamities": [],
	"calamity_entries": [],
	"contractor_entries": [],
	"class_entries": [
		{
			"id": 12900,
			"tree_type_id": 6,
			"usage_id": 3,
			"quality_id": 17,
			"thickness_class_id": 0,
			"log_number": 0,
			"tax_rate": 19,
			"quantity": 0,
			"fm_volume": 8.611,
			"volume_entries": [
				{
					"id": 22415,
					"volume_unit_id": 1,
					"volume": 8.611
				},
				{
					"id": 22416,
					"volume_unit_id": 4,
					"volume": 17.94
				}
			]
		}
	],
	"volume_entries": [
		{
			"id": 22418,
			"volume_unit_id": 1,
			"volume": 8.611
		},
		{
			"id": 22419,
			"volume_unit_id": 4,
			"volume": 17.94
		}
	]
}