Table of Contents

Items API v1

Overview

Reckon One API v2 is now available.
Items API v2 endpoints provides you with more information about your Items.

Endpoint: https://api.reckon.com/R1/{BOOKID}/items

Methods supported:  GET, POST, PUT, DELETE

Reckon One Module

Endpoint

Additional Parameter(s)

HTTP Method

Request URL

Description

API Portal

Countries

Core

Items

 

GET

https://api.reckon.com/R1/{BOOKID}/items

Retrieve a list of items

Portal

AU/NZ/UK

Core

Items

 

PUT

https://api.reckon.com/R1/{BOOKID}/items

Update an item

Portal

AU/NZ/UK

Core

Items

 

POST

https://api.reckon.com/R1/{BOOKID}/items

Create an item

Portal

AU/NZ/UK

Core

Items

/itemId

DELETE

https://api.reckon.com/R1/{BOOKID}/items

Delete items. If the item is used on a transaction, those transactions will need to be deleted before you can delete the item

Portal

AU/NZ/UK

 

 Sample

Sample response
{
"Id":"4ca28cda-92f1-4763-9550-0db480cf60d5",
"Name":"Milk",
"SalePrice":1.8181818182,
"SalePriceTaxInclusive":true,
"SaleTaxId":"eb2efb72-8b71-4cc3-bf46-6c681a3b63c4",
"SaleDescription":"Bottle of Milk",
"PurchasePrice":0.9090909091,
"PurchasePriceTaxInclusive":true,
"PurchaseTaxId":"b64cebe7-14eb-46aa-b83d-dfa352e461b5",
"PurchaseDescription":"Purchasing milk",
"IsActive":true,
"IsPurchased":true,
"IsSold":true,
"ItemCode":null
}

 

Sample Post
{ 
'ItemType':1, 
'Name':'ChocolateNutella, 
'SalePrice':5, 
'SalePriceTaxInclusive':false, 
'SaleDescription':null, 
'PurchasePrice':null, 
'PurchasePriceTaxInclusive':false, 
'PurchaseTaxId':null, 
'PurchaseDescription':null, 
'FullName':null, 
'ProjectRateApplied':false, 
'IsPurchased':false, 
'IsSold':false, 
'SoldOrPurchased':1, 
'ItemCode':null, 
'ItemStatus':1, 
'SaleCategoryId':'7696ebf4-39d1-4a55-9ffe-0ebe135dc4b5', 
'IsTaxInclusive':false
}

 

Sample Minimum Post

Below call will create an item called Coca Cola, mark it to be "Buy" only, set status as Active and assign an expense account to it)

{  
"Name":"Coca Cola",  
"ItemStatus":true,  
"ItemType":1,  
"SoldOrPurchased":2,  
"PurchaseCategoryId":"d8b3b024-cc93-46d8-91bd-37f8683237d7"
}

Details of each object

Data Field

Description

Data Type

Mandatory?

ID

The GUID of the item

GUID

Required for PUT (updating an item)

Name/FullName

Name of the item (Name on POST/ FullName on GET

Text

Yes

SalePrice

The Sale Price of the item

Number

No

*SalePriceTaxInclusive

Whether the sales price has tax included. *No longer required. Tax status for both sale and purchase price is now set by IsTaxInclusive

Boolean (true/false)

No

SaleTaxId

GUID of the tax code associated with the item. You can get the Id of the Tax item from this endpoint

GUID

No

SaleDescription

The sales description of the item

Text

No

PurchasePrice

The purchase price of the item

Number

No

*PurchasePriceTaxInclusive

Whether the purchase price includes tax. *No longer required. Tax status for both sale and purchase price is now set by IsTaxInclusive

Boolean (true/false)

No

PurchaseTaxId

The GUID of the tax code associated with the item. You can get the Id of the Tax item from this endpoint

GUID

No

PurchaseDescription

The purchase description of the item

Text

No

IsPurchased

Whether the item is purchased by the business to resell

Boolean (true/false)

No

IsSold

Whether the item is sold by the business

Boolean (true/false)

No

ItemCode

Item code of the item

Text

No

ProjectRateApplied

Whether the project rate should be applied to this item (write/edit only)

Boolean (true/false)

No

SoldOrPurchased

Whether the item is sold and purchased by the business (write/edit only)

1 – Sell Only

2 – Buy only

3 – Sell and Buy

Yes

ItemStatus

Whether the item is active in the book or not (write/edit only)

1– Active

2 – Inactive

Yes

SaleCategoryId

The Id of the Chart of Account that you want to link with this item, for example: "Income" account's Id (write/edit only)

GUID

Required if  SoldOrPurchased is 1 or 3

PurchaseCategoryID

The Id of the Chart of Account that you want to link with this item, for example: "Expense" account's Id (write/edit only)

GUID

Required if SoldOrPurchased is 2 or 3

IsTaxInclusive

Whether the sale and purchase amounts include tax (write/edit only)

Boolean (true/false)

No. If it's not provided then it's set to false

ParentChargeableItemID              

If the item is a subitem, the Id of the parent item. You can retrieve the Item's Id by performing a GET request to this Item endpoint

GUID

No

ItemType

The type of the item be it a product or service

1 – Product

2 - Service

Yes

 

How did we do?

Contacts API v1

Journals

Related Articles

Items API v2
Classifications API v1
Expenses API v1
Powered by HelpDocs (opens in a new tab)

Powered by HelpDocs (opens in a new tab)