# CRMService API Documentation - 'Report' scope

# Index
- [Employees](#employees)
  - [Projects](#list-all-projects)
  - [Employees](#list-all-employees)
  - [Custom Tasks](#list-all-custom-tasks)
  - [Time Logs](#list-all-time-logs)
  - [Customers](#list-all-customers)
  - [Teams](#list-all-teams)
# Reports

## List all Projects

Shows a list of all projects.

```
GET /api/v1/reports/projects
```
Example response:

```json
{
    "jsonapi": {
        "version": "1.0",
        "build": "default-build-id-1"
    },
    "data": [
        {
            "id": 65,
            "name": "1039",
            "startedAt": null,
            "customer": "1",
            "owner": "4d4325",
            "status": "opportunity",
            "budget": "100000.0",
            "currency": "pln",
            "trelloBoardId": null,
            "trelloCardId": null,
            "hasLoggedTime": false,
            "assignees": [
                2,
                3
            ],
            "customTasks": [],
            "timeLogs": [],
            "nbkfqr": null,
            "ckqbbz": null,
            "jniexb": null,
            "uvyxeg": null,
            "xlbflf": null
        }
    ],
    "meta": null
}
```

## List all employees

Shows a list of all employees.

```
GET /api/v1/reports/employees
```
Example response:

```json
{
    "jsonapi": {
        "version": "1.0",
        "build": "default-build-id-1"
    },
    "data": [
        {
            "id": 49,
            "user": 17,
            "firstName": null,
            "lastName": null,
            "globalSalary": 11,
            "personalSalary": null,
            "projectedSalary": "0.0",
            "contract": "mandatory",
            "partTime": "1.0",
            "hourlyRateCurrency": "pln",
            "hourlyRate": 0,
            "leaves": [],
            "wallets": [
                59
            ],
            "vacationLeaveCount": 0,
            "vacationLeaveLeft": 0,
            "sickLeaveCount": 0,
            "specialLeaveCount": 0,
            "sex": null,
            "hiredAt": null,
            "jzhhyd": "",
            "afnmez": null,
            "firedAt": null
        }
    ],
    "meta": null
}
```

## List all custom tasks

Shows a list of all custom-tasks.

```
GET /api/v1/reports/custom-tasks
```
Example response:

```json
{
    "jsonapi": {
        "version": "1.0",
        "build": "default-build-id-1"
    },
    "data": [
        {
            "id": 13,
            "projectId": 89,
            "trelloId": "59a94612441125fe9cb7ae9e",
            "account": 2,
            "taskType": "external",
            "timeLogs": [1,2]
        }
    ],
    "meta": null
}
```
## List all time logs

Shows a list of all time-logs.

```
GET /api/v1/reports/time-logs
```
Example response:

```json
{
{
    "jsonapi": {
        "version": "1.0",
        "build": "default-build-id-1"
    },
    "data": [
        {
            "id": 14,
            "user": 7,
            "duration": 480,
            "customTask": 2,
            "day": "2019-02-12",
            "note": "asdasd",
            "customTaskTrelloId": "5c0f88714a744176be395338",
            "boardId": "5c0f884b47b68518adb9a536",
            "projectName": "Trello",
            "projectId": 87,
            "createdAt": "2019-02-20T12:55:06.420Z",
            "hourlyRate": "0.0",
            "hourlyRateCurrency": "PLN"
        }
    ],
    "meta": null
}
```

## List all customers

Shows a list of all customers.

```
GET /api/v1/reports/customers
```
Example response:

```json
{
    "jsonapi": {
        "version": "1.0",
        "build": "default-build-id-1"
    },
    "data": [
        {
            "id": 2,
            "name": "First57 Last57",
            "currency": "pln",
            "status": "active",
            "client": {
                "clientType": "Person",
                "id": "117",
                "name": "First57 Last57"
            },
            "defaultBillingPeriod": "not_applicable",
            "projects": [2],
            "offers": [1,2],
            "customTasks": [3,5],
            "timeLogs": [4],
            "teams": [1],
            "users": [2]
        }
    ],
    "meta": null
}
```
## List all teams

Shows a list of all teams.

```
GET /api/v1/reports/teams
```
Example response:

```json
{
    "jsonapi": {
        "version": "1.0",
        "build": "default-build-id-1"
    },
    "data": [
        {
            "id": 2,
            "name": "asssa",
            "color": "#d74343",
            "visibility": "public_team",
            "customers": [
                4,
                1
            ],
            "users": [
                3,
                7
            ],
            "invitedUsers": [23],
            "applyingUsers": [31,52]
        }
    ],
    "meta": null
}
```