Categories

Minimum access level: My Money, unless stated otherwise.

Categories are used to explain the type of income or cost for estimate items, invoice items, expenses, bills and bank transaction explanations.

Attributes

Attribute Description Kind
url The unique identifier for the category URI
description Category name String
nominal_code

Category code:

  • 001 to 049: Income
  • 100 to 199: Cost of Sales
  • 200 to 399: Admin Expenses
String
Additional attributes for income categories
group_description Name of the group to which the category belongs String
auto_sales_tax_rate One of the following:

  • Outside of the scope of VAT
  • Zero rate
  • Reduced rate
  • Standard rate

String
Additional attributes for spending categories
group_description Name of the group to which the category belongs String
allowable_for_tax true if cost can be deducted from income when working out your tax bill, false otherwise Boolean
tax_reporting_name Where the category is reported in the Statutory Accounts String
auto_sales_tax_rate One of the following:

  • Outside of the scope of VAT
  • Zero rate
  • Reduced rate
  • Standard rate

String

List all categories

Returns the list of all categories for the current company in four sets: Admin Expenses, Cost of Sales, Income and General. The list of categories varies between companies as users can create custom categories.

GET https://api.freeagent.com/v2/categories

Response

Status: 200 OK

For clarity, only one category per set is shown below

{
  "admin_expenses_categories": [
    {
        "url": "https://api.freeagent.com/v2/categories/285",
        "description": "Accommodation and Meals",
        "nominal_code": "285",
        "allowable_for_tax": true,
        "tax_reporting_name": "Travel and subsistence expenses",
        "auto_sales_tax_rate": "Standard rate"
    },
  ],
  "cost_of_sales_categories": [
    {
        "url": "https://api.freeagent.com/v2/categories/102",
        "description": "Commission Paid",
        "nominal_code": "102",
        "allowable_for_tax": true,
        "tax_reporting_name": "Commissions Payable",
        "auto_sales_tax_rate": "Standard rate"
    }
  ],
  "income_categories": [
    {
        "url": "https://api.freeagent.com/v2/categories/001",
        "description": "Sales",
        "nominal_code": "001",
        "auto_sales_tax_rate": "Standard rate"
    }
  ],
  "general_categories": [
    {
        "url": "https://api.freeagent.com/v2/categories/051",
        "description": "Interest Received",
        "nominal_code": "051"
    }
  ]
}
Show as XML
<?xml version="1.0" encoding="UTF-8"?>
<freeagent>
  <admin-expenses-categories type="array">
    <admin-expenses-category>
      <url>https://api.freeagent.com/v2/categories/285</url>
      <description>Accommodation and Meals</description>
      <nominal-code>285</nominal-code>
      <allowable-for-tax type="boolean">true</allowable-for-tax>
      <tax-reporting-name>Travel and subsistence expenses</tax-reporting-name>
      <auto-sales-tax-rate>Standard rate</auto-sales-tax-rate>
    </admin-expenses-category>
  </admin-expenses-categories>
  <cost-of-sales-categories type="array">
    <cost-of-sales-category>
      <url>https://api.freeagent.com/v2/categories/102</url>
      <description>Commission Paid</description>
      <nominal-code>102</nominal-code>
      <allowable-for-tax type="boolean">true</allowable-for-tax>
      <tax-reporting-name>Commissions Payable</tax-reporting-name>
      <auto-sales-tax-rate>Standard rate</auto-sales-tax-rate>
    </cost-of-sales-category>
  </cost-of-sales-categories>
  <income-categories type="array">
    <income-category>
      <url>https://api.freeagent.com/v2/categories/001</url>
      <description>Sales</description>
      <nominal-code>001</nominal-code>
      <auto-sales-tax-rate>Standard rate</auto-sales-tax-rate>
    </income-category>
  </income-categories>
  <general-categories type="array">
    <general-category>
      <url>https://api.freeagent.com/v2/categories/051</url>
      <description>Interest Received</description>
      <nominal-code>051</nominal-code>
  </general-categories>
<freeagent>
Show as JSON

Get a single category

GET https://api.freeagent.com/v2/categories/:nominal_code

Response

Status: 200 OK
{
  "income_categories": {
      "url": "https://api.freeagent.com/v2/categories/001",
      "description": "Sales",
      "nominal_code": "001",
      "auto_sales_tax_rate": "Standard rate"
  }
}
Show as XML
<?xml version="1.0" encoding="UTF-8"?>
<freeagent>
  <income-categories>
    <url>https://api.freeagent.com/v2/categories/001</url>
    <description>Sales</description>
    <nominal-code>001</nominal-code>
    <auto-sales-tax-rate>Standard rate</auto-sales-tax-rate>
  </income-categories>
</freeagent>
Show as JSON