Expenses

For the purpose of this article, we create one test project. Lets check if there are any expenses tracked in it:

Response: HTTP 200, application/json (Hide)

GET /projects/1/expenses

Response:

1
2
3
4
{
    "expenses": null,
    "related": null
}

Good, it's empty. Before we can add new records, we need to see which expense categories we have defined. We can get a list by requesting data from /expense-categories command:

Response: HTTP 200, application/json (Hide)

GET /expense-categories

Response:

1
2
3
4
5
6
7
8
9
[
    {
        "id": 1,
        "class": "ExpenseCategory",
        "url_path": "\/expense-categories\/1",
        "name": "General",
        "is_default": true
    }
]

Now that we know that we have a valid job type that we can use, lets add two expenses, one attached directly to the project (we simply ommit task_id value) and one added to a task:

Response: HTTP 200, application/json (Hide)

POST /projects/1/expenses

Payload:

1
2
3
4
5
6
{
    "value": 250,
    "user_id": 1,
    "category_id": 1,
    "record_date": "2014-05-14"
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
    "single": {
        "id": 1,
        "class": "Expense",
        "url_path": "\/projects\/1\/expenses\/1",
        "is_trashed": false,
        "trashed_on": null,
        "trashed_by_id": 0,
        "billable_status": 1,
        "value": 250,
        "record_date": 1400025600,
        "summary": null,
        "user_id": 1,
        "parent_type": "Project",
        "parent_id": 1,
        "created_on": 1430164097,
        "created_by_id": 1,
        "updated_on": 1430164097,
        "updated_by_id": 1,
        "category_id": 1,
        "currency_id": 2
    }
}

Response: HTTP 200, application/json (Hide)

GET /projects/1/tasks/1

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
{
    "single": {
        "id": 1,
        "class": "Task",
        "url_path": "\/projects\/1\/tasks\/1",
        "name": "Test Task #1",
        "assignee_id": 0,
        "delegated_by_id": 0,
        "completed_on": null,
        "completed_by_id": null,
        "is_completed": false,
        "comments_count": 0,
        "attachments": [],
        "labels": [],
        "is_trashed": false,
        "trashed_on": null,
        "trashed_by_id": 0,
        "project_id": 1,
        "is_hidden_from_clients": false,
        "body": "",
        "body_formatted": "",
        "created_on": 1430164096,
        "created_by_id": 1,
        "updated_on": 1430164096,
        "updated_by_id": 1,
        "task_number": 1,
        "task_list_id": 0,
        "position": 1,
        "is_important": false,
        "due_on": null,
        "estimate": 0,
        "job_type_id": 0,
        "total_subtasks": 0,
        "completed_subtasks": 0,
        "open_subtasks": 0
    },
    "subscribers": [
        1
    ],
    "comments": [],
    "reminders": [],
    "subtasks": [],
    "task_list": null,
    "tracked_time": 0,
    "tracked_expenses": 0
}

Response: HTTP 200, application/json (Hide)

POST /projects/1/expenses

Payload:

1
2
3
4
5
6
7
8
{
    "task_id": 1,
    "value": 380.5,
    "user_id": 1,
    "category_id": 1,
    "record_date": "2014-05-14",
    "billable_status": 0
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
    "single": {
        "id": 2,
        "class": "Expense",
        "url_path": "\/projects\/1\/expenses\/2",
        "is_trashed": false,
        "trashed_on": null,
        "trashed_by_id": 0,
        "billable_status": 0,
        "value": 380.5,
        "record_date": 1400025600,
        "summary": null,
        "user_id": 1,
        "parent_type": "Task",
        "parent_id": 1,
        "created_on": 1430164097,
        "created_by_id": 1,
        "updated_on": 1430164097,
        "updated_by_id": 1,
        "category_id": 1,
        "currency_id": 2
    }
}

Response: HTTP 200, application/json (Hide)

GET /projects/1/tasks/1

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
{
    "single": {
        "id": 1,
        "class": "Task",
        "url_path": "\/projects\/1\/tasks\/1",
        "name": "Test Task #1",
        "assignee_id": 0,
        "delegated_by_id": 0,
        "completed_on": null,
        "completed_by_id": null,
        "is_completed": false,
        "comments_count": 0,
        "attachments": [],
        "labels": [],
        "is_trashed": false,
        "trashed_on": null,
        "trashed_by_id": 0,
        "project_id": 1,
        "is_hidden_from_clients": false,
        "body": "",
        "body_formatted": "",
        "created_on": 1430164096,
        "created_by_id": 1,
        "updated_on": 1430164097,
        "updated_by_id": 1,
        "task_number": 1,
        "task_list_id": 0,
        "position": 1,
        "is_important": false,
        "due_on": null,
        "estimate": 0,
        "job_type_id": 0,
        "total_subtasks": 0,
        "completed_subtasks": 0,
        "open_subtasks": 0
    },
    "subscribers": [
        1
    ],
    "comments": [],
    "reminders": [],
    "subtasks": [],
    "task_list": null,
    "tracked_time": 0,
    "tracked_expenses": 380.5
}

Project's /expenses request should return all records that are tracked on that projects, including project's tasks:

Response: HTTP 200, application/json (Hide)

GET /projects/1/expenses

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
{
    "expenses": [
        {
            "id": 2,
            "class": "Expense",
            "url_path": "\/projects\/1\/expenses\/2",
            "is_trashed": false,
            "trashed_on": null,
            "trashed_by_id": 0,
            "billable_status": 0,
            "value": 380.5,
            "record_date": 1400025600,
            "summary": null,
            "user_id": 1,
            "parent_type": "Task",
            "parent_id": 1,
            "created_on": 1430164097,
            "created_by_id": 1,
            "updated_on": 1430164097,
            "updated_by_id": 1,
            "category_id": 1,
            "currency_id": 2
        },
        {
            "id": 1,
            "class": "Expense",
            "url_path": "\/projects\/1\/expenses\/1",
            "is_trashed": false,
            "trashed_on": null,
            "trashed_by_id": 0,
            "billable_status": 1,
            "value": 250,
            "record_date": 1400025600,
            "summary": null,
            "user_id": 1,
            "parent_type": "Project",
            "parent_id": 1,
            "created_on": 1430164097,
            "created_by_id": 1,
            "updated_on": 1430164097,
            "updated_by_id": 1,
            "category_id": 1,
            "currency_id": 2
        }
    ],
    "related": {
        "Project": {
            "1": {
                "id": 1,
                "class": "Project",
                "url_path": "\/projects\/1",
                "name": "Test Project",
                "completed_on": null,
                "completed_by_id": null,
                "is_completed": false,
                "members": [
                    1
                ],
                "category_id": 0,
                "label_id": 0,
                "is_trashed": false,
                "trashed_on": null,
                "trashed_by_id": 0,
                "created_on": 1430164096,
                "created_by_id": 1,
                "updated_on": 1430164097,
                "updated_by_id": 1,
                "body": null,
                "body_formatted": "",
                "company_id": 1,
                "leader_id": 1,
                "currency_id": 2,
                "template_id": 0,
                "based_on_type": null,
                "based_on_id": null,
                "email": "notifications+m2p-jIWb8Lm@mail.manageprojects.com",
                "is_tracking_enabled": true,
                "is_client_reporting_enabled": false,
                "budget": null,
                "count_tasks": 2,
                "count_discussions": 0,
                "count_files": 0,
                "count_notes": 0
            }
        },
        "Task": {
            "1": {
                "id": 1,
                "class": "Task",
                "url_path": "\/projects\/1\/tasks\/1",
                "name": "Test Task #1",
                "assignee_id": 0,
                "delegated_by_id": 0,
                "completed_on": null,
                "completed_by_id": null,
                "is_completed": false,
                "comments_count": 0,
                "attachments": [],
                "labels": [],
                "is_trashed": false,
                "trashed_on": null,
                "trashed_by_id": 0,
                "project_id": 1,
                "is_hidden_from_clients": false,
                "body": "",
                "body_formatted": "",
                "created_on": 1430164096,
                "created_by_id": 1,
                "updated_on": 1430164097,
                "updated_by_id": 1,
                "task_number": 1,
                "task_list_id": 0,
                "position": 1,
                "is_important": false,
                "due_on": null,
                "estimate": 0,
                "job_type_id": 0,
                "total_subtasks": 0,
                "completed_subtasks": 0,
                "open_subtasks": 0
            }
        }
    }
}

