API Documentation

API Endpoint

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)

  • custom_fields[id] (where id is the identifier of your custom field; for dropdown and multiselect custom fields, use array filter)

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

  • profit

  • profit_margin

  • invoiced

  • pending_invoicing

  • paid

  • expense

  • expense_paid

  • budget_total

  • budget_used

  • company.name

  • project.name

  • responsible.name

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
Requestsreturns dealsreturns deals

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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "27",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-12-06",
        "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": "19510a362bc8e70c1e9014185cdf9a77",
        "purchase_order_number": null,
        "custom_fields": null,
        "position": null,
        "budget_revamp": false,
        "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,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-12-06T00:04:43.225+01:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-12-06",
        "sales_closed_on": null,
        "sample_data": false,
        "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,
        "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,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "226"
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "546"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "704"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "547"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "1164"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "546",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user547@email.com",
        "title": null,
        "joined_at": "2021-12-06T00:04:43.000+01:00",
        "last_seen_at": "2021-12-06T00:04:43.243+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 547,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:43.156+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "226"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "703"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "704",
      "type": "companies",
      "attributes": {
        "name": "Client477",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:43.181+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "226"
          }
        }
      }
    },
    {
      "id": "547",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user548@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:04:43.000+01:00",
        "is_user": true,
        "user_id": 548,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:43.192+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "226"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "705"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "1164",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "226"
          }
        }
      }
    },
    {
      "id": "703",
      "type": "companies",
      "attributes": {
        "name": "Organization226",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-12-06T00:04:43.155+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "226"
          }
        }
      }
    },
    {
      "id": "705",
      "type": "companies",
      "attributes": {
        "name": "Client478",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:43.188+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "226"
          }
        }
      }
    }
  ],
  "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
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "workflows": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "183",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-12-06",
        "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": "e64a1b78723b1f50b08ab60cde2c861d",
        "purchase_order_number": null,
        "custom_fields": null,
        "position": null,
        "budget_revamp": false,
        "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,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-12-06T00:06:19.210+01:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-12-06",
        "sales_closed_on": null,
        "sample_data": false,
        "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,
        "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,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "634"
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "1707"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2274"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "1708"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "3286"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "1707",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1656@email.com",
        "title": null,
        "joined_at": "2021-12-06T00:06:19.000+01:00",
        "last_seen_at": "2021-12-06T00:06:19.229+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 1697,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:06:19.133+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "634"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2273"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "2274",
      "type": "companies",
      "attributes": {
        "name": "Client1641",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:06:19.157+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "634"
          }
        }
      }
    },
    {
      "id": "1708",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1657@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:06:19.000+01:00",
        "is_user": true,
        "user_id": 1698,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:06:19.168+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "634"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2275"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "3286",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "634"
          }
        }
      }
    },
    {
      "id": "2273",
      "type": "companies",
      "attributes": {
        "name": "Organization634",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-12-06T00:06:19.132+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "634"
          }
        }
      }
    },
    {
      "id": "2275",
      "type": "companies",
      "attributes": {
        "name": "Client1642",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:06:19.164+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "634"
          }
        }
      }
    }
  ],
  "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
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "workflows": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get deals
GET/api/v2/deals

