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)

Supported sort params

  • name

  • date

  • end_date

  • number

  • suffix

  • time_approval

  • client_access

  • purchase_order_number

  • budget_warning

  • closed_at

  • created_at

  • last_activity_at

  • probability

  • billable_time

  • estimated_time

  • budgeted_time

  • total_budgeted_time

  • worked_time

  • revenue

  • services_revenue

  • cost

  • work_cost

  • profit

  • profit_margin

  • invoiced

  • pending_invoicing

  • paid

  • expense

  • expense_billable

  • expense_paid

  • budget_total

  • budget_used

  • company.name

  • project.name

  • responsible.name

  • actual_rate

  • estimated_remaining_time

Supported aggregates params

  • total_revenue

  • total_expense_billable

  • total_services_revenue

  • total_work_cost

  • total_expense

  • total_cost

  • total_profit

  • total_budget_total

  • total_budget_used

  • total_invoiced

  • total_pending_invoicing

  • average_actual_rate

  • total_worked_time

  • total_billable_time

  • total_estimated_time

  • total_budgeted_time

  • average_time_to_close

  • total_estimated_remaining_time

  • average_rate

Supported Enumerations

Deal type:

  • internal (deal_type_id: 1)

  • client (deal_type_id: 2)

Filter operations are supported on this endpoint.

