Other Income
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), art fairs, selling ads, or renting space, for example.
Access Requirements
Access | Requires Authorization |
Scopes | user:other_income:read user:other_income:write |
Includes
There are no includes for other income.
Filters
Filter Type | Field | Description |
---|---|---|
Equals | incomeid | matches incomeid exactly |
Equals | category_name | matches category exactly |
Equals | vis_state | matches vis_state exactly |
Field Descriptions
Field | Type | Description |
---|---|---|
incomeid | string | 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 | string | Time the other income entry was created, YYYY-MM-DD HH:MM:SS format |
date | boolean | The date the income was received, YYYY-MM-DD format |
note | object | 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/<incomeid>"
Response:
{
"response": {
"result": {
"other_income": {
"amount": {
"amount": "25.00",
"code": "USD"
},
"category_name": "online_sales",
"created_at": "2020-09-25 10:53:22",
"date": "2020-09-25",
"incomeid": 1234,
"note": "Cool beans!",
"payment_type": "PayPal",
"source": "Etsy",
"sourceid": null,
"taxes": [
{
"amount": "3",
"name": "HST"
},
{
"amount": "10",
"name": "Empire Tax"
}
],
"updated_at": "2020-09-25 10:53:22",
"userid": null,
"vis_state": 0
}
}
}
}
List Other Income Entries
Request: GET "https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes/"
Response:
{
"response": {
"result": {
"other_income": [
{
"amount": {
"amount": "25.00",
"code": "USD"
},
"category_name": "online_sales",
"created_at": "2020-09-25 10:53:22",
"date": "2020-09-25",
"incomeid": 1234,
"note": "Cool beans!",
"payment_type": "PayPal",
"source": "Etsy",
"sourceid": null,
"taxes": [
{
"amount": "3",
"name": "HST"
},
{
"amount": "10",
"name": "Empire Tax"
}
],
"updated_at": "2020-09-25 10:53:22",
"userid": null,
"vis_state": 0
},
{
...
}
}
}
}
Create Single Other Income
Request: POST https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes/<id>
{
"other_income": {
"amount": {
"amount": "113.00",
"code": "USD"
},
"category_name": "online_sales",
"date": "2020-09-24",
"note": "Product sent via ground mail",
"payment_type": "Visa",
"source": "etsy",
"sourceid": 1235,
"taxes": [
{
"amount": "3",
"name": "HST"
}
]
}
}
Response:
{
"response": {
"result": {
"other_income": {
"amount": {
"amount": "113.00",
"code": "USD"
},
"category_name": "online_sales",
"created_at": "2020-09-25 10:53:22",
"date": "2020-09-25",
"incomeid": 1234,
"note": "Cool beans!",
"payment_type": "PayPal",
"source": "Etsy",
"sourceid": 1235,
"taxes": [
{
"amount": "3",
"name": "HST"
}
],
"updated_at": "2020-09-25 10:53:22",
"userid": null,
"vis_state": 0
}
}
}
}
Update Single Other Income Entry
Request: PUT "https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes/<id>"
{
"other_income": {
"amount": {
"amount": "125.00",
"code": "USD"
},
"date": "2020-09-25",
"source": "Squarespace",
}
}
Response:
{
"response": {
"result": {
"other_income": {
"amount": {
"amount": "125.00",
"code": "USD"
},
"category_name": "online_sales",
"created_at": "2020-09-25 10:53:22",
"date": "2020-09-24",
"incomeid": 1234,
"note": "Cool beans!",
"payment_type": "PayPal",
"source": "Squarespace",
"sourceid": null,
"taxes": [
{
"amount": "3",
"name": "HST"
}
],
"updated_at": "2020-09-25 10:53:22",
"userid": null,
"vis_state": 0
}
}
}
}
Delete Other Income Entry
Request: DELETE https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes/<id>
Response:
{
"response": {}
}