If we run the same request on task level, we should get only expeses tracked for that task:

Response: HTTP 200, application/json (Hide)

GET /projects/1/tasks/1/expenses

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
{
    "expenses": [
        {
            "id": 2,
            "class": "Expense",
            "url_path": "\/projects\/1\/expenses\/2",
            "is_trashed": false,
            "trashed_on": null,
            "trashed_by_id": 0,
            "billable_status": 0,
            "value": 380.5,
            "record_date": 1400025600,
            "summary": null,
            "user_id": 1,
            "parent_type": "Task",
            "parent_id": 1,
            "created_on": 1430164097,
            "created_by_id": 1,
            "updated_on": 1430164097,
            "updated_by_id": 1,
            "category_id": 1,
            "currency_id": 2
        }
    ],
    "related": {
        "Project": {
            "1": {
                "id": 1,
                "class": "Project",
                "url_path": "\/projects\/1",
                "name": "Test Project",
                "completed_on": null,
                "completed_by_id": null,
                "is_completed": false,
                "members": [
                    1
                ],
                "category_id": 0,
                "label_id": 0,
                "is_trashed": false,
                "trashed_on": null,
                "trashed_by_id": 0,
                "created_on": 1430164096,
                "created_by_id": 1,
                "updated_on": 1430164097,
                "updated_by_id": 1,
                "body": null,
                "body_formatted": "",
                "company_id": 1,
                "leader_id": 1,
                "currency_id": 2,
                "template_id": 0,
                "based_on_type": null,
                "based_on_id": null,
                "email": "notifications+m2p-jIWb8Lm@mail.manageprojects.com",
                "is_tracking_enabled": true,
                "is_client_reporting_enabled": false,
                "budget": null,
                "count_tasks": 2,
                "count_discussions": 0,
                "count_files": 0,
                "count_notes": 0
            }
        },
        "Task": {
            "1": {
                "id": 1,
                "class": "Task",
                "url_path": "\/projects\/1\/tasks\/1",
                "name": "Test Task #1",
                "assignee_id": 0,
                "delegated_by_id": 0,
                "completed_on": null,
                "completed_by_id": null,
                "is_completed": false,
                "comments_count": 0,
                "attachments": [],
                "labels": [],
                "is_trashed": false,
                "trashed_on": null,
                "trashed_by_id": 0,
                "project_id": 1,
                "is_hidden_from_clients": false,
                "body": "",
                "body_formatted": "",
                "created_on": 1430164096,
                "created_by_id": 1,
                "updated_on": 1430164097,
                "updated_by_id": 1,
                "task_number": 1,
                "task_list_id": 0,
                "position": 1,
                "is_important": false,
                "due_on": null,
                "estimate": 0,
                "job_type_id": 0,
                "total_subtasks": 0,
                "completed_subtasks": 0,
                "open_subtasks": 0
            }
        }
    }
}

In order to alter this value, we can send PUT request:

Response: HTTP 200, application/json (Hide)

PUT /projects/1/expenses/1

Payload:

1
2
3
4
{
    "value": 123.45,
    "billable_status": 1
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
    "single": {
        "id": 1,
        "class": "Expense",
        "url_path": "\/projects\/1\/expenses\/1",
        "is_trashed": false,
        "trashed_on": null,
        "trashed_by_id": 0,
        "billable_status": 1,
        "value": 123.45,
        "record_date": 1400025600,
        "summary": null,
        "user_id": 1,
        "parent_type": "Project",
        "parent_id": 1,
        "created_on": 1430164097,
        "created_by_id": 1,
        "updated_on": 1430164098,
        "updated_by_id": 1,
        "category_id": 1,
        "currency_id": 2
    }
}

