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
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": [
{
"id": "27",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-04-15",
"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": "0552cdfe96308b2a7086e6fbf25b23af",
"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,
"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-04-15T01:03:27.411+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-04-15",
"sales_closed_on": 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": 217
}
},
"creator": {
"data": {
"type": "people",
"id": "498"
}
},
"company": {
"data": {
"type": "companies",
"id": "648"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "499"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "1119"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
}
],
"included": [
{
"id": "498",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user499@email.com",
"title": null,
"joined_at": "2021-04-15T01:03:27.000+02:00",
"last_seen_at": "2021-04-15T01:03:27.432+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 499,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:27.345+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 217
}
},
"company": {
"data": {
"type": "companies",
"id": "647"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "648",
"type": "companies",
"attributes": {
"name": "Client430",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:27.369+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 217
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "499",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user500@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-04-15T01:03:27.000+02:00",
"is_user": true,
"user_id": 500,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:27.379+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 217
}
},
"company": {
"data": {
"type": "companies",
"id": "649"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1119",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 217
}
}
}
},
{
"id": "647",
"type": "companies",
"attributes": {
"name": "Organization217",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-04-15T01:03:27.342+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 217
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "649",
"type": "companies",
"attributes": {
"name": "Client431",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:27.375+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 217
}
},
"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
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Get dealsGET/api/v2/deals
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+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "28",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-04-15",
"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": "b16ad685f24912fa7be1e5c27d57fe45",
"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,
"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-04-15T01:03:27.577+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-04-15",
"sales_closed_on": 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": 218
}
},
"creator": {
"data": {
"type": "people",
"id": "500"
}
},
"company": {
"data": {
"type": "companies",
"id": "651"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "501"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "1125"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
"included": [
{
"id": "500",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user501@email.com",
"title": null,
"joined_at": "2021-04-15T01:03:27.000+02:00",
"last_seen_at": "2021-04-15T01:03:27.608+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 501,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:27.511+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 218
}
},
"company": {
"data": {
"type": "companies",
"id": "650"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "651",
"type": "companies",
"attributes": {
"name": "Client432",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:27.534+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 218
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "501",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user502@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-04-15T01:03:27.000+02:00",
"is_user": true,
"user_id": 502,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:27.544+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 218
}
},
"company": {
"data": {
"type": "companies",
"id": "652"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1125",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 218
}
}
}
},
{
"id": "650",
"type": "companies",
"attributes": {
"name": "Organization218",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-04-15T01:03:27.510+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 218
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "652",
"type": "companies",
"attributes": {
"name": "Client433",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:27.540+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 218
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
POSTÂ Â /api/v2/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+json
Body
{
"data": {
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-04-15",
"deal_type_id": 2,
"deal_status_id": 1143,
"sales_status_id": 1,
"probability": 50,
"currency": "EUR"
},
"relationships": {
"company": {
"data": {
"type": "companies",
"id": "662"
}
},
"responsible": {
"data": {
"type": "people",
"id": "510"
}
}
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "32",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-04-15",
"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-04-15T01:03:28.000+02:00",
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "932e192b3ff6cb72de75b90228e9c51c",
"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,
"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-04-15T01:03:28.187+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-04-15",
"sales_closed_on": 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": 221
}
},
"creator": {
"data": {
"type": "people",
"id": "508"
}
},
"company": {
"data": {
"type": "companies",
"id": "662"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "510"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "1143"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
"included": [
{
"id": "508",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user509@email.com",
"title": null,
"joined_at": "2021-04-15T01:03:28.000+02:00",
"last_seen_at": "2021-04-15T01:03:28.165+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 509,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:28.057+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 221
}
},
"company": {
"data": {
"type": "companies",
"id": "661"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "662",
"type": "companies",
"attributes": {
"name": "Client440",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:28.077+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 221
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "510",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user511@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 2,
"invited_at": "2021-04-15T01:03:28.000+02:00",
"is_user": true,
"user_id": 511,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:28.134+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 221
}
},
"company": {
"data": {
"type": "companies",
"id": "664"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1143",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 221
}
}
}
},
{
"id": "661",
"type": "companies",
"attributes": {
"name": "Organization221",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-04-15T01:03:28.056+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 221
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "664",
"type": "companies",
"attributes": {
"name": "Client442",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:28.130+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 221
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
POSTÂ Â /api/v2/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+json
Body
{
"data": {
"type": "deals",
"attributes": {
"name": ""
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "attribute is invalid",
"source": {
"pointer": "data/attributes/company"
}
}
]
}
Create a dealPOST/api/v2/deals
- 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/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+json
Body
{
"data": {
"type": "deals",
"attributes": {
"name": "new name",
"tag_list": [
"invoiced",
"paid"
],
"sales_status_id": 2
},
"relationships": {
"responsible": {
"data": {
"type": "people",
"id": "517"
}
},
"subscribers": {
"data": [
{
"type": "people",
"id": "518"
},
{
"type": "people",
"id": "519"
}
]
}
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "35",
"type": "deals",
"attributes": {
"name": "new name",
"date": "2021-04-15",
"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-04-15T01:03:28.000+02:00",
"tag_list": [
"invoiced",
"paid"
],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "0420dd0658f12d6a91a4a8e36be365da",
"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,
"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-04-15T01:03:28.583+02:00",
"note": null,
"sales_closed_at": "2021-04-15T01:03:28.000+02:00",
"exchange_rate": "1.25",
"exchange_date": "2021-04-15",
"sales_closed_on": "2021-04-15",
"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": 224
}
},
"creator": {
"data": {
"type": "people",
"id": "515"
}
},
"company": {
"data": {
"type": "companies",
"id": "672"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "517"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "1161"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
"included": [
{
"id": "515",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user516@email.com",
"title": null,
"joined_at": "2021-04-15T01:03:28.000+02:00",
"last_seen_at": "2021-04-15T01:03:28.695+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 516,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:28.521+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 224
}
},
"company": {
"data": {
"type": "companies",
"id": "671"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "672",
"type": "companies",
"attributes": {
"name": "Client447",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:28.543+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 224
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "517",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user518@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 2,
"invited_at": "2021-04-15T01:03:28.000+02:00",
"is_user": true,
"user_id": 518,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:28.600+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 224
}
},
"company": {
"data": {
"type": "companies",
"id": "674"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1161",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 224
}
}
}
},
{
"id": "671",
"type": "companies",
"attributes": {
"name": "Organization224",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-04-15T01:03:28.520+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 224
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "674",
"type": "companies",
"attributes": {
"name": "Client449",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:28.597+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 224
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
PATCHÂ Â /api/v2/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+json
Body
{
"data": {
"type": "deals",
"attributes": {
"delivered_on": "2021-04-19"
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "37",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-04-15",
"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": "ed02792c9c7d09627ba4c417d7d7ba00",
"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,
"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-04-15T01:03:28.000+02:00",
"delivered_on": "2021-04-19",
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-04-15T01:03:28.998+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-04-15",
"sales_closed_on": 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": "520"
}
},
"company": {
"data": {
"type": "companies",
"id": "680"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "522"
}
},
"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": "520",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user521@email.com",
"title": null,
"joined_at": "2021-04-15T01:03:29.000+02:00",
"last_seen_at": "2021-04-15T01:03:29.016+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 521,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:28.842+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 225
}
},
"company": {
"data": {
"type": "companies",
"id": "677"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "680",
"type": "companies",
"attributes": {
"name": "Client454",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:28.914+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 225
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "522",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user523@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-04-15T01:03:28.000+02:00",
"is_user": true,
"user_id": 523,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:28.924+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 225
}
},
"company": {
"data": {
"type": "companies",
"id": "681"
}
},
"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-04-15T01:03:28.980+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,
"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": 225
}
},
"company": {
"data": {
"type": "companies",
"id": "683"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "523"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "677",
"type": "companies",
"attributes": {
"name": "Organization225",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-04-15T01:03:28.840+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 225
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "681",
"type": "companies",
"attributes": {
"name": "Client455",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:28.921+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 225
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "683",
"type": "companies",
"attributes": {
"name": "Client457",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:28.978+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 225
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "523",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user524@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-04-15T01:03:28.000+02:00",
"is_user": true,
"user_id": 524,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:28.955+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 225
}
},
"company": {
"data": {
"type": "companies",
"id": "682"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "682",
"type": "companies",
"attributes": {
"name": "Client456",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:28.951+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 225
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
PATCHÂ Â /api/v2/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+json
Body
{
"data": {
"type": "deals",
"attributes": {
"name": ""
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
}
]
}
PATCHÂ Â /api/v2/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+json
Body
{
"data": {
"type": "deals",
"attributes": {
"delivered_on": "2021-04-19"
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "40",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-04-15",
"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": "ac799caf06a1986a16d84ff6398fd85a",
"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,
"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-04-15T01:03:29.426+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-04-15",
"sales_closed_on": 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": 227
}
},
"creator": {
"data": {
"type": "people",
"id": "526"
}
},
"company": {
"data": {
"type": "companies",
"id": "690"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "528"
}
},
"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": "526",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user527@email.com",
"title": null,
"joined_at": "2021-04-15T01:03:29.000+02:00",
"last_seen_at": "2021-04-15T01:03:29.445+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 527,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:29.260+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 227
}
},
"company": {
"data": {
"type": "companies",
"id": "687"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "690",
"type": "companies",
"attributes": {
"name": "Client462",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:29.333+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 227
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "528",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user529@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-04-15T01:03:29.000+02:00",
"is_user": true,
"user_id": 529,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:29.343+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 227
}
},
"company": {
"data": {
"type": "companies",
"id": "691"
}
},
"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-04-15T01:03:29.406+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,
"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": 227
}
},
"company": {
"data": {
"type": "companies",
"id": "693"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "529"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "687",
"type": "companies",
"attributes": {
"name": "Organization227",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-04-15T01:03:29.259+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 227
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "691",
"type": "companies",
"attributes": {
"name": "Client463",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:29.339+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 227
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "693",
"type": "companies",
"attributes": {
"name": "Client465",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:29.404+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 227
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "529",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user530@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-04-15T01:03:29.000+02:00",
"is_user": true,
"user_id": 530,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:29.379+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 227
}
},
"company": {
"data": {
"type": "companies",
"id": "692"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "692",
"type": "companies",
"attributes": {
"name": "Client464",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:29.376+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 227
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
DELETEÂ Â /api/v2/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+json
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+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "64",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-04-15",
"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": "5b90c646c330f5a8b96e0f23a0321c2b",
"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,
"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-04-15T01:03:32.739+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-04-15",
"sales_closed_on": 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": 238
}
},
"creator": {
"data": {
"type": "people",
"id": "566"
}
},
"company": {
"data": {
"type": "companies",
"id": "755"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "568"
}
},
"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": "566",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user567@email.com",
"title": null,
"joined_at": "2021-04-15T01:03:32.000+02:00",
"last_seen_at": "2021-04-15T01:03:32.759+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 567,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:32.577+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 238
}
},
"company": {
"data": {
"type": "companies",
"id": "752"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "755",
"type": "companies",
"attributes": {
"name": "Client516",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:32.650+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 238
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "568",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user569@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-04-15T01:03:32.000+02:00",
"is_user": true,
"user_id": 569,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:32.659+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 238
}
},
"company": {
"data": {
"type": "companies",
"id": "756"
}
},
"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-04-15T01:03:32.720+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,
"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": 238
}
},
"company": {
"data": {
"type": "companies",
"id": "758"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "569"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "752",
"type": "companies",
"attributes": {
"name": "Organization238",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-04-15T01:03:32.576+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 238
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "756",
"type": "companies",
"attributes": {
"name": "Client517",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:32.656+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 238
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "758",
"type": "companies",
"attributes": {
"name": "Client519",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:32.718+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 238
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "569",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user570@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-04-15T01:03:32.000+02:00",
"is_user": true,
"user_id": 570,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:32.693+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 238
}
},
"company": {
"data": {
"type": "companies",
"id": "757"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "757",
"type": "companies",
"attributes": {
"name": "Client518",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:32.689+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 238
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
PATCHÂ Â /api/v2/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+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "66",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-04-15",
"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": "d88fac34a48ff32915d1471e537bdcbb",
"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,
"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-04-15T01:03:33.000+02:00",
"delivered_on": "2021-04-15",
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-04-15T01:03:33.040+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-04-15",
"sales_closed_on": 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": 239
}
},
"creator": {
"data": {
"type": "people",
"id": "570"
}
},
"company": {
"data": {
"type": "companies",
"id": "762"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "572"
}
},
"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": "570",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user571@email.com",
"title": null,
"joined_at": "2021-04-15T01:03:33.000+02:00",
"last_seen_at": "2021-04-15T01:03:33.059+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 571,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:32.879+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 239
}
},
"company": {
"data": {
"type": "companies",
"id": "759"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "762",
"type": "companies",
"attributes": {
"name": "Client522",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:32.952+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 239
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "572",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user573@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-04-15T01:03:32.000+02:00",
"is_user": true,
"user_id": 573,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:32.962+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 239
}
},
"company": {
"data": {
"type": "companies",
"id": "763"
}
},
"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-04-15T01:03:33.021+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,
"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": 239
}
},
"company": {
"data": {
"type": "companies",
"id": "765"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "573"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "759",
"type": "companies",
"attributes": {
"name": "Organization239",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-04-15T01:03:32.877+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 239
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "763",
"type": "companies",
"attributes": {
"name": "Client523",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:32.958+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 239
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "765",
"type": "companies",
"attributes": {
"name": "Client525",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:33.019+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 239
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "573",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user574@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-04-15T01:03:32.000+02:00",
"is_user": true,
"user_id": 574,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:32.994+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 239
}
},
"company": {
"data": {
"type": "companies",
"id": "764"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "764",
"type": "companies",
"attributes": {
"name": "Client524",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:32.990+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 239
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
PATCHÂ Â /api/v2/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+json
Body
{
"data": {
"type": "deals",
"attributes": {
"delivered_on": "2021-04-19"
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "68",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-04-15",
"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": "e35d822767b50c8301fb9c4dd1f387c6",
"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,
"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-04-15T01:03:33.000+02:00",
"delivered_on": "2021-04-19",
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-04-15T01:03:33.350+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-04-15",
"sales_closed_on": 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": 240
}
},
"creator": {
"data": {
"type": "people",
"id": "574"
}
},
"company": {
"data": {
"type": "companies",
"id": "769"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "576"
}
},
"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": "574",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user575@email.com",
"title": null,
"joined_at": "2021-04-15T01:03:33.000+02:00",
"last_seen_at": "2021-04-15T01:03:33.370+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 575,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:33.187+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 240
}
},
"company": {
"data": {
"type": "companies",
"id": "766"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "769",
"type": "companies",
"attributes": {
"name": "Client528",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:33.262+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 240
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "576",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user577@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-04-15T01:03:33.000+02:00",
"is_user": true,
"user_id": 577,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:33.272+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 240
}
},
"company": {
"data": {
"type": "companies",
"id": "770"
}
},
"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-04-15T01:03:33.331+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,
"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": 240
}
},
"company": {
"data": {
"type": "companies",
"id": "772"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "577"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "766",
"type": "companies",
"attributes": {
"name": "Organization240",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-04-15T01:03:33.186+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 240
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "770",
"type": "companies",
"attributes": {
"name": "Client529",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:33.269+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 240
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "772",
"type": "companies",
"attributes": {
"name": "Client531",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:33.329+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 240
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "577",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user578@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-04-15T01:03:33.000+02:00",
"is_user": true,
"user_id": 578,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:03:33.305+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 240
}
},
"company": {
"data": {
"type": "companies",
"id": "771"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "771",
"type": "companies",
"attributes": {
"name": "Client530",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-04-15T01:03:33.301+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 240
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Generated by aglio on 14 Apr 2021