EN/API/SuppliersContracts

◀ Back to API Menu

List of supply contracts

Authentication must be specified in the request header:

X-API-TOKEN: {128-character key provided for the specific plant}

GET https://smartbiogas.it/api/v1/suppliercontracts

Result: Json of the plant's supply contracts

[
	{
		"plant_suppliers_contracts_id": supplyContractId,
		"f_contract_number": "Contract number or code",
		"f_certificate_number": "Certificate number or code",
		"f_date_start": "Contract start date in ISO format",
		"f_date_end": "Contract end date in ISO format",
		"soggetto_id": supplierSubjectId
	},
	{
		"plant_suppliers_contracts_id": 47,
		"f_contract_number": "",
		"f_certificate_number": "",
		"f_date_start": "2025-05-12",
		"f_date_end": "2026-05-12",
		"soggetto_id": 1876
	},
	...
]

Search filtering by supplier

GET https://smartbiogas.it/api/v1/suppliercontracts?soggetto_id={subjectId}

Example: https://smartbiogas.it/api/v1/suppliercontracts?soggetto_id=1875

Result: Same Json but with 0 or more contracts filtered by the supplier passed in the criteria

Contract details

GET https://smartbiogas.it/api/v1/suppliercontracts/{supplyContractId}

Example: https://smartbiogas.it/api/v1/suppliercontracts/47

Result: Same Json as above but with a single record and more details

{
	"plant_suppliers_contracts_id": 47,
	"f_contract_number": "",
	"f_certificate_number": "",
	"f_date_start": "2025-05-12",
	"f_date_end": "2026-05-12",
	"soggetto_id": 1876,
	"feedstocks": [
		{
			"substrati_id": productId,
			"f_substrati_description": "Multilingual description of the product",
			"f_substrati_qta": quantity stipulated in the contract
		},
		{
			"substrati_id": 6,
			"f_substrati_description": "{\"it\":\"Mais pianta intera insilato\",\"en\":\"Maize whole plant silage\",\"es\":\"Maize whole plant silage\",\"fr\":\"Maïs plante entière ensilée\"}",
			"f_substrati_qta": 2500
		},
	],
	...
}