Finmei
finmeiFinmei is an invoicing tool designed to simplify billing processes, allowing users to create and manage invoices and track expenses efficiently.
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ónTool 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.
FINMEI_CREATE_INVOICEAcciónTool 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
codestringOptional custom invoice code or reference
typestringInvoice type required by API, e.g., 'invoice' or 'income'
buyerobjectBuyer object; required by API when not using customer_id
notesstringOptional notes to appear on the invoice
sellerobjectSeller object if not using default
seriesstringSeries code/prefix for the invoice
currencystringISO 4217 three-letter currency code
customerobjectInline customer details; mutually exclusive with `customer_id`
due_datestringPayment due date (YYYY-MM-DD)
productsobject[]Products array as required by API
issue_datestringDate the invoice was issued (YYYY-MM-DD)
line_itemsobject[]List of line items for the invoice
customer_idstringID of an existing customer; mutually exclusive with `customer`
invoice_datestringInvoice date as expected by the API (YYYY-MM-DD)
use_default_seller_infobooleanIf true, API will use default seller info instead of requiring seller object
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete CustomerFINMEI_DELETE_CUSTOMERAcciónTool to delete a specific customer by their ID. Use after confirming the correct customer_id to remove the record.
FINMEI_DELETE_CUSTOMERAcciónTool to delete a specific customer by their ID. Use after confirming the correct customer_id to remove the record.
Parámetros de entrada
customer_idstringObligatorioUnique identifier of the customer to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete InvoiceFINMEI_DELETE_INVOICEAcciónTool to delete an invoice. Use when you need to remove an existing invoice by its ID.
FINMEI_DELETE_INVOICEAcciónTool to delete an invoice. Use when you need to remove an existing invoice by its ID.
Parámetros de entrada
invoice_idstringObligatorioThe unique identifier of the invoice to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete PaymentFINMEI_DELETE_PAYMENTAcciónTool to delete a payment. Use when you need to remove a payment by its ID after confirming it's obsolete.
FINMEI_DELETE_PAYMENTAcciónTool 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_idstringObligatorioUnique identifier of the payment to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ProductFINMEI_DELETE_PRODUCTAcciónTool to delete a product by its ID. Use when you need to permanently remove a product from the catalog.
FINMEI_DELETE_PRODUCTAcciónTool to delete a product by its ID. Use when you need to permanently remove a product from the catalog.
Parámetros de entrada
product_idstringObligatorioID of the product to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get PaymentFINMEI_GET_PAYMENTAcciónTool to retrieve details of a specific payment by its ID. Use after creating a payment or when you need to confirm payment details.
FINMEI_GET_PAYMENTAcciónTool 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_idstringObligatorioUnique identifier of the payment to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Product by IDFINMEI_GET_PRODUCTAcciónTool to retrieve a product by its ID. Use when you need detailed information about a single product.
FINMEI_GET_PRODUCTAcciónTool to retrieve a product by its ID. Use when you need detailed information about a single product.
Parámetros de entrada
product_idstringObligatorioUnique identifier of the product to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List CurrenciesFINMEI_LIST_CURRENCIESAcciónTool to list all currencies supported by Finmei. Use when you need to retrieve available currency codes before creating transactions.
FINMEI_LIST_CURRENCIESAcciónTool 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
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List CustomersFINMEI_LIST_CUSTOMERSAcciónTool to list all customers with optional filters and pagination. Use when needing to browse or search customer records.
FINMEI_LIST_CUSTOMERSAcciónTool to list all customers with optional filters and pagination. Use when needing to browse or search customer records.
Parámetros de entrada
pageintegerPage number to retrieve (must be >= 1)
sortstringSort order, e.g., 'name_asc' or 'created_at_desc'
searchstringSearch term to filter customers by name or email
per_pageintegerNumber of customers per page (1-100)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List InvoicesFINMEI_LIST_INVOICESAcciónTool to list invoices. Use when you need a paginated list of invoices with basic details.
FINMEI_LIST_INVOICESAcciónTool to list invoices. Use when you need a paginated list of invoices with basic details.
Parámetros de entrada
pageintegerPage number to retrieve (must be >= 1)
per_pageintegerNumber of invoices per page (1-100)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List PaymentsFINMEI_LIST_PAYMENTSAcciónTool to retrieve a list of payments. Use when you need to view past payment records with optional filters and pagination.
FINMEI_LIST_PAYMENTSAcciónTool to retrieve a list of payments. Use when you need to view past payment records with optional filters and pagination.
Parámetros de entrada
limitintegerNumber of payments to retrieve (default 20, max 100)
offsetintegerNumber of payments to skip for pagination
statusstringenumFilter payments by status
pendingcompletedfailedend_datestringFilter payments created on or before this date (ISO 8601 format)
start_datestringFilter payments created on or after this date (ISO 8601 format)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ProductsFINMEI_LIST_PRODUCTSAcciónTool to retrieve a list of products with optional filters and pagination. Use when you need to browse or filter the product catalog.
FINMEI_LIST_PRODUCTSAcciónTool 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
namestringFilter products by name substring.
pageintegerPage number for pagination (1-indexed).
statusstringenumFilter products by their status.
activeinactiveper_pageintegerNumber of products per page.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update CustomerFINMEI_UPDATE_CUSTOMERAcciónTool to update an existing customer's details. Use after confirming the customer ID to modify their information.
FINMEI_UPDATE_CUSTOMERAcciónTool to update an existing customer's details. Use after confirming the customer ID to modify their information.
Parámetros de entrada
namestringFull name of the customer
emailstringEmail address of the customer
phonestringPhone number of the customer
addressobjectMailing address details
metadataobjectAdditional metadata for the customer as key-value pairs
customer_idstringObligatorioUnique identifier of the customer to update
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ProductFINMEI_UPDATE_PRODUCTAcciónTool to update an existing product's details. Use when you need to modify product information after confirming the product ID.
FINMEI_UPDATE_PRODUCTAcciónTool to update an existing product's details. Use when you need to modify product information after confirming the product ID.
Parámetros de entrada
namestringName of the product
pricenumberPrice of the product, must be non-negative
currencystringCurrency code of the product price, e.g., USD
product_idstringObligatorioUnique identifier of the product to update
descriptionstringDescription of the product
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not