NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Firmao

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.

CRMBusiness IntelligenceWeb del proveedor
Acciones
15
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (15)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create InvoiceFIRMAO_CREATE_INVOICEAcción

Tool to create an invoice. Use after gathering all invoice details.

Parámetros de entrada

  • modestringenum

    Document mode; 'SALE' for sales invoices

    SALEPURCHASE
  • paidboolean

    Whether the invoice is already paid

  • typestring

    Fixed to 'INVOICE' to create an invoice

  • emailsstring[]

    List of emails for new customer

  • phonesstring[]

    List of phone numbers for new customer

  • currencystringObligatorio

    Invoice currency code, e.g., 'PLN'

  • customerinteger

    Existing customer ID (if not creating new customer)

  • paidValuenumber

    Amount already paid

  • autoNumberboolean

    Let system assign invoice number automatically

  • invoiceDatestringObligatoriodate

    Invoice issue date (YYYY-MM-DD)

  • paymentDatestringdate

    Payment/due date (YYYY-MM-DD)

  • paymentTypestring

    Payment method, e.g., 'CASH' or 'TRANSFER'

  • customerNamestring

    Name for new customer (if auto-creating)

  • splitPaymentboolean

    Flag for split payment (if applicable)

  • issuingPersonstring

    Person responsible for issuing this invoice

  • customerAddressobject

    Address object for the customer on this invoice

  • organization_idstringObligatorio

    Firmao Organization ID used as path parameter

  • restOfPaidValuenumber

    Remaining amount due

  • transactionDatestringObligatoriodate

    Accounting date for the transaction (YYYY-MM-DD)

  • invoicePatternIdinteger

    Numbering series identifier

  • transactionNumberstring

    Explicit document number (if not using auto numbering)

  • calculateFromGrossboolean

    If true, calculate netto values from brutto

  • invoiceAnnotationsstring

    Free-text annotation or note on the invoice

  • transactionEntriesobject[]Obligatorio

    List of invoice line items

  • transactionVatPricenumberObligatorio

    Total VAT amount on the invoice

  • transactionNettoPricenumberObligatorio

    Total net amount of the invoice

  • transactionBruttoPricenumberObligatorio

    Total gross amount of the invoice

  • createNewCustomerIfNeededboolean

    Auto-create customer if they do not exist

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Company SettingFIRMAO_DELETE_COMPANY_SETTINGAcción

Tool to delete a specific company setting. Use when you need to remove a company setting by its unique ID after confirming the ID is valid.

Parámetros de entrada

  • setting_idstringObligatorio

    Unique identifier of the company setting to delete

  • organization_idstring

    Firmao organization identifier used in the URL path

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete ContactFIRMAO_DELETE_CONTACTAcción

Tool to delete a contact by marking it as deleted. Use when you need to soft-delete a contact after confirming its existence.

Parámetros de entrada

  • contact_idintegerObligatorio

    Numeric ID of the contact to delete

  • organization_idstringObligatorio

    Your organization identifier (found in URL after login)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete InvoiceFIRMAO_DELETE_INVOICEAcción

Tool to delete an invoice. Use when you need to soft-delete a specific invoice by marking it deleted=true. Implements robust endpoint fallbacks and graceful degradation to ensure a validated response even when the API denies access or returns unexpected shapes.

Parámetros de entrada

  • invoice_idintegerObligatorio

    ID of the invoice (transaction) to delete

  • organization_idstringObligatorio

    Your organization identifier (found in URL after login)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete OfferFIRMAO_DELETE_OFFERAcción

Tool to delete an offer. Use when you need to soft-delete an existing offer by marking its deleted flag to true. After this call, the offer is considered deleted within the system.

Parámetros de entrada

  • offer_idintegerObligatorio

    Numeric ID of the offer to delete.

  • organization_idstringObligatorio

    Identifier of the organization (as used in the API URL).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get InvoiceFIRMAO_GET_INVOICEAcción

Tool to retrieve a specific invoice by its ID. Use when you need the full invoice data by its unique ID.

Parámetros de entrada

  • invoice_idintegerObligatorio

    ID of the invoice (transaction) to retrieve

  • organization_idstringObligatorio

    Firmao organization identifier used in the path

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get OfferFIRMAO_GET_OFFERAcción

Tool to retrieve offer details. Use when you need complete information for a specific offer by ID.

