Price List Items

Minimum access level: Tax and Limited Accounting

Provides read-only access to the price list items defined in the FreeAgent account.

Attributes

Attribute Description Kind
url The unique identifier for the price list item URI
code A unique name / code used to identify the item when adding it to an invoice or estimate String
quantity Item quantity Decimal
item_type One of the following:

  • Hours
  • Days
  • Weeks
  • Months
  • Years
  • Products
  • Services
  • Training
  • Expenses
  • Comment
  • Bills
  • Discount
  • Credit
  • VAT
  • Stock

String
description Free-text description of the item String
price The unit price of one item Decimal
vat_status

One of the following:

  • reduced
  • standard
  • zero
String
stock_item Stock item, if item_type is stock URI

List all Price List Items

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

Response

{
  "price_list_items": [
    {
      "url": "https://api.freeagent.com/v2/price_list_items/1",
      "code": "A001",
      "item_type": "Products",
      "quantity": "1.0",
      "price": "10.99",
      "description": "Apple",
      "sales_tax_rate": "0.0",
      "second_sales_tax_rate": "0.0",
      "vat_status": "standard",
      "category": "https://api.freeagent.com/v2/categories/2"
    }
  ]
}
Show as XML
<?xml version="1.0" encoding="UTF-8"?>
<freeagent>
  <price-list-items type="array">
    <price-list-item>
      <url>https://api.freeagent.com/v2/price_list_items/1</url>
      <code>A001</code>
      <item-type>Products</item-type>
      <quantity>1.0</quantity>
      <price>10.99</price>
      <description>Apple</description>
      <sales-tax-rate>0.0</sales-tax-rate>
      <second-sales-tax-rate>0.0</second-sales-tax-rate>
      <vat-status>standard</vat-status>
      <category>https://api.freeagent.com/v2/categories/2</category>
    </price-list-item>
  </price-list-items>
</freeagent>
Show as JSON

Get a single Price List Item

GET https://api.freeagent.com/v2/price_list_item/:id

Response

Status: 200 OK
{
  "price_list_item": {
    "url": "https://api.freeagent.com/v2/price_list_items/1",
    "code": "A001",
    "item_type": "Products",
    "quantity": "1.0",
    "price": "10.99",
    "description": "Apple",
    "sales_tax_rate": "0.0",
    "second_sales_tax_rate": "0.0",
    "vat_status": "standard",
    "category": "https://api.freeagent.com/v2/categories/2"
  }
}
Show as XML
<?xml version="1.0" encoding="UTF-8"?>
<freeagent>
  <price-list-item>
    <url>https://api.freeagent.com/v2/price_list_items/1</url>
    <code>A001</code>
    <item-type>Products</item-type>
    <quantity>1.0</quantity>
    <price>10.99</price>
    <description>Apple</description>
    <sales-tax-rate>0.0</sales-tax-rate>
    <second-sales-tax-rate>0.0</second-sales-tax-rate>
    <vat-status>standard</vat-status>
    <category>https://api.freeagent.com/v2/categories/2</category>
  </price-list-item>
</freeagent>
Show as JSON