API Documentation
Salaries ¶
GET /api/v2/salaries
Requests
GET /api/v2/salaries
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": [
{
"id": "164",
"type": "salaries",
"attributes": {
"working_days": [],
"working_hours": [
8,
8,
8,
8,
8,
0,
0
],
"salary_type_id": 2,
"started_on": "2020-01-24",
"ended_on": "2020-12-24",
"hours": "8.0",
"overhead": true,
"note": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"cost": 2000,
"cost_default": 2500,
"cost_normalized": 2000,
"hourly_rate": 2000,
"hourly_rate_default": 2500,
"hourly_rate_normalized": 2000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1133
}
},
"person": {
"data": {
"type": "people",
"id": "4128"
}
}
}
}
],
"included": [
{
"id": "4128",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4075@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-01-24T00:08:19.000+01:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:08:19.927+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1133
}
},
"company": {
"data": {
"type": "companies",
"id": "6155"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "6155",
"type": "companies",
"attributes": {
"name": "Client5032",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:08:19.924+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1133
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/salaries?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/salaries?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Get salariesGET/api/v2/salaries
GET /api/v2/salaries/1
Requests
GET /api/v2/salaries/165
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "165",
"type": "salaries",
"attributes": {
"working_days": [],
"working_hours": [
8,
8,
8,
8,
8,
0,
0
],
"salary_type_id": 2,
"started_on": "2020-01-24",
"ended_on": "2020-12-24",
"hours": "8.0",
"overhead": true,
"note": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"cost": 2000,
"cost_default": 2500,
"cost_normalized": 2000,
"hourly_rate": 2000,
"hourly_rate_default": 2500,
"hourly_rate_normalized": 2000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1134
}
},
"person": {
"data": {
"type": "people",
"id": "4130"
}
}
}
},
"included": [
{
"id": "4130",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4077@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-01-24T00:08:20.000+01:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:08:20.104+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1134
}
},
"company": {
"data": {
"type": "companies",
"id": "6157"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "6157",
"type": "companies",
"attributes": {
"name": "Client5033",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:08:20.100+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1134
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
POST /api/v2/salaries
Requests
POST /api/v2/salaries
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "salaries",
"attributes": {
"started_on": "2021-01-24",
"salary_type_id": 2,
"hours": "8.0",
"currency": "EUR",
"cost": 2000,
"working_hours": [
8,
8,
8,
8,
8,
0,
0
]
},
"relationships": {
"person": {
"data": {
"type": "people",
"id": "4132"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "167",
"type": "salaries",
"attributes": {
"working_days": [],
"working_hours": [
8,
8,
8,
8,
8,
0,
0
],
"salary_type_id": 2,
"started_on": "2021-01-24",
"ended_on": null,
"hours": "8.0",
"overhead": true,
"note": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"cost": 2000,
"cost_default": 2500,
"cost_normalized": 2000,
"hourly_rate": 2000,
"hourly_rate_default": 2500,
"hourly_rate_normalized": 2000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1135
}
},
"person": {
"data": {
"type": "people",
"id": "4132"
}
}
}
},
"included": [
{
"id": "4132",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4079@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-01-24T00:08:20.000+01:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:08:20.280+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1135
}
},
"company": {
"data": {
"type": "companies",
"id": "6159"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "6159",
"type": "companies",
"attributes": {
"name": "Client5034",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:08:20.276+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1135
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
POST /api/v2/salaries
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "salaries",
"attributes": {
"salary_type_id": 2,
"hours": "8.0",
"currency": "EUR",
"cost": 2000,
"overhead": false
},
"relationships": {
"person": {
"data": {
"type": "people",
"id": "4134"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "168",
"type": "salaries",
"attributes": {
"working_days": [],
"working_hours": [
8,
8,
8,
8,
8,
0,
0
],
"salary_type_id": 2,
"started_on": "2020-01-24",
"ended_on": null,
"hours": "8.0",
"overhead": false,
"note": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"cost": 2000,
"cost_default": 2500,
"cost_normalized": 2000,
"hourly_rate": 2000,
"hourly_rate_default": 2500,
"hourly_rate_normalized": 2000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1136
}
},
"person": {
"data": {
"type": "people",
"id": "4134"
}
}
}
},
"included": [
{
"id": "4134",
"type": "people",
"attributes": {
"first_name": "name",
"last_name": "surname",
"email": "person2967@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-01-24T00:08:20.000+01:00",
"is_user": false,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:08:20.541+01:00",
"placeholder": true,
"color_id": null,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1136
}
},
"company": {
"data": null
},
"subsidiary": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 1
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
POST /api/v2/salaries
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "salaries",
"attributes": {
"salary_type_id": 2,
"hours": "8.0",
"currency": "EUR",
"cost": 2000,
"overhead": false
},
"relationships": {
"person": {
"data": {
"type": "people",
"id": "4136"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "169",
"type": "salaries",
"attributes": {
"working_days": [],
"working_hours": [
8,
8,
8,
8,
8,
0,
0
],
"salary_type_id": 2,
"started_on": "2020-01-24",
"ended_on": null,
"hours": "8.0"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1137
}
},
"person": {
"data": {
"type": "people",
"id": "4136"
}
}
}
},
"included": [
{
"id": "4136",
"type": "people",
"attributes": {
"first_name": "name",
"last_name": "surname",
"email": "person2969@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-01-24T00:08:20.000+01:00",
"is_user": false,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:08:20.778+01:00",
"placeholder": true,
"color_id": null,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1137
}
},
"company": {
"data": null
},
"subsidiary": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 1
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
POST /api/v2/salaries
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "salaries",
"attributes": {},
"relationships": {
"person": {
"data": {
"type": "people",
"id": "4138"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "must contain exactly 7 numbers",
"source": {
"pointer": "data/attributes/working_hours"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/salary_type"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/cost"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/started_on"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/currency"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "is not an valid currency",
"source": {
"pointer": "data/attributes/currency"
}
}
]
}
POST /api/v2/salaries
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "salaries",
"attributes": {
"started_on": "2021-01-24",
"salary_type_id": 2,
"hours": "8.0",
"currency": "EUR",
"cost": 2000,
"working_hours": [
8,
8,
8,
8,
8,
0,
0
]
},
"relationships": {
"person": {
"data": {
"type": "people",
"id": "4140"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "attribute is invalid",
"source": {
"pointer": "data/attributes/person"
}
}
]
}
POST /api/v2/salaries
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "salaries",
"attributes": {
"salary_type_id": 2,
"currency": "EUR",
"cost": 2000,
"hours": 8,
"overhead": true
},
"relationships": {
"person": {
"data": {
"type": "people",
"id": "4142"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "171",
"type": "salaries",
"attributes": {
"working_days": [],
"working_hours": [
8,
8,
8,
8,
8,
0,
0
],
"salary_type_id": 2,
"started_on": "2020-01-24",
"ended_on": null,
"hours": "8.0",
"overhead": false,
"note": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"cost": 2000,
"cost_default": 2500,
"cost_normalized": 2000,
"hourly_rate": 2000,
"hourly_rate_default": 2500,
"hourly_rate_normalized": 2000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1140
}
},
"person": {
"data": {
"type": "people",
"id": "4142"
}
}
}
},
"included": [
{
"id": "4142",
"type": "people",
"attributes": {
"first_name": "name",
"last_name": "surname",
"email": "person2972@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-01-24T00:08:21.000+01:00",
"is_user": false,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:08:21.256+01:00",
"placeholder": true,
"color_id": null,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1140
}
},
"company": {
"data": null
},
"subsidiary": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 1
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
POST /api/v2/salaries
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "salaries",
"attributes": {
"salary_type_id": 2,
"hours": "8.0",
"currency": "EUR",
"cost": 2000,
"overhead": false
},
"relationships": {
"person": {
"data": {
"type": "people",
"id": "4144"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "attribute is invalid",
"source": {
"pointer": "data/attributes/person"
}
}
]
}
Create a salaryPOST/api/v2/salaries
URI Parameters
- salary_type_id
number
(required) Example: 1salary type id
- started_on
date
(required) Example: 2018-01-01started on
- currency
string
(required) Example: EURcurrency
- hours
number
(required) Example: 8hours
PATCH /api/v2/salaries/1
Requests
PATCH /api/v2/salaries/174
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "salaries",
"attributes": {
"cost": ""
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/cost"
}
}
]
}
PATCH /api/v2/salaries/176
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "salaries",
"attributes": {
"overhead": true
},
"relationships": {
"person": {
"data": {
"type": "people",
"id": "4154"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "176",
"type": "salaries",
"attributes": {
"working_days": [],
"working_hours": [
8,
8,
8,
8,
8,
0,
0
],
"salary_type_id": 2,
"started_on": "2020-01-24",
"ended_on": null,
"hours": "8.0",
"overhead": false,
"note": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"cost": 2000,
"cost_default": 2500,
"cost_normalized": 2000,
"hourly_rate": 2000,
"hourly_rate_default": 2500,
"hourly_rate_normalized": 2000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1146
}
},
"person": {
"data": {
"type": "people",
"id": "4154"
}
}
}
},
"included": [
{
"id": "4154",
"type": "people",
"attributes": {
"first_name": "name",
"last_name": "surname",
"email": "person2979@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-01-24T00:08:22.000+01:00",
"is_user": false,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:08:22.298+01:00",
"placeholder": true,
"color_id": null,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1146
}
},
"company": {
"data": null
},
"subsidiary": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 1
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
PATCH /api/v2/salaries/177
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "salaries",
"attributes": {
"started_on": "2021-01-23",
"ended_on": "2021-01-23",
"working_hours": [
1,
1,
1,
1,
1,
1,
1
]
},
"relationships": {
"person": {
"data": {
"type": "people",
"id": "4156"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "177",
"type": "salaries",
"attributes": {
"working_days": [],
"working_hours": [
8,
8,
8,
8,
8,
0,
0
],
"salary_type_id": 2,
"started_on": "2020-01-24",
"ended_on": null,
"hours": "8.0",
"overhead": false,
"note": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"cost": 2000,
"cost_default": 2500,
"cost_normalized": 2000,
"hourly_rate": 2000,
"hourly_rate_default": 2500,
"hourly_rate_normalized": 2000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1147
}
},
"person": {
"data": {
"type": "people",
"id": "4156"
}
}
}
},
"included": [
{
"id": "4156",
"type": "people",
"attributes": {
"first_name": "name",
"last_name": "surname",
"email": "person2980@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-01-24T00:08:22.000+01:00",
"is_user": false,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:08:22.493+01:00",
"placeholder": true,
"color_id": null,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1147
}
},
"company": {
"data": null
},
"subsidiary": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 1
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
DELETE /api/v2/salaries/1
Requests
DELETE /api/v2/salaries/178
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
This response has no content.
Generated by aglio on 23 Jan 2021