API Documentation
Entitlements ¶
Entitlements ¶
GET /api/v2/entitlements
Requests
GET /api/v2/entitlements
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": "17",
"type": "entitlements",
"attributes": {
"start_date": "2021-04-14",
"end_date": "2021-04-25",
"allocated": 21,
"used": 0,
"note": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 266
}
},
"event": {
"data": {
"type": "events",
"id": "66"
}
},
"person": {
"data": {
"type": "people",
"id": "620"
}
}
}
},
{
"id": "18",
"type": "entitlements",
"attributes": {
"start_date": "2021-04-14",
"end_date": "2021-04-25",
"allocated": 21,
"used": 0,
"note": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 266
}
},
"event": {
"data": {
"type": "events",
"id": "67"
}
},
"person": {
"data": {
"type": "people",
"id": "621"
}
}
}
},
{
"id": "19",
"type": "entitlements",
"attributes": {
"start_date": "2021-04-14",
"end_date": "2021-04-25",
"allocated": 21,
"used": 0,
"note": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 266
}
},
"event": {
"data": {
"type": "events",
"id": "68"
}
},
"person": {
"data": {
"type": "people",
"id": "622"
}
}
}
}
],
"included": [
{
"id": "66",
"type": "events",
"attributes": {
"name": "test name",
"event_type_id": 2,
"icon_id": null,
"color_id": null,
"archived_at": null,
"limitation_type_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 266
}
}
}
},
{
"id": "620",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user621@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-04-15T01:03:36.000+02:00",
"is_user": true,
"user_id": 621,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:36.646+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 266
}
},
"company": {
"data": {
"type": "companies",
"id": "817"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "67",
"type": "events",
"attributes": {
"name": "test name",
"event_type_id": 2,
"icon_id": null,
"color_id": null,
"archived_at": null,
"limitation_type_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 266
}
}
}
},
{
"id": "621",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user622@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-04-15T01:03:36.000+02:00",
"is_user": true,
"user_id": 622,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:36.688+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 266
}
},
"company": {
"data": {
"type": "companies",
"id": "818"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "68",
"type": "events",
"attributes": {
"name": "test name",
"event_type_id": 2,
"icon_id": null,
"color_id": null,
"archived_at": null,
"limitation_type_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 266
}
}
}
},
{
"id": "622",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user623@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-04-15T01:03:36.000+02:00",
"is_user": true,
"user_id": 623,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:36.725+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 266
}
},
"company": {
"data": {
"type": "companies",
"id": "819"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "817",
"type": "companies",
"attributes": {
"name": "Client550",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:36.642+02: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": 266
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "818",
"type": "companies",
"attributes": {
"name": "Client551",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:36.684+02: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": 266
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "819",
"type": "companies",
"attributes": {
"name": "Client552",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:36.721+02: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": 266
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/entitlements?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/entitlements?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 3,
"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
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Get entitlementsGET/api/v2/entitlements
GET /api/v2/entitlements/1
Requests
GET /api/v2/entitlements/20
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": "20",
"type": "entitlements",
"attributes": {
"start_date": "2021-04-14",
"end_date": "2021-04-25",
"allocated": 21,
"used": 0,
"note": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 267
}
},
"event": {
"data": {
"type": "events",
"id": "69"
}
},
"person": {
"data": {
"type": "people",
"id": "624"
}
}
}
},
"included": [
{
"id": "69",
"type": "events",
"attributes": {
"name": "test name",
"event_type_id": 2,
"icon_id": null,
"color_id": null,
"archived_at": null,
"limitation_type_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 267
}
}
}
},
{
"id": "624",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user625@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-04-15T01:03:36.000+02:00",
"is_user": true,
"user_id": 625,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:36.867+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 267
}
},
"company": {
"data": {
"type": "companies",
"id": "821"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "821",
"type": "companies",
"attributes": {
"name": "Client553",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:36.863+02: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": 267
}
},
"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
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Gets a entitlementGET/api/v2/entitlements/{id}
URI Parameters
- id
number
(required) Example: 1entitlement id
POST /api/v2/entitlements
Requests
POST /api/v2/entitlements
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": "entitlements",
"attributes": {
"id": null,
"account_id": 268,
"event_id": 70,
"person_id": 626,
"start_date": "2021-04-14",
"end_date": "2021-04-25",
"allocated": 21,
"used": 0,
"deleted_at": null,
"created_at": null,
"updated_at": null,
"creator_id": null,
"updater_id": null,
"note": null
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "21",
"type": "entitlements",
"attributes": {
"start_date": "2021-04-14",
"end_date": "2021-04-25",
"allocated": 21,
"used": 0,
"note": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 268
}
},
"event": {
"data": {
"type": "events",
"id": "70"
}
},
"person": {
"data": {
"type": "people",
"id": "626"
}
}
}
},
"included": [
{
"id": "70",
"type": "events",
"attributes": {
"name": "test name",
"event_type_id": 2,
"icon_id": null,
"color_id": null,
"archived_at": null,
"limitation_type_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 268
}
}
}
},
{
"id": "626",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user627@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-04-15T01:03:37.000+02:00",
"is_user": true,
"user_id": 627,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:37.006+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 268
}
},
"company": {
"data": {
"type": "companies",
"id": "823"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "823",
"type": "companies",
"attributes": {
"name": "Client554",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:37.002+02: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": 268
}
},
"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
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
POST /api/v2/entitlements
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": "entitlements",
"attributes": {}
}
}
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/event"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/person"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/start_date"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "is not a date",
"source": {
"pointer": "data/attributes/start_date"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/end_date"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "is not a date",
"source": {
"pointer": "data/attributes/end_date"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/allocated"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "is not a number",
"source": {
"pointer": "data/attributes/allocated"
}
}
]
}
POST /api/v2/entitlements
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": "entitlements",
"attributes": {
"id": null,
"account_id": 270,
"event_id": 72,
"person_id": 0,
"start_date": "2021-04-14",
"end_date": "2021-04-25",
"allocated": 21,
"used": 0,
"deleted_at": null,
"created_at": null,
"updated_at": null,
"creator_id": null,
"updater_id": null,
"note": null
}
}
}
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/entitlements
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": "entitlements",
"attributes": {
"id": null,
"account_id": 271,
"event_id": 0,
"person_id": 631,
"start_date": "2021-04-14",
"end_date": "2021-04-25",
"allocated": 21,
"used": 0,
"deleted_at": null,
"created_at": null,
"updated_at": null,
"creator_id": null,
"updater_id": null,
"note": null
}
}
}
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/event"
}
}
]
}
Creates an entitlementPOST/api/v2/entitlements
URI Parameters
- event_id
number
(required) Example: 1event id
- person_id
number
(required) Example: 1person id
- start_date
date
(required) Example: Apr+18%2C+2021+at++1%3A02+amentitlement start date
- end_date
date
(required) Example: Jul+15%2C+2021+at++1%3A02+amentitlement end date
- allocated
number
(required) Example: 10allocated days
PATCH /api/v2/entitlements/1
Requests
PATCH /api/v2/entitlements/22
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": "entitlements",
"attributes": {
"allocated": 15
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "22",
"type": "entitlements",
"attributes": {
"start_date": "2021-04-14",
"end_date": "2021-04-25",
"allocated": 15,
"used": 0,
"note": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 272
}
},
"event": {
"data": {
"type": "events",
"id": "73"
}
},
"person": {
"data": {
"type": "people",
"id": "633"
}
}
}
},
"included": [
{
"id": "73",
"type": "events",
"attributes": {
"name": "test name",
"event_type_id": 2,
"icon_id": null,
"color_id": null,
"archived_at": null,
"limitation_type_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 272
}
}
}
},
{
"id": "633",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user634@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-04-15T01:03:37.000+02:00",
"is_user": true,
"user_id": 634,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:37.427+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 272
}
},
"company": {
"data": {
"type": "companies",
"id": "830"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "830",
"type": "companies",
"attributes": {
"name": "Client557",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:37.420+02: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": 272
}
},
"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
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
PATCH /api/v2/entitlements/23
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": "entitlements",
"attributes": {
"allocated": ""
}
}
}
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/allocated"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "is not a number",
"source": {
"pointer": "data/attributes/allocated"
}
}
]
}
Updates an entitlementPATCH/api/v2/entitlements/{id}
URI Parameters
- id
number
(required) Example: 1entitlement id
DELETE /api/v2/entitlements/1
Requests
DELETE /api/v2/entitlements/24
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.
Deletes an entitlementDELETE/api/v2/entitlements/{id}
URI Parameters
- id
number
(required) Example: 1entitlement id
Generated by aglio on 14 Apr 2021