GET /api/v2/deals/1
Requestsreturns dealreturns deal

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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "28",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2021-12-06",
      "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": "c3f93a66ef7f7bd80eedf7238d89ec13",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": null,
      "budget_revamp": false,
      "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,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-12-06T00:04:43.392+01:00",
      "note": null,
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2021-12-06",
      "sales_closed_on": null,
      "sample_data": false,
      "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,
      "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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "227"
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "548"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "707"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "549"
        }
      },
      "deal_status": {
        "data": {
          "type": "deal_statuses",
          "id": "1170"
        }
      },
      "project": {
        "data": null
      },
      "lost_reason": {
        "data": null
      },
      "contract": {
        "data": null
      },
      "contact": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "548",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user549@email.com",
        "title": null,
        "joined_at": "2021-12-06T00:04:43.000+01:00",
        "last_seen_at": "2021-12-06T00:04:43.410+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 549,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:43.313+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "227"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "706"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "707",
      "type": "companies",
      "attributes": {
        "name": "Client479",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:43.338+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "227"
          }
        }
      }
    },
    {
      "id": "549",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user550@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:04:43.000+01:00",
        "is_user": true,
        "user_id": 550,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:43.349+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "227"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "708"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "1170",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "227"
          }
        }
      }
    },
    {
      "id": "706",
      "type": "companies",
      "attributes": {
        "name": "Organization227",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-12-06T00:04:43.312+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "227"
          }
        }
      }
    },
    {
      "id": "708",
      "type": "companies",
      "attributes": {
        "name": "Client480",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:43.345+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "227"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "workflows": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

GET  /api/v2/deals/184

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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "184",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2021-12-06",
      "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": "a1b222d72c385ff7af7e4a799c39f4a5",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": null,
      "budget_revamp": false,
      "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,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-12-06T00:06:19.384+01:00",
      "note": null,
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2021-12-06",
      "sales_closed_on": null,
      "sample_data": false,
      "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,
      "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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "635"
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "1709"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "2277"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "1710"
        }
      },
      "deal_status": {
        "data": {
          "type": "deal_statuses",
          "id": "3292"
        }
      },
      "project": {
        "data": null
      },
      "lost_reason": {
        "data": null
      },
      "contract": {
        "data": null
      },
      "contact": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1709",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1658@email.com",
        "title": null,
        "joined_at": "2021-12-06T00:06:19.000+01:00",
        "last_seen_at": "2021-12-06T00:06:19.400+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 1699,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:06:19.314+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "635"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2276"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "2277",
      "type": "companies",
      "attributes": {
        "name": "Client1643",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:06:19.340+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "635"
          }
        }
      }
    },
    {
      "id": "1710",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1659@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:06:19.000+01:00",
        "is_user": true,
        "user_id": 1700,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:06:19.351+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "635"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2278"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "3292",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "635"
          }
        }
      }
    },
    {
      "id": "2276",
      "type": "companies",
      "attributes": {
        "name": "Organization635",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-12-06T00:06:19.312+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "635"
          }
        }
      }
    },
    {
      "id": "2278",
      "type": "companies",
      "attributes": {
        "name": "Client1644",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:06:19.347+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "635"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "workflows": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Gets a deal
GET/api/v2/deals/{id}

URI Parameters
HideShow
id
number (required) Example: 1

deal id

POST /api/v2/deals
Requestscreates dealreturns errorcreates dealreturns error

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-12-06",
      "deal_type_id": 2,
      "deal_status_id": 1188,
      "sales_status_id": 1,
      "probability": 50,
      "currency": "EUR"
    },
    "relationships": {
      "company": {
        "data": {
          "type": "companies",
          "id": "718"
        }
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "558"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "32",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2021-12-06",
      "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-12-06T00:04:44.000+01:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "discount": null,
      "email_key": "1b6f34f81df7e4b272ff25cd45f122da",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": null,
      "budget_revamp": false,
      "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,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-12-06T00:04:44.059+01:00",
      "note": null,
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2021-12-06",
      "sales_closed_on": null,
      "sample_data": false,
      "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,
      "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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "230"
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "556"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "718"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "558"
        }
      },
      "deal_status": {
        "data": {
          "type": "deal_statuses",
          "id": "1188"
        }
      },
      "project": {
        "data": null
      },
      "lost_reason": {
        "data": null
      },
      "contract": {
        "data": null
      },
      "contact": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "556",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user557@email.com",
        "title": null,
        "joined_at": "2021-12-06T00:04:44.000+01:00",
        "last_seen_at": "2021-12-06T00:04:44.032+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 557,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:43.884+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "230"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "717"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "718",
      "type": "companies",
      "attributes": {
        "name": "Client487",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:43.908+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "230"
          }
        }
      }
    },
    {
      "id": "558",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user559@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 2,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:04:43.000+01:00",
        "is_user": true,
        "user_id": 559,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:43.990+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "230"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "720"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "1188",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "230"
          }
        }
      }
    },
    {
      "id": "717",
      "type": "companies",
      "attributes": {
        "name": "Organization230",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-12-06T00:04:43.883+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "230"
          }
        }
      }
    },
    {
      "id": "720",
      "type": "companies",
      "attributes": {
        "name": "Client489",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:43.984+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "230"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "workflows": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "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": ""
    }
  }
}
Responses422
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"
      }
    }
  ]
}

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-12-06",
      "deal_type_id": 2,
      "deal_status_id": 3310,
      "sales_status_id": 1,
      "probability": 50,
      "currency": "EUR"
    },
    "relationships": {
      "company": {
        "data": {
          "type": "companies",
          "id": "2288"
        }
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "1719"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "188",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2021-12-06",
      "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-12-06T00:06:20.000+01:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "discount": null,
      "email_key": "904e7f46ba8b01c34092ca5af7bc00bf",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": null,
      "budget_revamp": false,
      "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,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-12-06T00:06:20.031+01:00",
      "note": null,
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2021-12-06",
      "sales_closed_on": null,
      "sample_data": false,
      "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,
      "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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "638"
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "1717"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "2288"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "1719"
        }
      },
      "deal_status": {
        "data": {
          "type": "deal_statuses",
          "id": "3310"
        }
      },
      "project": {
        "data": null
      },
      "lost_reason": {
        "data": null
      },
      "contract": {
        "data": null
      },
      "contact": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1717",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1666@email.com",
        "title": null,
        "joined_at": "2021-12-06T00:06:20.000+01:00",
        "last_seen_at": "2021-12-06T00:06:20.012+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 1707,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:06:19.884+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "638"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2287"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "2288",
      "type": "companies",
      "attributes": {
        "name": "Client1651",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:06:19.907+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "638"
          }
        }
      }
    },
    {
      "id": "1719",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1668@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 2,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:06:19.000+01:00",
        "is_user": true,
        "user_id": 1709,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:06:19.973+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "638"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2290"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "3310",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "638"
          }
        }
      }
    },
    {
      "id": "2287",
      "type": "companies",
      "attributes": {
        "name": "Organization638",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-12-06T00:06:19.882+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "638"
          }
        }
      }
    },
    {
      "id": "2290",
      "type": "companies",
      "attributes": {
        "name": "Client1653",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:06:19.969+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "638"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "workflows": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "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": ""
    }
  }
}
Responses422
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 deal
POST/api/v2/deals

