API Documentation

API Endpoint

Deals

Deals

This endpoint contains both budgets and deals. When creating a new record, a budget or deal will be created based on the budget attribute in the request. If the request does not contain the budget attribute or has budget: false the new record will be a deal. If the request has budget: true the new record will be a budget.

For more details on how to work with custom fields please refer to Working with custom fields guide.

Supported filter params

  • id

  • number

  • responsible_id (array)

  • creator_id (array)

  • company_id (array)

  • status_id (array)

  • stage_status_id (array) (1: open, 2: won, 3: lost)

  • contract_id (array)

  • recurring

  • project_id (array)

  • tags

  • query

  • won_date (automatically set date when won or overridden manually)

  • lost_date (automatically set date when lost or overridden manually)

  • won_at (automatically set date when won)

  • lost_at (automatically set date when lost)

  • needs_invoicing

  • type (1: deal, 2: budget)

  • project_type (1: internal project, 2: client project)

  • budget_status (1: open, 2: closed)

  • subsidiary_id (array)

  • pipeline_id (array)

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

  • time_approval (boolean)

Supported sort params

  • billable_time

  • budget_total

  • budget_used

  • budget_warning

  • budgeted_time

  • client_access

  • closed_at

  • company.name

  • cost

  • created_at

  • date

  • deal_status

  • end_date

  • estimated_time

  • expense

  • invoiced

  • last_activity_at

  • name

  • number

  • pending_invoicing

  • probability

  • profit

  • profit_margin

  • project.name

  • purchase_order_number

  • responsible.name

  • creator.name

  • revenue

  • stage_status

  • services_revenue

  • suffix

  • time_approval

  • total_budgeted_time

  • worked_time

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": "177",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2025-10-14",
        "end_date": null,
        "number": "1",
        "deal_number": "1",
        "suffix": null,
        "time_approval": true,
        "expense_approval": true,
        "client_access": false,
        "deal_type_id": 2,
        "budget": false,
        "sales_status_updated_at": "2025-10-14T06:04:00.000+02:00",
        "tag_list": [],
        "origin_deal_id": null,
        "profit_margin": 0,
        "email_key": "cca93b1cd6fb40c93d4712ae98aff783",
        "purchase_order_number": "123",
        "custom_fields": null,
        "position": 1,
        "service_type_restricted_tracking": false,
        "tracking_type_id": 1,
        "editor_config": {},
        "discount": null,
        "man_day_minutes": 480,
        "rounding_interval_id": null,
        "rounding_method_id": 1,
        "validate_expense_when_closing": false,
        "revenue_distribution_type": null,
        "color_id": null,
        "connection_status": "none",
        "billable_time": 0,
        "budget_warning": null,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "probability": 50,
        "previous_probability": null,
        "note_interpolated": null,
        "proposal_note_interpolated": null,
        "footer_interpolated": null,
        "proposal_footer_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "note": null,
        "proposal_note": null,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": "2025-10-14T06:04:16.000+02:00",
        "deleted_at": null,
        "created_at": "2025-10-14T06:04:16.363+02:00",
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2025-10-14",
        "sales_closed_on": null,
        "sample_data": false,
        "external_id": null,
        "external_sync": false,
        "manual_invoicing_status_id": 1,
        "footer": null,
        "proposal_footer": 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,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "invoiced": 0,
        "invoiced_default": 0,
        "invoiced_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "manually_invoiced": 0,
        "manually_invoiced_default": 0,
        "manually_invoiced_normalized": 0,
        "draft_invoiced": 0,
        "draft_invoiced_default": 0,
        "draft_invoiced_normalized": 0,
        "amount_credited": 0,
        "amount_credited_default": 0,
        "amount_credited_normalized": 0,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "341"
          }
        },
        "creator": {
          "meta": {
            "included": false
          }
        },
        "company": {
          "meta": {
            "included": false
          }
        },
        "document_type": {
          "meta": {
            "included": false
          }
        },
        "proposal_document_type": {
          "meta": {
            "included": false
          }
        },
        "responsible": {
          "meta": {
            "included": false
          }
        },
        "deal_status": {
          "meta": {
            "included": false
          }
        },
        "project": {
          "meta": {
            "included": false
          }
        },
        "lost_reason": {
          "meta": {
            "included": false
          }
        },
        "contract": {
          "meta": {
            "included": false
          }
        },
        "contact": {
          "meta": {
            "included": false
          }
        },
        "subsidiary": {
          "meta": {
            "included": false
          }
        },
        "template": {
          "meta": {
            "included": false
          }
        },
        "tax_rate": {
          "meta": {
            "included": false
          }
        },
        "pipeline": {
          "meta": {
            "included": false
          }
        },
        "origin_deal": {
          "meta": {
            "included": false
          }
        },
        "approval_policy_assignment": {
          "meta": {
            "included": false
          }
        },
        "next_todo": {
          "meta": {
            "included": false
          }
        },
        "expense_approval_workflow": {
          "meta": {
            "included": false
          }
        },
        "time_approval_workflow": {
          "meta": {
            "included": false
          }
        },
        "invoice_template": {
          "meta": {
            "included": false
          }
        },
        "automatic_invoicing_rule": {
          "meta": {
            "included": false
          }
        },
        "custom_field_people": {
          "meta": {
            "included": false
          }
        },
        "custom_field_attachments": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/deals?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/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
  }
}

Get deals
GET/api/v2/deals

GET /api/v2/deals/1
Requestsreturns deal

