Skip to main content
Firmao logo
  • Category: crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 14
  • Triggers: 0
  • Slug: FIRMAO
  • Version: 20261101_00

Tools

Slug: FIRMAO_CREATE_INVOICECreates 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

string ("SALE" | "PURCHASE")
Document mode; ‘SALE’ for sales invoices
boolean
Whether the invoice is already paid
string
Fixed to ‘INVOICE’ to create an invoice
array
List of emails for new customer
array
List of phone numbers for new customer
string
required
Invoice currency code in ISO 4217 format (e.g., ‘PLN’, ‘EUR’, ‘USD’, ‘GBP’)
integer
Existing customer ID from Firmao (mutually exclusive with createNewCustomerIfNeeded)
number
Amount already paid
boolean
Let system assign invoice number automatically (recommended); set to false to provide explicit transactionNumber
string
required
Invoice issue date (YYYY-MM-DD)
string
Payment/due date (YYYY-MM-DD)
string
Payment method: ‘CASH’ for cash payment, ‘TRANSFER’ for bank transfer, or other payment type
string
Customer name (required when createNewCustomerIfNeeded is true)
boolean
Enable split payment mechanism (relevant for certain tax jurisdictions)
string
Person responsible for issuing this invoice
object
Address object for the customer on this invoice
number
Remaining amount due
string
required
Accounting date for the transaction (YYYY-MM-DD)
integer
Invoice numbering pattern/series ID (optional, uses default if not specified)
string
Explicit document number (if not using auto numbering)
boolean
If true, calculate netto values from brutto
string
Free-text annotation or note on the invoice
array
required
List of invoice line items
number
required
Total VAT amount on the invoice
number
required
Total net amount of the invoice
number
required
Total gross amount of the invoice
boolean
Set to true to auto-create a new customer with provided details; requires customerName, emails, and/or phones

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRMAO_DELETE_COMPANY_SETTINGDeletes 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

string
required
Unique identifier of the company setting to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRMAO_DELETE_CONTACTSoft-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

integer
required
Unique numeric identifier of the contact to delete. Must be a positive integer representing an existing contact in your Firmao account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRMAO_DELETE_INVOICESoft-delete a Firmao invoice by marking its transaction as deleted. The record remains in the system and can be restored.

Input Parameters

integer
required
Unique numeric ID of the invoice (transaction) to soft-delete by marking it as deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRMAO_DELETE_OFFERSoft-delete a Firmao offer by marking it as deleted. The offer remains in the system and can be restored.

Input Parameters

integer
required
Numeric ID of the offer to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRMAO_GET_INVOICERetrieves invoice transaction details by ID, including customer, payment, pricing and metadata fields.

Input Parameters

integer
required
Unique identifier of the invoice to retrieve. Must be a positive integer representing an existing invoice/transaction ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRMAO_GET_OFFERRetrieves an offer from the connected Firmao organization by ID, including customer details, pricing, payment information and metadata.

Input Parameters

integer
required
Unique numeric identifier of the offer to retrieve from Firmao system
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRMAO_GET_TASKRetrieves task details by ID, including status, dates, responsible users, progress, financial data and related entities.

Input Parameters

string
Sort direction: ASC (ascending) or DESC (descending)
string
Field name to sort results by (typically not needed for single task retrieval)
integer
Maximum number of results to return (typically set to 1 for single task retrieval)
integer
Starting index for pagination (typically not needed for single task retrieval)
integer
required
Unique identifier of the task to retrieve
string
Level of detail in the response. Options: MINIMAL (basic fields only), MEDIUM (standard fields), FULL (all fields including extended data)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRMAO_LIST_COMPANY_SETTINGSLists Firmao company settings with optional company ID filtering and pagination.

Input Parameters

integer
Maximum number of settings to return
integer
Zero-based offset of the first setting to return
integer
Optional filter to return settings for a specific company

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRMAO_LIST_INVOICESTool to list invoices. Use when retrieving a list of invoices with optional pagination and filtering.

Input Parameters

string ("ASC" | "DESC")
Sort direction
string
Filter by invoice mode, e.g., ‘SALE’
string
Field to sort by
integer
Max results per page
integer
Pagination start index
integer
Filter by customer ID
string
Response size preset, e.g., ‘MEDIUM’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRMAO_LIST_TASKSRetrieves 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

string ("ASC" | "DESC")
Sort direction
string
Field name to sort by
integer
Maximum number of records per page
integer
0-based offset of the first record
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}
string ("MINIMAL" | "MEDIUM" | "FULL")
Level of detail for returned fields

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRMAO_UPDATE_CONTACTUpdates 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

array
List of tags/labels for categorizing this contact
string
Display name or label for the contact (typically the full name)
array
List of email addresses for the contact (will replace existing emails)
array
List of phone numbers for the contact (will replace existing phones)
integer
Customer/company ID to associate this contact with (must be an existing customer ID in Firmao)
string
Contact’s last (family) name
string
Contact’s job title or role within the organization
string
Contact’s first (given) name
integer
required
The unique ID of the contact to update (must already exist in Firmao)
string
Free-text notes or description about this contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRMAO_UPDATE_OFFERUpdates 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

string ("SALE" | "PURCHASE")
Transaction mode; one of SALE, PURCHASE
string
Offer name or label
array
List of tags
integer
Task ID to link
string ("OFFER" | "ORDER" | "AGREEMENT")
Document type; one of OFFER, ORDER, AGREEMENT
string
Offer number
object
Linked contact object as in GET response
array
List of line items; send only entries to update
integer
Project ID to link
string
Currency code, e.g., ‘PLN’
integer
Customer ID to link
integer
required
Identifier of the offer to update
string
Date of the offer, format YYYY-MM-DD
string
Valid-from date, format YYYY-MM-DD
string
Offer annotations
string
Offer description
string ("NEW" | "SENT" | "DURING_NEGOTIATIONS" | "ACCEPTED" | "REJECTED" | "EXECUTED")
Current offer status
string
Payment date, format YYYY-MM-DD
string
Payment method, e.g., ‘CASH’
string
Free-text customer name
integer
Days until due date
string
Name of issuing person
object
Customer postal data
string
Reminder advance value
boolean
Whether totals are calculated from gross

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIRMAO_UPDATE_TASKTool 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

string
Task name
array
List of tag IDs
integer
Parent task ID, for subtasks
string
Task status key
integer
required
ID of the task to update
integer
Priority value
string
Task description
number
Percent completion of the task
number
Estimated hours for task completion
string
Planned end date (ISO-8601)
string
Planned start date (ISO-8601)
array
List of responsible users
string
Type for planned end date
string
Type for planned start date

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not