Hanna CRM

Updates a contact person by UUID. Only provided fields are changed. When `clients` is sent, it replaces the full linked-client list; `main_client` (with `clients`) picks the main client. Returns `record` with the detail projection. May export the record to configured accounting or field-service integrations.

contact_update

Searches contact persons (first name, last name, email, phone). Each item includes linked `clients`. Results in `items`, pagination in `pagination`. Metadata filters: `uuid`, `created_by`/`updated_by` (staff UUID), `created_at`/`updated_at` (date ranges).

contacts_search

Creates a contract. Required: `subject` and either `contact` or `lead`. Returns `record` with the detail projection. May send record data to configured external webhook URLs when webhooks are enabled.

contract_create

Returns a single contract by UUID with detail projection (core fields, contact or lead, status, type, dates, values, relations, custom fields, and organization when applicable); response key `record`.

contract_get

Lists contract text templates (`uuid`, `code_name`, `name`, `document_name`). The template body is not returned. Results in `items`, pagination in `pagination`.

contract_text_templates_search

Lists contract types (`uuid`, `code_name`, `name`, `contract_prefix`). Use the `uuid` for the contract `type` field. Results in `items`, pagination in `pagination`.

contract_types_search

Updates a contract by UUID. Only provided fields are changed. Returns `record` with the detail projection. May send record data to configured external webhook URLs when webhooks are enabled.

contract_update

Searches contracts by subject, contract number, contact name, or description. Results in `items`, pagination in `pagination`. Metadata filters: `uuid`, `created_by`/`updated_by` (staff UUID), `created_at`/`updated_at` (date ranges).

contracts_search

Lists countries (`uuid`, `iso2`, `iso3`, `name`, `calling_code`). Use the `uuid` for the `country` address field. Results in `items`, pagination in `pagination`.

countries_search

Creates a credit note. Required: `contact`, `date`, `items`. Optional: currency (tenant default when omitted). Returns `record` with the detail projection. May export the record to a configured accounting integration.

credit_note_create

Returns a single credit note by UUID with detail projection (amounts, client, dates, status, items, addresses, invoice/project, and organization when applicable); response key `record`.

credit_note_get

Updates a credit note by UUID. Only provided fields are changed. Returns `record` with the detail projection. May export the record to a configured accounting integration.

credit_note_update

Searches credit notes by number or client name. Results in `items`, pagination in `pagination`. Metadata filters: `uuid`, `created_by`/`updated_by` (staff UUID), `created_at`/`updated_at` (date ranges).

credit_notes_search

Lists currencies (`uuid`, `name`, `symbol`, `is_default`). Use the `uuid` for the `currency` field. Results in `items`, pagination in `pagination`.

currencies_search

Lists custom fields defined on this account (`slug`, `name`, `type`, `module`, `required`, `options`). Use it to discover valid slugs before writing `custom_fields`. Narrow with the `module` filter (API module slug). Results in `items`.

custom_fields_search

Lists customer groups (`uuid`, `code_name`, `name`, `color`). Results in `items`, pagination in `pagination`.

customer_groups_search

Lists customer types (`uuid`, `code_name`, `name`, `color`). Results in `items`, pagination in `pagination`.

customer_types_search

Lists ticket departments (`uuid`, `code_name`, `name`). Use the `uuid` for the ticket `department` field. Results in `items`, pagination in `pagination`.

departments_search

Creates a document. Required: `name`, `client`. Returns `record` with the detail projection. May send staff email notifications according to notification settings.

document_create

Returns a single document by UUID with detail projection (core fields, status, category, type, relations, dates, custom fields, and organization when applicable); response key `record`.

document_get

Updates a document by UUID. Only provided fields are changed. Returns `record` with the detail projection. May send staff email notifications according to notification settings.

document_update

Searches documents by name, number, registration number, description, recipient address, client, or contact person. Results in `items`, pagination in `pagination`. Metadata filters: `uuid`, `created_by`/`updated_by` (staff UUID), `created_at`/`updated_at` (date ranges).

documents_search

Lists expense categories (`uuid`, `code_name`, `name`, `is_active`). Use the `uuid` for the expense `category` field. Results in `items`, pagination in `pagination`.

expense_categories_search

Creates an expense. Required: `name`, `amount`. Category defaults to tenant default when omitted. Returns `record` with the detail projection. May send staff email notifications according to notification settings.

expense_create

Returns a single expense by UUID with detail projection (amounts, category, status, relations, items, custom fields, and organization when applicable); response key `record`.

expense_get

Updates an expense by UUID. Only provided fields are changed. Returns `record` with the detail projection. May send staff email notifications according to notification settings.

expense_update

Searches expenses by name, reference number, note, or supplier name. Results in `items`, pagination in `pagination`. Metadata filters: `uuid`, `created_by`/`updated_by` (staff UUID), `created_at`/`updated_at` (date ranges).

expenses_search

Returns the content of one attached file, up to 5 MB: images as an image, text as text, anything else (PDF, office files) as `content_base64`. Pass `module`, `related_uuid` and the file `uuid` from `files_search`. Larger files: download them with API v4.

file_get_content

Attaches a file to a record (its Files tab), e.g. a task, client or project: `module`, `related_uuid`, `filename` (with extension) and the bytes as `content_base64`, up to 5 MB. Optional `description`. Needs edit rights on the record; the tenant's allowed file types apply. The file is not shown to the customer. Returns `record` (the file, as in `files_search`).

file_upload

Lists the files attached to one record (its Files tab), newest first: `uuid`, `file_name`, `filesize`, `filetype`, `description`, `created_at`. Pass `module` and the record's `related_uuid`. For tickets the list includes email attachments. Read a file with `file_get_content`.

files_search

Creates an invoice. Required: `contact`, `date`, `currency`, `items`. Optional: `document_prefix` + `document_number` for manual numbering without auto increment. Returns `record` with the detail projection. May send record data to configured external webhook URLs when webhooks are enabled.

invoice_create

Returns a single invoice by UUID with detail projection (amounts, client, dates, status, items, addresses, and organization when applicable); response key `record`.

invoice_get

Updates an invoice by UUID. Only provided fields are changed. Returns `record` with the detail projection. May send record data to configured external webhook URLs when webhooks are enabled.

invoice_update

Searches invoices by number or client name. Results in `items`, pagination in `pagination`. Metadata filters: `uuid`, `created_by`/`updated_by` (staff UUID), `created_at`/`updated_at` (date ranges).

invoices_search

Lists item categories (`uuid`, `code_name`, `name`, `parent`). Results in `items`, pagination in `pagination`.

item_categories_search

Creates an item. Required: `description`, `code`. Returns `record` with the detail projection. May send record data to configured external webhook URLs when webhooks are enabled.

item_create

Returns a single item by UUID with detail projection (pricing, tax, unit, category, manufacturer, flags, warehouse balances, and organization when applicable); response key `record`.

item_get

Lists item groups (`uuid`, `code_name`, `name`, `parent`). Use the `uuid` for the item `group` field. Results in `items`, pagination in `pagination`.

item_groups_search

Updates an item by UUID. Only provided fields are changed. Returns `record` with the detail projection. May send record data to configured external webhook URLs when webhooks are enabled.

item_update

Searches items by code, description, supplier code, barcode, EAN, or serial number. Results in `items`, pagination in `pagination`. Metadata filters: `uuid`, `created_by`/`updated_by` (staff UUID), `created_at`/`updated_at` (date ranges).

items_search