Parámetros de entrada

  • offer_idintegerObligatorio

    Numeric ID of the offer to retrieve

  • dataFormatstringenum

    Response verbosity level

    SHORTMEDIUMFULL
  • organization_idstringObligatorio

    Firmao organization ID used in the URL path

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get TaskFIRMAO_GET_TASKAcción

Tool to retrieve details of a specific task by its ID. Use when you need to fetch a task after knowing its ID.

Parámetros de entrada

  • dirstring

    Sort direction: ASC or DESC

  • sortstring

    Field to sort by

  • limitinteger

    Maximum number of items to return

  • startinteger

    Pagination start index

  • task_idintegerObligatorio

    ID of the task to retrieve

  • dataFormatstring

    Detail level of the returned data, e.g., MEDIUM

  • organization_idstringObligatorio

    Firmao organization identifier (as shown in the URL)

Parámetros de salida

  • dirstring

    Echoed sort direction

  • dataobject[]Obligatorio

    List containing the requested task

  • sortstring

    Echoed sort field

  • errorstring

    Error if any occurred during the execution of the action

  • totalSizeinteger

    Total number of matching tasks

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Company SettingsFIRMAO_LIST_COMPANY_SETTINGSAcción

Tool to list company settings. Use when retrieving custom configurations for a company, optionally filtered by organization or company ID.

Parámetros de entrada

  • limitinteger

    Maximum number of settings to return

  • startinteger

    Zero-based offset of the first setting to return

  • company_idinteger

    Optional filter to return settings for a specific company

  • organization_idstring

    Optional Firmao organization identifier used in the URL path

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List InvoicesFIRMAO_LIST_INVOICESAcción

Tool to list invoices. Use when retrieving a list of invoices with optional pagination and filtering.

Parámetros de entrada

  • dirstringenum

    Sort direction

    ASCDESC
  • sortstring

    Field to sort by

  • limitinteger

    Max results per page

  • startinteger

    Pagination start index

  • mode(eq)string

    Filter by invoice mode, e.g., 'SALE'

  • dataFormatstring

    Response size preset, e.g., 'MEDIUM'

  • customer(eq)integer

    Filter by customer ID

  • organization_idstringObligatorio

    Firmao Organization ID used as path parameter

Parámetros de salida

  • dirstringObligatorio

    Sort direction

  • dataobject[]Obligatorio

    Paged list of invoices

  • sortstringObligatorio

    Sort field

  • errorstring

    Error if any occurred during the execution of the action

  • totalSizeintegerObligatorio

    Total number of matching invoices

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List TasksFIRMAO_LIST_TASKSAcción

Tool to retrieve a list of tasks. Use when browsing tasks with pagination, sorting, or filters after confirming organization ID.

Parámetros de entrada

  • dirstringenum

    Sort direction

    ASCDESC
  • sortstring

    Field name to sort by

  • limitinteger

    Maximum number of records per page

  • startinteger

    0-based offset of the first record

  • filtersobject

    Filters in the form FieldName(ComparisonType)=value

  • dataFormatstringenum

    Level of detail for returned fields

    MINIMALMEDIUMFULL
  • organization_idstringObligatorio

    Firmao organization identifier (as shown in the URL)

Parámetros de salida

  • dirstring

    Direction used for sorting (ASC/DESC)

  • dataobject[]Obligatorio

    List of returned tasks

  • sortstring

    Field used for sorting

  • errorstring

    Error if any occurred during the execution of the action

  • totalSizeintegerObligatorio

    Total number of records matching the query

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update ContactFIRMAO_UPDATE_CONTACTAcción

Tool to update a contact. Use when you need to modify an existing contact by its ID after retrieving its details.

Parámetros de entrada

  • tagsstring[]

    List of tags associated with the contact

  • labelstring

    Display label for the contact

  • emailsstring[]

    List of email addresses for the contact

  • phonesstring[]

    List of phone numbers for the contact

  • customerinteger

    Customer ID to link this contact to

  • lastNamestring

    Contact's last name

  • positionstring

    Contact's position or job title

  • firstNamestring

    Contact's first name

  • contact_idintegerObligatorio

    ID of the contact to update

  • descriptionstring

    Free-text description about the contact

  • organization_idstringObligatorio

    Firmao Organization ID used as path parameter

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update InvoiceFIRMAO_UPDATE_INVOICEAcción

Tool to update an invoice. Use when you need to modify an existing invoice by its ID after retrieving its details.

Parámetros de entrada

  • modestringObligatorioenum
    SALEPURCHASE
  • paidboolean
  • typestring

    Fixed to 'INVOICE' to designate invoice

  • emailsstring[]
  • phonesstring[]
  • currencystring
  • customerinteger

    Existing customer ID

  • nipNumberstring

    Tax identification number

  • paidValuenumber

    Amount already paid

  • autoNumberboolean

    Let system auto-number invoice

  • invoice_idintegerObligatorio

    ID of the invoice (transaction) to update

  • invoiceDatestringdate

    Invoice issue date (YYYY-MM-DD)

  • paymentDatestringdate

    Payment due date (YYYY-MM-DD)

  • paymentTypestring

    Payment method, e.g., 'CASH'

  • customerNamestring

    Name for new customer if created

  • splitPaymentboolean

    Flag for split payment

  • issuingPersonstring

    Person issuing the invoice

  • customerAddressobject

    Address for the customer

  • organization_idstringObligatorio

    Firmao Organization ID used as path parameter

  • restOfPaidValuenumber

    Remaining amount due

  • transactionDatestringdate

    Accounting date (YYYY-MM-DD)

  • invoicePatternIdinteger

    Numbering series identifier

  • transactionNumberstring

    Custom invoice number

  • calculateFromGrossboolean

    Calculate netto from gross

  • invoiceAnnotationsstring

    Custom notes on the invoice

  • transactionEntriesobject[]

    List of invoice line items to update

  • transactionVatPricenumber

    Total VAT amount

  • transactionNettoPricenumber

    Total net amount

  • transactionBruttoPricenumber

    Total gross amount

  • createNewCustomerIfNeededboolean

    Auto-create customer if not existing

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update OfferFIRMAO_UPDATE_OFFERAcción

Tool to update an existing offer. Use when you need to modify offer fields after creation.

Parámetros de entrada

  • modestringenum

    Transaction mode; one of SALE, PURCHASE

    SALEPURCHASE
  • namestring

    Offer name or label

  • tagsstring[]

    List of tags

  • taskinteger

    Task ID to link

  • typestringenum

    Document type; one of OFFER, ORDER, AGREEMENT

    OFFERORDERAGREEMENT
  • numberstring

    Offer number

  • contactobject

    Linked contact object as in GET response

  • entriesobject[]

    List of line items; send only entries to update

  • projectinteger

    Project ID to link

  • currencystring

    Currency code, e.g., 'PLN'

  • customerinteger

    Customer ID to link

  • offer_idintegerObligatorio

    Identifier of the offer to update

  • offerDatestring

    Date of the offer, format YYYY-MM-DD

  • validFromstring

    Valid-from date, format YYYY-MM-DD

  • annotationsstring

    Offer annotations

  • descriptionstring

    Offer description

  • offerStatusstringenum

    Current offer status

    NEWSENTDURING_NEGOTIATIONSACCEPTEDREJECTEDEXECUTED
  • paymentDatestring

    Payment date, format YYYY-MM-DD

  • paymentTypestring

    Payment method, e.g., 'CASH'

  • customerNamestring

    Free-text customer name

  • daysToDueDateinteger

    Days until due date

  • issuingPersonstring

    Name of issuing person

  • customerAddressobject

    Customer postal data

  • organization_idstringObligatorio

    Organization ID used in the path

  • reminderAdvancestring

    Reminder advance value

  • calculateFromGrossboolean

    Whether totals are calculated from gross

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update TaskFIRMAO_UPDATE_TASKAcción

Tool to update an existing task. Use when you need to modify one or more fields of a task after confirming its current details.

Parámetros de entrada

  • namestring

    Task name

  • tagsobject[]

    List of tag IDs

  • parentinteger

    Parent task ID, for subtasks

  • statusstring

    Task status key

  • task_idintegerObligatorio

    ID of the task to update

  • priorityinteger

    Priority value

  • descriptionstring

    Task description

  • percentDonenumber

    Percent completion of the task

  • estimatedHoursnumber

    Estimated hours for task completion

  • plannedEndDatestring

    Planned end date (ISO-8601)

  • organization_idstringObligatorio

    Organization identifier (string or numeric as in Firmao URL)

  • plannedStartDatestring

    Planned start date (ISO-8601)

  • responsibleUsersobject[]

    List of responsible users

  • plannedEndDateTypestring

    Type for planned end date

  • plannedStartDateTypestring

    Type for planned start date

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not