Transactions are basic financial accounting records used to track and report on the profitability of your operation. They can be associated with various resources in orders to see the ROI return in investment (ROI) for certain animals or crop types. Transactions can only be accessed via the API by users assigned an Admin role in your account.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/farmbrite:farmbrite-transactions-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Farmbrite API Developers Documentation Transactions API
description: '# Overview
Welcome to the Farmbrite API. You can find out more about Farmbrite at
www.farmbrite.com
If you need help, check out our help center at help.farmbrite.com or email us at dev@farmbrite.com. ## API Reference
The Farmbrite API allows authorized users programatic access to their account data in order to facilitate the integration of this data with other systems and service. The API is organized around REST standards. The API uses resource-oriented URLs and returns JSON-encoded responses. It uses standard HTTP response codes, authentication, and verbs. > Base URL
```
https://api.farmbrite.com/v1
```
# Authentication
Farmbrite offers 2 authentication options for accessing the API both utilizing Personal Access Tokens (PATs) for enabling access to the API. Access Tokens (API Keys) are associated with an individual user in your account and inherit that user''s role and permissions. You can find the Access Token on the user profile page under API Key. When building an integration we recommend setting up a separate API user for the integration and changing the API KEY on a regular basis. Remember to keep your Access Tokens secret; treat them just like passwords! They act on your behalf when interacting with the API, with the same permissions and access as the user has. _Don''t hardcode them into your programs_. Instead, choose to store them as environment variables. ### Bearer Token
To make a request to the API include the Authorization Bearer header with your request and include your Access Token (API KEY) as the value. Access Token and API KEY are used interchangeably through out the documentation. > Example cURL request authenticating with Bearer Token authentication
```
curl https://api.farmbrite.com/v1/tasks \
-H "Authorization: Bearer ACCESS_TOKEN"
```
### API Key
Alternatively to using the Bearer Token authorization method, you can provide an API KEY as a header with your request. Use the header `api_key` with a value of your Access Token (API KEY). > Example cURL request authenticating with API Key header authentication
```
curl https://api.farmbrite.com/v1/tasks \
-H "api_key: ACCESS_TOKEN"
```
# Errors
Sadly, sometimes requests to the API fail. Failures can occur for a wide range of reasons. In all cases, the API should return an HTTP Status Code indicating the nature of the failure. | Code | Meaning | Description |
| --- | --- | --- |
| 200 | Success | The request was successful. If applicable the data it will be available in the data field at the top level of the response body. |
| 400 | Bad Request | Typically caused by a missing or malformed parameter. Check the documentation and your request and try again. |
| 401 | Unauthorized | No access token or an invalid access token was provided with the request. The error can also occur if the user or account is invalid or does not have access to this resource. |
| 403 | Forbidden | The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you access resources that the user or account does not have access to. |
| 404 | Not Found | Either the method and path supplied do not specify a known action or the object related to the request does not exist. |
| 429 | Too Many Requests | You have exceeded one of the rate limits in the API. See the Rate Limits section for more information. |
| 500 | Internal Server Error | There was a problem on Farmbrite''s side which was logged and reported to our technical team. You can retry, but if the problem continues please contact support. |
Details about errors can sometimes also be found in the ''message'' property at the root level of the JSON response body. # Pagination
In order to optimize performance, all list methods in the API will limit the total response data to a certain number of records and return the data in chunks (pages). API responses will include information about the total records available, the current page and total pages.'
version: 1.0.0
x-logo:
url: https://static.farmbrite.com/assets/www/images/logo.png
backgroundColor: '#FFFFFF'
altText: Farmbrite
termsOfService: https://www.farmbrite.com/terms
contact:
name: Farmbrite
url: https://developers.farmbrite.com
email: dev@farmbrite.com
servers:
- url: https://api.farmbrite.com/v1
security:
- bearerAuth: []
tags:
- name: Transactions
description: Transactions are basic financial accounting records used to track and report on the profitability of your operation. They can be associated with various resources in orders to see the ROI return in investment (ROI) for certain animals or crop types. Transactions can only be accessed via the API by users assigned an Admin role in your account.
paths:
/transactions:
post:
tags:
- Transactions
summary: Create a Transaction
description: '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:**
| **Key** | **Category** |
| --- | --- |
| 10 | Car and truck expenses |
| 11 | Chemicals |
| 12 | Conservation expenses |
| 13 | Custom hire (machine work) |
| 14 | Depreciation |
| 15 | Employee benefit programs |
| 16 | Feed |
| 17 | Fertilizers and lime |
| 18 | Freight and trucking |
| 19 | Gasoline, fuel, and oil |
| 20 | Insurance (other than health) |
| 21a | Interest Mortgage (paid to banks, etc.) |
| 21b | Interest Other |
| 22 | Labor hired (less employment credits) |
| 23 | Pension and profit-sharing plans" |
| 32a | Purchase of livestock" |
| 24a | Rent or Lease of Vehicles, machinery, equipment |
| 24b | Rent or Lease of Other (land, animals, etc.) |
| 25 | Repairs and maintenance |
| 26 | Seeds and plants |
| 27 | Storage and warehousing |
| 28 | Supplies |
| 29 | Taxes |
| 30 | Utilities |
| 31 | Veterinary, breeding, and medicine |
| 32 | Other expenses |
**Income Categories:**
| **Key** | **Category** |
| --- | --- |
| 1a | Sales of livestock and other resale items |
| 1b | Cost or other basis of livestock |
| 2 | Sales of livestock, produce, grains, and other products you raised |
| 3a | Cooperative distributions |
| 4a | Agricultural program payments |
| 5a | Commodity Credit Corporation (CCC) loans reported under election |
| 5b | CCC loans forfeited |
| 6 | Crop insurance proceeds and federal crop disaster payments |
| 7 | Custom hire (machine work) income |
| 8 | Other 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.'
requestBody:
content:
application/json:
schema:
type: object
example:
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: ''
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: postTransactions
x-operation-id-source: derived
get:
tags:
- Transactions
summary: List Transactions
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
example:
data:
- id: GUID
amount: 25
category: 'SCHUDULE F # OR CUSTOM'
check_number: null
date: '2022-03-16'
description: ''
keywords: null
ref_id: ''
ref_type: ''
reporting_year: null
type: Expense
updated_at: '2022-03-16 15:34:31'
vendor: John's Feed
year: 2022
operationId: getTransactions
x-operation-id-source: derived
/transactions/{transaction_id}:
get:
tags:
- Transactions
summary: Retrieve a Transaction
parameters:
- name: transaction_id
in: path
schema:
type: string
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
example:
id: GUID
amount: 25
category: 'SCHUDULE F # OR CUSTOM'
check_number: null
date: '2022-03-16'
description: ''
keywords: null
ref_id: ''
ref_type: ''
reporting_year: null
type: Expense
updated_at: '2022-03-16 15:34:31'
vendor: John's Feed
year: 2022
operationId: getTransactionsByTransactionId
x-operation-id-source: derived
put:
tags:
- Transactions
summary: Update a Transaction
requestBody:
content:
application/json:
schema:
type: object
example:
type: Expense
amount: 10
vendor: Updated
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: transaction_id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: putTransactionsByTransactionId
x-operation-id-source: derived
delete:
tags:
- Transactions
summary: Delete a Transaction
parameters:
- name: transaction_id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: deleteTransactionsByTransactionId
x-operation-id-source: derived
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer