Table of Contents
Projects
Overview
Projects API v2 endpoints provides you with more information about your Projects.
The endpoint can be found at: https://api.reckon.com/R1/{BOOKID}/projects
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 |
Projects | Projects |
| GET | Retrieve the list of projects | AU/NZ/UK | ||
Projects | Projects |
| POST | Create a project | AU/NZ/UK |
Sample
GET list of Projects
Endpoint: https://api.reckon.com/R1/{BOOKID}/projects
Method: GET
{
"ID":"2402abce-e210-4435-a32c-735e2d642874",
"Name":"H Project",
"Status":0
}Details of each object
Data Field | Description | Data Type |
ID | The unique ID of the project in the Reckon One book (file) | GUID |
Name | The name of the project | Alphanumeric |
Status | The status of the project | Set data types: 0 – Active 1 – Inactive 2 – Cancelled 3 - Completed |
POST a Project
Endpoint: https://api.reckon.com/R1/{BOOKID}/projects
Method: POST
{
'Name':’Building_2015’,
'StartDate':01.01.2015,
'EndDate':02.01.2015,
'Status':0,
'Description':'Shopping Centre',
'ProjectItems':[],
'Contacts':[],
'ParentId':'e52687e1-d598-4a32-b9ba-0f0370f5e94e'
}Details of each object
Data Field | Description | Data Type |
Name | The name of the project | Alphanumeric |
StartDate | Date of the start of the project | Date format (DD.MM.YYYY) |
End Date | Date of the end of the project | Date format (DD.MM.YYY) |
Status | The status of the project | Set data types: 0 – Active 1 – Inactive 2 – Cancelled 3 - Completed |
ParentId | If this is to be a subproject, the GUID of the main project | GUID |
Description | Description of the project | Text |
Contacts | You cannot add Contacts to a Project via Projects API v1. API v2 is now available that resolves this issue and it contains more features/enhancements. Click here to learn more. | |
ProjectItems | You cannot add Items to a Project via Projects API v1. API v2 is now available that resolves this issue and it contains more features/enhancements. Click here to learn more. |
