API Documentation

Welcome to the iBuildApp API documentation! You can use our API to access iBuildApp API endpoints for our solutions and features.

You can view code examples in the dark area to the right, and you can switch the programming language or format of the examples with the tabs in the top right (where available).

This is also intended to be an open doc, in that when developers create new features, they will be able to add any documentation here as well.

iBuildApp Timesheets

INTRO

Basic API for registering/authorizing a user, getting dashboard data and user history, starting/stopping time tracking, and adding new time sheet entries.

User Authorization

Request body (application/json):

{
    "email": "test@test.com",
    "password": "12345678"
}

Request data: JSON string with the following elements

Response body (application/json):

{
   "status": "SUCCESS",
   "message": "Successfully authorized.",
   "token": "$2y$10$UP8aZvonwuqnaSBrdpiB4eq5NI3VHZtzcFhC73o0Slf/6uSBU3.je"
}

Response data: JSON string with the following elements

User Registration

Request body (application/json):

{
    "email": "test@test.com",
    "password": "12345678",
    "first_name": "John",
    "last_name": "Doe"
}

Request data: JSON string with the following elements

Response body (application/json):

{
   "status": "SUCCESS",
   "message": "Successfully registered.",
   "token": "$2y$10$qhqCrGv2f6vxxnyy4PCWqe9OAmjjqNRDkfB4F8J6qV2mXq/wpQXni"
}

Response data: JSON string with the following elements

USER

User API for iBuildApp Timesheets, handling getting user information, creating/deleting/updating a user, and searching for user(s)

Get User Info

Request body (application/json):

{
    "user_id": 1
}

HTTP Request

POST /api/{APP_CODE}/user

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

Response data: JSON string with the following elements

Data:

• id (Integer) -
• email (String) -
• first_name (String) -
• last_name (String) -
• sex (String) - male or female
• position (String) - specialization, profession
• hourly_rate (Float) - hourly rate of user
• roles (Array) - role in app. Default - ROLE_USER
• created (Timestamp) -
• updated (Timestamp) -
• exported (Timestamp) - Date + Time of export to QBO,Xero,ADP
• settings (Array) - user properties for application
• picture (String) - link to user avatar
• paid_hours (Float) - total number of paid hours
• unapproved_hours (Float) - total number of unapproved hours
• teams (Array) - IDs of usergroups
• notes (String) - Notes fo admin. Visible only for admin.
• birth_date (Date) - YYYY-MM-DD

200 Response body (application/json):

{
   "status": "SUCCESS",
   "data": {
       "id": 1,
       "email": "test@test.com",
       "first_name": "John",
       "last_name": "Doe",
       "sex": "male",
        "position": "Manager",
        "hourly_rate": 5.5,
        "roles": [
          "ROLE_USER"
        ],
        "created": 1583905200,
        "updated": 1583905200,
        "exported": 1583905200,
        "activated": true,
        "settings": [
          {}
        ],
        "picture": "url_to_user_avatar",
        "paid_hours": 0,
        "unapproved_hours": 0,
        "teams": [
          0
        ],
        "notes": "description",
        "birth_date": "1988-11-22"
   }
}

401 Unauthorized. Response body (application/json):

{
     "status": "ERROR",
     "message": "Auth token not specified or incorrect.",
     "error_code": 9
}

404 User not found. Response body (application/json):

{
     "status": "ERROR",
      "message": "User not found.",
      "error_code": 5
}

Create New User

Request body (application/json):

{
    "email": "test2@test.com",
    "password": "string",
     "first_name": "John",
     "last_name": "Doe",
     "sex": "male",
     "position": "Manager",
     "hourly_rate": 10.5,
     "settings": [
        {}
      ],
     "notes": "string",
     "birth_date": "1988-11-22"
}

HTTP Request

POST /api/{APP_CODE}/user/create

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

Data:

• email (String. REQUIRED) -
• password (String) - Lengh need >=8 and <=15 characters
• first_name (String) -
• last_name (String) -
• sex (String) - male or female
• position (String) - specialization, profession
• hourly_rate (Float) - hourly rate of user
• settings (Array) - user properties for application
• notes (String) - Notes fo admin. Visible only for admin.
• birth_date (Date) - YYYY-MM-DD

200 Response body (application/json):

{
   "status": "SUCCESS",
   "message": "Successfully created.",
   "id": 2
}

401 Response body (application/json):

{
   "status": "ERROR",
    "message": "Auth token not specified or incorrect.",
    "error_code": 9
}

Response data: JSON string with the following elements

Update User

Request body (application/json):

{
    "user_id": 2,
    "first_name": "Jack"
}

HTTP Request

POST /api/{APP_CODE}/user/update

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

200 Response body (application/json):

{
   "status": "SUCCESS",
   "message": "Successfully updated."
}

401 Unauthorized. Response body (application/json):

{
   "status": "ERROR",
   "message": "Auth token not specified or incorrect.",
   "error_code": 9
}

404 User not found. Response body (application/json):

{
   "status": "ERROR",
    "message": "User not found.",
    "error_code": 5
}