We just realized that task expense that we added is logged for the incorrect task. Note that sending PUT request with project_id or task_id will note move the record:

Response: HTTP 200, application/json (Hide)

PUT /projects/1/expenses/2

Payload:

1
2
3
4
{
    "project_id": 2,
    "task_id": 2
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
    "single": {
        "id": 2,
        "class": "Expense",
        "url_path": "\/projects\/1\/expenses\/2",
        "is_trashed": false,
        "trashed_on": null,
        "trashed_by_id": 0,
        "billable_status": 0,
        "value": 380.5,
        "record_date": 1400025600,
        "summary": null,
        "user_id": 1,
        "parent_type": "Task",
        "parent_id": 1,
        "created_on": 1430164097,
        "created_by_id": 1,
        "updated_on": 1430164098,
        "updated_by_id": 1,
        "category_id": 1,
        "currency_id": 2
    }
}

For move to work, we need to call /projects/:project_id/expenses/:expense_id/move:

Response: HTTP 200, application/json (Hide)

PUT /projects/1/expenses/2/move

Payload:

1
2
3
{
    "task_id": 2
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
    "single": {
        "id": 2,
        "class": "Expense",
        "url_path": "\/projects\/1\/expenses\/2",
        "is_trashed": false,
        "trashed_on": null,
        "trashed_by_id": 0,
        "billable_status": 0,
        "value": 380.5,
        "record_date": 1400025600,
        "summary": null,
        "user_id": 1,
        "parent_type": "Task",
        "parent_id": 2,
        "created_on": 1430164097,
        "created_by_id": 1,
        "updated_on": 1430164098,
        "updated_by_id": 1,
        "category_id": 1,
        "currency_id": 2
    }
}

To move the expens on project level, send an empty value for task_id and project_id values:

Response: HTTP 200, application/json (Hide)

PUT /projects/1/expenses/2/move

Payload:

1
2
3
4
{
    "project_id": 2,
    "task_id": 0
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
    "single": {
        "id": 2,
        "class": "Expense",
        "url_path": "\/projects\/2\/expenses\/2",
        "is_trashed": false,
        "trashed_on": null,
        "trashed_by_id": 0,
        "billable_status": 0,
        "value": 380.5,
        "record_date": 1400025600,
        "summary": null,
        "user_id": 1,
        "parent_type": "Project",
        "parent_id": 2,
        "created_on": 1430164097,
        "created_by_id": 1,
        "updated_on": 1430164099,
        "updated_by_id": 1,
        "category_id": 1,
        "currency_id": 2
    }
}

Finally, lets move the newly created expense to trash:

Response: HTTP 200, application/json (Hide)

DELETE /projects/1/expenses/1

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
    "single": {
        "id": 1,
        "class": "Expense",
        "url_path": "\/projects\/1\/expenses\/1",
        "is_trashed": true,
        "trashed_on": 1430164099,
        "trashed_by_id": 1,
        "billable_status": 1,
        "value": 123.45,
        "record_date": 1400025600,
        "summary": null,
        "user_id": 1,
        "parent_type": "Project",
        "parent_id": 1,
        "created_on": 1430164097,
        "created_by_id": 1,
        "updated_on": 1430164099,
        "updated_by_id": 1,
        "category_id": 1,
        "currency_id": 2
    }
}

Confirmation that the record was deleted:

Response: HTTP 200, application/json (Hide)

GET /projects/1/expenses/1

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
    "single": {
        "id": 1,
        "class": "Expense",
        "url_path": "\/projects\/1\/expenses\/1",
        "is_trashed": true,
        "trashed_on": 1430164099,
        "trashed_by_id": 1,
        "billable_status": 1,
        "value": 123.45,
        "record_date": 1400025600,
        "summary": null,
        "user_id": 1,
        "parent_type": "Project",
        "parent_id": 1,
        "created_on": 1430164097,
        "created_by_id": 1,
        "updated_on": 1430164099,
        "updated_by_id": 1,
        "category_id": 1,
        "currency_id": 2
    }
}