GET  /api/v2/deals/178

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": "178",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2025-10-14",
      "end_date": null,
      "number": "1",
      "deal_number": "1",
      "suffix": null,
      "time_approval": true,
      "expense_approval": true,
      "client_access": false,
      "deal_type_id": 2,
      "budget": false,
      "sales_status_updated_at": "2025-10-14T06:04:00.000+02:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "email_key": "b1871d1ad6089bc2ab921de3684ffa47",
      "purchase_order_number": "123",
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": {},
      "discount": null,
      "man_day_minutes": 480,
      "rounding_interval_id": null,
      "rounding_method_id": 1,
      "validate_expense_when_closing": false,
      "revenue_distribution_type": null,
      "color_id": null,
      "connection_status": "none",
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "probability": 50,
      "previous_probability": null,
      "note_interpolated": null,
      "proposal_note_interpolated": null,
      "footer_interpolated": null,
      "proposal_footer_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "note": null,
      "proposal_note": null,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": "2025-10-14T06:04:16.000+02:00",
      "deleted_at": null,
      "created_at": "2025-10-14T06:04:16.502+02:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2025-10-14",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": 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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "manually_invoiced": 0,
      "manually_invoiced_default": 0,
      "manually_invoiced_normalized": 0,
      "draft_invoiced": 0,
      "draft_invoiced_default": 0,
      "draft_invoiced_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "342"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "proposal_document_type": {
        "meta": {
          "included": false
        }
      },
      "responsible": {
        "meta": {
          "included": false
        }
      },
      "deal_status": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "lost_reason": {
        "meta": {
          "included": false
        }
      },
      "contract": {
        "meta": {
          "included": false
        }
      },
      "contact": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "template": {
        "meta": {
          "included": false
        }
      },
      "tax_rate": {
        "meta": {
          "included": false
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      },
      "origin_deal": {
        "meta": {
          "included": false
        }
      },
      "approval_policy_assignment": {
        "meta": {
          "included": false
        }
      },
      "next_todo": {
        "meta": {
          "included": false
        }
      },
      "expense_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "time_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "invoice_template": {
        "meta": {
          "included": false
        }
      },
      "automatic_invoicing_rule": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

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

URI Parameters
HideShow
id
number (required) Example: 1

deal id

POST /api/v2/deals
Requestscreates dealreturns errorreturns errorcreates budget

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": "2025-10-14",
      "deal_type_id": 2,
      "deal_status_id": 1836,
      "probability": 50,
      "currency": "EUR",
      "budget": false,
      "purchase_order_number": "234"
    },
    "relationships": {
      "company": {
        "data": {
          "type": "companies",
          "id": "721"
        }
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "987"
        }
      },
      "subsidiary": {
        "data": {
          "type": "subsidiaries",
          "id": "197"
        }
      },
      "document_type": {
        "data": {
          "type": "document-types",
          "id": "191"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "182",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2025-10-14",
      "end_date": null,
      "number": "2",
      "deal_number": "2",
      "suffix": null,
      "time_approval": false,
      "expense_approval": false,
      "client_access": false,
      "deal_type_id": 2,
      "budget": false,
      "sales_status_updated_at": "2025-10-14T06:04:17.000+02:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "email_key": "a312416e62d72ec499330def40dec5ba",
      "purchase_order_number": "234",
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": null,
      "discount": null,
      "man_day_minutes": 480,
      "rounding_interval_id": null,
      "rounding_method_id": 1,
      "validate_expense_when_closing": false,
      "revenue_distribution_type": "even",
      "color_id": null,
      "connection_status": "none",
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "probability": 50,
      "previous_probability": null,
      "note_interpolated": null,
      "proposal_note_interpolated": null,
      "footer_interpolated": null,
      "proposal_footer_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "note": null,
      "proposal_note": null,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": "2025-10-14T06:04:17.000+02:00",
      "deleted_at": null,
      "created_at": "2025-10-14T06:04:17.120+02:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2025-10-14",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": 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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "manually_invoiced": 0,
      "manually_invoiced_default": 0,
      "manually_invoiced_normalized": 0,
      "draft_invoiced": 0,
      "draft_invoiced_default": 0,
      "draft_invoiced_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "345"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "proposal_document_type": {
        "meta": {
          "included": false
        }
      },
      "responsible": {
        "meta": {
          "included": false
        }
      },
      "deal_status": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "lost_reason": {
        "meta": {
          "included": false
        }
      },
      "contract": {
        "meta": {
          "included": false
        }
      },
      "contact": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "template": {
        "meta": {
          "included": false
        }
      },
      "tax_rate": {
        "meta": {
          "included": false
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      },
      "origin_deal": {
        "meta": {
          "included": false
        }
      },
      "approval_policy_assignment": {
        "meta": {
          "included": false
        }
      },
      "next_todo": {
        "meta": {
          "included": false
        }
      },
      "expense_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "time_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "invoice_template": {
        "meta": {
          "included": false
        }
      },
      "automatic_invoicing_rule": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

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": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/responsible"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/company"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/deal_type_id"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not included in the list",
      "source": {
        "pointer": "data/attributes/deal_type_id"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/probability"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not a number",
      "source": {
        "pointer": "data/attributes/probability"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/currency"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not an valid currency",
      "source": {
        "pointer": "data/attributes/currency"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/deal_status"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/date"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not a date",
      "source": {
        "pointer": "data/attributes/date"
      }
    }
  ]
}

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": "",
      "deal_type_id": 2,
      "deal_status_id": 1866,
      "probability": 50,
      "currency": "EUR"
    },
    "relationships": {
      "company": {
        "data": {
          "type": "companies",
          "id": "731"
        }
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "1001"
        }
      },
      "subsidiary": {
        "data": {
          "type": "subsidiaries",
          "id": "211"
        }
      },
      "document_type": {
        "data": {
          "type": "document-types",
          "id": "200"
        }
      }
    }
  }
}
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/date"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not a date",
      "source": {
        "pointer": "data/attributes/date"
      }
    }
  ]
}

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",
      "budget": true,
      "date": "2025-10-14",
      "deal_type_id": 2,
      "currency": "EUR"
    },
    "relationships": {
      "company": {
        "data": {
          "type": "companies",
          "id": "745"
        }
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "1019"
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "151"
        }
      },
      "subsidiary": {
        "data": {
          "type": "subsidiaries",
          "id": "227"
        }
      },
      "document_type": {
        "data": {
          "type": "document-types",
          "id": "209"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "200",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2025-10-14",
      "end_date": null,
      "number": "2",
      "deal_number": "2",
      "suffix": null,
      "time_approval": false,
      "expense_approval": false,
      "client_access": false,
      "deal_type_id": 2,
      "budget": true,
      "sales_status_updated_at": null,
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "email_key": "04b3414f8d6ab3fcc88ea5b9fed6af50",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": null,
      "discount": null,
      "man_day_minutes": 480,
      "rounding_interval_id": null,
      "rounding_method_id": 1,
      "validate_expense_when_closing": false,
      "revenue_distribution_type": "default",
      "color_id": null,
      "connection_status": "none",
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "probability": 100,
      "previous_probability": null,
      "note_interpolated": null,
      "proposal_note_interpolated": null,
      "footer_interpolated": null,
      "proposal_footer_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "note": null,
      "proposal_note": null,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": "2025-10-14T06:04:20.000+02:00",
      "deleted_at": null,
      "created_at": "2025-10-14T06:04:20.113+02:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2025-10-14",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": 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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "manually_invoiced": 0,
      "manually_invoiced_default": 0,
      "manually_invoiced_normalized": 0,
      "draft_invoiced": 0,
      "draft_invoiced_default": 0,
      "draft_invoiced_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "356"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "proposal_document_type": {
        "meta": {
          "included": false
        }
      },
      "responsible": {
        "meta": {
          "included": false
        }
      },
      "deal_status": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "lost_reason": {
        "meta": {
          "included": false
        }
      },
      "contract": {
        "meta": {
          "included": false
        }
      },
      "contact": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "template": {
        "meta": {
          "included": false
        }
      },
      "tax_rate": {
        "meta": {
          "included": false
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      },
      "origin_deal": {
        "meta": {
          "included": false
        }
      },
      "approval_policy_assignment": {
        "meta": {
          "included": false
        }
      },
      "next_todo": {
        "meta": {
          "included": false
        }
      },
      "expense_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "time_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "invoice_template": {
        "meta": {
          "included": false
        }
      },
      "automatic_invoicing_rule": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

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: 2

deal type

probability
number (required) Example: 100

probability

currency
currency (required) Example: EUR

currency

deal_status
number (required) Example: 1

deal pipeline stage (only for sales deals)

budget
boolean (optional) Example: false

determines if budget or sales deal

project_id
number (optional) Example: 1

project

PATCH /api/v2/deals/1
Requestsupdates dealupdates budgetreturns errorreturns errorassigns project to deal with same clientdoes not assign project to deal with different clientupdates probability to 100updates probability to 0updates deal probabilitydoes not update deal's probabilityupdates deal's probabilityupdates deal's probabilityupdates deal's probabilityupdates deal and breaks syncupdates deal and does not break sync

PATCH  /api/v2/deals/203

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"
      ],
      "tracking_type_id": 3,
      "purchase_order_number": "456"
    },
    "relationships": {
      "responsible": {
        "data": {
          "type": "people",
          "id": "1027"
        }
      },
      "subscribers": {
        "data": [
          {
            "type": "people",
            "id": "1028"
          },
          {
            "type": "people",
            "id": "1029"
          }
        ]
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "203",
    "type": "deals",
    "attributes": {
      "name": "new name",
      "date": "2025-10-14",
      "end_date": null,
      "number": "1",
      "deal_number": "1",
      "suffix": null,
      "time_approval": true,
      "expense_approval": true,
      "client_access": false,
      "deal_type_id": 2,
      "budget": false,
      "sales_status_updated_at": "2025-10-14T06:04:00.000+02:00",
      "tag_list": [
        "invoiced",
        "paid"
      ],
      "origin_deal_id": null,
      "profit_margin": 0,
      "email_key": "d1cc03535861e12ebdb8d54b49490ae0",
      "purchase_order_number": "456",
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 3,
      "editor_config": {},
      "discount": null,
      "man_day_minutes": 480,
      "rounding_interval_id": null,
      "rounding_method_id": 1,
      "validate_expense_when_closing": false,
      "revenue_distribution_type": "even",
      "color_id": null,
      "connection_status": "none",
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "probability": 50,
      "previous_probability": null,
      "note_interpolated": null,
      "proposal_note_interpolated": null,
      "footer_interpolated": null,
      "proposal_footer_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "note": null,
      "proposal_note": null,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": "2025-10-14T06:04:20.000+02:00",
      "deleted_at": null,
      "created_at": "2025-10-14T06:04:20.652+02:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2025-10-14",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": 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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "manually_invoiced": 0,
      "manually_invoiced_default": 0,
      "manually_invoiced_normalized": 0,
      "draft_invoiced": 0,
      "draft_invoiced_default": 0,
      "draft_invoiced_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "358"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "proposal_document_type": {
        "meta": {
          "included": false
        }
      },
      "responsible": {
        "meta": {
          "included": false
        }
      },
      "deal_status": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "lost_reason": {
        "meta": {
          "included": false
        }
      },
      "contract": {
        "meta": {
          "included": false
        }
      },
      "contact": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "template": {
        "meta": {
          "included": false
        }
      },
      "tax_rate": {
        "meta": {
          "included": false
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      },
      "origin_deal": {
        "meta": {
          "included": false
        }
      },
      "approval_policy_assignment": {
        "meta": {
          "included": false
        }
      },
      "next_todo": {
        "meta": {
          "included": false
        }
      },
      "expense_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "time_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "invoice_template": {
        "meta": {
          "included": false
        }
      },
      "automatic_invoicing_rule": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deals/209

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": "2025-10-18"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "209",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2025-10-14",
      "end_date": null,
      "number": "2",
      "deal_number": "2",
      "suffix": null,
      "time_approval": true,
      "expense_approval": true,
      "client_access": false,
      "deal_type_id": 2,
      "budget": true,
      "sales_status_updated_at": "2025-10-14T06:04:00.000+02:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "email_key": "c288dd13df6062f151521f6adae9b3c2",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": {},
      "discount": null,
      "man_day_minutes": 480,
      "rounding_interval_id": null,
      "rounding_method_id": 1,
      "validate_expense_when_closing": false,
      "revenue_distribution_type": "default",
      "color_id": null,
      "connection_status": "none",
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "probability": 100,
      "previous_probability": null,
      "note_interpolated": null,
      "proposal_note_interpolated": null,
      "footer_interpolated": null,
      "proposal_footer_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "note": null,
      "proposal_note": null,
      "lost_comment": null,
      "closed_at": "2025-10-14T06:04:22.000+02:00",
      "delivered_on": "2025-10-18",
      "last_activity_at": "2025-10-14T06:04:22.000+02:00",
      "deleted_at": null,
      "created_at": "2025-10-14T06:04:22.567+02:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2025-10-14",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": 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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "manually_invoiced": 0,
      "manually_invoiced_default": 0,
      "manually_invoiced_normalized": 0,
      "draft_invoiced": 0,
      "draft_invoiced_default": 0,
      "draft_invoiced_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "362"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "proposal_document_type": {
        "meta": {
          "included": false
        }
      },
      "responsible": {
        "meta": {
          "included": false
        }
      },
      "deal_status": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "lost_reason": {
        "meta": {
          "included": false
        }
      },
      "contract": {
        "meta": {
          "included": false
        }
      },
      "contact": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "template": {
        "meta": {
          "included": false
        }
      },
      "tax_rate": {
        "meta": {
          "included": false
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      },
      "origin_deal": {
        "meta": {
          "included": false
        }
      },
      "approval_policy_assignment": {
        "meta": {
          "included": false
        }
      },
      "next_todo": {
        "meta": {
          "included": false
        }
      },
      "expense_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "time_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "invoice_template": {
        "meta": {
          "included": false
        }
      },
      "automatic_invoicing_rule": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deals/210

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/212

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": "2025-10-18"
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "delivery date can be set only for closed budgets",
      "source": {
        "pointer": "data/attributes/delivered_on"
      }
    }
  ]
}

