Table of Contents

Expenses API v1

Overview

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

The endpoint can be found at: https://api.reckon.com/R1/{BOOKID}/expenseclaims

Methods supported:   GET, POST

The Book ID represents the unique GUID of the Book the user wants to write data to. For example c1b3da90-e9df-4d57-8cfb-71a1d7bfe401 

 

Reckon One Module

Endpoint

Additional Parameter(s)

HTTP Method

Request URL

Description

API Portal

Countries

Time and Expenses

Expenses

/expenseclaims

GET

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

Get a list of the expense claims in the book

Portal

AU/NZ/UK

Time and Expenses

Expenses

/expenseclaims/{id}

GET

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

Get a specific expense claim from the book returned with additional data

Portal

AU/NZ/UK

Time and Expenses

Expenses

/expenseclaims

POST

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

Post an expense claim to the book

Portal

AU/NZ/UK

 

Sample

Get list of Expense Claims

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

Method: GET  

 

{
     "CashbookID": "e17417ac-fc79-4d4d-9ee8-1780b3bc326f",
     "Id": "0e9a8bac-dd82-4efb-be17-446e81a3ddf3",
     "ClaimAmount": 89.7000,
     "ClaimDate": "2016-08-17T00:00:00+00:00",
     "ClaimNumber": "EXP0097",
     "ClaimOrder": 40,
     "CustomerID": null,
     "CustomerName": null,
     "EmployeeContactID": "7a900a85-fac7-4f05-bbb4-a16edd8894c0",
     "EmployeeName": "Steve Jobs",
     "Balance": 0.0000,
     "IsSubProject": false,
     "ProjectID": null,
     "ProjectName": null,
     "ProjectPath": null,
     "Status": 1,
     "Unbilled": 89.7000,
     "UserID": null
   }

 

Details of each object

Data Field

Description

Data Type

CashBookID

The id of the cashbook the data is from

GUID

ID

The ID of the expense claim

GUID

ClaimAmount

The total amount of the claim

Numeric

ClaimDate

The date of the claim

Date/Time

ClaimNumber

The number of the claim

Alphanumeric

ClaimOrder

Internal Use Only

Numeric

CustomerID

If the expense claim is linked to a customer their ID will appear here

GUID

CustomerName

If the expense claim is linked to a customer their name will appear here

Alphanumeric

EmployeeContactID

If the expense claim is linked to a employee their ID will appear here

GUID

EmployeeName

If the expense claim is linked to a employee their name will appear here

Alphanumeric

Balance

The balance of the claim. If 0.00 it means the claim has been fully paid out

Numeric

IsSubProject

If the expense claim is linked to a project, this will be true if the project is the subproject of another

Boolean true/false

ProjectID

If the expense claim is linked to a project this will be the ID of the project it is linked to

GUID

ProjectName

If the expense claim is linked to a project this will be the name of the project it is linked to

Alphanumeric

ProjectPath

Internal use only

Text

Status

The status of the expense claim

Set data types:

1 - Draft

2 - Approved

3 - Paid

Unbilled

Whether a billable bill has been assigned to a customer

The amount that hasn't been billed yet

UserID

The GUID of the user which entered the expense claim into the Reckon One book.

GUID

Get a list of Expense Claims by ID

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

Method: GET

 

