× Freshbooks App Logo
FreshBooks
Official App
Free - Google Play
Get it

Other Income

General Info

Other Income is for recording income that doesn't require an invoice and is received through other means.

This non-invoice income can be from selling through online stores (like Shopify and Etsy), at fairs, selling ads, or renting space, for example.

*Requires Authorization*

Includes

There are no includes for other income.

Filters

Filter Type Name Field Description
Equals incomeid incomeid matches incomeid exactly
Equals category category_name matches category exactly
Equals vis_state vis_state matches vis_state exactly

Field Descriptions

underlined fields are required on creation

Field Type Description
incomeid int unique identifier of this other income entry within the business
amount object subfields: amount and code
amount string amount of the income, to two decimal places
code string three-letter currency code
category_name string
    Options include:
  • advertising
  • in_person_sales
  • online_sales
  • rentals
  • other
created_at datetime Time the other income entry was created, YYYY-MM-DD HH:MM:SS format
date date The date the income was received, YYYY-MM-DD format
note string notes on the income
payment_type string Optional type of payment made. "Check", "Credit", "Cash", etc.
source string Source of external income. E.g. Shopify, Etsy, Farmers' Market
taxes object array subfields: amount and name
amount string amount of the tax, to two decimal places
name string name of the tax
updated_at datetime Time the other income entry was last updated, YYYY-MM-DD HH:MM:SS format
vis_state int 0 for active,
1 for deleted,
2 for archived
(more info on vis_state)

Get Single Other Income

Request: GET https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes/<id>

Response:

{
   "response": {
      "result": {
         "other_income": {
            "amount": {
               "amount": "113.00",
               "code": "USD"
            },
            "category_name": "online_sales",
            "created_at": "2018-05-25 10:53:58",
            "date": "2018-05-25",
            "incomeid": 1234,
            "note": "Han Solo portrait",
            "payment_type": "PayPal",
            "source": "Etsy",
            "taxes": [
               {
                  "amount": "3",
                  "name": "HST"
               },
               {
                  "amount": "10",
                  "name": "Empire Tax"
               }
            ],
            "updated_at": "2018-05-25 11:28:36",
            "vis_state": 0
         }
      }
   }
}

Create Single Other Income

Request: POST https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes

{
   "other_income": {
      "amount": {
         "amount": "113.00",
         "code": "USD"
      },
      "category_name": "online_sales",
      "date": "2018-05-25",
      "note": "Han Solo portrait",
      "payment_type": "PayPal",
      "source": "Etsy",
      "taxes": [
         {
            "amount": "3",
            "name": "HST"
         },
         {
            "amount": "10",
            "name": "Empire Tax"
         }
      ]
   }
}

Response:

{
   "response": {
      "result": {
         "other_income": {
            "amount": {
               "amount": "113.00",
               "code": "USD"
            },
            "category_name": "online_sales",
            "created_at": "2018-05-25 10:53:58",
            "date": "2018-05-25",
            "incomeid": 1234,
            "note": "Han Solo portrait",
            "payment_type": "PayPal",
            "source": "Etsy",
            "taxes": [
               {
                  "amount": "3",
                  "name": "HST"
               },
               {
                  "amount": "10",
                  "name": "Empire Tax"
               }
            ],
            "updated_at": "2018-05-25 11:28:36",
            "vis_state": 0
         }
      }
   }
}

Update Single Other Income

Request: PUT https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes/<id>

{
   "other_income": {
      "amount": {
         "amount": "125.00",
         "code": "USD"
      },
      "date": "2018-05-26",
      "source": "Squarespace site"
   }
}

Response:

{
   "response": {
      "result": {
         "other_income": {
            "amount": {
               "amount": "125.00",
               "code": "USD"
            },
            "category_name": "online_sales",
            "created_at": "2018-05-25 10:53:58",
            "date": "2018-05-26",
            "incomeid": 1234,
            "note": "Han Solo portrait",
            "payment_type": "PayPal",
            "source": "Squarespace site",
            "taxes": [
               {
                  "amount": "13",
                  "name": "HST"
               }
            ],
            "updated_at": "2018-05-26 12:36:36",
            "vis_state": 0
         }
      }
   }
}

Delete Single Other Income

Request: DELETE https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes/<id>

Response:

{
  "response": {}
}

List Other Income

Request: GET https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes

Response:

{
  "response": {
    "result": {
      "per_page": 15,
      "total": 3,
      "page": 1,
      "other_incomes": [
        {
          // same format as single other income
        },
        {
          // same format as single other income
        },
        {
          // same format as single other income
        }
      ],
      "pages": 1
    }
  }
}

List Archived Online Sales Income

Request: GET https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes?search[vis_state]=2&search[category]=online_sales

Response:

{
  "response": {
    "result": {
      "per_page": 15,
      "total": 1,
      "page": 1,
      "other_incomes": [
        {
          // same format as single other income
        }
      ],
      "pages": 1
    }
  }
}

Get Single Other Income

Request: GET
https://api.freshbooks.com/accounting/account/&ltaccountid&gt/other_incomes/other_incomes/&ltid&gt


