v1

latestOpenAPI 3.0.02026-08-061380344.2 KB
Transactions

Create a Transaction

Create an accounting transaction

Parameters

type REQUIRED

A value to indicate if the transaction is an income (revenue) or expense transaction. Supported values are:

"Expense", "Income"


amount REQUIRED

A positive numeric value (in your account currency) representing the transaction amount.


date REQUIRED

The date of the transaction


vendor OPTIONAL

A string representing the vendor or payee for the transaction


category OPTIONAL

Either a custom string value to represent the category of the transaction or the IRS Schedule F code/link number. If using the schedule F items, supported values are the keys listed below:

Expense Categories:

KeyCategory
10Car and truck expenses
11Chemicals
12Conservation expenses
13Custom hire (machine work)
14Depreciation
15Employee benefit programs
16Feed
17Fertilizers and lime
18Freight and trucking
19Gasoline, fuel, and oil
20Insurance (other than health)
21aInterest Mortgage (paid to banks, etc.)
21bInterest Other
22Labor hired (less employment credits)
23Pension and profit-sharing plans"
32aPurchase of livestock"
24aRent or Lease of Vehicles, machinery, equipment
24bRent or Lease of Other (land, animals, etc.)
25Repairs and maintenance
26Seeds and plants
27Storage and warehousing
28Supplies
29Taxes
30Utilities
31Veterinary, breeding, and medicine
32Other expenses

Income Categories:

KeyCategory
1aSales of livestock and other resale items
1bCost or other basis of livestock
2Sales of livestock, produce, grains, and other products you raised
3aCooperative distributions
4aAgricultural program payments
5aCommodity Credit Corporation (CCC) loans reported under election
5bCCC loans forfeited
6Crop insurance proceeds and federal crop disaster payments
7Custom hire (machine work) income
8Other income

ref_id OPTIONAL

The Farmbrite record id to associate this transaction to, used with the ref_type property.


ref_type OPTIONAL

A value used with the ref_id property to associate this transaction to a record in Farmbrite. Support values are:

"animal", "equipment", "plant", "location"


check_number OPTIONAL

Optional text containing the check number or other payment identifier


keywords OPTIONAL

A comma delimited list of keywords, tags, or labels to easily search for similar transactions.


description OPTIONAL

A text description or summary of the transaction.

post/transactions

Headers

Content-Typestring

Request body

object required

Example request

{
  "type": "Expense",
  "amount": 10,
  "date": "2022-02-03",
  "vendor": "API",
  "category": "Custom",
  "ref_id": "Related Resource ID",
  "ref_type": "Related Resource Type",
  "check_number": "",
  "keywords": "",
  "description": ""
}

Response

Successful response