URI Parameters
HideShow
name
string (required) Example: Name

name

date
date (required) Example: 2018-01-01

date

responsible_id: `1` (number, required) - responsible_id
string (required) 
company_id: `1` (number, required) - company_id
string (required) 
deal_type_id
number (required) Example: 1

deal type

probability
number (required) Example: 100

probability

currency
currency (required) Example: EUR

currency

deal_status
number (required) Example: 1

deal status

sales_status
number (required) Example: 1

sales status

PATCH /api/v2/deals/1
Requestsupdates dealupdates budgetreturns errorupdates budgetupdates dealupdates budgetreturns errorupdates budget

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": "565"
        }
      },
      "subscribers": {
        "data": [
          {
            "type": "people",
            "id": "566"
          },
          {
            "type": "people",
            "id": "567"
          }
        ]
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "35",
    "type": "deals",
    "attributes": {
      "name": "new name",
      "date": "2021-12-06",
      "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-12-06T00:04:44.000+01:00",
      "tag_list": [
        "invoiced",
        "paid"
      ],
      "origin_deal_id": null,
      "profit_margin": 0,
      "discount": null,
      "email_key": "5037f83d619a20eeecf0a8030589bd1d",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": null,
      "budget_revamp": false,
      "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,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-12-06T00:04:44.608+01:00",
      "note": null,
      "sales_closed_at": "2021-12-06T00:04:44.000+01:00",
      "exchange_rate": "1.25",
      "exchange_date": "2021-12-06",
      "sales_closed_on": "2021-12-06",
      "sample_data": false,
      "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,
      "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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "233"
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "563"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "728"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "565"
        }
      },
      "deal_status": {
        "data": {
          "type": "deal_statuses",
          "id": "1206"
        }
      },
      "project": {
        "data": null
      },
      "lost_reason": {
        "data": null
      },
      "contract": {
        "data": null
      },
      "contact": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "563",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user564@email.com",
        "title": null,
        "joined_at": "2021-12-06T00:04:44.000+01:00",
        "last_seen_at": "2021-12-06T00:04:44.744+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 564,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:44.530+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "233"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "727"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "728",
      "type": "companies",
      "attributes": {
        "name": "Client494",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:44.557+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "233"
          }
        }
      }
    },
    {
      "id": "565",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user566@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 2,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:04:44.000+01:00",
        "is_user": true,
        "user_id": 566,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:44.626+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "233"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "730"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "1206",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "233"
          }
        }
      }
    },
    {
      "id": "727",
      "type": "companies",
      "attributes": {
        "name": "Organization233",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-12-06T00:04:44.528+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "233"
          }
        }
      }
    },
    {
      "id": "730",
      "type": "companies",
      "attributes": {
        "name": "Client496",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:44.622+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "233"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "workflows": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "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-12-10"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "37",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2021-12-06",
      "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": "7089e312f3af31fa0178826a0a0cb752",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": null,
      "budget_revamp": false,
      "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,
      "lost_comment": null,
      "closed_at": "2021-12-06T00:04:45.000+01:00",
      "delivered_on": "2021-12-10",
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-12-06T00:04:45.266+01:00",
      "note": null,
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2021-12-06",
      "sales_closed_on": null,
      "sample_data": false,
      "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,
      "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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "234"
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "568"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "736"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "570"
        }
      },
      "deal_status": {
        "data": null
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "83"
        }
      },
      "lost_reason": {
        "data": null
      },
      "contract": {
        "data": null
      },
      "contact": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "568",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user569@email.com",
        "title": null,
        "joined_at": "2021-12-06T00:04:45.000+01:00",
        "last_seen_at": "2021-12-06T00:04:45.287+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 569,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:44.929+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "234"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "733"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "736",
      "type": "companies",
      "attributes": {
        "name": "Client501",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:45.004+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "234"
          }
        }
      }
    },
    {
      "id": "570",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user571@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:04:45.000+01:00",
        "is_user": true,
        "user_id": 571,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:45.014+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "234"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "737"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "83",
      "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-12-06T00:04:45.102+01:00",
        "budget_closing_date": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "234"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "739"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "571"
          }
        },
        "last_actor": {
          "data": null
        },
        "workflow": {
          "data": null
        }
      }
    },
    {
      "id": "733",
      "type": "companies",
      "attributes": {
        "name": "Organization234",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-12-06T00:04:44.927+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "234"
          }
        }
      }
    },
    {
      "id": "737",
      "type": "companies",
      "attributes": {
        "name": "Client502",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:45.010+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "234"
          }
        }
      }
    },
    {
      "id": "739",
      "type": "companies",
      "attributes": {
        "name": "Client504",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:45.099+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "234"
          }
        }
      }
    },
    {
      "id": "571",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user572@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:04:45.000+01:00",
        "is_user": true,
        "user_id": 572,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:45.068+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "234"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "738"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "738",
      "type": "companies",
      "attributes": {
        "name": "Client503",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:45.063+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "234"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "workflows": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "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": ""
    }
  }
}
Responses422
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-12-10"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "40",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2021-12-06",
      "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": "28b3b1f44bf1ddb9e387412492d96380",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": null,
      "budget_revamp": false,
      "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,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-12-06T00:04:45.886+01:00",
      "note": null,
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2021-12-06",
      "sales_closed_on": null,
      "sample_data": false,
      "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,
      "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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "236"
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "574"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "746"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "576"
        }
      },
      "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": "574",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user575@email.com",
        "title": null,
        "joined_at": "2021-12-06T00:04:45.000+01:00",
        "last_seen_at": "2021-12-06T00:04:45.905+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 575,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:45.566+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "236"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "743"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "746",
      "type": "companies",
      "attributes": {
        "name": "Client509",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:45.648+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "236"
          }
        }
      }
    },
    {
      "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,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:04:45.000+01:00",
        "is_user": true,
        "user_id": 577,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:45.660+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "236"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "747"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "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-12-06T00:04:45.734+01:00",
        "budget_closing_date": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "236"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "749"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "577"
          }
        },
        "last_actor": {
          "data": null
        },
        "workflow": {
          "data": null
        }
      }
    },
    {
      "id": "743",
      "type": "companies",
      "attributes": {
        "name": "Organization236",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-12-06T00:04:45.565+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "236"
          }
        }
      }
    },
    {
      "id": "747",
      "type": "companies",
      "attributes": {
        "name": "Client510",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:45.656+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "236"
          }
        }
      }
    },
    {
      "id": "749",
      "type": "companies",
      "attributes": {
        "name": "Client512",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:45.731+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "236"
          }
        }
      }
    },
    {
      "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,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:04:45.000+01:00",
        "is_user": true,
        "user_id": 578,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:45.699+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "236"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "748"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "748",
      "type": "companies",
      "attributes": {
        "name": "Client511",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:45.695+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "236"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "workflows": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

PATCH  /api/v2/deals/191

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": "1726"
        }
      },
      "subscribers": {
        "data": [
          {
            "type": "people",
            "id": "1727"
          },
          {
            "type": "people",
            "id": "1728"
          }
        ]
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "191",
    "type": "deals",
    "attributes": {
      "name": "new name",
      "date": "2021-12-06",
      "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-12-06T00:06:20.000+01:00",
      "tag_list": [
        "invoiced",
        "paid"
      ],
      "origin_deal_id": null,
      "profit_margin": 0,
      "discount": null,
      "email_key": "b18c0aaaf82f8d46d217fcd4c5b1687d",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": null,
      "budget_revamp": false,
      "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,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-12-06T00:06:20.551+01:00",
      "note": null,
      "sales_closed_at": "2021-12-06T00:06:20.000+01:00",
      "exchange_rate": "1.25",
      "exchange_date": "2021-12-06",
      "sales_closed_on": "2021-12-06",
      "sample_data": false,
      "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,
      "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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "641"
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "1724"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "2298"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "1726"
        }
      },
      "deal_status": {
        "data": {
          "type": "deal_statuses",
          "id": "3328"
        }
      },
      "project": {
        "data": null
      },
      "lost_reason": {
        "data": null
      },
      "contract": {
        "data": null
      },
      "contact": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1724",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1673@email.com",
        "title": null,
        "joined_at": "2021-12-06T00:06:20.000+01:00",
        "last_seen_at": "2021-12-06T00:06:20.669+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 1714,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:06:20.484+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "641"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2297"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "2298",
      "type": "companies",
      "attributes": {
        "name": "Client1658",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:06:20.508+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "641"
          }
        }
      }
    },
    {
      "id": "1726",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1675@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 2,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:06:20.000+01:00",
        "is_user": true,
        "user_id": 1716,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:06:20.567+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "641"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2300"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "3328",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "641"
          }
        }
      }
    },
    {
      "id": "2297",
      "type": "companies",
      "attributes": {
        "name": "Organization641",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-12-06T00:06:20.483+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "641"
          }
        }
      }
    },
    {
      "id": "2300",
      "type": "companies",
      "attributes": {
        "name": "Client1660",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:06:20.564+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "641"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "workflows": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

PATCH  /api/v2/deals/193

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-12-10"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "193",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2021-12-06",
      "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": "a9b7228fc6bbecb30e9db601edced4ac",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": null,
      "budget_revamp": false,
      "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,
      "lost_comment": null,
      "closed_at": "2021-12-06T00:06:20.000+01:00",
      "delivered_on": "2021-12-10",
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-12-06T00:06:21.198+01:00",
      "note": null,
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2021-12-06",
      "sales_closed_on": null,
      "sample_data": false,
      "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,
      "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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "642"
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "1729"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "2306"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "1731"
        }
      },
      "deal_status": {
        "data": null
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "344"
        }
      },
      "lost_reason": {
        "data": null
      },
      "contract": {
        "data": null
      },
      "contact": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1729",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1678@email.com",
        "title": null,
        "joined_at": "2021-12-06T00:06:21.000+01:00",
        "last_seen_at": "2021-12-06T00:06:21.225+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 1719,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:06:20.860+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "642"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2303"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "2306",
      "type": "companies",
      "attributes": {
        "name": "Client1665",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:06:20.954+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "642"
          }
        }
      }
    },
    {
      "id": "1731",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1680@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:06:20.000+01:00",
        "is_user": true,
        "user_id": 1721,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:06:20.966+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "642"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2307"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "344",
      "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-12-06T00:06:21.042+01:00",
        "budget_closing_date": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "642"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2309"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "1732"
          }
        },
        "last_actor": {
          "data": null
        },
        "workflow": {
          "data": null
        }
      }
    },
    {
      "id": "2303",
      "type": "companies",
      "attributes": {
        "name": "Organization642",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-12-06T00:06:20.858+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "642"
          }
        }
      }
    },
    {
      "id": "2307",
      "type": "companies",
      "attributes": {
        "name": "Client1666",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:06:20.962+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "642"
          }
        }
      }
    },
    {
      "id": "2309",
      "type": "companies",
      "attributes": {
        "name": "Client1668",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:06:21.039+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "642"
          }
        }
      }
    },
    {
      "id": "1732",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1681@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:06:21.000+01:00",
        "is_user": true,
        "user_id": 1722,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:06:21.006+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "642"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2308"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "2308",
      "type": "companies",
      "attributes": {
        "name": "Client1667",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:06:21.002+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "642"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "workflows": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

PATCH  /api/v2/deals/194

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": ""
    }
  }
}
Responses422
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/196

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-12-10"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "196",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2021-12-06",
      "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": "054c5d728e07b5a7a9eba1afd9bb6aa7",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": null,
      "budget_revamp": false,
      "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,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-12-06T00:06:21.825+01:00",
      "note": null,
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2021-12-06",
      "sales_closed_on": null,
      "sample_data": false,
      "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,
      "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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "644"
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "1735"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "2316"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "1737"
        }
      },
      "deal_status": {
        "data": null
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "345"
        }
      },
      "lost_reason": {
        "data": null
      },
      "contract": {
        "data": null
      },
      "contact": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1735",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1684@email.com",
        "title": null,
        "joined_at": "2021-12-06T00:06:21.000+01:00",
        "last_seen_at": "2021-12-06T00:06:21.844+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 1725,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:06:21.531+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "644"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2313"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "2316",
      "type": "companies",
      "attributes": {
        "name": "Client1673",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:06:21.616+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "644"
          }
        }
      }
    },
    {
      "id": "1737",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1686@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:06:21.000+01:00",
        "is_user": true,
        "user_id": 1727,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:06:21.626+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "644"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2317"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "345",
      "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-12-06T00:06:21.691+01:00",
        "budget_closing_date": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "644"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2319"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "1738"
          }
        },
        "last_actor": {
          "data": null
        },
        "workflow": {
          "data": null
        }
      }
    },
    {
      "id": "2313",
      "type": "companies",
      "attributes": {
        "name": "Organization644",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-12-06T00:06:21.530+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "644"
          }
        }
      }
    },
    {
      "id": "2317",
      "type": "companies",
      "attributes": {
        "name": "Client1674",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:06:21.622+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "644"
          }
        }
      }
    },
    {
      "id": "2319",
      "type": "companies",
      "attributes": {
        "name": "Client1676",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:06:21.689+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "644"
          }
        }
      }
    },
    {
      "id": "1738",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1687@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:06:21.000+01:00",
        "is_user": true,
        "user_id": 1728,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:06:21.661+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "644"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2318"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "2318",
      "type": "companies",
      "attributes": {
        "name": "Client1675",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:06:21.657+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "644"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "workflows": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Update a deal
PATCH/api/v2/deals/{id}

URI Parameters
HideShow
id
number (required) Example: 1

deal id

DELETE /api/v2/deals/1
Requestsarchives dealarchives deal

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
Responses204
This response has no content.

DELETE  /api/v2/deals/197

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
Responses204
This response has no content.

Deletes a deal
DELETE/api/v2/deals/{id}

URI Parameters
HideShow
id
number (required) Example: 1

deal id

PATCH /api/v2/deals/1/open
Requestsopens budgetopens budget

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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "64",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2021-12-06",
      "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": "3341dbd651d10544a5ab4eb6022a3897",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": null,
      "budget_revamp": false,
      "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,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-12-06T00:04:50.787+01:00",
      "note": null,
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2021-12-06",
      "sales_closed_on": null,
      "sample_data": false,
      "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,
      "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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "247"
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "614"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "811"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "616"
        }
      },
      "deal_status": {
        "data": null
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "91"
        }
      },
      "lost_reason": {
        "data": null
      },
      "contract": {
        "data": null
      },
      "contact": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "614",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user615@email.com",
        "title": null,
        "joined_at": "2021-12-06T00:04:50.000+01:00",
        "last_seen_at": "2021-12-06T00:04:50.807+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 615,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:50.422+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "247"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "808"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "811",
      "type": "companies",
      "attributes": {
        "name": "Client563",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:50.525+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "247"
          }
        }
      }
    },
    {
      "id": "616",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user617@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:04:50.000+01:00",
        "is_user": true,
        "user_id": 617,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:50.537+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "247"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "812"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "91",
      "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-12-06T00:04:50.617+01:00",
        "budget_closing_date": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "247"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "814"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "617"
          }
        },
        "last_actor": {
          "data": null
        },
        "workflow": {
          "data": null
        }
      }
    },
    {
      "id": "808",
      "type": "companies",
      "attributes": {
        "name": "Organization247",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-12-06T00:04:50.421+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "247"
          }
        }
      }
    },
    {
      "id": "812",
      "type": "companies",
      "attributes": {
        "name": "Client564",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:50.532+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "247"
          }
        }
      }
    },
    {
      "id": "814",
      "type": "companies",
      "attributes": {
        "name": "Client566",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:50.614+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "247"
          }
        }
      }
    },
    {
      "id": "617",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user618@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:04:50.000+01:00",
        "is_user": true,
        "user_id": 618,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:50.582+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "247"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "813"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "813",
      "type": "companies",
      "attributes": {
        "name": "Client565",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:50.578+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "247"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "workflows": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

PATCH  /api/v2/deals/220/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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "220",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2021-12-06",
      "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": "48c8c753ca414d4968205c20a3927562",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": null,
      "budget_revamp": false,
      "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,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-12-06T00:06:26.575+01:00",
      "note": null,
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2021-12-06",
      "sales_closed_on": null,
      "sample_data": false,
      "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,
      "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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "655"
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "1775"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "2381"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "1777"
        }
      },
      "deal_status": {
        "data": null
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "352"
        }
      },
      "lost_reason": {
        "data": null
      },
      "contract": {
        "data": null
      },
      "contact": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1775",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1724@email.com",
        "title": null,
        "joined_at": "2021-12-06T00:06:26.000+01:00",
        "last_seen_at": "2021-12-06T00:06:26.595+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 1765,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:06:26.241+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "655"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2378"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "2381",
      "type": "companies",
      "attributes": {
        "name": "Client1727",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:06:26.339+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "655"
          }
        }
      }
    },
    {
      "id": "1777",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1726@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:06:26.000+01:00",
        "is_user": true,
        "user_id": 1767,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:06:26.352+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "655"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2382"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "352",
      "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-12-06T00:06:26.426+01:00",
        "budget_closing_date": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "655"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2384"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "1778"
          }
        },
        "last_actor": {
          "data": null
        },
        "workflow": {
          "data": null
        }
      }
    },
    {
      "id": "2378",
      "type": "companies",
      "attributes": {
        "name": "Organization655",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-12-06T00:06:26.239+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "655"
          }
        }
      }
    },
    {
      "id": "2382",
      "type": "companies",
      "attributes": {
        "name": "Client1728",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:06:26.347+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "655"
          }
        }
      }
    },
    {
      "id": "2384",
      "type": "companies",
      "attributes": {
        "name": "Client1730",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:06:26.423+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "655"
          }
        }
      }
    },
    {
      "id": "1778",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1727@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:06:26.000+01:00",
        "is_user": true,
        "user_id": 1768,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:06:26.394+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "655"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2383"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "2383",
      "type": "companies",
      "attributes": {
        "name": "Client1729",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:06:26.389+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "655"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "workflows": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Opens a deal
PATCH/api/v2/deals/{id}/open

URI Parameters
HideShow
id
number (required) Example: 1

deal id

PATCH /api/v2/deals/1/close
Requestscloses budgetcloses budgetcloses budgetcloses budget

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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "66",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2021-12-06",
      "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": "6bd0dd95fceea02e7a9fd74560677787",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": null,
      "budget_revamp": false,
      "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,
      "lost_comment": null,
      "closed_at": "2021-12-06T00:04:51.000+01:00",
      "delivered_on": "2021-12-06",
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-12-06T00:04:51.245+01:00",
      "note": null,
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2021-12-06",
      "sales_closed_on": null,
      "sample_data": false,
      "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,
      "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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "248"
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "618"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "818"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "620"
        }
      },
      "deal_status": {
        "data": null
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "92"
        }
      },
      "lost_reason": {
        "data": null
      },
      "contract": {
        "data": null
      },
      "contact": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "618",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user619@email.com",
        "title": null,
        "joined_at": "2021-12-06T00:04:51.000+01:00",
        "last_seen_at": "2021-12-06T00:04:51.269+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 619,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:50.937+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "248"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "815"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "818",
      "type": "companies",
      "attributes": {
        "name": "Client569",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:51.012+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "248"
          }
        }
      }
    },
    {
      "id": "620",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user621@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:04:51.000+01:00",
        "is_user": true,
        "user_id": 621,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:51.023+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "248"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "819"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "92",
      "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-12-06T00:04:51.100+01:00",
        "budget_closing_date": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "248"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "821"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "621"
          }
        },
        "last_actor": {
          "data": null
        },
        "workflow": {
          "data": null
        }
      }
    },
    {
      "id": "815",
      "type": "companies",
      "attributes": {
        "name": "Organization248",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-12-06T00:04:50.936+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "248"
          }
        }
      }
    },
    {
      "id": "819",
      "type": "companies",
      "attributes": {
        "name": "Client570",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:51.018+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "248"
          }
        }
      }
    },
    {
      "id": "821",
      "type": "companies",
      "attributes": {
        "name": "Client572",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:51.097+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "248"
          }
        }
      }
    },
    {
      "id": "621",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user622@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:04:51.000+01:00",
        "is_user": true,
        "user_id": 622,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:51.066+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "248"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "820"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "820",
      "type": "companies",
      "attributes": {
        "name": "Client571",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:51.062+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "248"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "workflows": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "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-12-10"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "68",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2021-12-06",
      "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": "e3a7eb5ead233457807c9c25d1f62138",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": null,
      "budget_revamp": false,
      "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,
      "lost_comment": null,
      "closed_at": "2021-12-06T00:04:51.000+01:00",
      "delivered_on": "2021-12-10",
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-12-06T00:04:51.712+01:00",
      "note": null,
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2021-12-06",
      "sales_closed_on": null,
      "sample_data": false,
      "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,
      "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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "249"
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "622"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "825"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "624"
        }
      },
      "deal_status": {
        "data": null
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "93"
        }
      },
      "lost_reason": {
        "data": null
      },
      "contract": {
        "data": null
      },
      "contact": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "622",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user623@email.com",
        "title": null,
        "joined_at": "2021-12-06T00:04:51.000+01:00",
        "last_seen_at": "2021-12-06T00:04:51.734+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 623,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:51.434+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "249"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "822"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "825",
      "type": "companies",
      "attributes": {
        "name": "Client575",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:51.512+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "249"
          }
        }
      }
    },
    {
      "id": "624",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user625@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:04:51.000+01:00",
        "is_user": true,
        "user_id": 625,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:51.522+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "249"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "826"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "93",
      "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-12-06T00:04:51.588+01:00",
        "budget_closing_date": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "249"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "828"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "625"
          }
        },
        "last_actor": {
          "data": null
        },
        "workflow": {
          "data": null
        }
      }
    },
    {
      "id": "822",
      "type": "companies",
      "attributes": {
        "name": "Organization249",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-12-06T00:04:51.433+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "249"
          }
        }
      }
    },
    {
      "id": "826",
      "type": "companies",
      "attributes": {
        "name": "Client576",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:51.519+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "249"
          }
        }
      }
    },
    {
      "id": "828",
      "type": "companies",
      "attributes": {
        "name": "Client578",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:51.586+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "249"
          }
        }
      }
    },
    {
      "id": "625",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user626@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-12-06T00:04:51.000+01:00",
        "is_user": true,
        "user_id": 626,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:04:51.558+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "249"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "827"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "827",
      "type": "companies",
      "attributes": {
        "name": "Client577",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-12-06T00:04:51.554+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "249"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "workflows": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

PATCH  /api/v2/deals/222/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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "222",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2021-12-06",
      "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": "451d4382427f0e0d22a22ed55e1dd527",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": null,
      "budget_revamp": false,
      "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,
      "lost_comment": null,
      "closed_at": "2021-12-06T00:06:27.000+01:00",
      "delivered_on": "2021-12-06",
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-12-06T00:06:27.038+01:00",
      "note": null,
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2021-12-06",
      "sales_closed_on": null,
      "sample_data": false,
      "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,
      "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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "656"
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "1779"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "2388"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "1781"
        }
      },
      "deal_status": {
        "data": null
      },
      "project": {
        "data": {
          "type": "projects",
          "id":