PATCH  /api/v2/deals/213

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": {},
    "relationships": {
      "project": {
        "data": {
          "type": "projects",
          "id": "156"
        }
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "213",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2025-10-14",
      "end_date": null,
      "number": "1",
      "deal_number": "1",
      "suffix": null,
      "time_approval": true,
      "expense_approval": true,
      "client_access": false,
      "deal_type_id": 2,
      "budget": false,
      "sales_status_updated_at": "2025-10-14T06:04:00.000+02:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "email_key": "89ae1740806c863a3bdfd923d0e5d34a",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": {},
      "discount": null,
      "man_day_minutes": 480,
      "rounding_interval_id": null,
      "rounding_method_id": 1,
      "validate_expense_when_closing": false,
      "revenue_distribution_type": "even",
      "color_id": null,
      "connection_status": "none",
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "probability": 50,
      "previous_probability": null,
      "note_interpolated": null,
      "proposal_note_interpolated": null,
      "footer_interpolated": null,
      "proposal_footer_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "note": null,
      "proposal_note": null,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": "2025-10-14T06:04:23.000+02:00",
      "deleted_at": null,
      "created_at": "2025-10-14T06:04:23.435+02:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2025-10-14",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": 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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "manually_invoiced": 0,
      "manually_invoiced_default": 0,
      "manually_invoiced_normalized": 0,
      "draft_invoiced": 0,
      "draft_invoiced_default": 0,
      "draft_invoiced_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "365"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "proposal_document_type": {
        "meta": {
          "included": false
        }
      },
      "responsible": {
        "meta": {
          "included": false
        }
      },
      "deal_status": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "lost_reason": {
        "meta": {
          "included": false
        }
      },
      "contract": {
        "meta": {
          "included": false
        }
      },
      "contact": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "template": {
        "meta": {
          "included": false
        }
      },
      "tax_rate": {
        "meta": {
          "included": false
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      },
      "origin_deal": {
        "meta": {
          "included": false
        }
      },
      "approval_policy_assignment": {
        "meta": {
          "included": false
        }
      },
      "next_todo": {
        "meta": {
          "included": false
        }
      },
      "expense_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "time_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "invoice_template": {
        "meta": {
          "included": false
        }
      },
      "automatic_invoicing_rule": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deals/214

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": {},
    "relationships": {
      "project": {
        "data": {
          "type": "projects",
          "id": "158"
        }
      }
    }
  }
}
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/project"
      }
    }
  ]
}

