v1

latestOpenAPI 3.0.02026-08-061380344.2 KB
Tools & Equipment

Create Tool or Equipment

Create equipment

Parameters

name REQUIRED

The name or label for this piece of equipment


amount OPTIONAL

Numeric value representing the amount paid for the equipment, in the currency of your account.


brand OPTIONAL

Brand of equipment


date_purchased OPTIONAL

Date purchased


description OPTIONAL

Text description / summary of the equipment


engine OPTIONAL

Engine type (if applicable)


manual_url OPTIONAL

A valid web address / URL for the service manual


model_number OPTIONAL

Model number


plate_number OPTIONAL

License plate number (if applicable)


purchased OPTIONAL

Boolean value indicating if the item was purchased or not


serial_number OPTIONAL

Serial number


electronic_id OPTIONAL

Electronic ID - useful to set if using an RFID or barcode scanner to search for for sync data with Farmbrite.


transmission OPTIONAL

Transmission type (if applicable)


type OPTIONAL

Any string representing the type of equipment. For example: Tractor, harvester, cleaning station, feeder, etc.


usage_unit OPTIONAL

How do you track the usage of this equipment. Supported options are:

"Hours", "Miles", "Kilometers"

post/tools

Headers

Content-Typestring

Request body

object required

Example request

{
  "amount": 28900,
  "brand": "Kubato",
  "date_purchased": "2018-12-19",
  "description": "Orange",
  "engine": "Kubato",
  "manual_url": "",
  "model_number": "M6060",
  "name": "Big Orange",
  "plate_number": "NA",
  "purchased": false,
  "serial_number": "kjhfsdhu6546871",
  "transmission": "Kubato",
  "type": "Tractor",
  "usage_unit": "Hours"
}

Response

Successful response