{
   "AccountsPayableAccountingCategoryID": "c806a197-4fb0-400e-8f93-513a2386bcf6",
   "Allocations": [],
   "AmountTaxStatus": 3,
   "CashbookId": "e17417ac-fc79-4d4d-9ee8-1780b3bc326f",
   "ClaimDate": "2017-01-12T00:00:00",
   "ClaimNumber": "EXP0119",
   "CompanyName": "ABC Building",
   "CustomerId": "00000000-0000-0000-0000-000000000000",
   "EmployeeContactID": "5a2b0d5c-daf8-4b22-b8bd-c333a453e751",
   "ExpenseClaimAmount": 5020.0000,
   "ExpenseClaimItems": [
     {
       "CustomerID": "0790a34c-1315-40da-a3c9-6e0d1c78e96b",
       "Date": "2017-01-12T00:00:00",
       "ExpenseClaimID": "d81c6f79-8794-4f4b-bf92-f2c2cb07c38d",
       "ExpenseClaimLineItemID": "4b691f42-d7a9-468e-b7dd-9a61a3627464",
       "IsBillable": true,
       "Notes": null,
       "Status": 3,
       "SupplierID": "00000000-0000-0000-0000-000000000000",
       "DiscountAmountExTax": null,
       "DiscountAmountTax": null,
       "DiscountAccuracy": null,
       "DiscountPercent": null,
       "Amount": 5020.00,
       "AmountAccuracy": null,
       "InvoiceDiscountedAmountExTax": 5020.00,
       "InvoiceDiscountedTaxAmount": 0.0000,
       "HasDataForPosting": true,
       "IsSubTotal": false,
       "IsParent": false,
       "IsHidden": false,
       "AccountId": "11c92368-9cb4-4024-9f78-92aaf6abe940",
       "PrintGroupAsSingleLine": false,
       "Id": "00000000-0000-0000-0000-000000000000",
       "ChargeableItemId": "00000000-0000-0000-0000-000000000000",
       "LineNo": 1,
       "Description": "Bank Fee description",
       "Quantity": null,
       "ProjectId": "00000000-0000-0000-0000-000000000000",
       "UnitPriceExTax": 0.0,
       "UnitPriceTax": 0.0,
       "UnitPricePrecision": 2.0,
       "UnitPriceIsTaxInclusive": false,
       "TaxGroupId": "cf46f8f0-d301-4ba1-8d52-aeffb506b571",
       "TaxIsModified": false,
       "TaxAmount": 0.0000,
       "AmountExTax": 5020.0000
     }
   ],
   "ExpenseClaimTax": 0.0000,
   "Id": "d81c6f79-8794-4f4b-bf92-f2c2cb07c38d",
   "LegalName": "ABC Building Pty Ltd",
   "Notes": null,
   "ProjectID": "00000000-0000-0000-0000-000000000000",
   "ReferenceCode": null,
   "Status": 2,
   "TemplateId": "d4ef2f8d-78a9-47c3-99b9-3942d99f82ee"
}  

Details of each object

Data Field

Description

Data Type

AccountsPayableCategoryID

The accounts payable account that the expense claim is linked to

GUID

Allocations Array

If there is any allocations linked to this expense claim

Array

AmountTaxStatus

The tax status of the Expense Claim

Set data types:

1 - Non Taxed

2 - Taxed (Net)

3 - Taxed (Gross)

 

CashBookID

The id of the cashbook the expense claim is from

GUID

ClaimDate

The date of the expense claim

Date/Time

ClaimNumber

The number of the expense claim

Numeric

CompanyName

The name of the company the expense claim is linked to

Alphanumeric

CustomerID

If the expense claim is linked to a customer the customers ID will appear here

GUID

EmployeeContactID

If the expense claim is linked to a employee the employees ID will appear here

GUID

ExpenseClaimAmount

The total amount for the expense claim

Numeric

Expense Claim Items Array

This array contains the individual links that appear on the expense claim

Array

CustomerID

If a customer is linked to the line of the expense claim their ID will appear here

GUID

Date

The Date entered against this line in the expense claim

Date/Time

ExpenseClaimID

The id of the expense claim

GUID

ExpenseClaimLineItemID

The id of the line on the expense claim

GUID

IsBillable

Whether the line is set to billable or not

Boolean true/false

Notes

Any notes entered against the line on the expense claim

 

Status

Whether the line is billable or not

Set data types:

2 - Unbillable

3 - Billable

SupplierID

If the line on the expense claim is linked to a supplier their ID will appear here

GUID

DiscountAmountExTax

The amount of discount applied to the line without tax

Numeric

DiscountAmountTax

The amount of tax discount applied to the line

Numeric

DiscountAccuracy

How many decimal places were used to calculate the discount up to 8. Can be null.

Numeric

DiscountPercent

The amount of percentage discount applied to the line if any

Numeric

Amount

The amount of the line 

Numeric

AmountAccuracy

How many decimal points are associated with the amount for the total lineup to 8. Is 2 by default and can be posted as null.

Numeric

InvoiceDiscountedAmountExTax

The amount of the line including any discounts without tax

Numeric

InvoiceDiscountedTaxAmount

The tax amount of the line including any discounts

Numeric

HasDataForPosting

If not set to true this will post as a non-posting transaction which cannot be currently changed in the UI. ** POST AS TRUE.

Boolean

true/false

IsSubtotal

Whether the line is a subtotal line or not

Boolean true/false

IsParent

Whether the line has sublines attached to it

Boolean true/false

IsHidden

Whether the line is hidden on the UI for the expense claim

Boolean true/false

AccountID

The ID of any account attached to the line

GUID

PrintGroupAsSingleLine

Whether the user has set to print a group of lines a a single line

Boolean true/false

ChargeableItemID

If a item was applied to the line its ID will appear here

GUID

LineNo

