Volver al catálogo

Finmei

finmei

Finmei is an invoicing tool designed to simplify billing processes, allowing users to create and manage invoices and track expenses efficiently.

Acciones
14
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 (14)

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 InvoiceFINMEI_CREATE_INVOICEAcción

Tool to create a new invoice. Use when you have all invoice details ready and need to record it. Example: "Create an invoice for customer X with two items.

Parámetros de entrada

  • codestring

    Optional custom invoice code or reference

  • typestring

    Invoice type required by API, e.g., 'invoice' or 'income'

  • buyerobject

    Buyer object; required by API when not using customer_id

  • notesstring

    Optional notes to appear on the invoice

  • sellerobject

    Seller object if not using default

  • seriesstring

    Series code/prefix for the invoice

  • currencystring

    ISO 4217 three-letter currency code

  • customerobject

    Inline customer details; mutually exclusive with `customer_id`

  • due_datestring

    Payment due date (YYYY-MM-DD)

  • productsobject[]

    Products array as required by API

  • issue_datestring

    Date the invoice was issued (YYYY-MM-DD)

  • line_itemsobject[]

    List of line items for the invoice

  • customer_idstring

    ID of an existing customer; mutually exclusive with `customer`

  • invoice_datestring

    Invoice date as expected by the API (YYYY-MM-DD)

  • use_default_seller_infoboolean

    If true, API will use default seller info instead of requiring seller object

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 CustomerFINMEI_DELETE_CUSTOMERAcción

Tool to delete a specific customer by their ID. Use after confirming the correct customer_id to remove the record.

Parámetros de entrada

  • customer_idstringObligatorio

    Unique identifier of the customer to delete

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 InvoiceFINMEI_DELETE_INVOICEAcción

Tool to delete an invoice. Use when you need to remove an existing invoice by its ID.

Parámetros de entrada

  • invoice_idstringObligatorio

    The unique identifier of the invoice to delete

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 PaymentFINMEI_DELETE_PAYMENTAcción

Tool to delete a payment. Use when you need to remove a payment by its ID after confirming it's obsolete.

Parámetros de entrada

  • payment_idstringObligatorio

    Unique identifier of the payment to delete

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 ProductFINMEI_DELETE_PRODUCTAcción

Tool to delete a product by its ID. Use when you need to permanently remove a product from the catalog.

Parámetros de entrada

  • product_idstringObligatorio

    ID of the product to delete

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 PaymentFINMEI_GET_PAYMENTAcción

Tool to retrieve details of a specific payment by its ID. Use after creating a payment or when you need to confirm payment details.

Parámetros de entrada

  • payment_idstringObligatorio

    Unique identifier of the payment to retrieve

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 Product by IDFINMEI_GET_PRODUCTAcción

Tool to retrieve a product by its ID. Use when you need detailed information about a single product.

Parámetros de entrada

  • product_idstringObligatorio

    Unique identifier of the product to retrieve

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 CurrenciesFINMEI_LIST_CURRENCIESAcción

Tool to list all currencies supported by Finmei. Use when you need to retrieve available currency codes before creating transactions.

Parámetros de entrada

Sin parámetros.

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 CustomersFINMEI_LIST_CUSTOMERSAcción

Tool to list all customers with optional filters and pagination. Use when needing to browse or search customer records.

Parámetros de entrada

  • pageinteger

    Page number to retrieve (must be >= 1)

  • sortstring

    Sort order, e.g., 'name_asc' or 'created_at_desc'

  • searchstring

    Search term to filter customers by name or email

  • per_pageinteger

    Number of customers per page (1-100)

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 InvoicesFINMEI_LIST_INVOICESAcción

Tool to list invoices. Use when you need a paginated list of invoices with basic details.

Parámetros de entrada

  • pageinteger

    Page number to retrieve (must be >= 1)

  • per_pageinteger

    Number of invoices per page (1-100)

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 PaymentsFINMEI_LIST_PAYMENTSAcción

Tool to retrieve a list of payments. Use when you need to view past payment records with optional filters and pagination.

Parámetros de entrada

  • limitinteger

    Number of payments to retrieve (default 20, max 100)

  • offsetinteger

    Number of payments to skip for pagination

  • statusstringenum

    Filter payments by status

    pendingcompletedfailed
  • end_datestring

    Filter payments created on or before this date (ISO 8601 format)

  • start_datestring

    Filter payments created on or after this date (ISO 8601 format)

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 ProductsFINMEI_LIST_PRODUCTSAcción

Tool to retrieve a list of products with optional filters and pagination. Use when you need to browse or filter the product catalog.

Parámetros de entrada

  • namestring

    Filter products by name substring.

  • pageinteger

    Page number for pagination (1-indexed).

  • statusstringenum

    Filter products by their status.

    activeinactive
  • per_pageinteger

    Number of products per page.

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 CustomerFINMEI_UPDATE_CUSTOMERAcción

Tool to update an existing customer's details. Use after confirming the customer ID to modify their information.

Parámetros de entrada

  • namestring

    Full name of the customer

  • emailstring

    Email address of the customer

  • phonestring

    Phone number of the customer

  • addressobject

    Mailing address details

  • metadataobject

    Additional metadata for the customer as key-value pairs

  • customer_idstringObligatorio

    Unique identifier of the customer to update

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 ProductFINMEI_UPDATE_PRODUCTAcción

Tool to update an existing product's details. Use when you need to modify product information after confirming the product ID.

Parámetros de entrada

  • namestring

    Name of the product

  • pricenumber

    Price of the product, must be non-negative

  • currencystring

    Currency code of the product price, e.g., USD

  • product_idstringObligatorio

    Unique identifier of the product to update

  • descriptionstring

    Description of the product

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