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)

  • deal_type_id (1: internal, 2: client) (deals can only be “client” type, while budgets can be both)

  • 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": "181",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2026-03-17",
        "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": "2026-03-17T05:05:00.000+01:00",
        "tag_list": [],
        "origin_deal_id": null,
        "profit_margin": 0,
        "profit_margin_normalized": 0,
        "profit_margin_default": 0,
        "email_key": "c49f3c649f91f8350126c139b07ea970",
        "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",
        "revenue_distribution_method": null,
        "retainer_interval": null,
        "retainer_interval_count": 1,
        "billable_time": 0,
        "budget_warning": null,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "days_since_created": 0,
        "days_since_last_activity": 0,
        "days_in_current_stage": 0,
        "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": "2026-03-17T05:05:47.000+01:00",
        "deleted_at": null,
        "created_at": "2026-03-17T05:05:47.365+01:00",
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2026-03-17",
        "sales_closed_on": null,
        "sample_data": false,
        "external_id": null,
        "external_sync": false,
        "manual_invoicing_status_id": 1,
        "footer": null,
        "proposal_footer": null,
        "access_to_deal": true,
        "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": "366"
          }
        },
        "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
          }
        },
        "designated_approver": {
          "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/182

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": "182",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2026-03-17",
      "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": "2026-03-17T05:05:00.000+01:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "profit_margin_normalized": 0,
      "profit_margin_default": 0,
      "email_key": "05c668ef51bb388e406d950f131600ec",
      "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",
      "revenue_distribution_method": null,
      "retainer_interval": null,
      "retainer_interval_count": 1,
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "days_since_created": 0,
      "days_since_last_activity": 0,
      "days_in_current_stage": 0,
      "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": "2026-03-17T05:05:47.000+01:00",
      "deleted_at": null,
      "created_at": "2026-03-17T05:05:47.511+01:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2026-03-17",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "access_to_deal": true,
      "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
        }
      },
      "designated_approver": {
        "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 retainer dealcreates 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": "2026-03-17",
      "deal_type_id": 2,
      "deal_status_id": 1972,
      "probability": 50,
      "currency": "EUR",
      "budget": false,
      "purchase_order_number": "234"
    },
    "relationships": {
      "company": {
        "data": {
          "type": "companies",
          "id": "770"
        }
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "1028"
        }
      },
      "subsidiary": {
        "data": {
          "type": "subsidiaries",
          "id": "201"
        }
      },
      "document_type": {
        "data": {
          "type": "document-types",
          "id": "195"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "186",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2026-03-17",
      "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": "2026-03-17T05:05:48.000+01:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "profit_margin_normalized": 0,
      "profit_margin_default": 0,
      "email_key": "412bba72cda9d4b936d6b5180e9a481b",
      "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",
      "revenue_distribution_method": null,
      "retainer_interval": null,
      "retainer_interval_count": 1,
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "days_since_created": 0,
      "days_since_last_activity": 0,
      "days_in_current_stage": 0,
      "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": "2026-03-17T05:05:48.000+01:00",
      "deleted_at": null,
      "created_at": "2026-03-17T05:05:48.299+01:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2026-03-17",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "access_to_deal": true,
      "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": "370"
        }
      },
      "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
        }
      },
      "designated_approver": {
        "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",
      "meta": {},
      "source": {
        "pointer": "data/attributes/name"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "meta": {},
      "source": {
        "pointer": "data/attributes/responsible"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "meta": {
        "unless": "internal?"
      },
      "source": {
        "pointer": "data/attributes/company"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "meta": {},
      "source": {
        "pointer": "data/attributes/deal_type_id"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not included in the list",
      "meta": {
        "value": null
      },
      "source": {
        "pointer": "data/attributes/deal_type_id"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "meta": {
        "if": "sales_pipeline?"
      },
      "source": {
        "pointer": "data/attributes/probability"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not a number",
      "meta": {
        "if": "sales_pipeline?",
        "value": null
      },
      "source": {
        "pointer": "data/attributes/probability"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "meta": {
        "if": "financials_required?"
      },
      "source": {
        "pointer": "data/attributes/currency"
      }
    },
    {
      "status": "422",
      "code": "currency_invalid",
      "title": "Invalid Attribute",
      "detail": "is not a valid currency",
      "meta": {},
      "source": {
        "pointer": "data/attributes/currency"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "meta": {
        "if": "sales_pipeline?"
      },
      "source": {
        "pointer": "data/attributes/deal_status"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "meta": {},
      "source": {
        "pointer": "data/attributes/date"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not a date",
      "meta": {
        "allow_nil": false
      },
      "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": 2002,
      "probability": 50,
      "currency": "EUR"
    },
    "relationships": {
      "company": {
        "data": {
          "type": "companies",
          "id": "780"
        }
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "1042"
        }
      },
      "subsidiary": {
        "data": {
          "type": "subsidiaries",
          "id": "215"
        }
      },
      "document_type": {
        "data": {
          "type": "document-types",
          "id": "204"
        }
      }
    }
  }
}
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",
      "meta": {},
      "source": {
        "pointer": "data/attributes/date"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not a date",
      "meta": {
        "allow_nil": false
      },
      "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": "2026-03-17",
      "deal_type_id": 2,
      "deal_status_id": 2040,
      "probability": 50,
      "currency": "EUR",
      "budget": false,
      "retainer_interval": "month",
      "retainer_interval_count": 6
    },
    "relationships": {
      "company": {
        "data": {
          "type": "companies",
          "id": "793"
        }
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "1060"
        }
      },
      "subsidiary": {
        "data": {
          "type": "subsidiaries",
          "id": "231"
        }
      },
      "document_type": {
        "data": {
          "type": "document-types",
          "id": "213"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "204",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2026-03-17",
      "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": "2026-03-17T05:05:51.000+01:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "profit_margin_normalized": 0,
      "profit_margin_default": 0,
      "email_key": "57f00b76a854bd63c0e7b1c3b6a8b74b",
      "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": "even",
      "color_id": null,
      "connection_status": "none",
      "revenue_distribution_method": null,
      "retainer_interval": "month",
      "retainer_interval_count": 6,
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "days_since_created": 0,
      "days_since_last_activity": 0,
      "days_in_current_stage": 0,
      "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": "2026-03-17T05:05:51.000+01:00",
      "deleted_at": null,
      "created_at": "2026-03-17T05:05:51.878+01:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2026-03-17",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "access_to_deal": true,
      "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": "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
        }
      },
      "designated_approver": {
        "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": "test name",
      "budget": true,
      "date": "2026-03-17",
      "deal_type_id": 2,
      "currency": "EUR"
    },
    "relationships": {
      "company": {
        "data": {
          "type": "companies",
          "id": "796"
        }
      },
      "responsible": {
        "data": {
          "type": "people",
          "id": "1063"
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "156"
        }
      },
      "subsidiary": {
        "data": {
          "type": "subsidiaries",
          "id": "234"
        }
      },
      "document_type": {
        "data": {
          "type": "document-types",
          "id": "215"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "206",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2026-03-17",
      "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,
      "profit_margin_normalized": 0,
      "profit_margin_default": 0,
      "email_key": "85349e901f0724fb0d5a238eaca4b3dc",
      "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",
      "revenue_distribution_method": null,
      "retainer_interval": null,
      "retainer_interval_count": 1,
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "days_since_created": 0,
      "days_since_last_activity": 0,
      "days_in_current_stage": 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": "2026-03-17T05:05:52.000+01:00",
      "deleted_at": null,
      "created_at": "2026-03-17T05:05:52.328+01:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2026-03-17",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "access_to_deal": true,
      "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": "382"
        }
      },
      "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
        }
      },
      "designated_approver": {
        "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/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": {
      "name": "new name",
      "tracking_type_id": 3,
      "purchase_order_number": "456"
    },
    "relationships": {
      "responsible": {
        "data": {
          "type": "people",
          "id": "1071"
        }
      },
      "subscribers": {
        "data": [
          {
            "type": "people",
            "id": "1072"
          },
          {
            "type": "people",
            "id": "1073"
          }
        ]
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "209",
    "type": "deals",
    "attributes": {
      "name": "new name",
      "date": "2026-03-17",
      "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": "2026-03-17T05:05:00.000+01:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "profit_margin_normalized": 0,
      "profit_margin_default": 0,
      "email_key": "108faa566d99fca864aafdf53d331e34",
      "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",
      "revenue_distribution_method": null,
      "retainer_interval": null,
      "retainer_interval_count": 1,
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "days_since_created": 0,
      "days_since_last_activity": 0,
      "days_in_current_stage": 0,
      "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": "2026-03-17T05:05:53.000+01:00",
      "deleted_at": null,
      "created_at": "2026-03-17T05:05:53.030+01:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2026-03-17",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "access_to_deal": true,
      "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": "384"
        }
      },
      "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
        }
      },
      "designated_approver": {
        "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/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": {
      "delivered_on": "2026-03-21"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "215",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2026-03-17",
      "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": "2026-03-17T05:05:00.000+01:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "profit_margin_normalized": 0,
      "profit_margin_default": 0,
      "email_key": "ab2d0a81fb62ed2d88452703378ffd91",
      "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",
      "revenue_distribution_method": null,
      "retainer_interval": null,
      "retainer_interval_count": 1,
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "days_since_created": 0,
      "days_since_last_activity": 0,
      "days_in_current_stage": 0,
      "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": "2026-03-17T05:05:55.000+01:00",
      "delivered_on": "2026-03-21",
      "last_activity_at": "2026-03-17T05:05:55.000+01:00",
      "deleted_at": null,
      "created_at": "2026-03-17T05:05:55.385+01:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2026-03-17",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "access_to_deal": true,
      "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": "388"
        }
      },
      "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
        }
      },
      "designated_approver": {
        "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": {
      "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",
      "meta": {},
      "source": {
        "pointer": "data/attributes/name"
      }
    }
  ]
}

PATCH  /api/v2/deals/218

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

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": {},
    "relationships": {
      "project": {
        "data": {
          "type": "projects",
          "id": "161"
        }
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "219",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2026-03-17",
      "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": "2026-03-17T05:05:00.000+01:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "profit_margin_normalized": 0,
      "profit_margin_default": 0,
      "email_key": "0521f11534d8d48f32811fdb480dcec5",
      "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",
      "revenue_distribution_method": null,
      "retainer_interval": null,
      "retainer_interval_count": 1,
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "days_since_created": 0,
      "days_since_last_activity": 0,
      "days_in_current_stage": 0,
      "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": "2026-03-17T05:05:56.000+01:00",
      "deleted_at": null,
      "created_at": "2026-03-17T05:05:56.809+01:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2026-03-17",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "access_to_deal": true,
      "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": "391"
        }
      },
      "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
        }
      },
      "designated_approver": {
        "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": {},
    "relationships": {
      "project": {
        "data": {
          "type": "projects",
          "id": "163"
        }
      }
    }
  }
}
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",
      "meta": {},
      "source": {
        "pointer": "data/attributes/project"
      }
    }
  ]
}

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": {
      "deal_status_id": "2114"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "221",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2026-03-17",
      "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": "2026-03-17T05:05:57.000+01:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "profit_margin_normalized": 0,
      "profit_margin_default": 0,
      "email_key": "2fc3528ccb89e16bec2038c33bc991b3",
      "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",
      "revenue_distribution_method": null,
      "retainer_interval": null,
      "retainer_interval_count": 1,
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": 0,
      "days_since_created": 0,
      "days_since_last_activity": 0,
      "days_in_current_stage": 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": "2026-03-17T05:05:57.000+01:00",
      "deleted_at": null,
      "created_at": "2026-03-17T05:05:57.588+01:00",
      "sales_closed_at": "2026-03-17T05:05:57.000+01:00",
      "exchange_rate": "1.25",
      "exchange_date": "2026-03-17",
      "sales_closed_on": "2026-03-17",
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "access_to_deal": true,
      "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": "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
        }
      },
      "designated_approver": {
        "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": {
      "deal_status_id": "2121"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "222",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2026-03-17",
      "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": "2026-03-17T05:05:57.000+01:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "profit_margin_normalized": 0,
      "profit_margin_default": 0,
      "email_key": "d1d926fa0f9251479cb94ff263ab7abb",
      "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",
      "revenue_distribution_method": null,
      "retainer_interval": null,
      "retainer_interval_count": 1,
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": 0,
      "days_since_created": 0,
      "days_since_last_activity": 0,
      "days_in_current_stage": 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": "2026-03-17T05:05:57.000+01:00",
      "deleted_at": null,
      "created_at": "2026-03-17T05:05:57.850+01:00",
      "sales_closed_at": "2026-03-17T05:05:57.000+01:00",
      "exchange_rate": "1.25",
      "exchange_date": "2026-03-17",
      "sales_closed_on": "2026-03-17",
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "access_to_deal": true,
      "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": "394"
        }
      },
      "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
        }
      },
      "designated_approver": {
        "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": {
      "deal_status_id": "2142"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "225",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2026-03-17",
      "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": "2026-03-17T05:05:58.000+01:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "profit_margin_normalized": 0,
      "profit_margin_default": 0,
      "email_key": "32d4f53d44dbfb189009ac3f689baf4d",
      "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",
      "revenue_distribution_method": null,
      "retainer_interval": null,
      "retainer_interval_count": 1,
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "days_since_created": 0,
      "days_since_last_activity": 0,
      "days_in_current_stage": 0,
      "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": "2026-03-17T05:05:58.000+01:00",
      "deleted_at": null,
      "created_at": "2026-03-17T05:05:58.615+01:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2026-03-17",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "access_to_deal": true,
      "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": "397"
        }
      },
      "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
        }
      },
      "designated_approver": {
        "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/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
Body
{
  "data": {
    "type": "deals",
    "attributes": {
      "deal_status_id": "2149"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "226",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2026-03-17",
      "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": "2026-03-17T05:05:58.000+01:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "profit_margin_normalized": 0,
      "profit_margin_default": 0,
      "email_key": "cf00c471fcd1252d0d81f457295d7b53",
      "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",
      "revenue_distribution_method": null,
      "retainer_interval": null,
      "retainer_interval_count": 1,
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "days_since_created": 0,
      "days_since_last_activity": 0,
      "days_in_current_stage": 0,
      "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": "2026-03-17T05:05:58.000+01:00",
      "deleted_at": null,
      "created_at": "2026-03-17T05:05:58.885+01:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2026-03-17",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "access_to_deal": true,
      "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": "398"
        }
      },
      "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
        }
      },
      "designated_approver": {
        "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/227

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": "227",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2026-03-17",
      "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": "2026-03-17T05:05:00.000+01:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "profit_margin_normalized": 0,
      "profit_margin_default": 0,
      "email_key": "b61e886faacb594b8d649497821ab0fd",
      "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",
      "revenue_distribution_method": null,
      "retainer_interval": null,
      "retainer_interval_count": 1,
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "days_since_created": 0,
      "days_since_last_activity": 0,
      "days_in_current_stage": 0,
      "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": "2026-03-17T05:05:59.000+01:00",
      "deleted_at": null,
      "created_at": "2026-03-17T05:05:59.128+01:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2026-03-17",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "access_to_deal": true,
      "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": "399"
        }
      },
      "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
        }
      },
      "designated_approver": {
        "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/228

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": "228",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2026-03-17",
      "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": "2026-03-17T05:05:00.000+01:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "profit_margin_normalized": 0,
      "profit_margin_default": 0,
      "email_key": "b9fb8828764ca66a38f05b237566192c",
      "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",
      "revenue_distribution_method": null,
      "retainer_interval": null,
      "retainer_interval_count": 1,
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "days_since_created": 0,
      "days_since_last_activity": 0,
      "days_in_current_stage": 0,
      "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": "2026-03-17T05:05:59.000+01:00",
      "deleted_at": null,
      "created_at": "2026-03-17T05:05:59.338+01:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2026-03-17",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "access_to_deal": true,
      "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": "400"
        }
      },
      "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
        }
      },
      "designated_approver": {
        "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/229

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": "229",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2026-03-17",
      "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": "2026-03-17T05:05:00.000+01:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "profit_margin_normalized": 0,
      "profit_margin_default": 0,
      "email_key": "2bdbcdef561debc8ed1afd82a2e5ac2a",
      "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",
      "revenue_distribution_method": null,
      "retainer_interval": null,
      "retainer_interval_count": 1,
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "days_since_created": 0,
      "days_since_last_activity": 0,
      "days_in_current_stage": 0,
      "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": "2026-03-17T05:05:59.000+01:00",
      "deleted_at": null,
      "created_at": "2026-03-17T05:05:59.562+01:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2026-03-17",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "access_to_deal": true,
      "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": "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
        }
      },
      "designated_approver": {
        "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/230

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": "230",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2026-03-17",
      "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": "2026-03-17T05:05:00.000+01:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "profit_margin_normalized": 0,
      "profit_margin_default": 0,
      "email_key": "052c2d07bb721d6d51bf3e9ee2a5cf79",
      "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",
      "revenue_distribution_method": null,
      "retainer_interval": null,
      "retainer_interval_count": 1,
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "days_since_created": 0,
      "days_since_last_activity": 0,
      "days_in_current_stage": 0,
      "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": "2026-03-17T05:05:59.000+01:00",
      "deleted_at": null,
      "created_at": "2026-03-17T05:05:59.781+01:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2026-03-17",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": "123",
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "access_to_deal": true,
      "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": "402"
        }
      },
      "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
        }
      },
      "designated_approver": {
        "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/231

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": "231",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2026-03-17",
      "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": "2026-03-17T05:05:00.000+01:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "profit_margin_normalized": 0,
      "profit_margin_default": 0,
      "email_key": "5da42992a0411b7931d148ef9f7184c8",
      "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",
      "revenue_distribution_method": null,
      "retainer_interval": null,
      "retainer_interval_count": 1,
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "days_since_created": 0,
      "days_since_last_activity": 0,
      "days_in_current_stage": 0,
      "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": "2026-03-17T05:05:59.000+01:00",
      "deleted_at": null,
      "created_at": "2026-03-17T05:05:59.994+01:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2026-03-17",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": "123",
      "external_sync": true,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "access_to_deal": true,
      "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": "403"
        }
      },
      "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
        }
      },
      "designated_approver": {
        "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/232

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": "237"
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "165"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "239",
    "type": "deals",
    "attributes": {
      "name": "test from origin",
      "date": "2026-03-17",
      "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": 237,
      "email_key": "e1a032a07bae9a01a9393b6112f7edcc",
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": null,
      "man_day_minutes": 480,
      "rounding_interval_id": 2,
      "rounding_method_id": 4,
      "validate_expense_when_closing": false,
      "revenue_distribution_type": "default",
      "color_id": null,
      "connection_status": "none",
      "revenue_distribution_method": null,
      "retainer_interval": null,
      "retainer_interval_count": 1,
      "budget_warning": 80,
      "days_since_created": 0,
      "days_since_last_activity": 0,
      "days_in_current_stage": 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": "2026-03-17T05:06:01.000+01:00",
      "deleted_at": null,
      "created_at": "2026-03-17T05:06:01.535+01:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2026-03-17",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "access_to_deal": false,
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "407"
        }
      },
      "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
        }
      },
      "designated_approver": {
        "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",
      "meta": {},
      "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": 283,
      "project_id": 177
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "285",
    "type": "deals",
    "attributes": {
      "name": "copied deal",
      "date": "2026-03-17",
      "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": "2026-03-17T05:06:11.000+01:00",
      "tag_list": [],
      "origin_deal_id": null,
      "email_key": "7a9dff9d47e7fc14082cf5ba7ad20e56",
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": {},
      "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",
      "revenue_distribution_method": null,
      "retainer_interval": null,
      "retainer_interval_count": 1,
      "budget_warning": 80,
      "days_since_created": 0,
      "days_since_last_activity": 0,
      "days_in_current_stage": 0,
      "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": "2026-03-17T05:06:10.000+01:00",
      "deleted_at": null,
      "created_at": "2026-03-17T05:06:11.310+01:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2026-03-17",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "access_to_deal": false,
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "419"
        }
      },
      "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
        }
      },
      "designated_approver": {
        "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": 324
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "326",
    "type": "deals",
    "attributes": {
      "name": "copied deal",
      "date": "2026-03-17",
      "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": "2026-03-17T05:06:23.000+01:00",
      "tag_list": [],
      "origin_deal_id": null,
      "email_key": "1ead806670c3e5accfc89712cbf75d5b",
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": {},
      "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",
      "revenue_distribution_method": null,
      "retainer_interval": null,
      "retainer_interval_count": 1,
      "budget_warning": 80,
      "days_since_created": 0,
      "days_since_last_activity": 0,
      "days_in_current_stage": 0,
      "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": "2026-03-17T05:06:23.000+01:00",
      "deleted_at": null,
      "created_at": "2026-03-17T05:06:23.769+01:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2026-03-17",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "access_to_deal": false,
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "428"
        }
      },
      "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
        }
      },
      "designated_approver": {
        "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/334/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": "334",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2026-03-17",
      "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": "2026-03-17T05:06:00.000+01:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "profit_margin_normalized": 0,
      "profit_margin_default": 0,
      "email_key": "3e54a7847f1dc16841131e11d75b4fc7",
      "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",
      "revenue_distribution_method": null,
      "retainer_interval": null,
      "retainer_interval_count": 1,
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "days_since_created": 0,
      "days_since_last_activity": 0,
      "days_in_current_stage": 0,
      "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": "2026-03-17T05:06:25.000+01:00",
      "deleted_at": null,
      "created_at": "2026-03-17T05:06:25.880+01:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2026-03-17",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "access_to_deal": true,
      "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": "431"
        }
      },
      "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
        }
      },
      "designated_approver": {
        "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/336/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": "336",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2026-03-17",
      "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": "2026-03-17T05:06:00.000+01:00",
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "profit_margin_normalized": 0,
      "profit_margin_default": 0,
      "email_key": "598b6548efae09da7f65d24e070ad696",
      "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",
      "revenue_distribution_method": null,
      "retainer_interval": null,
      "retainer_interval_count": 1,
      "billable_time": 0,
      "budget_warning": null,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "days_since_created": 0,
      "days_since_last_activity": 0,
      "days_in_current_stage": 0,
      "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": "2026-03-17T05:06:26.000+01:00",
      "delivered_on": "2026-03-17",
      "last_activity_at": "2026-03-17T05:06:26.000+01:00",
      "deleted_at": null,
      "created_at": "2026-03-17T05:06:26.506+01:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2026-03-17",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "manual_invoicing_status_id": 1,
      "footer": null,
      "proposal_footer": null,
      "access_to_deal": true,
      "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": "432"
        }
      },
      "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
        }
      },
      "designated_approver": {
        "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 17 Mar 2026