PATCH  /api/v2/deals/215

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": {
      "deal_status_id": "1972"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "215",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2025-10-14",
      "end_date": null,
      "number": "1",
      "deal_number": "1",
      "suffix": null,
      "time_approval": true,
      "expense_approval": true,
      "client_access": false,
      "deal_type_id": 2,
      "budget": false,
      "sales_status_updated_at": "2025-10-14T06:04:24.000+02:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "email_key": "4bf9dc4036143ee2b6bd8a1e93b08391",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": {},
      "discount": null,
      "man_day_minutes": 480,
      "rounding_interval_id": null,
      "rounding_method_id": 1,
      "validate_expense_when_closing": false,
      "revenue_distribution_type": "even",
      "color_id": null,
      "connection_status": "none",
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": 0,
      "probability": 100,
      "previous_probability": 50,
      "note_interpolated": null,
      "proposal_note_interpolated": null,
      "footer_interpolated": null,
      "proposal_footer_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "note": null,
      "proposal_note": null,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": "2025-10-14T06:04:24.000+02:00",
      "deleted_at": null,
      "created_at": "2025-10-14T06:04:24.011+02:00",
      "sales_closed_at": "2025-10-14T06:04:24.000+02:00",
      "exchange_rate": "1.25",
      "exchange_date": "2025-10-14",
      "sales_closed_on": "2025-10-14",
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": 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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "manually_invoiced": 0,
      "manually_invoiced_default": 0,
      "manually_invoiced_normalized": 0,
      "draft_invoiced": 0,
      "draft_invoiced_default": 0,
      "draft_invoiced_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "367"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "proposal_document_type": {
        "meta": {
          "included": false
        }
      },
      "responsible": {
        "meta": {
          "included": false
        }
      },
      "deal_status": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "lost_reason": {
        "meta": {
          "included": false
        }
      },
      "contract": {
        "meta": {
          "included": false
        }
      },
      "contact": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "template": {
        "meta": {
          "included": false
        }
      },
      "tax_rate": {
        "meta": {
          "included": false
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      },
      "origin_deal": {
        "meta": {
          "included": false
        }
      },
      "approval_policy_assignment": {
        "meta": {
          "included": false
        }
      },
      "next_todo": {
        "meta": {
          "included": false
        }
      },
      "expense_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "time_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "invoice_template": {
        "meta": {
          "included": false
        }
      },
      "automatic_invoicing_rule": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deals/216

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": {
      "deal_status_id": "1979"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "216",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2025-10-14",
      "end_date": null,
      "number": "1",
      "deal_number": "1",
      "suffix": null,
      "time_approval": true,
      "expense_approval": true,
      "client_access": false,
      "deal_type_id": 2,
      "budget": false,
      "sales_status_updated_at": "2025-10-14T06:04:24.000+02:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "email_key": "1d4c7b80228823e815fa125e6b48e5f5",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": {},
      "discount": null,
      "man_day_minutes": 480,
      "rounding_interval_id": null,
      "rounding_method_id": 1,
      "validate_expense_when_closing": false,
      "revenue_distribution_type": "even",
      "color_id": null,
      "connection_status": "none",
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": 0,
      "probability": 0,
      "previous_probability": 50,
      "note_interpolated": null,
      "proposal_note_interpolated": null,
      "footer_interpolated": null,
      "proposal_footer_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "note": null,
      "proposal_note": null,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": "2025-10-14T06:04:24.000+02:00",
      "deleted_at": null,
      "created_at": "2025-10-14T06:04:24.258+02:00",
      "sales_closed_at": "2025-10-14T06:04:24.000+02:00",
      "exchange_rate": "1.25",
      "exchange_date": "2025-10-14",
      "sales_closed_on": "2025-10-14",
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": 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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "manually_invoiced": 0,
      "manually_invoiced_default": 0,
      "manually_invoiced_normalized": 0,
      "draft_invoiced": 0,
      "draft_invoiced_default": 0,
      "draft_invoiced_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "368"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "proposal_document_type": {
        "meta": {
          "included": false
        }
      },
      "responsible": {
        "meta": {
          "included": false
        }
      },
      "deal_status": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "lost_reason": {
        "meta": {
          "included": false
        }
      },
      "contract": {
        "meta": {
          "included": false
        }
      },
      "contact": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "template": {
        "meta": {
          "included": false
        }
      },
      "tax_rate": {
        "meta": {
          "included": false
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      },
      "origin_deal": {
        "meta": {
          "included": false
        }
      },
      "approval_policy_assignment": {
        "meta": {
          "included": false
        }
      },
      "next_todo": {
        "meta": {
          "included": false
        }
      },
      "expense_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "time_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "invoice_template": {
        "meta": {
          "included": false
        }
      },
      "automatic_invoicing_rule": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deals/219

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": {
      "deal_status_id": "2000"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "219",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2025-10-14",
      "end_date": null,
      "number": "1",
      "deal_number": "1",
      "suffix": null,
      "time_approval": true,
      "expense_approval": true,
      "client_access": false,
      "deal_type_id": 2,
      "budget": false,
      "sales_status_updated_at": "2025-10-14T06:04:24.000+02:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "email_key": "233850a718fc894ec2384843b575c81c",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": {},
      "discount": null,
      "man_day_minutes": 480,
      "rounding_interval_id": null,
      "rounding_method_id": 1,
      "validate_expense_when_closing": false,
      "revenue_distribution_type": "even",
      "color_id": null,
      "connection_status": "none",
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "probability": 30,
      "previous_probability": 50,
      "note_interpolated": null,
      "proposal_note_interpolated": null,
      "footer_interpolated": null,
      "proposal_footer_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "note": null,
      "proposal_note": null,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": "2025-10-14T06:04:24.000+02:00",
      "deleted_at": null,
      "created_at": "2025-10-14T06:04:24.886+02:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2025-10-14",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": 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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "manually_invoiced": 0,
      "manually_invoiced_default": 0,
      "manually_invoiced_normalized": 0,
      "draft_invoiced": 0,
      "draft_invoiced_default": 0,
      "draft_invoiced_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "371"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "proposal_document_type": {
        "meta": {
          "included": false
        }
      },
      "responsible": {
        "meta": {
          "included": false
        }
      },
      "deal_status": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "lost_reason": {
        "meta": {
          "included": false
        }
      },
      "contract": {
        "meta": {
          "included": false
        }
      },
      "contact": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "template": {
        "meta": {
          "included": false
        }
      },
      "tax_rate": {
        "meta": {
          "included": false
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      },
      "origin_deal": {
        "meta": {
          "included": false
        }
      },
      "approval_policy_assignment": {
        "meta": {
          "included": false
        }
      },
      "next_todo": {
        "meta": {
          "included": false
        }
      },
      "expense_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "time_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "invoice_template": {
        "meta": {
          "included": false
        }
      },
      "automatic_invoicing_rule": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deals/220

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": {
      "deal_status_id": "2007"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "220",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2025-10-14",
      "end_date": null,
      "number": "1",
      "deal_number": "1",
      "suffix": null,
      "time_approval": true,
      "expense_approval": true,
      "client_access": false,
      "deal_type_id": 2,
      "budget": false,
      "sales_status_updated_at": "2025-10-14T06:04:25.000+02:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "email_key": "e58d9927751e4b6fa41e3b8c655899ba",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": {},
      "discount": null,
      "man_day_minutes": 480,
      "rounding_interval_id": null,
      "rounding_method_id": 1,
      "validate_expense_when_closing": false,
      "revenue_distribution_type": "even",
      "color_id": null,
      "connection_status": "none",
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "probability": 50,
      "previous_probability": null,
      "note_interpolated": null,
      "proposal_note_interpolated": null,
      "footer_interpolated": null,
      "proposal_footer_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "note": null,
      "proposal_note": null,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": "2025-10-14T06:04:25.000+02:00",
      "deleted_at": null,
      "created_at": "2025-10-14T06:04:25.113+02:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2025-10-14",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": 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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "manually_invoiced": 0,
      "manually_invoiced_default": 0,
      "manually_invoiced_normalized": 0,
      "draft_invoiced": 0,
      "draft_invoiced_default": 0,
      "draft_invoiced_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "372"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "proposal_document_type": {
        "meta": {
          "included": false
        }
      },
      "responsible": {
        "meta": {
          "included": false
        }
      },
      "deal_status": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "lost_reason": {
        "meta": {
          "included": false
        }
      },
      "contract": {
        "meta": {
          "included": false
        }
      },
      "contact": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "template": {
        "meta": {
          "included": false
        }
      },
      "tax_rate": {
        "meta": {
          "included": false
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      },
      "origin_deal": {
        "meta": {
          "included": false
        }
      },
      "approval_policy_assignment": {
        "meta": {
          "included": false
        }
      },
      "next_todo": {
        "meta": {
          "included": false
        }
      },
      "expense_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "time_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "invoice_template": {
        "meta": {
          "included": false
        }
      },
      "automatic_invoicing_rule": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deals/221

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": {
      "probability": 90
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "221",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2025-10-14",
      "end_date": null,
      "number": "1",
      "deal_number": "1",
      "suffix": null,
      "time_approval": true,
      "expense_approval": true,
      "client_access": false,
      "deal_type_id": 2,
      "budget": false,
      "sales_status_updated_at": "2025-10-14T06:04:00.000+02:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "email_key": "16c6bca41894e5844767cff9cccbbc18",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": {},
      "discount": null,
      "man_day_minutes": 480,
      "rounding_interval_id": null,
      "rounding_method_id": 1,
      "validate_expense_when_closing": false,
      "revenue_distribution_type": "even",
      "color_id": null,
      "connection_status": "none",
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "probability": 90,
      "previous_probability": 50,
      "note_interpolated": null,
      "proposal_note_interpolated": null,
      "footer_interpolated": null,
      "proposal_footer_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "note": null,
      "proposal_note": null,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": "2025-10-14T06:04:25.000+02:00",
      "deleted_at": null,
      "created_at": "2025-10-14T06:04:25.344+02:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2025-10-14",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": 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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "manually_invoiced": 0,
      "manually_invoiced_default": 0,
      "manually_invoiced_normalized": 0,
      "draft_invoiced": 0,
      "draft_invoiced_default": 0,
      "draft_invoiced_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "373"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "proposal_document_type": {
        "meta": {
          "included": false
        }
      },
      "responsible": {
        "meta": {
          "included": false
        }
      },
      "deal_status": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "lost_reason": {
        "meta": {
          "included": false
        }
      },
      "contract": {
        "meta": {
          "included": false
        }
      },
      "contact": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "template": {
        "meta": {
          "included": false
        }
      },
      "tax_rate": {
        "meta": {
          "included": false
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      },
      "origin_deal": {
        "meta": {
          "included": false
        }
      },
      "approval_policy_assignment": {
        "meta": {
          "included": false
        }
      },
      "next_todo": {
        "meta": {
          "included": false
        }
      },
      "expense_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "time_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "invoice_template": {
        "meta": {
          "included": false
        }
      },
      "automatic_invoicing_rule": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deals/222

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": {
      "probability": 90
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "222",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2025-10-14",
      "end_date": null,
      "number": "1",
      "deal_number": "1",
      "suffix": null,
      "time_approval": true,
      "expense_approval": true,
      "client_access": false,
      "deal_type_id": 2,
      "budget": false,
      "sales_status_updated_at": "2025-10-14T06:04:00.000+02:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "email_key": "813b45dc3908c85878bbc0c8f59ca125",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": {},
      "discount": null,
      "man_day_minutes": 480,
      "rounding_interval_id": null,
      "rounding_method_id": 1,
      "validate_expense_when_closing": false,
      "revenue_distribution_type": "even",
      "color_id": null,
      "connection_status": "none",
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "probability": 90,
      "previous_probability": 30,
      "note_interpolated": null,
      "proposal_note_interpolated": null,
      "footer_interpolated": null,
      "proposal_footer_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "note": null,
      "proposal_note": null,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": "2025-10-14T06:04:25.000+02:00",
      "deleted_at": null,
      "created_at": "2025-10-14T06:04:25.561+02:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2025-10-14",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": 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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "manually_invoiced": 0,
      "manually_invoiced_default": 0,
      "manually_invoiced_normalized": 0,
      "draft_invoiced": 0,
      "draft_invoiced_default": 0,
      "draft_invoiced_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "374"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "proposal_document_type": {
        "meta": {
          "included": false
        }
      },
      "responsible": {
        "meta": {
          "included": false
        }
      },
      "deal_status": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "lost_reason": {
        "meta": {
          "included": false
        }
      },
      "contract": {
        "meta": {
          "included": false
        }
      },
      "contact": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "template": {
        "meta": {
          "included": false
        }
      },
      "tax_rate": {
        "meta": {
          "included": false
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      },
      "origin_deal": {
        "meta": {
          "included": false
        }
      },
      "approval_policy_assignment": {
        "meta": {
          "included": false
        }
      },
      "next_todo": {
        "meta": {
          "included": false
        }
      },
      "expense_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "time_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "invoice_template": {
        "meta": {
          "included": false
        }
      },
      "automatic_invoicing_rule": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deals/223

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": {
      "probability": 90
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "223",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2025-10-14",
      "end_date": null,
      "number": "1",
      "deal_number": "1",
      "suffix": null,
      "time_approval": true,
      "expense_approval": true,
      "client_access": false,
      "deal_type_id": 2,
      "budget": false,
      "sales_status_updated_at": "2025-10-14T06:04:00.000+02:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "email_key": "8582c076220671878815997e862bebb3",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": {},
      "discount": null,
      "man_day_minutes": 480,
      "rounding_interval_id": null,
      "rounding_method_id": 1,
      "validate_expense_when_closing": false,
      "revenue_distribution_type": "even",
      "color_id": null,
      "connection_status": "none",
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "probability": 90,
      "previous_probability": 50,
      "note_interpolated": null,
      "proposal_note_interpolated": null,
      "footer_interpolated": null,
      "proposal_footer_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "note": null,
      "proposal_note": null,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": "2025-10-14T06:04:25.000+02:00",
      "deleted_at": null,
      "created_at": "2025-10-14T06:04:25.783+02:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2025-10-14",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": 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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "manually_invoiced": 0,
      "manually_invoiced_default": 0,
      "manually_invoiced_normalized": 0,
      "draft_invoiced": 0,
      "draft_invoiced_default": 0,
      "draft_invoiced_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "375"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "proposal_document_type": {
        "meta": {
          "included": false
        }
      },
      "responsible": {
        "meta": {
          "included": false
        }
      },
      "deal_status": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "lost_reason": {
        "meta": {
          "included": false
        }
      },
      "contract": {
        "meta": {
          "included": false
        }
      },
      "contact": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "template": {
        "meta": {
          "included": false
        }
      },
      "tax_rate": {
        "meta": {
          "included": false
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      },
      "origin_deal": {
        "meta": {
          "included": false
        }
      },
      "approval_policy_assignment": {
        "meta": {
          "included": false
        }
      },
      "next_todo": {
        "meta": {
          "included": false
        }
      },
      "expense_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "time_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "invoice_template": {
        "meta": {
          "included": false
        }
      },
      "automatic_invoicing_rule": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deals/224

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": {
      "probability": 90
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "224",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2025-10-14",
      "end_date": null,
      "number": "1",
      "deal_number": "1",
      "suffix": null,
      "time_approval": true,
      "expense_approval": true,
      "client_access": false,
      "deal_type_id": 2,
      "budget": false,
      "sales_status_updated_at": "2025-10-14T06:04:00.000+02:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "email_key": "ec23f2f727273f05ca651bde55037667",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": {},
      "discount": null,
      "man_day_minutes": 480,
      "rounding_interval_id": null,
      "rounding_method_id": 1,
      "validate_expense_when_closing": false,
      "revenue_distribution_type": "even",
      "color_id": null,
      "connection_status": "none",
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "probability": 90,
      "previous_probability": 50,
      "note_interpolated": null,
      "proposal_note_interpolated": null,
      "footer_interpolated": null,
      "proposal_footer_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "note": null,
      "proposal_note": null,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": "2025-10-14T06:04:25.000+02:00",
      "deleted_at": null,
      "created_at": "2025-10-14T06:04:25.997+02:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2025-10-14",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": "123",
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": 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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "manually_invoiced": 0,
      "manually_invoiced_default": 0,
      "manually_invoiced_normalized": 0,
      "draft_invoiced": 0,
      "draft_invoiced_default": 0,
      "draft_invoiced_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "376"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "proposal_document_type": {
        "meta": {
          "included": false
        }
      },
      "responsible": {
        "meta": {
          "included": false
        }
      },
      "deal_status": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "lost_reason": {
        "meta": {
          "included": false
        }
      },
      "contract": {
        "meta": {
          "included": false
        }
      },
      "contact": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "template": {
        "meta": {
          "included": false
        }
      },
      "tax_rate": {
        "meta": {
          "included": false
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      },
      "origin_deal": {
        "meta": {
          "included": false
        }
      },
      "approval_policy_assignment": {
        "meta": {
          "included": false
        }
      },
      "next_todo": {
        "meta": {
          "included": false
        }
      },
      "expense_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "time_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "invoice_template": {
        "meta": {
          "included": false
        }
      },
      "automatic_invoicing_rule": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deals/225

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": {
      "note": "Meh"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "225",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2025-10-14",
      "end_date": null,
      "number": "1",
      "deal_number": "1",
      "suffix": null,
      "time_approval": true,
      "expense_approval": true,
      "client_access": false,
      "deal_type_id": 2,
      "budget": false,
      "sales_status_updated_at": "2025-10-14T06:04:00.000+02:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "email_key": "8978e7cd10bfa6ae0c19229e8686f289",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": {},
      "discount": null,
      "man_day_minutes": 480,
      "rounding_interval_id": null,
      "rounding_method_id": 1,
      "validate_expense_when_closing": false,
      "revenue_distribution_type": "even",
      "color_id": null,
      "connection_status": "none",
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "probability": 50,
      "previous_probability": null,
      "note_interpolated": "Meh",
      "proposal_note_interpolated": null,
      "footer_interpolated": null,
      "proposal_footer_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "note": "Meh",
      "proposal_note": null,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": "2025-10-14T06:04:26.000+02:00",
      "deleted_at": null,
      "created_at": "2025-10-14T06:04:26.214+02:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2025-10-14",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": "123",
      "external_sync": true,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": 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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "manually_invoiced": 0,
      "manually_invoiced_default": 0,
      "manually_invoiced_normalized": 0,
      "draft_invoiced": 0,
      "draft_invoiced_default": 0,
      "draft_invoiced_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "377"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "proposal_document_type": {
        "meta": {
          "included": false
        }
      },
      "responsible": {
        "meta": {
          "included": false
        }
      },
      "deal_status": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "lost_reason": {
        "meta": {
          "included": false
        }
      },
      "contract": {
        "meta": {
          "included": false
        }
      },
      "contact": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "template": {
        "meta": {
          "included": false
        }
      },
      "tax_rate": {
        "meta": {
          "included": false
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      },
      "origin_deal": {
        "meta": {
          "included": false
        }
      },
      "approval_policy_assignment": {
        "meta": {
          "included": false
        }
      },
      "next_todo": {
        "meta": {
          "included": false
        }
      },
      "expense_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "time_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "invoice_template": {
        "meta": {
          "included": false
        }
      },
      "automatic_invoicing_rule": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

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

URI Parameters
HideShow
id
number (required) Example: 1

deal id

DELETE /api/v2/deals/1
Requestsdeletes deal

DELETE  /api/v2/deals/226

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

POST /api/v2/deals/create_from_origin
Requestscreates budget from origin dealreturns error

POST  /api/v2/deals/create_from_origin

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",
    "relationships": {
      "origin_deal": {
        "data": {
          "type": "deals",
          "id": "231"
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "160"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "233",
    "type": "deals",
    "attributes": {
      "name": "test from origin",
      "date": "2025-10-14",
      "end_date": null,
      "number": "4",
      "deal_number": "4",
      "suffix": null,
      "time_approval": true,
      "expense_approval": true,
      "client_access": false,
      "deal_type_id": 2,
      "budget": true,
      "sales_status_updated_at": null,
      "tag_list": [],
      "origin_deal_id": 231,
      "profit_margin": "100.0",
      "email_key": "0a8b691719f93f06f9658e82b095cc01",
      "purchase_order_number": "abc",
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": null,
      "discount": null,
      "man_day_minutes": 480,
      "rounding_interval_id": 2,
      "rounding_method_id": 4,
      "validate_expense_when_closing": false,
      "revenue_distribution_type": null,
      "color_id": null,
      "connection_status": "none",
      "billable_time": 0,
      "budget_warning": 80,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "probability": 100,
      "previous_probability": null,
      "note_interpolated": null,
      "proposal_note_interpolated": null,
      "footer_interpolated": null,
      "proposal_footer_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "note": null,
      "proposal_note": null,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": "2025-10-14T06:04:27.000+02:00",
      "deleted_at": null,
      "created_at": "2025-10-14T06:04:27.592+02:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2025-10-14",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR",
      "revenue": 200000,
      "revenue_default": 250000,
      "revenue_normalized": 200000,
      "services_revenue": 0,
      "services_revenue_default": 0,
      "services_revenue_normalized": 0,
      "budget_total": 200000,
      "budget_total_default": 250000,
      "budget_total_normalized": 200000,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "profit": 200000,
      "profit_default": 250000,
      "profit_normalized": 200000,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 200000,
      "pending_invoicing_default": 250000,
      "pending_invoicing_normalized": 200000,
      "manually_invoiced": 0,
      "manually_invoiced_default": 0,
      "manually_invoiced_normalized": 0,
      "draft_invoiced": 0,
      "draft_invoiced_default": 0,
      "draft_invoiced_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "381"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "proposal_document_type": {
        "meta": {
          "included": false
        }
      },
      "responsible": {
        "meta": {
          "included": false
        }
      },
      "deal_status": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "lost_reason": {
        "meta": {
          "included": false
        }
      },
      "contract": {
        "meta": {
          "included": false
        }
      },
      "contact": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "template": {
        "meta": {
          "included": false
        }
      },
      "tax_rate": {
        "meta": {
          "included": false
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      },
      "origin_deal": {
        "meta": {
          "included": false
        }
      },
      "approval_policy_assignment": {
        "meta": {
          "included": false
        }
      },
      "next_todo": {
        "meta": {
          "included": false
        }
      },
      "expense_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "time_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "invoice_template": {
        "meta": {
          "included": false
        }
      },
      "automatic_invoicing_rule": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/deals/create_from_origin

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",
    "relationships": {}
  }
}
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/origin_deal"
      }
    }
  ]
}