The line number on the expense claim

Numeric

Description

Any descriptionm entered on the line for the expense claim

Alphanumeric

Quantity

If a quantity is associated with the expense claim line it will appear here

Numeric

ProjectID

If the line has been linked with a project its ID will appear here

GUID

UnitPriceExTax

If a item has been linked to the line a unit price will appear here minus tax

Numeric

UnitPriceTax

If a item has been linked to the line the tax amount of the unit price will appear here

Numeric

UnitPricePrecision

How many decimal places are included in the unit price. It is important for tax calcs and by default will set to 2.0

Numeric

UnitPriceIsTaxInclusive

Whether the unit price is inclusive of tax or not

Boolean true/false

TaxGroupID

The ID of the tax item linked to the line on the expense claim

GUID

TaxIsModified

If its false, your tax calculations will be compared against the Reckon One tax engine and if it does not match the transaction is blocked. If set to true, the engine is not checked and you can post any tax you desire. The UI also controls this function via SETTINGS for the same purpose.

Boolean true/false

TaxAmount

Any tax amount associated with the line

Numeric

AmountExTax

The amount of the line minmus any tax amounts

Numeric

 

POST an Expense Claim

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

Method: POST

 

{
   "EmployeeContactId": "86a9a1b7-e28c-4997-b849-d4402144c1a2",
   "CustomerId": "af0b1e11-c327-40f5-af65-27c155367305",
   "Status": 1,
   "ClaimNumber": null,
   "ReferenceCode": null,
   "ProjectId": "e3dbab49-50f2-4c12-8a30-d30227165d04",
   "ClaimDate": "2016-09-07T00:00:00",
   "TemplateId": "64d80480-11b2-4e87-a9af-0f8bd5e0c24e",
   "AccountsPayableAccountingCategoryId": "66bafa47-a83d-4b87-8bc5-06b81733e6f",
   "ExpenseClaimAmount": 41.0,
   "ExpenseClaimTax": 1.0,
   "AmountTaxStatus": 2,
   "ExpenseClaimItems": [
     {
       "Date": "2016-09-07T00:00:00",
       "SupplierID": "e38db1f9-cbe6-4b4a-a1b6-fc4c7f1ac41c",
       "CustomerID": "af0b1e11-c327-40f5-af65-27c155367305",
       "Notes": "qqqqqqqqqqq",
       "IsBillable": false,
       "Status": 1,
       "DiscountAmountExTax": null,
       "DiscountAmountTax": null,
       "DiscountAccuracy": null,
       "DiscountPercent": null,
       "Amount": 11.0,
       "AmountAccuracy": null,
       "InvoiceDiscountedAmountExTax": 10.0,
       "InvoiceDiscountedTaxAmount": 1.0,
       "HasDataForPosting": true,
       "IsSubTotal": false,
       "IsParent": false,
       "IsHidden": false,
       "AccountId": "bbf4c47e-afdc-4632-b9d2-07912889eb4a",
       "PrintGroupAsSingleLine": false,
       "ChargeableItemId": null,
       "LineNo": 1,
       "Description": "qqqqq",
       "Quantity": null,
       "ProjectId": "e3dbab49-50f2-4c12-8a30-d30227165d04",
       "UnitPriceExTax": 0.0,
       "UnitPriceTax": 0.0,
       "UnitPricePrecision": 0.0,
       "UnitPriceIsTaxInclusive": false,
       "TaxGroupId": "a23b1b14-40e1-4cd2-a60a-0d6fa995c1e1",
       "TaxIsModified": false,
       "TaxAmount": 1.0,
       "AmountExTax": 10.0
     },
     {
       "Date": "2016-09-07T00:00:00",
       "SupplierID": "2ba2f113-e2bd-40df-b6ca-dce68f5f8640",
       "CustomerID": "af0b1e11-c327-40f5-af65-27c155367305",
       "Notes": "xxxxx",
       "IsBillable": false,
       "Status": 1,
       "DiscountAmountExTax": null,
       "DiscountAmountTax": null,
       "DiscountAccuracy": null,
       "DiscountPercent": null,
       "Amount": 30.0,
       "AmountAccuracy": null,
       "InvoiceDiscountedAmountExTax": 30.0,
       "InvoiceDiscountedTaxAmount": null,
       "HasDataForPosting": true,
       "IsSubTotal": false,
       "IsParent": false,
       "IsHidden": false,
       "AccountId": null,
       "PrintGroupAsSingleLine": false,
       "ChargeableItemId": "5ff29403-205e-40e0-adab-202dec0bd6c4",
       "LineNo": 2,
       "Description": "cbcvbcvb",
       "Quantity": 1.0,
       "ProjectId": "e3dbab49-50f2-4c12-8a30-d30227165d04",
       "UnitPriceExTax": 30.0,
       "UnitPriceTax": 0.0,
       "UnitPricePrecision": 0.0,
       "UnitPriceIsTaxInclusive": false,
       "TaxGroupId": null,
       "TaxIsModified": false,
       "TaxAmount": null,
       "AmountExTax": 30.0
     }
   ],
   "Notes": null
 }
