API Documentation
Prices ¶
GET /api/v2/prices
Requests
GET /api/v2/prices
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": "1",
"type": "prices",
"attributes": {
"name": "Price",
"pricing_type_id": null,
"unit_id": 2,
"quantity": "5.0",
"updated_at": "2021-04-15T01:04:39.559+02:00",
"description": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"rate": 10000,
"rate_default": 10000,
"rate_normalized": 10000,
"fixed_amount": null,
"fixed_amount_default": null,
"fixed_amount_normalized": null,
"hourly_rate": null,
"hourly_rate_default": null,
"hourly_rate_normalized": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 572
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "107"
}
},
"company": {
"data": {
"type": "companies",
"id": "1926"
}
},
"updater": {
"data": {
"type": "people",
"id": "1457"
}
}
}
}
],
"included": [
{
"id": "107",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null,
"description": "test description"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 572
}
}
}
},
{
"id": "1926",
"type": "companies",
"attributes": {
"name": "Client1355",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:04:39.552+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": 572
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1457",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1407@email.com",
"title": null,
"joined_at": "2021-04-15T01:04:39.000+02:00",
"last_seen_at": "2021-04-15T01:04:39.572+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 1447,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:04:39.512+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 572
}
},
"company": {
"data": {
"type": "companies",
"id": "1925"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1925",
"type": "companies",
"attributes": {
"name": "Organization572",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-04-15T01:04:39.510+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": 572
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/prices?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/prices?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
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Get pricesGET/api/v2/prices
GET /api/v2/prices/1
Requests
GET /api/v2/prices/2
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": "2",
"type": "prices",
"attributes": {
"name": "Price",
"pricing_type_id": null,
"unit_id": 2,
"quantity": "5.0",
"updated_at": "2021-04-15T01:04:39.659+02:00",
"description": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"rate": 10000,
"rate_default": 10000,
"rate_normalized": 10000,
"fixed_amount": null,
"fixed_amount_default": null,
"fixed_amount_normalized": null,
"hourly_rate": null,
"hourly_rate_default": null,
"hourly_rate_normalized": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 573
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "108"
}
},
"company": {
"data": {
"type": "companies",
"id": "1928"
}
},
"updater": {
"data": {
"type": "people",
"id": "1458"
}
}
}
},
"included": [
{
"id": "108",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null,
"description": "test description"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 573
}
}
}
},
{
"id": "1928",
"type": "companies",
"attributes": {
"name": "Client1356",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:04:39.655+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": 573
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1458",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1408@email.com",
"title": null,
"joined_at": "2021-04-15T01:04:39.000+02:00",
"last_seen_at": "2021-04-15T01:04:39.671+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 1448,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:04:39.634+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 573
}
},
"company": {
"data": {
"type": "companies",
"id": "1927"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1927",
"type": "companies",
"attributes": {
"name": "Organization573",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-04-15T01:04:39.632+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": 573
}
},
"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/prices
Requests
POST /api/v2/prices
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": "prices",
"attributes": {
"name": "test name",
"unit_id": 2,
"rate": 100,
"currency": "USD",
"quantity": 5
},
"relationships": {
"company": {
"data": {
"type": "companies",
"id": "1930"
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "109"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "4",
"type": "prices",
"attributes": {
"name": "test name",
"pricing_type_id": null,
"unit_id": 2,
"quantity": "5.0",
"updated_at": "2021-04-15T01:04:39.778+02:00",
"description": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"rate": 100,
"rate_default": 100,
"rate_normalized": 100,
"fixed_amount": null,
"fixed_amount_default": null,
"fixed_amount_normalized": null,
"hourly_rate": null,
"hourly_rate_default": null,
"hourly_rate_normalized": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 574
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "109"
}
},
"company": {
"data": {
"type": "companies",
"id": "1930"
}
},
"updater": {
"data": {
"type": "people",
"id": "1459"
}
}
}
},
"included": [
{
"id": "109",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null,
"description": "test description"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 574
}
}
}
},
{
"id": "1930",
"type": "companies",
"attributes": {
"name": "Client1357",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:04:39.753+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": 574
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1459",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1409@email.com",
"title": null,
"joined_at": "2021-04-15T01:04:39.000+02:00",
"last_seen_at": "2021-04-15T01:04:39.769+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 1449,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:04:39.732+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 574
}
},
"company": {
"data": {
"type": "companies",
"id": "1929"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1929",
"type": "companies",
"attributes": {
"name": "Organization574",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-04-15T01:04:39.731+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": 574
}
},
"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/prices
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": "prices",
"attributes": {
"name": ""
}
}
}
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/name"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/company_id"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/unit_id"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/currency"
}
}
]
}
POST /api/v2/prices
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": "prices",
"attributes": {
"name": "test name",
"unit_id": 2,
"rate": 100,
"currency": "USD",
"quantity": 5.12345
},
"relationships": {
"company": {
"data": {
"type": "companies",
"id": "1934"
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "111"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "7",
"type": "prices",
"attributes": {
"name": "test name",
"pricing_type_id": null,
"unit_id": 2,
"quantity": "5.12",
"updated_at": "2021-04-15T01:04:39.962+02:00",
"description": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"rate": 100,
"rate_default": 100,
"rate_normalized": 100,
"fixed_amount": null,
"fixed_amount_default": null,
"fixed_amount_normalized": null,
"hourly_rate": null,
"hourly_rate_default": null,
"hourly_rate_normalized": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 576
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "111"
}
},
"company": {
"data": {
"type": "companies",
"id": "1934"
}
},
"updater": {
"data": {
"type": "people",
"id": "1461"
}
}
}
},
"included": [
{
"id": "111",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null,
"description": "test description"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 576
}
}
}
},
{
"id": "1934",
"type": "companies",
"attributes": {
"name": "Client1359",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:04:39.931+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": 576
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1461",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1411@email.com",
"title": null,
"joined_at": "2021-04-15T01:04:39.000+02:00",
"last_seen_at": "2021-04-15T01:04:39.955+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 1451,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:04:39.911+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 576
}
},
"company": {
"data": {
"type": "companies",
"id": "1933"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1933",
"type": "companies",
"attributes": {
"name": "Organization576",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-04-15T01:04:39.910+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": 576
}
},
"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": {}
}
}
Create a pricePOST/api/v2/prices
URI Parameters
- name
string
(required) Example: Namename
- company_id
number
(required) Example: 1company id
- service_type_id
number
(required) Example: 1service type id
- unit_id
number
(required) Example: 1unit id
PATCH /api/v2/prices/1
Requests
PATCH /api/v2/prices/8
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": "prices",
"attributes": {
"name": "new name"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "8",
"type": "prices",
"attributes": {
"name": "new name",
"pricing_type_id": null,
"unit_id": 2,
"quantity": "5.0",
"updated_at": "2021-04-15T01:04:40.065+02:00",
"description": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"rate": 10000,
"rate_default": 10000,
"rate_normalized": 10000,
"fixed_amount": null,
"fixed_amount_default": null,
"fixed_amount_normalized": null,
"hourly_rate": null,
"hourly_rate_default": null,
"hourly_rate_normalized": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 577
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "112"
}
},
"company": {
"data": {
"type": "companies",
"id": "1936"
}
},
"updater": {
"data": {
"type": "people",
"id": "1462"
}
}
}
},
"included": [
{
"id": "112",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null,
"description": "test description"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 577
}
}
}
},
{
"id": "1936",
"type": "companies",
"attributes": {
"name": "Client1360",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:04:40.042+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": 577
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1462",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1412@email.com",
"title": null,
"joined_at": "2021-04-15T01:04:40.000+02:00",
"last_seen_at": "2021-04-15T01:04:40.058+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 1452,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:04:40.022+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 577
}
},
"company": {
"data": {
"type": "companies",
"id": "1935"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1935",
"type": "companies",
"attributes": {
"name": "Organization577",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-04-15T01:04:40.020+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": 577
}
},
"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/prices/9
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": "prices",
"attributes": {
"name": ""
},
"relationships": {
"company": {
"data": {
"type": "companies",
"id": "0"
}
}
}
}
}
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/name"
}
}
]
}
PATCH /api/v2/prices/10
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": "prices",
"attributes": {
"name": ""
},
"relationships": {
"service_type": {
"data": {
"type": "service_types",
"id": "0"
}
}
}
}
}
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/name"
}
}
]
}
PATCH /api/v2/prices/11
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": "prices",
"attributes": {
"name": ""
}
}
}
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/name"
}
}
]
}
PATCH /api/v2/prices/12
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": "prices",
"attributes": {
"name": "new name"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "12",
"type": "prices",
"attributes": {
"name": "new name",
"pricing_type_id": null,
"unit_id": 2,
"quantity": "5.12345",
"updated_at": "2021-04-15T01:04:40.409+02:00",
"description": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"rate": 10000,
"rate_default": 10000,
"rate_normalized": 10000,
"fixed_amount": null,
"fixed_amount_default": null,
"fixed_amount_normalized": null,
"hourly_rate": null,
"hourly_rate_default": null,
"hourly_rate_normalized": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 581
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "116"
}
},
"company": {
"data": {
"type": "companies",
"id": "1944"
}
},
"updater": {
"data": {
"type": "people",
"id": "1466"
}
}
}
},
"included": [
{
"id": "116",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null,
"description": "test description"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 581
}
}
}
},
{
"id": "1944",
"type": "companies",
"attributes": {
"name": "Client1364",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:04:40.380+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": 581
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1466",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1416@email.com",
"title": null,
"joined_at": "2021-04-15T01:04:40.000+02:00",
"last_seen_at": "2021-04-15T01:04:40.402+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 1456,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:04:40.360+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 581
}
},
"company": {
"data": {
"type": "companies",
"id": "1943"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1943",
"type": "companies",
"attributes": {
"name": "Organization581",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-04-15T01:04:40.359+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": 581
}
},
"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/prices/13
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": "prices",
"attributes": {
"name": "new name",
"quantity": 2.12345
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "13",
"type": "prices",
"attributes": {
"name": "new name",
"pricing_type_id": null,
"unit_id": 2,
"quantity": "2.12",
"updated_at": "2021-04-15T01:04:40.513+02:00",
"description": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"rate": 10000,
"rate_default": 10000,
"rate_normalized": 10000,
"fixed_amount": null,
"fixed_amount_default": null,
"fixed_amount_normalized": null,
"hourly_rate": null,
"hourly_rate_default": null,
"hourly_rate_normalized": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 582
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "117"
}
},
"company": {
"data": {
"type": "companies",
"id": "1946"
}
},
"updater": {
"data": {
"type": "people",
"id": "1467"
}
}
}
},
"included": [
{
"id": "117",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null,
"description": "test description"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 582
}
}
}
},
{
"id": "1946",
"type": "companies",
"attributes": {
"name": "Client1365",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:04:40.484+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": 582
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1467",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1417@email.com",
"title": null,
"joined_at": "2021-04-15T01:04:40.000+02:00",
"last_seen_at": "2021-04-15T01:04:40.507+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 1457,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:04:40.464+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 582
}
},
"company": {
"data": {
"type": "companies",
"id": "1945"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1945",
"type": "companies",
"attributes": {
"name": "Organization582",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-04-15T01:04:40.463+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": 582
}
},
"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": {}
}
}
DELETE /api/v2/prices/1
Requests
DELETE /api/v2/prices/14
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 14 Apr 2021