contracts

Create /contracts

Create a contract. Required: subject and either contact (client UUID) or lead (lead UUID). Optional: contract type (code_name), state, dates, values, project, objects, opportunities, assignees, document template, organization, and custom fields. Returns record with the detail projection.

POST

/contracts

Create /contracts

curl --request POST \
  --url https://default.hannacrm.app/api/v4/contracts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "advance": "<string>",
  "advance_percentage": "<string>",
  "advance_with_vat": "<string>",
  "assignees": [
    "<string>"
  ],
  "contact": "<string>",
  "contact_person": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "content": "<string>",
  "contract_date": "<string>",
  "contract_number": "<string>",
  "contract_number_full": "<string>",
  "contract_prefix": "<string>",
  "contract_state": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contract_type": "<string>",
  "contract_value": "<string>",
  "custom_fields": [
    {
      "slug": "<string>",
      "value": "<any>"
    }
  ],
  "dateend": "<string>",
  "datestart": "<string>",
  "description": "<string>",
  "document_template": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lead": "<string>",
  "lead_contact_person": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "objects": [
    "<string>"
  ],
  "opportunities": [
    "<string>"
  ],
  "organization": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "price_with_vat": "<string>",
  "project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subject": "<string>",
  "vat": 123
}
'

{
  "record": {
    "advance": "<string>",
    "advance_percentage": "<string>",
    "advance_with_vat": "<string>",
    "assignees": [
      {}
    ],
    "contact": [
      {}
    ],
    "contact_person": [
      {}
    ],
    "content": "<string>",
    "contract_date": "<string>",
    "contract_number": "<string>",
    "contract_number_full": "<string>",
    "contract_prefix": "<string>",
    "contract_state": [
      {}
    ],
    "contract_type": [
      {}
    ],
    "contract_value": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "custom_fields": [
      {
        "slug": "<string>",
        "value": "<any>"
      }
    ],
    "dateadded": "2023-11-07T05:31:56Z",
    "dateend": "<string>",
    "datestart": "<string>",
    "description": "<string>",
    "document_template": [
      {}
    ],
    "lead": [
      {}
    ],
    "lead_contact_person": [
      {}
    ],
    "objects": [
      {}
    ],
    "opportunities": [
      {}
    ],
    "organization": [
      {}
    ],
    "organization_name": "<string>",
    "price_with_vat": "<string>",
    "project": [
      {}
    ],
    "subject": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "uuid": "<string>",
    "vat": "<string>"
  }
}

Authorizations

Authorizationstringheaderrequired

API key (Bearer token) created in Setup → API & MCP.

Body

advancestring

Advance amount.

advance_percentagestring

Advance percentage.

advance_with_vatstring

Advance amount including VAT.

assigneesstring[]

Responsible person staff UUIDs.

contactstring

Client UUID (required on create if lead is omitted).

contact_personstring

Client contact person UUID.

contentstring

Contract content (HTML).

contract_datestring

Contract date (Y-m-d).

contract_numberstring

Contract number (without prefix).

contract_number_fullstring

Full contract number (prefix + number).

contract_prefixstring

Contract number prefix.

contract_statestring

Contract state picklist value UUID.

contract_typestring

Contract type code_name (e.g. sales_contracts) or numeric ID.

contract_valuestring

Contract value.

custom_fieldsobject[]

Custom field values by slug.

Show child attributes

dateendstring

Contract end date (Y-m-d).

datestartstring

Contract start date (Y-m-d).

descriptionstring

Contract description.

document_templatestring

Document template UUID.

leadstring

Lead UUID (required on create if contact is omitted).

lead_contact_personstring

Lead contact person UUID.

objectsstring[]

Object UUIDs.

opportunitiesstring[]

Opportunity UUIDs.

organizationstring

Organization UUID.

price_with_vatstring

Price including VAT.

projectstring

Project UUID.

subjectstringrequired

Contract subject/title.

vatinteger

VAT rate (basis points, e.g. 2100 = 21%).

any

Response

Success

recordobject

Fields enabled for this documentation instance (projection enabled: feature, option, subdomain, closures) plus account-level form field visibility. Role- and user-level field overrides are not applied here, so an API key whose staff user has such overrides may receive fewer fields. A disabled field is omitted from the response object entirely; a present key with a null value means the record simply has no value.

Show child attributes

Still need help? Ask the team