Details of each object

Data Field

Description

Data Type

EmployeeContactID

The ID of the employee the expense claim is associated with

GUID

CustomerID

The ID of the customer the expense claim is associated with

GUID

Status

The status of the expense claim

Set data types:

1- Draft

2 - Approved

3 - Paid

ClaimNumber

The number to be associated with the expense claim

Alphanumeric

ReferenceCode

Any reference to be associated with the expense claim

Alphanumeric

ProjectID

If the expense claim is to be linked to a project include the GUID of the project here

GUID

ClaimDate

The date for the expense claim

Date/Time

TemplateID

The template to be used with this expense claim

GUID

AccountsPayableAccountingCategoryID

The ID of the accounts payable account to associate with the expense claim

GUID

ExpenseClaimAmount

The amount of the expense claim

Numeric

ExpenseClaimTax

The tax amount of the expense claim

Numeric

AmountTaxStatus

The tax status of the expense claim

Set data types:

1- Untaxable

2 - Taxable Net

3 - Taxable Gross

ExpenseClaimItemsArray

This array contains the line items for the expense claim

Array

Date

The date to be associated with the expense claim line

Date/Time

SupplierID

If a supplier is to be linked to the expense claim line include their ID here

GUID

CustomerID

If a customer is to be linked to the expense claim include their ID here

GUID

Notes

Any notes to associate with the expense claim line

Alphanumeric

IsBillable

Whether the expense claim line should be marked as billable

Boolean true/false

Status

Whether the expense claim is billable or not

Set data types:

2- Unbillable

3- Billable

DiscountAmountExTax

Any discount to be applied to the line without tax

Numeric

DiscountAmounTax

Any discount to be applied to the lines tax amount

Numeric

DiscountAccuracy

How many decimal places are to be set with the discount up to 8. Can be null.

Numeric

DiscountPercent

Any percentage discount to apply to the line

Numeric

Amount

The amount of the line

Numeric

AmountAccuracy

How many decimal points are associated with the amount for the total transaction up to 8. Is 2 by default and can be posted as null.

Numeric

InvoiceDiscountedAmountExTax

The amount of the line including any discounts minus tax

Numeric

InvoiceDiscountedTaxAmount

The tax amount of the line including any discounts

Numeric

IsSubTotal

Whether the line is a subtotal line

Boolean true/false

IsParent

Whether the line is a parent of other sub lines or not

Boolean true/false

IsHidden

Whether the line should appear on the UI for the user or not

Boolean true/false

HasDataForPosting

If not set to true this will post as a non-posting transaction which cannot be currently changed in the UI. ** POST AS TRUE.

Boolean

true/false

AccountID

The id of any account to be associated with the line

GUID

PrintGroupAsSingleItem

Whether a group of line items should be printed as a single line

Boolean true/false

ChargeableItemID

If the line should be linked with a item the GUID of the item should appear here

GUID

LineNo

The line number on the expenses claim

Numeric

Description

The description to associate with the line

Alphanumeric

Quantity

Any quantity to be associated with the line

Numeric

ProjectID

The ID of the project to be associated with the line

GUID

UnitPriceExTax

The amount of the unit price without tax

Numeric

UnitPriceTax

The amount of the unit price tax amount

Numeric

UnitPricePrecision

How many decimal places the unit price has up to 8. Is important for tax calcs by default will set to 2.0

Numeric

UnitPriceIsTaxInclusive

Whether the unit price includes tax or not

Boolean true/false

TaxGroupId

The GUID of the tax item to be associated with the line item

GUID

TaxIsModified

If its false, your tax calculations will be compared against the Reckon One tax engine and if it does not match the transaction is blocked. If set to true, the engine is not checked and you can post any tax you desire. The UI also controls this function via SETTINGS for the same purpose.

Boolean true/false

TaxAmount

The tax amount of the line

Numeric

AmountExTax

The amount of the line without tax

Numeric

 

How did we do?

Timesheets API v1

Activity Statements

Related Articles

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

Powered by HelpDocs (opens in a new tab)