GET /api/v2/deals
Requestsreturns 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-01-24",
        "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": "e4481e6fcedca4ab94adaa1d0072778a",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 0,
        "forecasted_budget_usage": 0,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "rejected_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-01-24T00:03:51.196+01:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-01-24",
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "services_revenue": 0,
        "services_revenue_default": 0,
        "services_revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "invoiced": 0,
        "invoiced_default": 0,
        "invoiced_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 0,
        "budget_remaining_default": 0,
        "budget_remaining_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 0,
        "future_budget_used_default": 0,
        "future_budget_used_normalized": 0,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 0,
        "forecasted_revenue_default": 0,
        "forecasted_revenue_normalized": 0,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 0,
        "forecasted_profit_default": 0,
        "forecasted_profit_normalized": 0,
        "forecasted_budget_used": 0,
        "forecasted_budget_used_default": 0,
        "forecasted_budget_used_normalized": 0,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 209
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "463"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "613"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "464"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "1079"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "463",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user464@email.com",
        "title": null,
        "joined_at": "2021-01-24T00:03:51.000+01:00",
        "last_seen_at": "2021-01-24T00:03:51.215+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:51.135+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 209
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "612"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "613",
      "type": "companies",
      "attributes": {
        "name": "Client403",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:51.156+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 209
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "464",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user465@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-01-24T00:03:51.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:51.165+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 209
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "614"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1079",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 209
          }
        }
      }
    },
    {
      "id": "612",
      "type": "companies",
      "attributes": {
        "name": "Organization209",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-01-24T00:03:51.133+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 209
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "614",
      "type": "companies",
      "attributes": {
        "name": "Client404",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:51.162+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 209
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/deals?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/deals?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get deals
GET/api/v2/deals

GET /api/v2/deals/1
Requestsreturns 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-01-24",
      "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": "cc919e03de7f88ec3cbb987247b4b6de",
      "purchase_order_number": null,
      "custom_fields": null,
      "forecasted_billable_time": 0,
      "forecasted_margin": 0,
      "forecasted_budget_usage": 0,
      "forecasted_time_usage": 0,
      "budget_usage": 0,
      "future_booked_time": 0,
      "probability": 50,
      "budget_warning": null,
      "billable_time": 0,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "unapproved_entries_count": 0,
      "rejected_entries_count": 0,
      "estimated_remaining_time": 0,
      "unapproved_time": 0,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-01-24T00:03:51.367+01:00",
      "note": null,
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2021-01-24",
      "note_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR",
      "revenue": 0,
      "revenue_default": 0,
      "revenue_normalized": 0,
      "services_revenue": 0,
      "services_revenue_default": 0,
      "services_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "work_cost": 0,
      "work_cost_default": 0,
      "work_cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0,
      "expense_billable": 0,
      "expense_billable_default": 0,
      "expense_billable_normalized": 0,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "actual_rate": 0,
      "actual_rate_default": 0,
      "actual_rate_normalized": 0,
      "budget_remaining": 0,
      "budget_remaining_default": 0,
      "budget_remaining_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "future_revenue": 0,
      "future_revenue_default": 0,
      "future_revenue_normalized": 0,
      "future_budget_used": 0,
      "future_budget_used_default": 0,
      "future_budget_used_normalized": 0,
      "future_cost": 0,
      "future_cost_default": 0,
      "future_cost_normalized": 0,
      "forecasted_revenue": 0,
      "forecasted_revenue_default": 0,
      "forecasted_revenue_normalized": 0,
      "forecasted_cost": 0,
      "forecasted_cost_default": 0,
      "forecasted_cost_normalized": 0,
      "forecasted_profit": 0,
      "forecasted_profit_default": 0,
      "forecasted_profit_normalized": 0,
      "forecasted_budget_used": 0,
      "forecasted_budget_used_default": 0,
      "forecasted_budget_used_normalized": 0,
      "invoiced_rate": 0,
      "invoiced_rate_default": 0,
      "invoiced_rate_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 210
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "465"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "616"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "466"
        }
      },
      "deal_status": {
        "data": {
          "type": "deal_statuses",
          "id": "1085"
        }
      },
      "project": {
        "data": null
      },
      "lost_reason": {
        "data": null
      },
      "contract": {
        "data": null
      },
      "contact": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "465",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user466@email.com",
        "title": null,
        "joined_at": "2021-01-24T00:03:51.000+01:00",
        "last_seen_at": "2021-01-24T00:03:51.384+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:51.303+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 210
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "615"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "616",
      "type": "companies",
      "attributes": {
        "name": "Client405",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:51.324+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 210
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "466",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user467@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-01-24T00:03:51.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:51.333+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 210
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "617"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1085",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 210
          }
        }
      }
    },
    {
      "id": "615",
      "type": "companies",
      "attributes": {
        "name": "Organization210",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-01-24T00:03:51.302+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 210
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "617",
      "type": "companies",
      "attributes": {
        "name": "Client406",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:51.330+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 210
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      }
    },
    "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 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-01-24",
      "deal_type_id": 2,
      "deal_status_id": 1103,
      "sales_status_id": 1,
      "probability": 50,
      "currency": "EUR"
    },
    "relationships": {
      "company": {
        "data": {
          "type": "companies",
          "id": "627"
        }
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "475"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "32",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2021-01-24",
      "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-01-24T00:03:51.000+01:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "discount": null,
      "email_key": "90f8435e2cd23a0a81e80460a0af576d",
      "purchase_order_number": null,
      "custom_fields": null,
      "forecasted_billable_time": 0,
      "forecasted_margin": 0,
      "forecasted_budget_usage": 0,
      "forecasted_time_usage": 0,
      "budget_usage": 0,
      "future_booked_time": 0,
      "probability": 50,
      "budget_warning": null,
      "billable_time": 0,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "unapproved_entries_count": 0,
      "rejected_entries_count": 0,
      "estimated_remaining_time": 0,
      "unapproved_time": 0,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-01-24T00:03:51.961+01:00",
      "note": null,
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2021-01-24",
      "note_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR",
      "revenue": 0,
      "revenue_default": 0,
      "revenue_normalized": 0,
      "services_revenue": 0,
      "services_revenue_default": 0,
      "services_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "work_cost": 0,
      "work_cost_default": 0,
      "work_cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0,
      "expense_billable": 0,
      "expense_billable_default": 0,
      "expense_billable_normalized": 0,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "actual_rate": 0,
      "actual_rate_default": 0,
      "actual_rate_normalized": 0,
      "budget_remaining": 0,
      "budget_remaining_default": 0,
      "budget_remaining_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "future_revenue": 0,
      "future_revenue_default": 0,
      "future_revenue_normalized": 0,
      "future_budget_used": 0,
      "future_budget_used_default": 0,
      "future_budget_used_normalized": 0,
      "future_cost": 0,
      "future_cost_default": 0,
      "future_cost_normalized": 0,
      "forecasted_revenue": 0,
      "forecasted_revenue_default": 0,
      "forecasted_revenue_normalized": 0,
      "forecasted_cost": 0,
      "forecasted_cost_default": 0,
      "forecasted_cost_normalized": 0,
      "forecasted_profit": 0,
      "forecasted_profit_default": 0,
      "forecasted_profit_normalized": 0,
      "forecasted_budget_used": 0,
      "forecasted_budget_used_default": 0,
      "forecasted_budget_used_normalized": 0,
      "invoiced_rate": 0,
      "invoiced_rate_default": 0,
      "invoiced_rate_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 213
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "473"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "627"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "475"
        }
      },
      "deal_status": {
        "data": {
          "type": "deal_statuses",
          "id": "1103"
        }
      },
      "project": {
        "data": null
      },
      "lost_reason": {
        "data": null
      },
      "contract": {
        "data": null
      },
      "contact": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "473",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user474@email.com",
        "title": null,
        "joined_at": "2021-01-24T00:03:51.000+01:00",
        "last_seen_at": "2021-01-24T00:03:51.939+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:51.828+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 213
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "626"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "627",
      "type": "companies",
      "attributes": {
        "name": "Client413",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:51.850+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 213
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "475",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user476@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 2,
        "invited_at": "2021-01-24T00:03:51.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:51.907+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 213
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "629"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1103",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 213
          }
        }
      }
    },
    {
      "id": "626",
      "type": "companies",
      "attributes": {
        "name": "Organization213",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-01-24T00:03:51.827+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 213
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "629",
      "type": "companies",
      "attributes": {
        "name": "Client415",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:51.903+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 213
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      }
    },
    "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 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": "482"
        }
      },
      "subscribers": {
        "data": [
          {
            "type": "people",
            "id": "483"
          },
          {
            "type": "people",
            "id": "484"
          }
        ]
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "35",
    "type": "deals",
    "attributes": {
      "name": "new name",
      "date": "2021-01-24",
      "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-01-24T00:03:52.000+01:00",
      "tag_list": [
        "invoiced",
        "paid"
      ],
      "origin_deal_id": null,
      "profit_margin": 0,
      "discount": null,
      "email_key": "24457dae7e6e49cd8c934c76e1f3b463",
      "purchase_order_number": null,
      "custom_fields": null,
      "forecasted_billable_time": 0,
      "forecasted_margin": 0,
      "forecasted_budget_usage": 0,
      "forecasted_time_usage": 0,
      "budget_usage": 0,
      "future_booked_time": 0,
      "probability": 50,
      "budget_warning": null,
      "billable_time": 0,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": 0,
      "unapproved_entries_count": 0,
      "rejected_entries_count": 0,
      "estimated_remaining_time": 0,
      "unapproved_time": 0,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-01-24T00:03:52.366+01:00",
      "note": null,
      "sales_closed_at": "2021-01-24T00:03:52.000+01:00",
      "exchange_rate": "1.25",
      "exchange_date": "2021-01-24",
      "note_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR",
      "revenue": 0,
      "revenue_default": 0,
      "revenue_normalized": 0,
      "services_revenue": 0,
      "services_revenue_default": 0,
      "services_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "work_cost": 0,
      "work_cost_default": 0,
      "work_cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0,
      "expense_billable": 0,
      "expense_billable_default": 0,
      "expense_billable_normalized": 0,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "actual_rate": 0,
      "actual_rate_default": 0,
      "actual_rate_normalized": 0,
      "budget_remaining": 0,
      "budget_remaining_default": 0,
      "budget_remaining_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "future_revenue": 0,
      "future_revenue_default": 0,
      "future_revenue_normalized": 0,
      "future_budget_used": 0,
      "future_budget_used_default": 0,
      "future_budget_used_normalized": 0,
      "future_cost": 0,
      "future_cost_default": 0,
      "future_cost_normalized": 0,
      "forecasted_revenue": 0,
      "forecasted_revenue_default": 0,
      "forecasted_revenue_normalized": 0,
      "forecasted_cost": 0,
      "forecasted_cost_default": 0,
      "forecasted_cost_normalized": 0,
      "forecasted_profit": 0,
      "forecasted_profit_default": 0,
      "forecasted_profit_normalized": 0,
      "forecasted_budget_used": 0,
      "forecasted_budget_used_default": 0,
      "forecasted_budget_used_normalized": 0,
      "invoiced_rate": 0,
      "invoiced_rate_default": 0,
      "invoiced_rate_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 216
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "480"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "637"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "482"
        }
      },
      "deal_status": {
        "data": {
          "type": "deal_statuses",
          "id": "1121"
        }
      },
      "project": {
        "data": null
      },
      "lost_reason": {
        "data": null
      },
      "contract": {
        "data": null
      },
      "contact": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "480",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user481@email.com",
        "title": null,
        "joined_at": "2021-01-24T00:03:52.000+01:00",
        "last_seen_at": "2021-01-24T00:03:52.475+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:52.305+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 216
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "636"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "637",
      "type": "companies",
      "attributes": {
        "name": "Client420",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:52.325+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 216
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "482",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user483@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 2,
        "invited_at": "2021-01-24T00:03:52.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:52.383+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 216
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "639"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1121",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 216
          }
        }
      }
    },
    {
      "id": "636",
      "type": "companies",
      "attributes": {
        "name": "Organization216",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-01-24T00:03:52.303+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 216
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "639",
      "type": "companies",
      "attributes": {
        "name": "Client422",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:52.379+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 216
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      }
    },
    "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-01-28"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "37",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2021-01-24",
      "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": "9ee3797c4fe8111b912ce7af0c8c828c",
      "purchase_order_number": null,
      "custom_fields": null,
      "forecasted_billable_time": 0,
      "forecasted_margin": 0,
      "forecasted_budget_usage": 0,
      "forecasted_time_usage": 0,
      "budget_usage": 0,
      "future_booked_time": 0,
      "probability": 100,
      "budget_warning": null,
      "billable_time": 0,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "unapproved_entries_count": 0,
      "rejected_entries_count": 0,
      "estimated_remaining_time": 0,
      "unapproved_time": 0,
      "lost_comment": null,
      "closed_at": "2021-01-24T00:03:52.000+01:00",
      "delivered_on": "2021-01-28",
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-01-24T00:03:52.758+01:00",
      "note": null,
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2021-01-24",
      "note_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR",
      "revenue": 0,
      "revenue_default": 0,
      "revenue_normalized": 0,
      "services_revenue": 0,
      "services_revenue_default": 0,
      "services_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "work_cost": 0,
      "work_cost_default": 0,
      "work_cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0,
      "expense_billable": 0,
      "expense_billable_default": 0,
      "expense_billable_normalized": 0,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "actual_rate": 0,
      "actual_rate_default": 0,
      "actual_rate_normalized": 0,
      "budget_remaining": 0,
      "budget_remaining_default": 0,
      "budget_remaining_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "future_revenue": 0,
      "future_revenue_default": 0,
      "future_revenue_normalized": 0,
      "future_budget_used": 0,
      "future_budget_used_default": 0,
      "future_budget_used_normalized": 0,
      "future_cost": 0,
      "future_cost_default": 0,
      "future_cost_normalized": 0,
      "forecasted_revenue": 0,
      "forecasted_revenue_default": 0,
      "forecasted_revenue_normalized": 0,
      "forecasted_cost": 0,
      "forecasted_cost_default": 0,
      "forecasted_cost_normalized": 0,
      "forecasted_profit": 0,
      "forecasted_profit_default": 0,
      "forecasted_profit_normalized": 0,
      "forecasted_budget_used": 0,
      "forecasted_budget_used_default": 0,
      "forecasted_budget_used_normalized": 0,
      "invoiced_rate": 0,
      "invoiced_rate_default": 0,
      "invoiced_rate_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 217
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "485"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "645"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "487"
        }
      },
      "deal_status": {
        "data": null
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "76"
        }
      },
      "lost_reason": {
        "data": null
      },
      "contract": {
        "data": null
      },
      "contact": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "485",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user486@email.com",
        "title": null,
        "joined_at": "2021-01-24T00:03:52.000+01:00",
        "last_seen_at": "2021-01-24T00:03:52.780+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:52.603+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 217
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "642"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "645",
      "type": "companies",
      "attributes": {
        "name": "Client427",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:52.673+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 217
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "487",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user488@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-01-24T00:03:52.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:52.683+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 217
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "646"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "76",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-01-24T00:03:52.740+01:00",
        "board_count": 0,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 217
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "648"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "488"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "642",
      "type": "companies",
      "attributes": {
        "name": "Organization217",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-01-24T00:03:52.602+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 217
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "646",
      "type": "companies",
      "attributes": {
        "name": "Client428",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:52.679+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 217
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "648",
      "type": "companies",
      "attributes": {
        "name": "Client430",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:52.737+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 217
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "488",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user489@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-01-24T00:03:52.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:52.714+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 217
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "647"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "647",
      "type": "companies",
      "attributes": {
        "name": "Client429",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:52.710+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 217
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      }
    },
    "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-01-28"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "40",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2021-01-24",
      "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": "3fd412bea3c7753e7d7a7bfc02914b4d",
      "purchase_order_number": null,
      "custom_fields": null,
      "forecasted_billable_time": 0,
      "forecasted_margin": 0,
      "forecasted_budget_usage": 0,
      "forecasted_time_usage": 0,
      "budget_usage": 0,
      "future_booked_time": 0,
      "probability": 100,
      "budget_warning": null,
      "billable_time": 0,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "unapproved_entries_count": 0,
      "rejected_entries_count": 0,
      "estimated_remaining_time": 0,
      "unapproved_time": 0,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-01-24T00:03:53.178+01:00",
      "note": null,
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2021-01-24",
      "note_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR",
      "revenue": 0,
      "revenue_default": 0,
      "revenue_normalized": 0,
      "services_revenue": 0,
      "services_revenue_default": 0,
      "services_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "work_cost": 0,
      "work_cost_default": 0,
      "work_cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0,
      "expense_billable": 0,
      "expense_billable_default": 0,
      "expense_billable_normalized": 0,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "actual_rate": 0,
      "actual_rate_default": 0,
      "actual_rate_normalized": 0,
      "budget_remaining": 0,
      "budget_remaining_default": 0,
      "budget_remaining_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "future_revenue": 0,
      "future_revenue_default": 0,
      "future_revenue_normalized": 0,
      "future_budget_used": 0,
      "future_budget_used_default": 0,
      "future_budget_used_normalized": 0,
      "future_cost": 0,
      "future_cost_default": 0,
      "future_cost_normalized": 0,
      "forecasted_revenue": 0,
      "forecasted_revenue_default": 0,
      "forecasted_revenue_normalized": 0,
      "forecasted_cost": 0,
      "forecasted_cost_default": 0,
      "forecasted_cost_normalized": 0,
      "forecasted_profit": 0,
      "forecasted_profit_default": 0,
      "forecasted_profit_normalized": 0,
      "forecasted_budget_used": 0,
      "forecasted_budget_used_default": 0,
      "forecasted_budget_used_normalized": 0,
      "invoiced_rate": 0,
      "invoiced_rate_default": 0,
      "invoiced_rate_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 219
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "491"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "655"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "493"
        }
      },
      "deal_status": {
        "data": null
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "77"
        }
      },
      "lost_reason": {
        "data": null
      },
      "contract": {
        "data": null
      },
      "contact": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "491",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user492@email.com",
        "title": null,
        "joined_at": "2021-01-24T00:03:53.000+01:00",
        "last_seen_at": "2021-01-24T00:03:53.195+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:53.022+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 219
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "652"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "655",
      "type": "companies",
      "attributes": {
        "name": "Client435",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:53.092+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 219
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "493",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user494@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-01-24T00:03:53.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:53.101+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 219
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "656"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "77",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-01-24T00:03:53.158+01:00",
        "board_count": 0,
        "budget_count": 1,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 219
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "658"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "494"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "652",
      "type": "companies",
      "attributes": {
        "name": "Organization219",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-01-24T00:03:53.021+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 219
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "656",
      "type": "companies",
      "attributes": {
        "name": "Client436",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:53.097+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 219
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "658",
      "type": "companies",
      "attributes": {
        "name": "Client438",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:53.156+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 219
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "494",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user495@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-01-24T00:03:53.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:53.132+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 219
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "657"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "657",
      "type": "companies",
      "attributes": {
        "name": "Client437",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:53.129+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 219
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      }
    },
    "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 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.

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 budget

PATCH  /api/v2/deals/61/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": "61",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2021-01-24",
      "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": "d8ce9b00982d40867e05500e0a2ade96",
      "purchase_order_number": null,
      "custom_fields": null,
      "forecasted_billable_time": 0,
      "forecasted_margin": 0,
      "forecasted_budget_usage": 0,
      "forecasted_time_usage": 0,
      "budget_usage": 0,
      "future_booked_time": 0,
      "probability": 50,
      "budget_warning": null,
      "billable_time": 0,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "unapproved_entries_count": 0,
      "rejected_entries_count": 0,
      "estimated_remaining_time": 0,
      "unapproved_time": 0,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-01-24T00:03:55.873+01:00",
      "note": null,
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2021-01-24",
      "note_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR",
      "revenue": 0,
      "revenue_default": 0,
      "revenue_normalized": 0,
      "services_revenue": 0,
      "services_revenue_default": 0,
      "services_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "work_cost": 0,
      "work_cost_default": 0,
      "work_cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0,
      "expense_billable": 0,
      "expense_billable_default": 0,
      "expense_billable_normalized": 0,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "actual_rate": 0,
      "actual_rate_default": 0,
      "actual_rate_normalized": 0,
      "budget_remaining": 0,
      "budget_remaining_default": 0,
      "budget_remaining_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "future_revenue": 0,
      "future_revenue_default": 0,
      "future_revenue_normalized": 0,
      "future_budget_used": 0,
      "future_budget_used_default": 0,
      "future_budget_used_normalized": 0,
      "future_cost": 0,
      "future_cost_default": 0,
      "future_cost_normalized": 0,
      "forecasted_revenue": 0,
      "forecasted_revenue_default": 0,
      "forecasted_revenue_normalized": 0,
      "forecasted_cost": 0,
      "forecasted_cost_default": 0,
      "forecasted_cost_normalized": 0,
      "forecasted_profit": 0,
      "forecasted_profit_default": 0,
      "forecasted_profit_normalized": 0,
      "forecasted_budget_used": 0,
      "forecasted_budget_used_default": 0,
      "forecasted_budget_used_normalized": 0,
      "invoiced_rate": 0,
      "invoiced_rate_default": 0,
      "invoiced_rate_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 230
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "528"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "714"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "530"
        }
      },
      "deal_status": {
        "data": null
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "84"
        }
      },
      "lost_reason": {
        "data": null
      },
      "contract": {
        "data": null
      },
      "contact": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "528",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user529@email.com",
        "title": null,
        "joined_at": "2021-01-24T00:03:55.000+01:00",
        "last_seen_at": "2021-01-24T00:03:55.889+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:55.729+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 230
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "711"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "714",
      "type": "companies",
      "attributes": {
        "name": "Client483",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:55.795+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 230
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "530",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user531@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-01-24T00:03:55.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:55.804+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 230
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "715"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "84",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-01-24T00:03:55.856+01:00",
        "board_count": 0,
        "budget_count": 1,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 230
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "717"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "531"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "711",
      "type": "companies",
      "attributes": {
        "name": "Organization230",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-01-24T00:03:55.728+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 230
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "715",
      "type": "companies",
      "attributes": {
        "name": "Client484",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:55.801+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 230
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "717",
      "type": "companies",
      "attributes": {
        "name": "Client486",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:55.854+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 230
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "531",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user532@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-01-24T00:03:55.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:55.832+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 230
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "716"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "716",
      "type": "companies",
      "attributes": {
        "name": "Client485",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:55.829+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 230
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      }
    },
    "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 budget

PATCH  /api/v2/deals/63/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": "63",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2021-01-24",
      "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": "54265cb390c33f899d35cd3369d84985",
      "purchase_order_number": null,
      "custom_fields": null,
      "forecasted_billable_time": 0,
      "forecasted_margin": 0,
      "forecasted_budget_usage": 0,
      "forecasted_time_usage": 0,
      "budget_usage": 0,
      "future_booked_time": 0,
      "probability": 50,
      "budget_warning": null,
      "billable_time": 0,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "unapproved_entries_count": 0,
      "rejected_entries_count": 0,
      "estimated_remaining_time": 0,
      "unapproved_time": 0,
      "lost_comment": null,
      "closed_at": "2021-01-24T00:03:56.000+01:00",
      "delivered_on": "2021-01-24",
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-01-24T00:03:56.141+01:00",
      "note": null,
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2021-01-24",
      "note_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR",
      "revenue": 0,
      "revenue_default": 0,
      "revenue_normalized": 0,
      "services_revenue": 0,
      "services_revenue_default": 0,
      "services_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "work_cost": 0,
      "work_cost_default": 0,
      "work_cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0,
      "expense_billable": 0,
      "expense_billable_default": 0,
      "expense_billable_normalized": 0,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "actual_rate": 0,
      "actual_rate_default": 0,
      "actual_rate_normalized": 0,
      "budget_remaining": 0,
      "budget_remaining_default": 0,
      "budget_remaining_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "future_revenue": 0,
      "future_revenue_default": 0,
      "future_revenue_normalized": 0,
      "future_budget_used": 0,
      "future_budget_used_default": 0,
      "future_budget_used_normalized": 0,
      "future_cost": 0,
      "future_cost_default": 0,
      "future_cost_normalized": 0,
      "forecasted_revenue": 0,
      "forecasted_revenue_default": 0,
      "forecasted_revenue_normalized": 0,
      "forecasted_cost": 0,
      "forecasted_cost_default": 0,
      "forecasted_cost_normalized": 0,
      "forecasted_profit": 0,
      "forecasted_profit_default": 0,
      "forecasted_profit_normalized": 0,
      "forecasted_budget_used": 0,
      "forecasted_budget_used_default": 0,
      "forecasted_budget_used_normalized": 0,
      "invoiced_rate": 0,
      "invoiced_rate_default": 0,
      "invoiced_rate_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 231
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "532"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "721"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "534"
        }
      },
      "deal_status": {
        "data": null
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "85"
        }
      },
      "lost_reason": {
        "data": null
      },
      "contract": {
        "data": null
      },
      "contact": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "532",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user533@email.com",
        "title": null,
        "joined_at": "2021-01-24T00:03:56.000+01:00",
        "last_seen_at": "2021-01-24T00:03:56.156+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:55.998+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 231
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "718"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "721",
      "type": "companies",
      "attributes": {
        "name": "Client489",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:56.062+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 231
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "534",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user535@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-01-24T00:03:56.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:56.071+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 231
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "722"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "85",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-01-24T00:03:56.124+01:00",
        "board_count": 0,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 231
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "724"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "535"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "718",
      "type": "companies",
      "attributes": {
        "name": "Organization231",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-01-24T00:03:55.996+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 231
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "722",
      "type": "companies",
      "attributes": {
        "name": "Client490",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:56.068+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 231
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "724",
      "type": "companies",
      "attributes": {
        "name": "Client492",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:56.122+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 231
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "535",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user536@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-01-24T00:03:56.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:56.100+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 231
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "723"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "723",
      "type": "companies",
      "attributes": {
        "name": "Client491",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:56.096+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 231
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

PATCH  /api/v2/deals/65/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-01-28"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "65",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2021-01-24",
      "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": "fcdfec76f1267cebc1cb79ed7e5c0565",
      "purchase_order_number": null,
      "custom_fields": null,
      "forecasted_billable_time": 0,
      "forecasted_margin": 0,
      "forecasted_budget_usage": 0,
      "forecasted_time_usage": 0,
      "budget_usage": 0,
      "future_booked_time": 0,
      "probability": 50,
      "budget_warning": null,
      "billable_time": 0,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "unapproved_entries_count": 0,
      "rejected_entries_count": 0,
      "estimated_remaining_time": 0,
      "unapproved_time": 0,
      "lost_comment": null,
      "closed_at": "2021-01-24T00:03:56.000+01:00",
      "delivered_on": "2021-01-28",
      "last_activity_at": null,
      "deleted_at": null,
      "created_at": "2021-01-24T00:03:56.429+01:00",
      "note": null,
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2021-01-24",
      "note_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR",
      "revenue": 0,
      "revenue_default": 0,
      "revenue_normalized": 0,
      "services_revenue": 0,
      "services_revenue_default": 0,
      "services_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "work_cost": 0,
      "work_cost_default": 0,
      "work_cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0,
      "expense_billable": 0,
      "expense_billable_default": 0,
      "expense_billable_normalized": 0,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "actual_rate": 0,
      "actual_rate_default": 0,
      "actual_rate_normalized": 0,
      "budget_remaining": 0,
      "budget_remaining_default": 0,
      "budget_remaining_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "future_revenue": 0,
      "future_revenue_default": 0,
      "future_revenue_normalized": 0,
      "future_budget_used": 0,
      "future_budget_used_default": 0,
      "future_budget_used_normalized": 0,
      "future_cost": 0,
      "future_cost_default": 0,
      "future_cost_normalized": 0,
      "forecasted_revenue": 0,
      "forecasted_revenue_default": 0,
      "forecasted_revenue_normalized": 0,
      "forecasted_cost": 0,
      "forecasted_cost_default": 0,
      "forecasted_cost_normalized": 0,
      "forecasted_profit": 0,
      "forecasted_profit_default": 0,
      "forecasted_profit_normalized": 0,
      "forecasted_budget_used": 0,
      "forecasted_budget_used_default": 0,
      "forecasted_budget_used_normalized": 0,
      "invoiced_rate": 0,
      "invoiced_rate_default": 0,
      "invoiced_rate_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 232
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "536"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "728"
        }
      },
      "document_type": {
        "data": null
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "538"
        }
      },
      "deal_status": {
        "data": null
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "86"
        }
      },
      "lost_reason": {
        "data": null
      },
      "contract": {
        "data": null
      },
      "contact": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "536",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user537@email.com",
        "title": null,
        "joined_at": "2021-01-24T00:03:56.000+01:00",
        "last_seen_at": "2021-01-24T00:03:56.447+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:56.284+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 232
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "725"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "728",
      "type": "companies",
      "attributes": {
        "name": "Client495",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:56.348+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 232
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "538",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user539@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-01-24T00:03:56.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:56.357+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 232
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "729"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "86",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-01-24T00:03:56.412+01:00",
        "board_count": 0,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 232
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "731"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "539"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "725",
      "type": "companies",
      "attributes": {
        "name": "Organization232",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-01-24T00:03:56.283+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 232
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "729",
      "type": "companies",
      "attributes": {
        "name": "Client496",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:56.353+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 232
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "731",
      "type": "companies",
      "attributes": {
        "name": "Client498",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:56.410+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 232
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "539",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user540@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-01-24T00:03:56.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:03:56.388+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 232
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "730"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "730",
      "type": "companies",
      "attributes": {
        "name": "Client497",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:03:56.384+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 232
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Closes a deal
PATCH/api/v2/deals/{id}/close

URI Parameters
HideShow
id
number (required) Example: 1

deal id

Generated by aglio on 23 Jan 2021