Harvest Profit Calculations

Global

Type Definitions

application

An application is the root of our cost structure. It contains all the values we use to calculate costs.

Type:
  • Object
Properties:
Name Type Description
yield number

The total yield of the application
planted_acres number

The planted acres of the application
chemical_cost string

Chemical cost of the application
crop_insurance_cost string

Crop Insurance cost of the application
drying_cost string

Drying cost of the application
fertilizer_cost string

Fertilizer cost of the application
fuel_cost string

Fuel cost of the application
labor_cost string

Labor cost of the application
land_cost string

Land cost of the application
other_cost string

Other cost of the application
payments_depreciation_cost string

Payments/Depreciation cost of the application
repair_cost string

Repair cost of the application
seed_cost string

Seed cost of the application
custom_cost Object

Any custom costs of the application

contract

Contracts represent sales.

Type:
  • Object
Properties:
Name Type Description
amount_sold number

The amount sold from the contract
cash_price number

The value of the contract
type_name string

The name of the contract type

contractLongShort

Contract Long/Short attribute. Only used with Futures Contracts.

Type:
  • Object
Properties:
Name Type Description
name string

The display name of the Long/Short value
value string

The value of the contract long/short to be stored

contractMonths

Contract Month attribute. Only used many different contract types.

Type:
  • Object
Properties:
Name Type Description
name string

The name of the contract month
value string

The value of the contract month to be stored

contractOptionStrategy

Contract Option Strategy. Only used with Option Sale contracts.

Type:
  • Object
Properties:
Name Type Description
name string

The name of the contract option strategy
value string

The value of the contract option strategy to be stored

contractSize

Contract Size Object

Type:
  • Object
Properties:
Name Type Description
name string

The name of the contract size
value string

The value of the contract size to be stored

crop

Type:
  • Object
Properties:
Name Type Description
market_crop_id number

The market crop associated to the crop
name string

The name of the crop

line_item

A line item represents a cost applied to a field.

Type:
  • Object
Properties:
Name Type Description
amount number

The amount of the line item
name number

The name of the line item
price number

The price of the line item
type_name string

The type of the line item, made into a URL-formatted name
units string

The units applied of the line item
application_id number

The application the line item belongs to
product_id number

The product the line item belongs to

market_crop

Type:
  • Object
Properties:
Name Type Description
name string

The name of the market crop
symbol string

The market symbol of the market crop

planting

A planting is an abstract concept that rounds out plantings

Type:
  • Object
Properties:
Name Type Description
field_id number

The field ID of the planting
year_id number

The year ID of the planting
crop_id number

The crop ID of the planting
planted_acres number

The planted acres of the planting
applications Array.<application>

The associated applications for the planting

product

A product represents a cost of some sort.

Type:
  • Object
Properties:
Name Type Description
amount number

The amount of the product
coverage_amount number

The amount covered by crop insurance (as an integer)
crop_names string

The crops that this product can be applied to
crop_ids Array.<number>

The crops that this product can be applied to
density number

The density of the product, if the product is a solid applied as a liquid
liquid boolean

Whether the product is applied as a liquid
multiplier number

The units that make up a single product, if units are 'custom'
name number

The name of the product
position number

The position of the product, when listed
price number

The price per unit of the product
type_name string

The type of the product, made into a URL-formatted name
units string

The units applied of the product
input_id number

The input the product belongs to
sub_entity_id number | null

The sub_entity the product belongs to

revenue

A revenue represents income of some sort.

Type:
  • Object
Properties:
Name Type Description
amount number

The amount of the revenue
crop_names string

The crops that this revenue can be applied to
crop_ids Array.<number>

The crops that this revenue can be applied to
name number

The name of the revenue
position number

The position of the revenue, when listed
year_id number

The year the revenue belongs to
sub_entity_id number | null

The sub_entity the revenue belongs to

setting

Settings for the given user

Properties:
Name Type Description
value number | string

The value of the setting