API Documentation
Deals ¶
Deals ¶
Supported filter params
-
id
-
responsible_id (array)
-
company_id (array)
-
status_id (array)
-
sales_status_id (array) (1: open, 2: won, 3: lost)
-
contract_id (array)
-
recurring
-
project_id (array)
-
tags
-
query
-
after
-
before
-
won_after
-
won_before
-
lost_after
-
lost_before
-
closed_after
-
closed_before
-
needs_invoicing
-
type (1: deal, 2: budget)
-
project_type (1: internal project, 2: client project)
-
budget_status (1: open, 2: closed)
-
date_after
-
date_before
-
subsidiary_id (array)
Supported sort params
-
name
-
date
-
end_date
-
number
-
suffix
-
time_approval
-
client_access
-
purchase_order_number
-
budget_warning
-
closed_at
-
created_at
-
last_activity_at
-
probability
-
billable_time
-
estimated_time
-
budgeted_time
-
total_budgeted_time
-
worked_time
-
revenue
-
services_revenue
-
cost
-
work_cost
-
profit
-
profit_margin
-
invoiced
-
pending_invoicing
-
paid
-
expense
-
expense_billable
-
expense_paid
-
budget_total
-
budget_used
-
actual_rate
-
estimated_remaining_time
Supported aggregates params
-
total_revenue
-
total_expense_billable
-
total_services_revenue
-
total_work_cost
-
total_expense
-
total_cost
-
total_profit
-
total_budget_total
-
total_budget_used
-
total_invoiced
-
total_pending_invoicing
-
average_actual_rate
-
total_worked_time
-
total_billable_time
-
total_estimated_time
-
total_budgeted_time
-
average_time_to_close
-
total_estimated_remaining_time
-
average_rate
Supported Enumerations
Deal type:
-
internal (deal_type_id: 1)
-
client (deal_type_id: 2)
Filter operations are supported on this endpoint.
GET /api/v2/deals
Requests
GETÂ Â /api/v2/deals
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+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "27",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-06-16",
"end_date": null,
"number": 1,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": false,
"sales_status_id": 1,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "67e8d4997c160436d8b9541d288625b2",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 1,
"global_position": 0,
"budget_revamp": false,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-06-16T01:04:10.235+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"sales_closed_on": null,
"sample_data": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 0,
"forecasted_revenue_default": 0,
"forecasted_revenue_normalized": 0,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 0,
"forecasted_profit_default": 0,
"forecasted_profit_normalized": 0,
"forecasted_budget_used": 0,
"forecasted_budget_used_default": 0,
"forecasted_budget_used_normalized": 0,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 225
}
},
"creator": {
"data": {
"type": "people",
"id": "533"
}
},
"company": {
"data": {
"type": "companies",
"id": "683"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "534"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "1159"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
}
],
"included": [
{
"id": "533",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user534@email.com",
"title": null,
"joined_at": "2021-06-16T01:04:10.000+02:00",
"last_seen_at": "2021-06-16T01:04:10.265+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 534,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:10.124+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 225
}
},
"company": {
"data": {
"type": "companies",
"id": "682"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "683",
"type": "companies",
"attributes": {
"name": "Client457",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:10.159+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 225
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "534",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user535@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:10.000+02:00",
"is_user": true,
"user_id": 535,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:10.180+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 225
}
},
"company": {
"data": {
"type": "companies",
"id": "684"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1159",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 225
}
}
}
},
{
"id": "682",
"type": "companies",
"attributes": {
"name": "Organization225",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:04:10.122+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 225
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "684",
"type": "companies",
"attributes": {
"name": "Client458",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:10.172+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 225
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/deals?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/deals?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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Get dealsGET/api/v2/deals
GET /api/v2/deals/1
Requests
GETÂ Â /api/v2/deals/28
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+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "28",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-06-16",
"end_date": null,
"number": 1,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": false,
"sales_status_id": 1,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "da2cd21ecd3be775495be799c5a5a339",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 1,
"global_position": 0,
"budget_revamp": false,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-06-16T01:04:10.470+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"sales_closed_on": null,
"sample_data": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 0,
"forecasted_revenue_default": 0,
"forecasted_revenue_normalized": 0,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 0,
"forecasted_profit_default": 0,
"forecasted_profit_normalized": 0,
"forecasted_budget_used": 0,
"forecasted_budget_used_default": 0,
"forecasted_budget_used_normalized": 0,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 226
}
},
"creator": {
"data": {
"type": "people",
"id": "535"
}
},
"company": {
"data": {
"type": "companies",
"id": "686"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "536"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "1165"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
"included": [
{
"id": "535",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user536@email.com",
"title": null,
"joined_at": "2021-06-16T01:04:10.000+02:00",
"last_seen_at": "2021-06-16T01:04:10.499+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 536,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:10.380+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 226
}
},
"company": {
"data": {
"type": "companies",
"id": "685"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "686",
"type": "companies",
"attributes": {
"name": "Client459",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:10.409+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 226
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "536",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user537@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:10.000+02:00",
"is_user": true,
"user_id": 537,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:10.424+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 226
}
},
"company": {
"data": {
"type": "companies",
"id": "687"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1165",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 226
}
}
}
},
{
"id": "685",
"type": "companies",
"attributes": {
"name": "Organization226",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:04:10.378+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 226
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "687",
"type": "companies",
"attributes": {
"name": "Client460",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:10.418+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 226
}
},
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}POST /api/v2/deals
Requests
POSTÂ Â /api/v2/deals
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+jsonBody
{
"data": {
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-06-16",
"deal_type_id": 2,
"deal_status_id": 1183,
"sales_status_id": 1,
"probability": 50,
"currency": "EUR"
},
"relationships": {
"company": {
"data": {
"type": "companies",
"id": "697"
}
},
"responsible": {
"data": {
"type": "people",
"id": "545"
}
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "32",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-06-16",
"end_date": null,
"number": 2,
"suffix": null,
"time_approval": false,
"expense_approval": false,
"client_access": false,
"deal_type_id": 2,
"budget": false,
"sales_status_id": 1,
"sales_status_updated_at": "2021-06-16T01:04:11.000+02:00",
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "ee1c3d82d82c9eb761fbdc373be04934",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 2,
"global_position": 1073741824,
"budget_revamp": false,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-06-16T01:04:11.494+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"sales_closed_on": null,
"sample_data": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 0,
"forecasted_revenue_default": 0,
"forecasted_revenue_normalized": 0,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 0,
"forecasted_profit_default": 0,
"forecasted_profit_normalized": 0,
"forecasted_budget_used": 0,
"forecasted_budget_used_default": 0,
"forecasted_budget_used_normalized": 0,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 229
}
},
"creator": {
"data": {
"type": "people",
"id": "543"
}
},
"company": {
"data": {
"type": "companies",
"id": "697"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "545"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "1183"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
"included": [
{
"id": "543",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user544@email.com",
"title": null,
"joined_at": "2021-06-16T01:04:11.000+02:00",
"last_seen_at": "2021-06-16T01:04:11.461+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 544,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:11.308+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 229
}
},
"company": {
"data": {
"type": "companies",
"id": "696"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "697",
"type": "companies",
"attributes": {
"name": "Client467",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:11.341+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 229
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "545",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user546@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 2,
"invited_at": "2021-06-16T01:04:11.000+02:00",
"is_user": true,
"user_id": 546,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:11.419+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 229
}
},
"company": {
"data": {
"type": "companies",
"id": "699"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1183",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 229
}
}
}
},
{
"id": "696",
"type": "companies",
"attributes": {
"name": "Organization229",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:04:11.305+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 229
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "699",
"type": "companies",
"attributes": {
"name": "Client469",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:11.414+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 229
}
},
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}POSTÂ Â /api/v2/deals
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+jsonBody
{
"data": {
"type": "deals",
"attributes": {
"name": ""
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "attribute is invalid",
"source": {
"pointer": "data/attributes/company"
}
}
]
}Create a dealPOST/api/v2/deals
URI Parameters
- name
string(required) Example: Namename
- date
date(required) Example: 2018-01-01date
- responsible_id: `1` (number, required) - responsible_id
string(required)- company_id: `1` (number, required) - company_id
string(required)- deal_type_id
number(required) Example: 1deal type
- probability
number(required) Example: 100probability
- currency
currency(required) Example: EURcurrency
- deal_status
number(required) Example: 1deal status
- sales_status
number(required) Example: 1sales status
PATCH /api/v2/deals/1
Requests
PATCHÂ Â /api/v2/deals/35
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+jsonBody
{
"data": {
"type": "deals",
"attributes": {
"name": "new name",
"tag_list": [
"invoiced",
"paid"
],
"sales_status_id": 2
},
"relationships": {
"responsible": {
"data": {
"type": "people",
"id": "552"
}
},
"subscribers": {
"data": [
{
"type": "people",
"id": "553"
},
{
"type": "people",
"id": "554"
}
]
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "35",
"type": "deals",
"attributes": {
"name": "new name",
"date": "2021-06-16",
"end_date": null,
"number": 1,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": false,
"sales_status_id": 2,
"sales_status_updated_at": "2021-06-16T01:04:12.000+02:00",
"tag_list": [
"invoiced",
"paid"
],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "2b13b809fc729620780a211041565db3",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 1,
"global_position": 0,
"budget_revamp": false,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": 0,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-06-16T01:04:12.032+02:00",
"note": null,
"sales_closed_at": "2021-06-16T01:04:12.000+02:00",
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"sales_closed_on": "2021-06-16",
"sample_data": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 0,
"forecasted_revenue_default": 0,
"forecasted_revenue_normalized": 0,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 0,
"forecasted_profit_default": 0,
"forecasted_profit_normalized": 0,
"forecasted_budget_used": 0,
"forecasted_budget_used_default": 0,
"forecasted_budget_used_normalized": 0,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 232
}
},
"creator": {
"data": {
"type": "people",
"id": "550"
}
},
"company": {
"data": {
"type": "companies",
"id": "707"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "552"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "1201"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
"included": [
{
"id": "550",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user551@email.com",
"title": null,
"joined_at": "2021-06-16T01:04:12.000+02:00",
"last_seen_at": "2021-06-16T01:04:12.151+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 551,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:11.959+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 232
}
},
"company": {
"data": {
"type": "companies",
"id": "706"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "707",
"type": "companies",
"attributes": {
"name": "Client474",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:11.982+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 232
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "552",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user553@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 2,
"invited_at": "2021-06-16T01:04:12.000+02:00",
"is_user": true,
"user_id": 553,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:12.051+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 232
}
},
"company": {
"data": {
"type": "companies",
"id": "709"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1201",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 232
}
}
}
},
{
"id": "706",
"type": "companies",
"attributes": {
"name": "Organization232",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:04:11.958+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 232
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "709",
"type": "companies",
"attributes": {
"name": "Client476",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:12.047+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 232
}
},
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}PATCHÂ Â /api/v2/deals/37
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+jsonBody
{
"data": {
"type": "deals",
"attributes": {
"delivered_on": "2021-06-20"
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "37",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-06-16",
"end_date": null,
"number": 2,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": true,
"sales_status_id": null,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "f578b466a4a418b6f703799371c69bd5",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 2,
"global_position": 1073741824,
"budget_revamp": false,
"future_booked_time": 0,
"probability": 100,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": "2021-06-16T01:04:12.000+02:00",
"delivered_on": "2021-06-20",
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-06-16T01:04:12.484+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"sales_closed_on": null,
"sample_data": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 0,
"forecasted_revenue_default": 0,
"forecasted_revenue_normalized": 0,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 0,
"forecasted_profit_default": 0,
"forecasted_profit_normalized": 0,
"forecasted_budget_used": 0,
"forecasted_budget_used_default": 0,
"forecasted_budget_used_normalized": 0,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 233
}
},
"creator": {
"data": {
"type": "people",
"id": "555"
}
},
"company": {
"data": {
"type": "companies",
"id": "715"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "557"
}
},
"deal_status": {
"data": null
},
"project": {
"data": {
"type": "projects",
"id": "76"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
"included": [
{
"id": "555",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user556@email.com",
"title": null,
"joined_at": "2021-06-16T01:04:12.000+02:00",
"last_seen_at": "2021-06-16T01:04:12.505+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 556,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:12.313+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 233
}
},
"company": {
"data": {
"type": "companies",
"id": "712"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "715",
"type": "companies",
"attributes": {
"name": "Client481",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:12.391+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 233
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "557",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user558@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:12.000+02:00",
"is_user": true,
"user_id": 558,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:12.401+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 233
}
},
"company": {
"data": {
"type": "companies",
"id": "716"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "76",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-06-16T01:04:12.462+02:00",
"board_count": 0,
"budget_count": 0,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 233
}
},
"company": {
"data": {
"type": "companies",
"id": "718"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "558"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "712",
"type": "companies",
"attributes": {
"name": "Organization233",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:04:12.312+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 233
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "716",
"type": "companies",
"attributes": {
"name": "Client482",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:12.397+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 233
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "718",
"type": "companies",
"attributes": {
"name": "Client484",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:12.460+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 233
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "558",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user559@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:12.000+02:00",
"is_user": true,
"user_id": 559,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:12.435+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 233
}
},
"company": {
"data": {
"type": "companies",
"id": "717"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "717",
"type": "companies",
"attributes": {
"name": "Client483",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:12.431+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 233
}
},
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}PATCHÂ Â /api/v2/deals/38
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+jsonBody
{
"data": {
"type": "deals",
"attributes": {
"name": ""
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
}
]
}PATCHÂ Â /api/v2/deals/40
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+jsonBody
{
"data": {
"type": "deals",
"attributes": {
"delivered_on": "2021-06-20"
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "40",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-06-16",
"end_date": null,
"number": 2,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": true,
"sales_status_id": null,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "ac9e5e846af3381697cd08db93cd1882",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 2,
"global_position": 1073741824,
"budget_revamp": false,
"future_booked_time": 0,
"probability": 100,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-06-16T01:04:12.958+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"sales_closed_on": null,
"sample_data": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 0,
"forecasted_revenue_default": 0,
"forecasted_revenue_normalized": 0,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 0,
"forecasted_profit_default": 0,
"forecasted_profit_normalized": 0,
"forecasted_budget_used": 0,
"forecasted_budget_used_default": 0,
"forecasted_budget_used_normalized": 0,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 235
}
},
"creator": {
"data": {
"type": "people",
"id": "561"
}
},
"company": {
"data": {
"type": "companies",
"id": "725"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "563"
}
},
"deal_status": {
"data": null
},
"project": {
"data": {
"type": "projects",
"id": "77"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
"included": [
{
"id": "561",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user562@email.com",
"title": null,
"joined_at": "2021-06-16T01:04:12.000+02:00",
"last_seen_at": "2021-06-16T01:04:12.979+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 562,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:12.774+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 235
}
},
"company": {
"data": {
"type": "companies",
"id": "722"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "725",
"type": "companies",
"attributes": {
"name": "Client489",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:12.861+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 235
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "563",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user564@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:12.000+02:00",
"is_user": true,
"user_id": 564,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:12.871+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 235
}
},
"company": {
"data": {
"type": "companies",
"id": "726"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "77",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-06-16T01:04:12.935+02:00",
"board_count": 0,
"budget_count": 1,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 235
}
},
"company": {
"data": {
"type": "companies",
"id": "728"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "564"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "722",
"type": "companies",
"attributes": {
"name": "Organization235",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:04:12.773+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 235
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "726",
"type": "companies",
"attributes": {
"name": "Client490",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:12.867+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 235
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "728",
"type": "companies",
"attributes": {
"name": "Client492",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:12.933+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 235
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "564",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user565@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:12.000+02:00",
"is_user": true,
"user_id": 565,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:12.906+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 235
}
},
"company": {
"data": {
"type": "companies",
"id": "727"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "727",
"type": "companies",
"attributes": {
"name": "Client491",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:12.902+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 235
}
},
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}DELETE /api/v2/deals/1
Requests
DELETEÂ Â /api/v2/deals/41
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+jsonResponses
This response has no content.
PATCH /api/v2/deals/1/open
Requests
PATCHÂ Â /api/v2/deals/64/open
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+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "64",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-06-16",
"end_date": null,
"number": 2,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": true,
"sales_status_id": null,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "e12178b1771350392887ed463d9239b3",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 2,
"global_position": 1073741824,
"budget_revamp": false,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-06-16T01:04:17.097+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"sales_closed_on": null,
"sample_data": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 0,
"forecasted_revenue_default": 0,
"forecasted_revenue_normalized": 0,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 0,
"forecasted_profit_default": 0,
"forecasted_profit_normalized": 0,
"forecasted_budget_used": 0,
"forecasted_budget_used_default": 0,
"forecasted_budget_used_normalized": 0,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 246
}
},
"creator": {
"data": {
"type": "people",
"id": "601"
}
},
"company": {
"data": {
"type": "companies",
"id": "790"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "603"
}
},
"deal_status": {
"data": null
},
"project": {
"data": {
"type": "projects",
"id": "84"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
"included": [
{
"id": "601",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user602@email.com",
"title": null,
"joined_at": "2021-06-16T01:04:17.000+02:00",
"last_seen_at": "2021-06-16T01:04:17.117+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 602,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:16.921+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 246
}
},
"company": {
"data": {
"type": "companies",
"id": "787"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "790",
"type": "companies",
"attributes": {
"name": "Client543",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:16.999+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 246
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "603",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user604@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:17.000+02:00",
"is_user": true,
"user_id": 604,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:17.009+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 246
}
},
"company": {
"data": {
"type": "companies",
"id": "791"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "84",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-06-16T01:04:17.075+02:00",
"board_count": 0,
"budget_count": 1,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 246
}
},
"company": {
"data": {
"type": "companies",
"id": "793"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "604"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "787",
"type": "companies",
"attributes": {
"name": "Organization246",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:04:16.919+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 246
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "791",
"type": "companies",
"attributes": {
"name": "Client544",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:17.005+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 246
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "793",
"type": "companies",
"attributes": {
"name": "Client546",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:17.073+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 246
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "604",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user605@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:17.000+02:00",
"is_user": true,
"user_id": 605,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:17.048+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 246
}
},
"company": {
"data": {
"type": "companies",
"id": "792"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "792",
"type": "companies",
"attributes": {
"name": "Client545",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:17.044+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 246
}
},
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}PATCH /api/v2/deals/1/close
Requests
PATCHÂ Â /api/v2/deals/66/close
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+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "66",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-06-16",
"end_date": null,
"number": 2,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": true,
"sales_status_id": null,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "386b610567f50a659888fa55ff98776f",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 2,
"global_position": 1073741824,
"budget_revamp": false,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": "2021-06-16T01:04:17.000+02:00",
"delivered_on": "2021-06-16",
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-06-16T01:04:17.423+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"sales_closed_on": null,
"sample_data": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 0,
"forecasted_revenue_default": 0,
"forecasted_revenue_normalized": 0,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 0,
"forecasted_profit_default": 0,
"forecasted_profit_normalized": 0,
"forecasted_budget_used": 0,
"forecasted_budget_used_default": 0,
"forecasted_budget_used_normalized": 0,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 247
}
},
"creator": {
"data": {
"type": "people",
"id": "605"
}
},
"company": {
"data": {
"type": "companies",
"id": "797"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "607"
}
},
"deal_status": {
"data": null
},
"project": {
"data": {
"type": "projects",
"id": "85"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
"included": [
{
"id": "605",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user606@email.com",
"title": null,
"joined_at": "2021-06-16T01:04:17.000+02:00",
"last_seen_at": "2021-06-16T01:04:17.443+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 606,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:17.248+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 247
}
},
"company": {
"data": {
"type": "companies",
"id": "794"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "797",
"type": "companies",
"attributes": {
"name": "Client549",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:17.327+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 247
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "607",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user608@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:17.000+02:00",
"is_user": true,
"user_id": 608,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:17.337+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 247
}
},
"company": {
"data": {
"type": "companies",
"id": "798"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "85",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-06-16T01:04:17.401+02:00",
"board_count": 0,
"budget_count": 0,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 247
}
},
"company": {
"data": {
"type": "companies",
"id": "800"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "608"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "794",
"type": "companies",
"attributes": {
"name": "Organization247",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:04:17.247+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 247
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "798",
"type": "companies",
"attributes": {
"name": "Client550",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:17.333+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 247
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "800",
"type": "companies",
"attributes": {
"name": "Client552",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:17.398+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 247
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "608",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user609@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:17.000+02:00",
"is_user": true,
"user_id": 609,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:17.372+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 247
}
},
"company": {
"data": {
"type": "companies",
"id": "799"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "799",
"type": "companies",
"attributes": {
"name": "Client551",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:17.368+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 247
}
},
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}PATCHÂ Â /api/v2/deals/68/close
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+jsonBody
{
"data": {
"type": "deals",
"attributes": {
"delivered_on": "2021-06-20"
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "68",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-06-16",
"end_date": null,
"number": 2,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": true,
"sales_status_id": null,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "33712954db88d5fe551dd04826a9bc98",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 2,
"global_position": 1073741824,
"budget_revamp": false,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": "2021-06-16T01:04:17.000+02:00",
"delivered_on": "2021-06-20",
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-06-16T01:04:17.780+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"sales_closed_on": null,
"sample_data": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 0,
"forecasted_revenue_default": 0,
"forecasted_revenue_normalized": 0,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 0,
"forecasted_profit_default": 0,
"forecasted_profit_normalized": 0,
"forecasted_budget_used": 0,
"forecasted_budget_used_default": 0,
"forecasted_budget_used_normalized": 0,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 248
}
},
"creator": {
"data": {
"type": "people",
"id": "609"
}
},
"company": {
"data": {
"type": "companies",
"id": "804"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "611"
}
},
"deal_status": {
"data": null
},
"project": {
"data": {
"type": "projects",
"id": "86"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
"included": [
{
"id": "609",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user610@email.com",
"title": null,
"joined_at": "2021-06-16T01:04:17.000+02:00",
"last_seen_at": "2021-06-16T01:04:17.799+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 610,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:17.607+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 248
}
},
"company": {
"data": {
"type": "companies",
"id": "801"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "804",
"type": "companies",
"attributes": {
"name": "Client555",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:17.686+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 248
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "611",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user612@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:17.000+02:00",
"is_user": true,
"user_id": 612,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:17.696+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 248
}
},
"company": {
"data": {
"type": "companies",
"id": "805"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "86",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-06-16T01:04:17.758+02:00",
"board_count": 0,
"budget_count": 0,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 248
}
},
"company": {
"data": {
"type": "companies",
"id": "807"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "612"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "801",
"type": "companies",
"attributes": {
"name": "Organization248",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:04:17.605+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 248
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "805",
"type": "companies",
"attributes": {
"name": "Client556",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:17.693+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 248
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "807",
"type": "companies",
"attributes": {
"name": "Client558",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:17.756+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 248
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "612",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user613@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:17.000+02:00",
"is_user": true,
"user_id": 613,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:17.730+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 248
}
},
"company": {
"data": {
"type": "companies",
"id": "806"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "806",
"type": "companies",
"attributes": {
"name": "Client557",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:17.726+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 248
}
},
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Generated by aglio on 15 Jun 2021