Creates a budget from origin deal
POST/api/v2/deals/create_from_origin

URI Parameters
HideShow
id
number (required) Example: 1

deal id

POST /api/v2/deals/copy
Requestscopy from templatecopy from template

POST  /api/v2/deals/copy

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": "copied deal",
      "template_id": 277,
      "project_id": 172
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "279",
    "type": "deals",
    "attributes": {
      "name": "copied deal",
      "date": "2025-10-14",
      "end_date": null,
      "number": "4",
      "deal_number": "4",
      "suffix": null,
      "time_approval": true,
      "expense_approval": true,
      "client_access": false,
      "deal_type_id": 2,
      "budget": false,
      "sales_status_updated_at": "2025-10-14T06:04:35.000+02:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": "100.0",
      "email_key": "39c2d6813e099f0ace750fb6ce573dd4",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": {},
      "discount": null,
      "man_day_minutes": 480,
      "rounding_interval_id": null,
      "rounding_method_id": 1,
      "validate_expense_when_closing": false,
      "revenue_distribution_type": null,
      "color_id": null,
      "connection_status": "none",
      "billable_time": 0,
      "budget_warning": 80,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "probability": 50,
      "previous_probability": null,
      "note_interpolated": null,
      "proposal_note_interpolated": null,
      "footer_interpolated": null,
      "proposal_footer_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "note": null,
      "proposal_note": null,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": "2025-10-14T06:04:35.000+02:00",
      "deleted_at": null,
      "created_at": "2025-10-14T06:04:35.912+02:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2025-10-14",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR",
      "revenue": 100000,
      "revenue_default": 125000,
      "revenue_normalized": 100000,
      "services_revenue": 0,
      "services_revenue_default": 0,
      "services_revenue_normalized": 0,
      "budget_total": 100000,
      "budget_total_default": 125000,
      "budget_total_normalized": 100000,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 50000,
      "projected_revenue_default": 62500,
      "projected_revenue_normalized": 50000,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "profit": 100000,
      "profit_default": 125000,
      "profit_normalized": 100000,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 100000,
      "pending_invoicing_default": 125000,
      "pending_invoicing_normalized": 100000,
      "manually_invoiced": 0,
      "manually_invoiced_default": 0,
      "manually_invoiced_normalized": 0,
      "draft_invoiced": 0,
      "draft_invoiced_default": 0,
      "draft_invoiced_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "393"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "proposal_document_type": {
        "meta": {
          "included": false
        }
      },
      "responsible": {
        "meta": {
          "included": false
        }
      },
      "deal_status": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "lost_reason": {
        "meta": {
          "included": false
        }
      },
      "contract": {
        "meta": {
          "included": false
        }
      },
      "contact": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "template": {
        "meta": {
          "included": false
        }
      },
      "tax_rate": {
        "meta": {
          "included": false
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      },
      "origin_deal": {
        "meta": {
          "included": false
        }
      },
      "approval_policy_assignment": {
        "meta": {
          "included": false
        }
      },
      "next_todo": {
        "meta": {
          "included": false
        }
      },
      "expense_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "time_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "invoice_template": {
        "meta": {
          "included": false
        }
      },
      "automatic_invoicing_rule": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/deals/copy

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": "copied deal",
      "template_id": 313
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "315",
    "type": "deals",
    "attributes": {
      "name": "copied deal",
      "date": "2025-10-14",
      "end_date": null,
      "number": "4",
      "deal_number": "4",
      "suffix": null,
      "time_approval": true,
      "expense_approval": true,
      "client_access": false,
      "deal_type_id": 2,
      "budget": true,
      "sales_status_updated_at": "2025-10-14T06:04:44.000+02:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": "100.0",
      "email_key": "16e30ba3ee25507eebe2b24740dee077",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": {},
      "discount": null,
      "man_day_minutes": 480,
      "rounding_interval_id": null,
      "rounding_method_id": 1,
      "validate_expense_when_closing": false,
      "revenue_distribution_type": null,
      "color_id": null,
      "connection_status": "none",
      "billable_time": 0,
      "budget_warning": 80,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "probability": 50,
      "previous_probability": null,
      "note_interpolated": null,
      "proposal_note_interpolated": null,
      "footer_interpolated": null,
      "proposal_footer_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "note": null,
      "proposal_note": null,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": "2025-10-14T06:04:44.000+02:00",
      "deleted_at": null,
      "created_at": "2025-10-14T06:04:44.597+02:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2025-10-14",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR",
      "revenue": 100000,
      "revenue_default": 125000,
      "revenue_normalized": 100000,
      "services_revenue": 0,
      "services_revenue_default": 0,
      "services_revenue_normalized": 0,
      "budget_total": 100000,
      "budget_total_default": 125000,
      "budget_total_normalized": 100000,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "profit": 100000,
      "profit_default": 125000,
      "profit_normalized": 100000,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 100000,
      "pending_invoicing_default": 125000,
      "pending_invoicing_normalized": 100000,
      "manually_invoiced": 0,
      "manually_invoiced_default": 0,
      "manually_invoiced_normalized": 0,
      "draft_invoiced": 0,
      "draft_invoiced_default": 0,
      "draft_invoiced_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "401"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "proposal_document_type": {
        "meta": {
          "included": false
        }
      },
      "responsible": {
        "meta": {
          "included": false
        }
      },
      "deal_status": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "lost_reason": {
        "meta": {
          "included": false
        }
      },
      "contract": {
        "meta": {
          "included": false
        }
      },
      "contact": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "template": {
        "meta": {
          "included": false
        }
      },
      "tax_rate": {
        "meta": {
          "included": false
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      },
      "origin_deal": {
        "meta": {
          "included": false
        }
      },
      "approval_policy_assignment": {
        "meta": {
          "included": false
        }
      },
      "next_todo": {
        "meta": {
          "included": false
        }
      },
      "expense_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "time_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "invoice_template": {
        "meta": {
          "included": false
        }
      },
      "automatic_invoicing_rule": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Copies a deal
POST/api/v2/deals/copy

URI Parameters
HideShow
id
number (required) Example: 1

deal id

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

PATCH  /api/v2/deals/323/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": "323",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2025-10-14",
      "end_date": null,
      "number": "2",
      "deal_number": "2",
      "suffix": null,
      "time_approval": true,
      "expense_approval": true,
      "client_access": false,
      "deal_type_id": 2,
      "budget": true,
      "sales_status_updated_at": "2025-10-14T06:04:00.000+02:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "email_key": "4a1f1b16473fa1ed7b803a048dc6eb78",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": {},
      "discount": null,
      "man_day_minutes": 480,
      "rounding_interval_id": null,
      "rounding_method_id": 1,
      "validate_expense_when_closing": false,
      "revenue_distribution_type": null,
      "color_id": null,
      "connection_status": "none",
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "probability": 50,
      "previous_probability": null,
      "note_interpolated": null,
      "proposal_note_interpolated": null,
      "footer_interpolated": null,
      "proposal_footer_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "note": null,
      "proposal_note": null,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": "2025-10-14T06:04:46.000+02:00",
      "deleted_at": null,
      "created_at": "2025-10-14T06:04:46.525+02:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2025-10-14",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": 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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "manually_invoiced": 0,
      "manually_invoiced_default": 0,
      "manually_invoiced_normalized": 0,
      "draft_invoiced": 0,
      "draft_invoiced_default": 0,
      "draft_invoiced_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "404"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "proposal_document_type": {
        "meta": {
          "included": false
        }
      },
      "responsible": {
        "meta": {
          "included": false
        }
      },
      "deal_status": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "lost_reason": {
        "meta": {
          "included": false
        }
      },
      "contract": {
        "meta": {
          "included": false
        }
      },
      "contact": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "template": {
        "meta": {
          "included": false
        }
      },
      "tax_rate": {
        "meta": {
          "included": false
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      },
      "origin_deal": {
        "meta": {
          "included": false
        }
      },
      "approval_policy_assignment": {
        "meta": {
          "included": false
        }
      },
      "next_todo": {
        "meta": {
          "included": false
        }
      },
      "expense_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "time_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "invoice_template": {
        "meta": {
          "included": false
        }
      },
      "automatic_invoicing_rule": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

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 budget

PATCH  /api/v2/deals/325/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": "325",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2025-10-14",
      "end_date": null,
      "number": "2",
      "deal_number": "2",
      "suffix": null,
      "time_approval": true,
      "expense_approval": true,
      "client_access": false,
      "deal_type_id": 2,
      "budget": true,
      "sales_status_updated_at": "2025-10-14T06:04:00.000+02:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "email_key": "27e73b3a4a24e62d15f41b205441798d",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": {},
      "discount": null,
      "man_day_minutes": 480,
      "rounding_interval_id": null,
      "rounding_method_id": 1,
      "validate_expense_when_closing": false,
      "revenue_distribution_type": null,
      "color_id": null,
      "connection_status": "none",
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "probability": 50,
      "previous_probability": null,
      "note_interpolated": null,
      "proposal_note_interpolated": null,
      "footer_interpolated": null,
      "proposal_footer_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "note": null,
      "proposal_note": null,
      "lost_comment": null,
      "closed_at": "2025-10-14T06:04:47.000+02:00",
      "delivered_on": "2025-10-14",
      "last_activity_at": "2025-10-14T06:04:46.000+02:00",
      "deleted_at": null,
      "created_at": "2025-10-14T06:04:46.956+02:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2025-10-14",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": 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,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "manually_invoiced": 0,
      "manually_invoiced_default": 0,
      "manually_invoiced_normalized": 0,
      "draft_invoiced": 0,
      "draft_invoiced_default": 0,
      "draft_invoiced_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "405"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "proposal_document_type": {
        "meta": {
          "included": false
        }
      },
      "responsible": {
        "meta": {
          "included": false
        }
      },
      "deal_status": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "lost_reason": {
        "meta": {
          "included": false
        }
      },
      "contract": {
        "meta": {
          "included": false
        }
      },
      "contact": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "template": {
        "meta": {
          "included": false
        }
      },
      "tax_rate": {
        "meta": {
          "included": false
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      },
      "origin_deal": {
        "meta": {
          "included": false
        }
      },
      "approval_policy_assignment": {
        "meta": {
          "included": false
        }
      },
      "next_todo": {
        "meta": {
          "included": false
        }
      },
      "expense_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "time_approval_workflow": {
        "meta": {
          "included": false
        }
      },
      "invoice_template": {
        "meta": {
          "included": false
        }
      },
      "automatic_invoicing_rule": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

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

URI Parameters
HideShow
id
number (required) Example: 1

deal id

Generated by aglio on 14 Oct 2025