Response data: JSON string with the following elements

Search Users

Request body (application/json):

{
    "email": "test"
}

HTTP Request

POST /api/{APP_CODE}/user/search

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

200 Response body (application/json):

{
   "status": "SUCCESS",
   "message": "2 user(s) found.",
   "data": [
       {
           "id": 1,
           "email": "test@test.com",
           "first_name": "John",
           "last_name": "Doe"
       },
       {
           "id": 2,
           "email": "test2@test.com",
           "first_name": "Jack",
           "last_name": "Smith"
       }
   ],
  "count": 2
}

401 Unauthorized. Response body (application/json):

{
   "status": "ERROR",
   "message": "Auth token not specified or incorrect.",
   "error_code": 9
}

Response data: JSON string with the following elements

Data (Array) - array of User objects:

• id (Integer)
  
• email (String)
  
• first_name (String)
  
• last_name (String)
  

Search Users with Grouping

Request body (application/json):

{
    "group_by": "is_active",
    "order": "asc"
}

HTTP Request

POST /api/{APP_CODE}/user/search_group

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

200 Response body (application/json):

{
  "status": "SUCCESS",
  "message": "1 group(s) found.",
  "data": {
    "groups": [
      {
        "value": true,
        "count": 1,
        "items": [
          {
            "id": 0,
            "email": "email@domain.com",
            "first_name": "John",
            "last_name": "Smith",
            "sex": "male",
            "position": "Manager",
            "hourly_rate": 5.1,
            "roles": [
              "ROLE_USER"
            ],
            "created": 1583905200,
            "updated": 1583905200,
            "exported": 1583905200,
            "activated": true,
            "settings": [
              {}
            ],
            "picture": "url_to_user_avatar",
            "paid_hours": 0,
            "unapproved_hours": 0,
            "teams": [
              0
            ],
            "notes": "notes",
            "birth_date": "1988-11-22"
          }
        ]
      }
    ]
  },
  "count": 1
}

401 Unauthorized. Response body (application/json):

{
   "status": "ERROR",
   "message": "Auth token not specified or incorrect.",
   "error_code": 9
}

Response data: JSON string with the following elements

Data:

• count (Integer): - Count of finded groups
  
• groups: - array of objects:
  
  • value - Value of grouping field
    
  • count (Integer) - Count of items in group
    
  • items - Array of object:
    
    • id (Integer)
      
    • email (String)
      
    • first_name (String)
      
    • last_name (String)
      
    • sex (String)
      
    • position (String)
      
    • hourly_rate (Float) - hourly rate of user
      
    • roles (Array) - role in app. Default - ROLE_USER
      
    • created (Timestamp) -
      
    • updated (Timestamp) -
      
    • exported (Timestamp) - Date + Time of export to QBO,Xero,ADP
      
    • activated (Boolean) -
      
    • settings (Array) - user properties for application
      
    • picture (String) - link to user avatar
      
    • paid_hours (Float) - total number of paid hours
      
    • unapproved_hours (Float) - total number of unapproved hours
      
    • teams (Array) - IDs of usergroups
      
    • notes (String) - Notes for admin. Visible only for admin.
      
    • birth_date (Date) - YYYY-MM-DD
      

Delete User

Request body (application/json):

{
    "user_id": 2
}

HTTP Request

POST /api/{APP_CODE}/user/delete

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

200 Response body (application/json):

{
   "status": "SUCCESS",
   "message": "Successfully deleted."
}

401 Unauthorized. Response body (application/json):

{
   "status": "ERROR",
   "message": "Auth token not specified or incorrect.",
   "error_code": 9
}

404 User not found. Response body (application/json):

{
   "status": "ERROR",
    "message": "User not found.",
    "error_code": 5
}

Response data: JSON string with the following elements

Get User Dashboard Data

Request body (application/json):

{
    "user_id":1,
    "last_update":1565768191
}

HTTP Request

POST /api/{APP_CODE}/user/dashboard

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

200 Response body (application/json):

{
   "status": "SUCCESS",
   "message": "1 task(s) found.",
   "data": {
       "current_tasks": [
           {
               "id": 1,
               "name": "testTask",
               "status": "in-progress",
               "project": 1,   
               "duration": 10,
               "users": [
                 0
               ]
           }
       ],
       "current_time_entry": {
           "id": 3,
           "user_id": 1,
           "task_id": 1,
           "schedule_id": 1,
           "status": "in-progress",
           "start_time": 1565687043,
            "payment_status": "pending",
            "breaks": 2,
            "comments": "",
            "duration": 10
       }
   },
   "timestamp": 1565954217
}

401 Unauthorized. Response body (application/json):

{
   "status": "ERROR",
   "message": "Auth token not specified or incorrect.",
   "error_code": 9
}

404 User not found. Response body (application/json):

{
   "status": "ERROR",
    "message": "User not found.",
    "error_code": 5
}

Response data: JSON string with the following elements

Data:

• current_tasks: - array of Task objects:
  

  • id (Integer)
    
  • name (String)
    
  • status (String) May be: new, in-progress, cancelled, done
    
  • project (Integer) Project ID
    
  • duration (Integer) Duration in seconds
    
  • users (Array) - array of IDs related Users
    

• current_time_entry: - TimeEntry object:
  

  • id (Integer)
    
  • user_id (Integer)
    
  • task_id (Integer)
    
  • schedule_id (Integer)
    
  • status (String) May be: in-progress, rejected, approved
    
  • start_time (Timestamp)
    
  • end_time (Timestamp) (optional, if TimeEntry ended)
    
  • payment_status (String) May be: pending, payed
    
  • breaks (Integer) Count of breaks
    
  • comments (Integer) Count of comments
    
  • duration (Integer) Duration in seconds
    

Get User History

Request body (application/json):

{
    "user_id":1,
    "last_update":1565768191,
    "with": ["users", "tasks", "projects"],
    "filters": {"task_id": {"value": 2, "operand": "<"}, "status":"done"},
    "sorts": {"task_id": "desc"}
}

HTTP Request

POST /api/{APP_CODE}/user/history

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

200 Response body (application/json):

{
   "status": "SUCCESS",
   "message": "1 time entries found.",
   "data": {
       "time_entries": [
           {
               "id": 3,
               "user_id": 1,
               "task_id": 1,
               "status": "done",
               "start_time": "2019-08-13 12:04:03"
           }
       ],
       "tasks": {
           "1": {
               "id": 1,
               "project": 2,
               "name": "Test task 1",
               "status": "in-progress"
           }
       },
        "users": {
           "1": {
               "id": 1,
               "first_name": "John",
               "last_name": "Smith",
               "picture": "url_to_user_avatar"
           }
               },
       "projects": {
           "2": {
               "id": 2,
               "name": "Test project 1",
               "status": "in-progress"
           }
       }
   },
  "count": 1,
  "timestamp": 1565954217
}

401 Unauthorized. Response body (application/json):

{
   "status": "ERROR",
   "message": "Auth token not specified or incorrect.",
   "error_code": 9
}

404 User not found. Response body (application/json):

{
   "status": "ERROR",
    "message": "User not found.",
    "error_code": 5
}

Response data: JSON string with the following elements

• time_entries (Array) : - TimeEntry object:
  
  • id (Integer)
    
  • user_id (Integer)
    
  • task_id (Integer)
    
  • schedule_id (Integer)
    
  • status (String) May be: in-progress, rejected, approved
    
  • start_time (Timestamp)
    
  • end_time (Timestamp) (optional, if TimeEntry ended)
    
  • payment_status (String) May be: pending, payed
    
  • breaks (Integer) Count of breaks
    
  • comments (Integer) Count of comments
    
  • duration (Integer) Duration in seconds
    
  • created (Timestamp)
    
  • updated (Timestamp)
    
  • approve_date (Timestamp) (optional, if set)
    
  • start_location (Array) - array of coordinates
    
  • end_location (Array) - array of coordinates
    

if("with"=["tasks"]) :

• tasks (Array of [key:object]):
  
  • key (Integer) - Task ID
    
  • object:
    
    • id (Integer) - Task ID
      
    • project (Integer) - Project ID
      
    • name (String)
      
    • status (String) - May be: new, in-progress, cancelled, done
      

if("with"=["users"]) :