url = "https://api.freshbooks.com/accounting/account/&ltaccountid&gt/other_incomes/other_incomes/&ltid&gt"
headers = {'Authorization': 'Bearer &ltBearer Token&gt', 'Api-Version': 'alpha', 'Content-Type': 'application/json'}
res = requests.get(url, data=None, headers=headers)

Response:

{
   "response": {
      "result": {
         "other_income": {
            "amount": {
               "amount": "113.00",
               "code": "USD"
            },
            "category_name": "online_sales",
            "created_at": "2018-05-25 10:53:58",
            "date": "2018-05-25",
            "incomeid": 1234,
            "note": "Han Solo portrait",
            "payment_type": "PayPal",
            "source": "Etsy",
            "taxes": [
               {
                  "amount": "3",
                  "name": "HST"
               },
               {
                  "amount": "10",
                  "name": "Empire Tax"
               }
            ],
            "updated_at": "2018-05-25 11:28:36",
            "vis_state": 0
         }
      }
   }
}

Create Single Other Income

Request: POST
https://api.freshbooks.com/accounting/account/&ltaccountid&gt/other_incomes/other_incomes

url = "https://api.freshbooks.com/accounting/account/&ltaccountid>&gt/other_incomes/other_incomes"
headers = {'Authorization': 'Bearer &ltBearer Token&gt', 'Api-Version': 'alpha', 'Content-Type': 'application/json'}
payload = {
   "other_income": {
      "amount": {
         "amount": "113.00",
         "code": "USD"
      },
      "category_name": "online_sales",
      "date": "2018-05-25",
      "note": "Han Solo portrait",
      "payment_type": "PayPal",
      "source": "Etsy",
      "taxes": [
         {
            "amount": "3",
            "name": "HST"
         },
         {
            "amount": "10",
            "name": "Empire Tax"
         }
      ]
   }
}
res = requests.post(url, data=json.dumps(payload), headers=headers)

Response:

{
   "response": {
      "result": {
         "other_income": {
            "amount": {
               "amount": "113.00",
               "code": "USD"
            },
            "category_name": "online_sales",
            "created_at": "2018-05-25 10:53:58",
            "date": "2018-05-25",
            "incomeid": 1234,
            "note": "Han Solo portrait",
            "payment_type": "PayPal",
            "source": "Etsy",
            "taxes": [
               {
                  "amount": "3",
                  "name": "HST"
               },
               {
                  "amount": "10",
                  "name": "Empire Tax"
               }
            ],
            "updated_at": "2018-05-25 11:28:36",
            "vis_state": 0
         }
      }
   }
}

Update Single Other Income

Request: PUT
https://api.freshbooks.com/accounting/account/&ltaccountid&gt/other_incomes/other_incomes/&ltid&gt


url = "https://api.freshbooks.com/accounting/account/&ltaccountid&gt/other_incomes/other_incomes/&ltid&gt"
headers = {'Authorization': 'Bearer &ltBearer Token&gt', 'Api-Version': 'alpha', 'Content-Type': 'application/json'}
payload = {
   "other_income": {
      "amount": {
         "amount": "125.00",
         "code": "USD"
      },
      "date": "2018-05-26",
      "source": "Squarespace site"
   }
}
res = requests.put(url, data=json.dumps(payload), headers=headers)

Response:

{
   "response": {
      "result": {
         "other_income": {
            "amount": {
               "amount": "125.00",
               "code": "USD"
            },
            "category_name": "online_sales",
            "created_at": "2018-05-25 10:53:58",
            "date": "2018-05-26",
            "incomeid": 1234,
            "note": "Han Solo portrait",
            "payment_type": "PayPal",
            "source": "Squarespace site",
            "taxes": [
               {
                  "amount": "13",
                  "name": "HST"
               }
            ],
            "updated_at": "2018-05-26 12:36:36",
            "vis_state": 0
         }
      }
   }
}

Delete Single Other Income

Request: DELETE
https://api.freshbooks.com/accounting/account/&ltaccountid&gt/other_incomes/other_incomes/&ltid&gt


url = "https://api.freshbooks.com/accounting/account/&ltaccountid&gt/other_incomes/other_incomes/&ltid&gt"
headers = {'Authorization': 'Bearer &ltBearer Token&gt', 'Api-Version': 'alpha', 'Content-Type': 'application/json'}
res = requests.delete(url, data=None, headers=headers)

Response:


{
  "response": {}
}

List Other Income

Request: GET
https://api.freshbooks.com/accounting/account/&ltaccountid&gt/other_incomes/other_incomes


{
  "response": {
    "result": {
      "per_page": 15,
      "total": 3,
      "page": 1,
      "other_income": [
        {
          // same format as single other income
        },
        {
          // same format as single other income
        },
        {
          // same format as single other income
        }
      ],
      "pages": 1
    }
  }
}

List Archived Online Sales Income

Request: GET
https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes


url = "https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes"
headers = {'Authorization': 'Bearer <Bearer Token>', 'Api-Version': 'alpha', 'Content-Type': 'application/json'}
params = {'search[vis_state]': 2, 'search[category]': 'online_sales'}
res = requests.get(url, params=params, data=None, headers=headers)

Response:


{
  "response": {
    "result": {
      "per_page": 15,
      "total": 1,
      "page": 1,
      "other_income": [
        {
          // same format as single other income
        }
      ],
      "pages": 1
    }
  }
}