Aggregation

External API

OpenAPI Description:

Legacy API

Aggregation Entity spec

id	int	Primary ID
created_at	string	Date of creation
updated_at	string	Date of last change
owner_group	object	Owner group ID and name
creator_account	object	User ID and full name
buyer	object	Buyer ID and name
seller_group	object	Group that acts as the seller ( ID and name )
latitude	float	Latitude
longitude	float	Longitude
images	object	List of images ( ID, url and original URL ). Note that image URLs are thumbnails with max width of 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	List of values with description see below.
measurement_type	int	List of values with description see below.
supplier_billing_status	int	List of values with description see below.
woodlist_number	int	Woodlist number
sellingunit_number	int	Sellingunit number
number	int	Aggregation number. A complete identifier should include the woodlist-, sellingunit- and aggregation number.
area	object	Area entity
base_area	object	Base area is the first level area selected on the woodlist the aggregation is connected to
tree_types	object	List of tree types that are included in the aggregation. ( ID, name and short name )
usages	object	List of usages that are included in the aggregation. ( ID, name and short name )
qualities	object	List of qualities that are included in the aggregation. ( ID, name and short name )
thickness_classes	object	List of thickness classes that are included in the aggregation. ( ID, name and short name )
calamities	object	List of calamities that are included in the aggregation. ( ID, name and short name )
avg_length	int	Avg. length in meters
avg_diameter	int	Avg. diameteer in CM
cut_identifier	string	Cut identifier
class_entries	List of class entries	Class entry describes the composition of an aggregation. It provides a volume for every composition part. Not rendered in listing responses.
volume_entries	List of volume entries	Every aggregation is guaranteed to provide its volume in FM but depending on the measurement method other volume units might be avilable

Sales status values:

1: The aggregation is unsold and not in any sales process.
2: The aggregation is offered to a customer but not yet sold.
3: The aggregation is sold.
4: The aggregation is currently offerred on the TimberTom marketplace.
5: The aggregation was included in a delivery note.

Measurement types:

1: Single log
2: Section
3: Sample
4: Estimation

Contractor billing status:

1: Contractors have been referenced but not yet credited.
2: Contractors have been credited.
3: No contractors are referenced for the harves of the aggregation.

Aggregation Listing

Aggregation listings do not contain detailed information about the composition of the aggregation or any measurement data. If such information is needed the aggregation needs to be loaded via the single aggregation endpoint below.

Endpoint	`/inventory/v4/inventory/aggregation/list`
Method	GET
Scope	`aggregation`
Query parameter
per_page	Number of results perr page ( max. 100 )	`per_page=50`
page	Current page	`page=1`
aggregation_ids	List of aggregation IDs	`aggregation_ids=1,2,3`
woodlist_ids	List of woodlist IDs	`woodlist_ids=4,5`
woodlist_numbers	List of woodlist user numbers	`woodlist_numbers=543,9876`
owner_group_ids	List of group IDs	`owner_group_ids=87`
search_number	The search parameter looks for partial matches in the combined string of woodlist number + selling unit number + aggregation number	`search_number=54391`
polygon_points	Polygon defined by list tupels of longitude and then latitude ( List must end with same tupel of values that were the first so the poylgon is completed )	`polygon_points=8.771377,47.905267,...`
created_start_time	Only show aggregations created up on this day or after	`created_start_time=2024-05-02`
created_end_time	Only show aggregations created on this day or before	`created_end_time=2024-05-03`
updated_start_time	Only show aggregations updated up on this day or after	`updated_start_time=2024-05-02`
updated_end_time	Only show aggregations updated on this day or before	`updated_end_time=2024-05-03`
cut_identifier	Only show aggregations that are connected to the given cut identifier	`cut_identifier=ABC-123`
sort_field	Field to sort by	`sort_field=id` `sort_field=number` `sort_field=created_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	Sort order	`sort_order=asc` `sort_order=desc`

Example response for /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": []
		}
	]
}

Load a single aggregation

Endpoint	`/inventory/v4/inventory/aggregation/:ID`
Method	GET
Scope	`aggregation`

Example response for: /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
		}
	]
}