• users (Array of [key:object]
  
  • key (Integer) - User ID
    
  • object:
    
    • id (Integer) - User ID
      
    • first_name (String)
      
    • last_name (String)
      
    • picture (String) - link to user avatar
      

if("with"=["projects"]) :

• projects (Array of [key:object]
  
  • key (Integer) - Project ID
    
  • object:
    
    • id (Integer) - Project ID
      
    • name (String) -
      
    • status (String) - May be: new, in-progress, cancelled, done
      

GROUP

Group/Team API for iBuildApp Timesheets, handling getting group/team information, creating/deleting/updating a group/team, getting user(s) in a group/team, adding/deleting user(s) from group/team, and searching for group/team(s)

Get Group Info

Request body (application/json):

{
    "group_id":1
}

HTTP Request

POST /api/{app_path}/group

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

200 Response body (application/json):

{
    "status": "SUCCESS",
    "message": "Successfully found.",
    "data": {
        "id": 1,
        "name": "Group 1",
        "status": "active",
        "pay_rate": 10
    }
}

404 Not found. Response body (application/json):

{
   "status": "ERROR",
    "message": "Group not found.",
    "error_code": 5
}

Response data: JSON string with the following elements

data (Group object):

• id (Integer)
  
• name (Integer)
  
• status (String) - May be: "active" OR "inactive"
  
• pay_rate (Float)
  

Create New Group

Request body (application/json):

{
    "name":"nameTest"
}

HTTP Request

POST /api/{app_path}/group/create

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

Response body (application/json):

{
   "status": "SUCCESS",
   "message": "Successfully created.",
   "id": 1
}

Response data: JSON string with the following elements

Update Group

Request body (application/json):

{
    "group_id": 1,
    "name": "New_name",
    "description": "New_description"
}

HTTP Request

POST /api/{app_path}/group/update

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

200 Response body (application/json):

{
   "status": "SUCCESS",
   "message": "Successfully updated."
}

404 Not found. Response body (application/json):

{
   "status": "ERROR",
    "message": "Group not found.",
    "error_code": 5
}

Response data: JSON string with the following elements

Search Groups

Request body (application/json):

{
    "group_id":1
}

HTTP Request

POST /api/{app_path}/group/search

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

Must be at least one of parameters: group_id, name, keyword

Response 200 body (application/json):

{
    "status": "SUCCESS",
    "message": "1 group(s) found.",
    "data": [
        {
            "id": 1,
            "name": "Group 1",
            "status": "active",
            "pay_rate": 10
        }
    ],
    "count": 1
}

Response data: JSON string with the following elements

Data:

• time_entries (Array): - Array of Group objects:
  

  • id (Integer)
    
  • name (Integer)
    
  • status (String) - May be: "active" OR "inactive"
    
  • pay_rate (Float)
    

Add User to Group

Request body (application/json):

{
    "group_id":1,
    "user_id":2
}

HTTP Request

POST /api/{app_path}/group/add_user

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

200 Response body (application/json):

{
   "status": "SUCCESS",
   "message": "Successfully added."
}

404 Not found. Response body (application/json):

{
   "status": "ERROR",
    "message": "Group not found.",
    "error_code": 5
}

Response data: JSON string with the following elements

Delete User from Group

Request body (application/json): json { "group_id":1, "user_id":2 }

HTTP Request

POST /api/{app_path}/group/delete_user

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

200 Response body (application/json):

{
   "status": "SUCCESS",
   "message": "Successfully deleted."
}

404 Not found. Response body (application/json):

{
   "status": "ERROR",
    "message": "Group not found.",
    "error_code": 5
}

Response data: JSON string with the following elements

Get Users in Group

Request body (application/json):

{
    "group_id":1
}

HTTP Request

POST /api/{app_path}/group/get_users

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

200 Response body (application/json):

{
    "status": "SUCCESS",
    "message": "1 user(s) found.",
    "data": [
        {
            "id": 111,
            "email": "222@222.ru",
            "first_name": "222",
            "last_name": "2222",
            "hourly_rate": 0,
            "roles": ["ROLE_USER"],
            "created": 1591787712,
            "exported": 946684800,
            "updated": 1593163617,
            "activated": true,
            "settings": {
                "datetime_format": "d/m/Y h:ia"
            },
            "paid_hours": 0,
            "unapproved_hours": 4.01,
            "teams": [1],
            "birth_date": "1990-05-01"
        }
    ],
    "count": 1
}

404 Not found. Response body (application/json):

{
   "status": "ERROR",
    "message": "Group not found.",
    "error_code": 5
}

Response data: JSON string with the following elements

Data: array of User object:

• id (Integer)
  
• email (String)
  
• first_name (String)
  
• last_name (String)
  
• hourly_rate (Float)
  
• roles (Array) - role in app. Default - ROLE_USER
  
• created (Timestamp) -
  
• updated (Timestamp) -
  
• exported (Timestamp) - Date + Time of export to QBO,Xero,ADP
  
• activated (Boolean) -
  
• settings (Array) - user properties for application. Default: {"datetime_format": "d/m/Y h:ia"}
  
• paid_hours (Float) - total number of paid hours
  
• unapproved_hours (Float) - total number of unapproved hours
  
• picture (String)
  
• teams (Array) - Array of usergroup ID
  
• birth_date (String) - YYYY-MM-DD
  

Delete Group

Request body (application/json):

{
    "group_id":1
}

HTTP Request

POST /api/{app_path}/group/delete

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

200 Response body (application/json):

{
   "status": "SUCCESS",
   "message": "Successfully deleted."
}

404 Not found. Response body (application/json):

{
   "status": "ERROR",
   "message": "Group not found.",
   "error_code": 5
}

Response data: JSON string with the following elements

CLIENT

Client/Customer API for iBuildApp Timesheets, handling getting client/customer information, creating/deleting/updating a client/customer, and searching for client/customer(s)

Get Client Info

Request body (application/json):

{
    "client_id":1
}

HTTP Request

POST /api/{APP_CODE}/client

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

200 Response body (application/json):

{
  "status": "SUCCESS",
  "data": {
    "id": 0,
    "name": "Client Name",
    "email": "email@client.com",
    "contact_info": "contact_info...",
    "address": "address...",
    "state": "State",
    "website": "site...",
    "notes": "Descriptions...",
    "status": "active"
  }
}

404 Not found. Response body (application/json):

{
   "status": "ERROR",
    "message": "Client not found.",
    "error_code": 5
}

Response data: JSON string with the following elements

Data: Client object:

• id (Integer) - Client ID
  
• name (String)
  
• email (String)
  
• contact_info (String)
  
• address (String)
  
• state (String)
  
• city (String)
  
• website (String)
  
• industry (String)
  
• notes (String)
  
• status (String) - May be: "active", "inactive"
  
• projects (Array of Integer) - array of IDs related Projects
  

Create New Client

Request body (application/json):

{
    "name": "John Smith",
    "phone": 12345678912,
    "email": "mail@mail.com",
    "contact_info": "contact_info",
    "address": "test city, test street, test house",
    "city": "New-York",
    "state": "NY",
    "industry": "Finance",
    "website": "website.com",
    "notes": "Descriptions...",
    "status": true
}

HTTP Request

POST /api/{APP_CODE}/client/create

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

Response 200 body (application/json):

{
   "status": "SUCCESS",
   "message": "Successfully created.",
   "id": 1
}

Response data: JSON string with the following elements

Update Client

HTTP Request

POST /api/{APP_CODE}/client/update

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request body (application/json):

{
  "client_id": 1,
  "name": "John Doe"
}

Request data: JSON string with the following elements

200 Response body (application/json):

{
   "status": "SUCCESS",
   "message": "Successfully updated."
}

404 Not found. Response body (application/json): json { "status": "ERROR", "message": "Client not found.", "error_code": 5 }

Response data: JSON string with the following elements

Search Clients

HTTP Request

POST /api/{APP_CODE}/client/search

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request body (application/json):

{
    "name": "John",
    "with": ["projects"]
}

Request data: JSON string with the following elements

Response body (application/json):

{
  "status": "SUCCESS",
  "message": "1 client(s) found.",
  "data": {
    "clients":[
    {
        "id": 0,
        "name": "John Smith",
        "phone": 12345678912,
        "email": "mail@mail.com",
        "contact_info": "contact_info",
        "address": "test city, test street, test house",
        "city": "New-York",
        "state": "NY",
        "industry": "Finance",
        "website": "website.com",
        "notes": "Descriptions...",
        "status": "active",
        "projects": [4,3,1]
    }
  ],
      "projects": {
      "1": {
          "id": 1,
          "name": "Project #1",
          "status": "in-progress"
      },
      "4": {
          "id": 4,
          "name": "Brand Launch Event",
          "status": "in-progress"
      },
      "3": {
          "id": 3,
          "name": "Project #3",
          "status": "in-progress"
      }
    }
},
  "count": 1
}

Response data: JSON string with the following elements

Data:

• clients: - array of Client objects:
  
  • id (Integer)
    
  • name (String)
    
  • phone (String)
    
  • email (String)
    
  • contact_info (String)
    
  • address (String)
    
  • state (String)
    
  • city (String)
    
  • industry (String)
    
  • website (String)
    
  • notes (String)
    
  • status - (String) - May be: "active" OR "inactive"
    
  • projects - (Array) - array of IDs related Projects
    

if ("with"=["projects"]):

• projects: - array of [key:object]:
  
  • key - Project ID
    
  • object :
    
    • id (Integer)
      
    • name (String)
      
    • status (String) - May be: "new", "in-progress", "cancelled", "done"
      

Search Clients with Grouping

HTTP Request

POST /api/{APP_CODE}/client/search_group

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request body (application/json):

{
    "group_by": "industry",
    "with": ["projects"]
}

Request data: JSON string with the following elements

Response body (application/json):

{
    "status": "SUCCESS",
    "message": "3 group(s) found.",
    "count": 3,
    "data": {
        "groups": [
            {
                "value": "IT",
                "count": 1,
                "items": [
                    {
                        "id": 146,
                        "email": "xero_customer_fa52f698-1244-47cd-8fb9-5f32b6490a55@mail.com",
                        "name": "City Agency",
                        "address": ";1237;;Oaktown;P O Box 4321 Central Mailing Centre  ",
                        "state": "",
                        "city": "Oaktown",
                        "industry": "IT"
                    }
                ]
            },
            {
                "value": "education",
                "count": 2,
                "items": [
                    {
                        "id": 142,
                        "email": "xero_customer_47f61ab1-5245-40a2-a3a5-bc224c850c8d@mail.com",
                        "name": "Bank West",
                        "address": ";9876;;Pinehaven;Procurement Services\n GPO 1234  ",
                        "state": "",
                        "city": "Pinehaven",
                        "industry": "education"
                    },
                    {
                        "id": 145,
                        "email": "xero_customer_37918a06-92f6-4edb-bfe0-1fc041c90f8b@mail.com",
                        "name": "Boom FM",
                        "address": ";;;;   ",
                        "industry": "education"
                    }
                ]
            },
            {
                "value": "?",
                "count": 2,
                "items": [
                    {
                        "id": 155,
                        "email": "xero_customer_021b18f8-b62f-4d8a-889e-71fd5427892a@mail.com",
                        "name": "Young Bros Transport",
                        "address": ";;;;   ",
                        "state": "",
                        "city": ""
                    },
                    {
                        "id": 156,
                        "email": "Birds@Intuit.com",
                        "name": "Amy's Bird Sanctuary",
                        "address": ";94326;CA;Bayshore;4581 Finch St.    ",
                        "state": "CA",
                        "city": "Bayshore",
                        "notes": "Imported from QBO as Customer 'Amy's Bird Sanctuary'",
                        "status": "active"
                    }
                ]
            }
        ],
        "projects": {
            "2": {
                "id": 2,
                "name": "Project #2",
                "status": "in-progress",
                "tasks": [10,8,6,4,2]
            },
            "6": {
                "id": 6,
                "name": "Brand Launch Event",
                "status": "in-progress"
            },
            "1": {
                "id": 1,
                "name": "Project #1",
                "status": "in-progress",
                "tasks": [9,7,5,3,1]
            }
        }
    }
}

Response data: JSON string with the following elements

Data:

• groups: - array of objects:
  
  • value - value of grouping field
    
  • count - count of items in group
    
  • items[object] - array of Client objects:
    
    • object:
      
      • id (Integer)
        
      • email (String)
        
      • name (String)
        
      • address (String)
        
      • state (String)
        
      • city (String)
        
      • industry (String)
        
      • notes
        
      • status - (String) "active" OR not present
        

if ("with"=["projects"]):

• projects[key:object] - list of related projects
  
  • key - Project ID
    
  • object:
    
    • id (Integer)
      
    • name (String)
      
    • tasks (Array of Integer) - array of ID related tasks
      
    • status (String) - May be: "new", "in-progress", "cancelled", "done"
      

Export Clients to CSV

HTTP Request

POST /api/{APP_CODE}/client/export_csv

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request body (application/json):

{
    "city": "Bayshore",
    "with": ["projects"]
}

Request data: JSON string with the following elements

Response data: file

Format of CSV:

• id
• email
• name
• contact_info
• address
• state
• city
• industry
• website
• notes
• status - "active" OR not present
(if "with"=["projects"]):
• projects - Array of IDs related projects

Delete Client

HTTP Request

POST /api/{APP_CODE}/client/delete

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request body (application/json):

{
    "client_id": 1
}

Request data: JSON string with the following elements

200 Response body (application/json):

{
   "status": "SUCCESS",
   "message": "Successfully deleted."
}

404 Not found. Response body (application/json):

{
   "status": "ERROR",
    "message": "Client not found.",
    "error_code": 5
}

Response data: JSON string with the following elements

INVOICE

Invoice API for iBuildApp Timesheets, handling getting invoice information, creating/deleting/updating an invoice, changing invoice status, and searching for invoice(s).

Get Invoice Info

HTTP Request

POST /api/{app_path}/invoice

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request body (application/json):

{
    "invoice_id":1
}

Request data: JSON string with the following elements

Response body 200 (application/json):

{
    "status": "SUCCESS",
    "message": "Successfully found.",
    "data": {
        "id": 1,
        "due_date": "1587340800",
        "payed_date": "1587340800",
        "amount": 100,
        "status": "paid"
    }
}

Response data: JSON string with the following elements

Data:

• id (Integer)
  
• due_date (Timestamp) -
  
• payed_date (Timestamp)
  
• amount (Float) -
  
• status (String) - May be: "new", "paid"
  

Create New Invoice

Request body (application/json):

{
    "client_id":1,
    "task_ids":[1,2]
}

HTTP Request

POST /api/{app_path}/invoice/create

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

200 Response body (application/json):

{
   "status": "SUCCESS",
   "message": "Successfully created.",
   "id": 2
}

404 Not found. Response body (application/json):

{
   "status": "ERROR",
   "message": "Client not found.",
   "error_code": 5
}

Response data: JSON string with the following elements

Update Invoice

Request body (application/json):

{
    "invoice_id":1,
    "amount":30.5
}

HTTP Request

POST /api/{app_path}/invoice/update

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

200 Response body (application/json):

{
   "status": "SUCCESS",
   "message": "Successfully updated."
}

404 Not found. Response body (application/json):

{
   "status": "ERROR",
   "message": "Invoice not found.",
   "error_code": 5
}

Response data: JSON string with the following elements

Set Invoice Status (Paid)

Set payed this invoice and all his timeEntries. ADMIN_ACCESS_ONLY

Request body (application/json):

{
    "invoice_id":2,
    "payed_date":1587081600
}

HTTP Request

POST /api/{app_path}/invoice/set_payed

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

Response body (application/json):

{
   "status": "SUCCESS",
   "message": "Successfully payed."
}

Response data: JSON string with the following elements

Search Invoices

Request body (application/json):

{
    "client_id":[1]
}

HTTP Request

POST /api/{app_path}/invoice/search

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

Response body (application/json):

{
    "status": "SUCCESS",
    "message": "1 invoice(s) found.",
    "data": [
        {
            "id": 1,
            "due_date": "1587340800",
            "payed_date": "1587340800",
            "amount": 100,
            "status": "paid"
        }
    ],
    "count": 1
}

Response data: JSON string with the following elements

Data (Array): array of Invoice object:

• id (Integer)
  
• due_date (Timestamp) -
  
• payed_date (Timestamp)
  
• amount (Float) -
  
• status (String) - May be: "new", "paid"
  

Search Invoices with Grouping

Request body (application/json):

{
    "client_id":[1],
    "group_by": "status",
    "order_by": "asc"
}

HTTP Request

POST /api/{app_path}/invoice/search_group

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

Response body (application/json):

{
    "status": "SUCCESS",
    "message": "1 group(s) found.",
    "data": {
        "groups": [
            {
                "value": "paid",
                "count": 1,
                "items": [
                    {
                        "id": 1,
                        "due_date": "1587340800",
                        "payed_date": "1587340800",
                        "amount": 100,
                        "status": "paid"
                    }
                ]
            }
        ]
    },
    "count": 1
}

Response data: JSON string with the following elements

Data:

• count (Integer): - Count of finded groups
  
• groups: - array of objects:
  
  • value - Value of grouping field
    
  • count (Integer) - Count of items in group
    
  • items - Array of object:
    
    • id (Integer)
      
    • due_date (Timestamp) -
      
    • payed_date (Timestamp)
      
    • amount (Float) -
      
    • status (String) - May be: "new", "paid"
      

Delete Invoice

Request body (application/json):

{
    "invoice_id":1
}

HTTP Request

POST /api/{app_path}/invoice/delete

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

200 Response body (application/json):

{
   "status": "SUCCESS",
   "message": "Successfully deleted."
}

404 Not found. Response body (application/json):

{
   "status": "ERROR",
   "message": "Invoice not found.",
   "error_code": 5
}

Response data: JSON string with the following elements

Add comment to invoice

Request body (application/json):

{
  "invoice_id": 1,
  "content": "content text"
}

HTTP Request

POST /api/{APP_CODE}/invoice/add_comment

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

200 Response body (application/json):

{
  "status": "SUCCESS",
  "id": 1
}

404 Not found. Response body (application/json):

{
   "status": "ERROR",
   "message": "Invoice not found.",
   "error_code": 5
}

Response data: JSON string with the following elements

Get comments of invoice

Request body (application/json):

{
    "invoice_id": 1,
    "with": ["users"]
}

HTTP Request

POST /api/{APP_CODE}/invoice/comments

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

200 Response body (application/json):

{
  "status": "SUCCESS",
  "data": {
    "comments": [
      {
        "id": 0,
        "commentator": 1,
        "content": "Comment text",
        "date": 1566402943
      }
    ],
    "users": {
      "1": {
        "id": 1,
        "first_name": "John",
        "last_name": "Smith",
        "picture": "url_to_user_avatar"
      }
    }
  },
  "count": 1
}

404 Not found. Response body (application/json):

{
   "status": "ERROR",
   "message": "Invoice not found.",
   "error_code": 5
}

Response data: JSON string with the following elements

Data:

• comments (Array): - Array of Comment objects:
  

  • id (Integer)
    
  • commentator (Integer) - User ID
    
  • content (String) - Text of comment
    
  • date (Timestamp) - Date of comment
    

• users (Array of [key:object]):
  

  • key (Integer) - User ID
    
  • object:
    
    • id (Integer)
      
    • first_name (String)
      
    • last_name (String)
      
    • picture (String) - Link to user avatar
      

TASK

Task API for iBuildApp Timesheets, handling getting task information, creating/deleting/updating a task, setting task status, adding/deleting user(s) from a task, and searching for task(s).

Get Task Info

Request body (application/json):

{
  "task_id": 1,
  "with": ["users","projects"]
}

HTTP Request

POST /timesheets/task

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request data: JSON string with the following elements

200 Response body (application/json):

{
  "status": "SUCCESS",
  "message": "string",
  "data": {
    "tasks": [
      {
        "id": 1,
        "name": "Task name",
        "project": 0,
        "duration": 100,
        "estimate": 100,
        "estimate_unit": "minutes",
        "estimate_hours": 3.2,
        "description": "description",
        "status": "new",
        "users": [0],
        "entries": [
          {
            "id": 0,
            "user_id": 0,
            "task_id": 0,
            "start_time": 1583905200,
            "end_time": 1583905200,
            "approve_date": 1583905200,
            "breaks": 0,
            "comments": 0,
            "duration": 0,
            "status": "in-progress",
            "payment_status": "pending",
            "start_location": [
              37.270248,
              -119.989356
            ],
            "end_location": [
              37.270248,
              -119.989356
            ]
          }
        ]
      }
    ],
    "users": {
      "0": {
        "id": 0,
        "email": "email@domain.com",
        "first_name": "John",
        "last_name": "Smith",
        "hourly_rate": 0,
        "picture": "url_to_user_avatar",
        "birth_date": "1988-11-22"
      }
    },
    "projects": {
      "0": {
        "id": 0,
        "name": "Project name",
        "description": "description...",
        "client_id": 0,
        "duration_unit": "minutes",
        "status": "new",
        "planned_start_date": 1583905200,
        "actual_start_date": 1583905200,
        "planned_end_date": 1583905200,
        "actual_end_date": 1583905200,
        "estimated_duration": 100,
        "actual_duration": 100,
        "tasks": [0]
      }
    }
  }
}

Response data: JSON string with the following elements

Data:

• tasks: - array of Task objects:
  
  • id (Integer)
    
  • name (String)
    
  • project (Integer) Project ID
    
  • duration (Integer) Duration in seconds
    
  • status (String) May be: new, in-progress, cancelled, done
    
  • users (Array) - array of IDs related Users
    
  • entries (Array) - array of [key: value]:
    
    • key (Integer) - TimeEntry ID
      
    • object:
      
      • id (Integer)
        
      • user_id (Integer)
        
      • task_id (Integer)
        
      • schedule_id (Integer)
        
      • status (String) May be: in-progress, rejected, approved
        
      • start_time (Timestamp)
        
      • end_time (Timestamp) (optional, if TimeEntry ended)
        
      • approve_date (Timestamp) (optional, if set)
        
      • payment_status (String) May be: pending, payed
        
      • breaks (Integer) Count of breaks
        
      • comments (Integer) Count of comments
        
      • duration (Integer) Duration in seconds
        
      • start_location (Array of Float) - array of coordinates
        
      • end_location (Array of Float) - array of coordinates
        

if "with" = ["users"]:

• users: - array of *[key:object]** related Clients:*
  
  • key - ID of User
    
  • object - User
    
    • id (Integer)
      
    • email (String)
      
    • first_name (String)
      
    • last_name (String)
      
    • hourly_rate (Float)
      
    • picture (String)
      
    • birth_date (String) - YYYY-MM-DD
      

if "with" = ["projects"]:

• projects: - array of *[key:object]** related Projects:*
  
  • key - ID of Project
    
  • object - Project
    
    • id (Integer)
      
    • name (String)
      
    • description (String)
      
    • client_id (Integer) - Client ID
      
    • duration_unit (String) - May be: minutes, hours, days, months, years
      
    • status (String) - May be: new, in-progress, cancelled, done
      
    • planned_start_date (Timestamp)
      
    • actual_start_date (Timestamp)
      
    • planned_end_date (Timestamp)
      
    • actual_end_date (Timestamp)
      
    • estimated_duration (Float)
      
    • actual_duration (Float)
      
    • tasks (Array of Integer) - Array of related Task ID
      

Create New Task

HTTP Request

POST /api/{app_path}/task/create

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request body (application/json):

{
    "project_id": 1,
    "name": "Task name",
    "estimate": 30,
    "estimate_unit": "minutes",
    "description": "description..."
}

Request data: JSON string with the following elements

200 Response body (application/json):

{
   "status": "SUCCESS",
   "message": "Successfully created.",
   "id": 2
}

404 Not found. Response body (application/json):

{
     "status": "ERROR",
      "message": "Project not found.",
      "error_code": 5
}

Response data: JSON string with the following elements

Update Task

HTTP Request

POST /timesheets/task/update

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request body (application/json):

{
  "task_id": 1,
  "name": "New name",
  "estimate": 32,
  "estimate_unit": "hours"
}

Request data: JSON string with the following elements

200 Response body (application/json):

{
  "status": "SUCCESS",
  "message": "Successfully updated."
}

404 Not found. Response body (application/json):

{
     "status": "ERROR",
      "message": "Task not found.",
      "error_code": 5
}

Response data: JSON string with the following elements

Search Tasks

HTTP Request

POST /api/{app_path}/task/search

HEADER: “Authorization” = Bearer {token} (Auth token. String. Required)

Request body (application/json):

{
  "project_id": 0,
  "with": ["users","projects"]
}

Request data: JSON string with the following elements

Response body (application/json):

{
  "status": "SUCCESS",
  "message": "1 task(s) found.",
  "data": {
    "tasks": [
      {
        "id": 0,
        "name": "Task name",
        "project": 0,
        "duration": 10,
        "status": "new",
        "users": [0],
        "entries": {
          "0": {
            "start_datetime": 1583905200,
            "end_datetime": 1583905200,
            "duration": 3600
          }
        }
      }
    ],
    "users": {
      "0": {
        "id": 0,
        "email": "email@mail.com",
        "first_name": "John",
        "last_name": "Smith",
        "hourly_rate": 10,
        "picture": "url_to_user_avatar",
        "birth_date": "1988-11-22",
        "teams": [0]
      }
    },
    "teams": {
      "0": {
        "id": 0,
        "name": "Group name",
        "description": "description...",
        "notes": "notes...",
        "status": "new",
        "pay_rate": 10.5
      }
    },
    "projects": {
      "0": {
        "id": 0,
        "name": "Project name",
        "description": "description...",
        "client_id": 0,
        "duration_unit": "minutes",
        "status": "new",
        "planned_start_date": 1583905200,
        "actual_start_date": 1583905200,
        "planned_end_date": 1583905200,
        "actual_end_date": 1583905200,
        "estimated_duration": 100,
        "actual_duration": 100,
        "tasks": [0]
      }
    },
    "count": 1
  }
}

Response data: JSON string with the following elements