Events - Implan-Group/api GitHub Wiki

Events

🔗Links

🖽 The base Event Object

Property Type Details
id guid The Event's unique Identifier.
projectId guid The Event's Project's Identifier.
impactEventType str The Event's Type.
title str The name of the Event.
tags array❔ A list of tags associated with this Event.

Note

All Event Objects have these properties in common.

🖽 The Industry Output Event Object

Property Type Details
output float❔
employment float❔
employeeCompensation float❔
proprietorIncome float❔
industryCode int The Industry Code for the Industry being effected.
marginType str❔ One of ProducerPrice or PurchaserPrice.
percentage float❔
datasetId int❔

🖽 The Industry Employment Event Object

Property Type Details
output float❔
employment float❔
employeeCompensation float❔
proprietorIncome float❔
industryCode int The Industry Code for the Industry being effected.

🖽 The Industry Employee Compensation Event Object

Property Type Details
output float❔
employment float❔
employeeCompensation float❔
proprietorIncome float❔
industryCode int The Industry Code for the Industry being effected.

🖽 The Industry Proprietor Income Event Object

Property Type Details
output float❔
employment float❔
employeeCompensation float❔
proprietorIncome float❔
industryCode int The Industry Code for the Industry being effected.

🖽 The Labor Income Event Object

Property Type Details
value float❔
laborIncomeCode int (see below)

📋 Labor Income Codes

Code Description Notes
5001 Employee Compensation Available for US, Can, and INTL.
6001 Proprietor Income Available for US and Can ONLY.

🖽 The Industry Contribution Analysis Event Object

Property Type Details
output float❔
industryCode int The Industry Code for the Industry being effected.
isOutputPercentage bool Whether or not the output is expressed as a percentage (from -1.0 to 1.0)

🖽 The Household Income Event Object

Property Type Details
value float❔
householdIncomeCode int The Household Income Code.

🖽 The Commodity Output Event Object

Property Type Details
output float❔
commodityCode int The Commodity being affected.
localPurchasePercentage float❔ The percentage of this commodity that is purchased locally (defaults to 1.0 = 100%)
isSam bool If a Local Purchase Percentage is specified, this must be false. Set to true to use the purchase percentage from the SAM.
datasetId int❔
marginType str❔ One of ProducerPrice or PurchaserPrice.
commodities array[str] A list of commodities (see below) being affected.

🖽 The Commodity Object

Property Type Details
commodityCode int The Code of the Commodity.
description str A description for the commodity.
localPurchasePercentage float❔ The percentage of this commodity that is purchased locally (defaults to 1.0 = 100%).
isSam bool If an LPP is specified, this must be false, set to true to use the LPP defined in the SAM.
margin float

🖽 The Industry Spending Pattern Event Object

Property Type Details
output float❔
industryCode int The Industry Code for the affected Industry.
localPurchasePercentage float❔ The percentage of this Industry that is purchased locally (defaults to 1.0 = 100%).
isSam bool If an LPP is specified, this must be false, set to true to use the LPP defined in the SAM.
spendingPatternDatasetId int❔
spendingPatternValueType str One of IntermediateExpenditure or Output.
spendingPatternCommodities array A list of Spending Pattern Commodity objects.

🖽 The Institutional Spending Pattern Event Object

Property Type Details
value float❔
institutionCode int The Institution Code for the Institution being affected.
localPurchasePercentage float❔ The percentage of this Institution that is purchased locally (defaults to 1.0 = 100%).
isSam bool If an LPP is specified, this must be false, set to true to use the LPP defined in the SAM.
spendingPatternDatasetId int❔
isSpendingPatternEdited bool Indicates whether this is a custom (edited) Spending Pattern or a default one.
spendingPatternRegionUrid int❔
spendingPatternCommodities array A list of Spending Pattern Commodity objects.

🖽 The Industry Impact Analysis Event Object

Property Type Details
industryCode int The Industry Code of the Industry being affected.
intermediateInputs float❔
totalEmployment float❔
employeeCompensation float❔
proprietorIncome float❔
wageAndSalaryEmployment float❔
proprietorEmployment float❔
totalLaborIncome float❔
otherPropertyIncome float❔
taxOnProductionAndImports float❔
localPurchasePercentage float❔
totalOutput float❔
isSam bool
spendingPatternDatasetId int❔
spendingPatternValueType str One of IntermediateExpenditure or Output.
isLocalEmployeeCompensation bool
isFteEmployment bool
isWageAndSalary bool
spendingPatternCommodities array A list of Spending Pattern Commodity objects.

🖽 The Custom Industry Impact Analysis Event Object

Property Type Details
specificationCode int
intermediateInputs float❔
totalEmployment float❔
employeeCompensation float❔
proprietorIncome float❔
wageAndSalaryEmployment float❔
proprietorEmployment float❔
totalLaborIncome float❔
otherPropertyIncome float❔
taxOnProductionAndImports float❔
localPurchasePercentage float❔
totalOutput float❔
isSam bool
spendingPatternDatasetId int❔
spendingPatternValueType str One of IntermediateExpenditure or Output.
isLocalEmployeeCompensation bool
isFteEmployment bool
isWageAndSalary bool
spendingPatternCommodities array A list of Spending Pattern Commodity objects.

🖽 The Custom Spending Pattern Event Object

Property Type Details
value float❔
specificationCode int
isSpendingPatternEdited bool
spendingPatternRegionUrid int❔
spendingPatternDatasetId int❔
spendingPatternValueType str One of IntermediateExpenditure or Output.
spendingPatternCommodities array A list of Spending Pattern Commodity objects.

🖽 The International Industry Impact Analysis Event Object

Property Type Details
industryCode int The Industry Code of the Industry being affected.
wageAndSalaryEmployment float❔
employeeCompensation float❔
totalOutput float❔
intermediateInputs float❔
grossOperatingSurplus float❔
otherTaxOnProductionAndImports float❔
isSpendingPatternEdited bool
spendingPatternRegionUrid int❔
isSam bool
spendingPatternDatasetId float❔
spendingPatternValueType str One of IntermediateExpenditure or Output.
isLocalEmployeeCompensation bool
spendingPatternCommodities array A list of Spending Pattern Commodity objects.

🖽 The Custom International Industry Impact Analysis Event Object

Property Type Details
specificationCode int
wageAndSalaryEmployment float❔
employeeCompensation float❔
totalOutput float❔
intermediateInputs float❔
grossOperatingSurplus float❔
otherTaxOnProductionAndImports float❔
isSpendingPatternEdited bool
spendingPatternRegionUrid int❔
isSam bool
spendingPatternDatasetId float❔
spendingPatternValueType str One of IntermediateExpenditure or Output.
isLocalEmployeeCompensation bool
spendingPatternCommodities array A list of Spending Pattern Commodity objects.

🌐 Endpoints

© 2025 - IMPLAN

⚠️ **GitHub.com Fallback** ⚠️