> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Firmao

> Firmao is a business information platform offering data and insights on companies, industries, and markets, providing tools for company research, industry analysis, and market intelligence.

![Firmao logo](https://mintcdn.com/composio-preview/GL28i3tBlbEbBd-f/images/toolkits/firmao.svg?fit=max\&auto=format\&n=GL28i3tBlbEbBd-f\&q=85\&s=5cce48883a2657e5111def82c1dbb62d)

* **Category:** crm
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 14
* **Triggers:** 0
* **Slug:** `FIRMAO`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Invoice
>
> **Slug:** `FIRMAO_CREATE_INVOICE`
>
> Creates a new sales or purchase invoice in Firmao CRM. This action generates an invoice transaction with line items, customer information, pricing details, and payment terms. It can auto-create customers if needed and supports automatic invoice numbering.
>
> #### Input Parameters
>
> **mode** `string ("SALE" | "PURCHASE")`
>
> Document mode; 'SALE' for sales invoices
>
> **paid** `boolean`
>
> Whether the invoice is already paid
>
> **type** `string`
>
> Fixed to 'INVOICE' to create an invoice
>
> **emails** `array`
>
> List of emails for new customer
>
> **phones** `array`
>
> List of phone numbers for new customer
>
> **currency** `string` *required*
>
> Invoice currency code in ISO 4217 format (e.g., 'PLN', 'EUR', 'USD', 'GBP')
>
> **customer** `integer`
>
> Existing customer ID from Firmao (mutually exclusive with createNewCustomerIfNeeded)
>
> **paidValue** `number`
>
> Amount already paid
>
> **autoNumber** `boolean`
>
> Let system assign invoice number automatically (recommended); set to false to provide explicit transactionNumber
>
> **invoiceDate** `string` *required*
>
> Invoice issue date (YYYY-MM-DD)
>
> **paymentDate** `string`
>
> Payment/due date (YYYY-MM-DD)
>
> **paymentType** `string`
>
> Payment method: 'CASH' for cash payment, 'TRANSFER' for bank transfer, or other payment type
>
> **customerName** `string`
>
> Customer name (required when createNewCustomerIfNeeded is true)
>
> **splitPayment** `boolean`
>
> Enable split payment mechanism (relevant for certain tax jurisdictions)
>
> **issuingPerson** `string`
>
> Person responsible for issuing this invoice
>
> **customerAddress** `object`
>
> Address object for the customer on this invoice
>
> **restOfPaidValue** `number`
>
> Remaining amount due
>
> **transactionDate** `string` *required*
>
> Accounting date for the transaction (YYYY-MM-DD)
>
> **invoicePatternId** `integer`
>
> Invoice numbering pattern/series ID (optional, uses default if not specified)
>
> **transactionNumber** `string`
>
> Explicit document number (if not using auto numbering)
>
> **calculateFromGross** `boolean`
>
> If true, calculate netto values from brutto
>
> **invoiceAnnotations** `string`
>
> Free-text annotation or note on the invoice
>
> **transactionEntries** `array` *required*
>
> List of invoice line items
>
> **transactionVatPrice** `number` *required*
>
> Total VAT amount on the invoice
>
> **transactionNettoPrice** `number` *required*
>
> Total net amount of the invoice
>
> **transactionBruttoPrice** `number` *required*
>
> Total gross amount of the invoice
>
> **createNewCustomerIfNeeded** `boolean`
>
> Set to true to auto-create a new customer with provided details; requires customerName, emails, and/or phones
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Company Setting
>
> **Slug:** `FIRMAO_DELETE_COMPANY_SETTING`
>
> Deletes a company setting by its unique identifier. Returns success status and details about the deletion attempt. Use this when you need to permanently remove a specific company setting configuration.
>
> #### Input Parameters
>
> **setting\_id** `string` *required*
>
> Unique identifier of the company setting to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Contact
>
> **Slug:** `FIRMAO_DELETE_CONTACT`
>
> Soft-deletes a contact in Firmao CRM by marking it as deleted (sets deleted=true). This action sends a PUT request to mark the contact as deleted without permanently removing it from the system. The contact can potentially be restored later through the Firmao interface. Returns a changelog documenting the deletion operation. Use this when you need to remove a contact from active use in Firmao CRM.
>
> #### Input Parameters
>
> **contact\_id** `integer` *required*
>
> Unique numeric identifier of the contact to delete. Must be a positive integer representing an existing contact in your Firmao account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Invoice
>
> **Slug:** `FIRMAO_DELETE_INVOICE`
>
> Soft-delete a Firmao invoice by marking its transaction as deleted. The record remains in the system and can be restored.
>
> #### Input Parameters
>
> **invoice\_id** `integer` *required*
>
> Unique numeric ID of the invoice (transaction) to soft-delete by marking it as deleted
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Offer
>
> **Slug:** `FIRMAO_DELETE_OFFER`
>
> Soft-delete a Firmao offer by marking it as deleted. The offer remains in the system and can be restored.
>
> #### Input Parameters
>
> **offer\_id** `integer` *required*
>
> Numeric ID of the offer to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Invoice
>
> **Slug:** `FIRMAO_GET_INVOICE`
>
> Retrieves invoice transaction details by ID, including customer, payment, pricing and metadata fields.
>
> #### Input Parameters
>
> **invoice\_id** `integer` *required*
>
> Unique identifier of the invoice to retrieve. Must be a positive integer representing an existing invoice/transaction ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Offer
>
> **Slug:** `FIRMAO_GET_OFFER`
>
> Retrieves an offer from the connected Firmao organization by ID, including customer details, pricing, payment information and metadata.
>
> #### Input Parameters
>
> **offer\_id** `integer` *required*
>
> Unique numeric identifier of the offer to retrieve from Firmao system
>
> **dataFormat** `string ("SHORT" | "MEDIUM" | "FULL")`
>
> Level of detail in the API response: SHORT returns minimal fields, MEDIUM returns standard fields (default), FULL returns all available fields including custom fields and extended metadata
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Task
>
> **Slug:** `FIRMAO_GET_TASK`
>
> Retrieves task details by ID, including status, dates, responsible users, progress, financial data and related entities.
>
> #### Input Parameters
>
> **dir** `string`
>
> Sort direction: ASC (ascending) or DESC (descending)
>
> **sort** `string`
>
> Field name to sort results by (typically not needed for single task retrieval)
>
> **limit** `integer`
>
> Maximum number of results to return (typically set to 1 for single task retrieval)
>
> **start** `integer`
>
> Starting index for pagination (typically not needed for single task retrieval)
>
> **taskId** `integer` *required*
>
> Unique identifier of the task to retrieve
>
> **dataFormat** `string`
>
> Level of detail in the response. Options: MINIMAL (basic fields only), MEDIUM (standard fields), FULL (all fields including extended data)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Company Settings
>
> **Slug:** `FIRMAO_LIST_COMPANY_SETTINGS`
>
> Lists Firmao company settings with optional company ID filtering and pagination.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of settings to return
>
> **start** `integer`
>
> Zero-based offset of the first setting to return
>
> **company\_id** `integer`
>
> Optional filter to return settings for a specific company
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Invoices
>
> **Slug:** `FIRMAO_LIST_INVOICES`
>
> Tool to list invoices. Use when retrieving a list of invoices with optional pagination and filtering.
>
> #### Input Parameters
>
> **dir** `string ("ASC" | "DESC")`
>
> Sort direction
>
> **mode** `string`
>
> Filter by invoice mode, e.g., 'SALE'
>
> **sort** `string`
>
> Field to sort by
>
> **limit** `integer`
>
> Max results per page
>
> **start** `integer`
>
> Pagination start index
>
> **customer** `integer`
>
> Filter by customer ID
>
> **dataFormat** `string`
>
> Response size preset, e.g., 'MEDIUM'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Tasks
>
> **Slug:** `FIRMAO_LIST_TASKS`
>
> Retrieves a paginated list of tasks from Firmao. Returns task details including status, priority, dates, responsible users, tags, and financial data. Supports sorting, filtering by various fields, and configurable detail levels (MINIMAL, MEDIUM, FULL).
>
> #### Input Parameters
>
> **dir** `string ("ASC" | "DESC")`
>
> Sort direction
>
> **sort** `string`
>
> Field name to sort by
>
> **limit** `integer`
>
> Maximum number of records per page
>
> **start** `integer`
>
> 0-based offset of the first record
>
> **filters** `object`
>
> Query filters as key-value pairs where keys follow the format 'FieldName(ComparisonType)'. Supported comparison types: eq (equals), gte (greater than or equal), lte (less than or equal). Example: \{'status(eq)': 'OPEN', 'priority(gte)': 5}
>
> **dataFormat** `string ("MINIMAL" | "MEDIUM" | "FULL")`
>
> Level of detail for returned fields
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Contact in Firmao
>
> **Slug:** `FIRMAO_UPDATE_CONTACT`
>
> Updates an existing contact in Firmao CRM by its ID. Use this tool to modify contact information such as name, email, phone, position, or customer association. Only include the fields you want to change - omitted fields will remain unchanged. Returns a changelog of the modifications made. Prerequisites: - The contact ID must exist in your Firmao organization - If updating the customer field, the customer ID must already exist
>
> #### Input Parameters
>
> **tags** `array`
>
> List of tags/labels for categorizing this contact
>
> **label** `string`
>
> Display name or label for the contact (typically the full name)
>
> **emails** `array`
>
> List of email addresses for the contact (will replace existing emails)
>
> **phones** `array`
>
> List of phone numbers for the contact (will replace existing phones)
>
> **customer** `integer`
>
> Customer/company ID to associate this contact with (must be an existing customer ID in Firmao)
>
> **lastName** `string`
>
> Contact's last (family) name
>
> **position** `string`
>
> Contact's job title or role within the organization
>
> **firstName** `string`
>
> Contact's first (given) name
>
> **contact\_id** `integer` *required*
>
> The unique ID of the contact to update (must already exist in Firmao)
>
> **description** `string`
>
> Free-text notes or description about this contact
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Offer
>
> **Slug:** `FIRMAO_UPDATE_OFFER`
>
> Updates an existing offer/quote in Firmao by ID. Modifies specified fields while preserving unspecified ones. Returns a changelog detailing what changed. Supports partial updates - only provide fields you want to change.
>
> #### Input Parameters
>
> **mode** `string ("SALE" | "PURCHASE")`
>
> Transaction mode; one of SALE, PURCHASE
>
> **name** `string`
>
> Offer name or label
>
> **tags** `array`
>
> List of tags
>
> **task** `integer`
>
> Task ID to link
>
> **type** `string ("OFFER" | "ORDER" | "AGREEMENT")`
>
> Document type; one of OFFER, ORDER, AGREEMENT
>
> **number** `string`
>
> Offer number
>
> **contact** `object`
>
> Linked contact object as in GET response
>
> **entries** `array`
>
> List of line items; send only entries to update
>
> **project** `integer`
>
> Project ID to link
>
> **currency** `string`
>
> Currency code, e.g., 'PLN'
>
> **customer** `integer`
>
> Customer ID to link
>
> **offer\_id** `integer` *required*
>
> Identifier of the offer to update
>
> **offerDate** `string`
>
> Date of the offer, format YYYY-MM-DD
>
> **validFrom** `string`
>
> Valid-from date, format YYYY-MM-DD
>
> **annotations** `string`
>
> Offer annotations
>
> **description** `string`
>
> Offer description
>
> **offerStatus** `string ("NEW" | "SENT" | "DURING_NEGOTIATIONS" | "ACCEPTED" | "REJECTED" | "EXECUTED")`
>
> Current offer status
>
> **paymentDate** `string`
>
> Payment date, format YYYY-MM-DD
>
> **paymentType** `string`
>
> Payment method, e.g., 'CASH'
>
> **customerName** `string`
>
> Free-text customer name
>
> **daysToDueDate** `integer`
>
> Days until due date
>
> **issuingPerson** `string`
>
> Name of issuing person
>
> **customerAddress** `object`
>
> Customer postal data
>
> **reminderAdvance** `string`
>
> Reminder advance value
>
> **calculateFromGross** `boolean`
>
> Whether totals are calculated from gross
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Task
>
> **Slug:** `FIRMAO_UPDATE_TASK`
>
> Tool to update an existing task. Use when you need to modify one or more fields of a task after confirming its current details.
>
> #### Input Parameters
>
> **name** `string`
>
> Task name
>
> **tags** `array`
>
> List of tag IDs
>
> **parent** `integer`
>
> Parent task ID, for subtasks
>
> **status** `string`
>
> Task status key
>
> **task\_id** `integer` *required*
>
> ID of the task to update
>
> **priority** `integer`
>
> Priority value
>
> **description** `string`
>
> Task description
>
> **percentDone** `number`
>
> Percent completion of the task
>
> **estimatedHours** `number`
>
> Estimated hours for task completion
>
> **plannedEndDate** `string`
>
> Planned end date (ISO-8601)
>
> **plannedStartDate** `string`
>
> Planned start date (ISO-8601)
>
> **responsibleUsers** `array`
>
> List of responsible users
>
> **plannedEndDateType** `string`
>
> Type for planned end date
>
> **plannedStartDateType** `string`
>
> Type for planned start date
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
