×
FreshBooks
Official App
Free – Google Play
Get it
Hey there - We have updated our privacy policy in accordance with GDPR. Got 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 TypeNameFieldDescription
Equalsincomeidincomeidmatches incomeid exactly
Equalscategorycategory_namematches category exactly
Equalsvis_statevis_statematches vis_state exactly

Field Descriptions

underlined fields are required on creation

FieldTypeDescription
incomeidintunique identifier of this other income entry within the business
amountobjectsubfields: amount and code
amountstringamount of the income, to two decimal places
codestringthree-letter currency code
category_namestring
    Options include:
  • advertising
  • in_person_sales
  • online_sales
  • rentals
  • other
created_atdatetimeTime the other income entry was created, YYYY-MM-DD HH:MM:SS format
datedateThe date the income was received, YYYY-MM-DD format
notestringnotes on the income
payment_typestringOptional type of payment made. "Check", "Credit", "Cash", etc.
sourcestringE.g. Shopify, Etsy, Farmers' Market
taxesobject arraysubfields: amount and name
amountstringamount of the tax, to two decimal places
namestringname of the tax
updated_atdatetimeTime the other income entry was last updated, YYYY-MM-DD HH:MM:SS format
vis_stateint0 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-01",
        "incomeid": 1234,
        "note": "Han Solo portrait",
        "payment_type": "PayPal",
        "source": "Etsy",
        "taxes": [
          {
            "amount": "13",
            "name": "HST"
          }
        ],
        "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/<accountid>/other_incomes/other_incomes/<id>


url = "https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes/<id>"
headers = {'Authorization': 'Bearer <Bearer Token>', '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-01",
        "incomeid": 1234,
        "note": "Han Solo portrait",
        "payment_type": "PayPal",
        "source": "Etsy",
        "taxes": [
          {
            "amount": "13",
            "name": "HST"
          }
        ],
        "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


url = "https://api.freshbooks.com/accounting/account/<accountid>>/other_incomes/other_incomes"
headers = {'Authorization': 'Bearer <Bearer Token>', '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/<accountid>/other_incomes/other_incomes/<id>


url = "https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes/<id>"
headers = {'Authorization': 'Bearer <Bearer Token>', '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)

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


url = "https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes/<id>"
headers = {'Authorization': 'Bearer <Bearer Token>', '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/<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'}
res = requests.get(url, data=None, headers=headers)

Response:


{
  "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
    }
  }
}