Skip to main content
Finmei logo
  • Category: accounting
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 24
  • Triggers: 0
  • Slug: FINMEI
  • Version: 20261101_00

Tools

Slug: FINMEI_CREATE_EXPENSETool to create a new expense with file upload (receipt or invoice). Use when you need to record an expense with supporting documentation. Requires multipart/form-data submission with file, date, total, currency, and seller information.

Input Parameters

string
required
Date of the expense in YYYY-MM-DD format
object
required
Receipt file (PDF or image).
number
required
Total amount of the expense, must be non-negative
string
required
Name of the seller/vendor from the invoice or receipt
string
required
Uppercase three-letter ISO 4217 currency code

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: FINMEI_CREATE_INVOICECreates a new invoice in Finmei with buyer information and line items. Use this when you need to generate an invoice for a customer. You can specify: - Buyer details (person or company) - Products/services with quantities and prices - Invoice type (regular, VAT, preliminary, credit) - Currency, dates, and custom notes Example: “Create an invoice for Tech Solutions Inc with 3 months of support services at $99.99/month”

Input Parameters

string
Optional custom invoice code or reference
string ("regular_invoice" | "vat_invoice" | "preliminary_invoice" | "preliminary_vat_invoice" | "credit_invoice" | "credit_vat_invoice")
Invoice type required by API. Valid values: ‘regular_invoice’, ‘vat_invoice’, ‘preliminary_invoice’, ‘preliminary_vat_invoice’, ‘credit_invoice’, ‘credit_vat_invoice’
object
Buyer object; required by API when not using customer_id
string
Optional notes to appear on the invoice
object
Seller object if not using default
string
Series code/prefix for the invoice
string
ISO 4217 three-letter currency code
object
Inline customer details; mutually exclusive with customer_id
string
Payment due date (YYYY-MM-DD)
array
Products array as required by API
string
Date the invoice was issued (YYYY-MM-DD)
array
List of line items for the invoice
string
ID of an existing customer; mutually exclusive with customer
string
Invoice date as expected by the API (YYYY-MM-DD)
boolean
If true, API will use default seller info instead of requiring seller object

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: FINMEI_DELETE_CUSTOMERDeletes a Finmei customer record by its ID.

Input Parameters

string
required
Unique identifier of the customer 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: FINMEI_DELETE_INVOICETool to delete an invoice. Use when you need to remove an existing invoice by its ID.

Input Parameters

string
required
The unique identifier of the invoice 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: FINMEI_DELETE_PAYMENTAttempts to delete a payment record by its unique identifier. A success response can also be returned after a 404, so it does not necessarily confirm deletion.

Input Parameters

string
required
Unique identifier of the payment to delete. This is typically returned from payment creation or list operations.

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: FINMEI_DELETE_PRODUCTDeletes a product from the Finmei catalog by its ID, for example to remove an obsolete or duplicate product.

Input Parameters

string
required
Unique identifier of the product to delete. This is the product’s ID as returned by list_products or get_product operations.

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: FINMEI_DOWNLOAD_EXPENSE_FILETool to download the file associated with an expense. Returns the expense document file (PDF or image). Use when you need to retrieve the actual file content for an expense.

Input Parameters

string
required
Unique identifier of the expense to download the file for

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: FINMEI_DOWNLOAD_INVOICE_PDFTool to download an invoice as a PDF file. Use when you need to retrieve the PDF version of an invoice.

Input Parameters

string
required
The unique identifier of the invoice to download as PDF

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: FINMEI_GET_EXPENSETool to retrieve a single expense by its ID. Use when you need to get details about a specific expense including date, total, currency, and seller information.

Input Parameters

string
required
Unique identifier of the expense to retrieve

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: FINMEI_GET_INVOICETool to retrieve a single invoice by its ID. Use when you need full invoice details including buyer, seller, items, amounts, and payment options.

Input Parameters

string
required
Invoice ID to retrieve

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: FINMEI_GET_PAYMENTLooks up Finmei payment details using a payment ID, such as after creating a payment.

Input Parameters

string
required
Unique identifier of the payment to retrieve

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: FINMEI_GET_PRODUCTTool to retrieve a product by its ID. Use when you need detailed information about a single product.

Input Parameters

string
required
Unique identifier of the product to retrieve

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: FINMEI_GET_PROFILETool to retrieve main information about the business to which the API token is assigned. Use when needing business ID, title, type, address, VAT code, company name, or company code.

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: FINMEI_LIST_CURRENCIESTool to list all currencies supported by Finmei. Use when you need to retrieve available currency codes before creating transactions.

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: FINMEI_LIST_CUSTOMERSLists Finmei customers for browsing or searching, with optional search and sorting. Results are paginated, with 1 to 100 customers per page.

Input Parameters

integer
Page number to retrieve (must be >= 1)
string
Sort order, e.g., ‘name_asc’ or ‘created_at_desc’
Search term to filter customers by name or email
integer
Number of customers per page (1-100)

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: FINMEI_LIST_EXPENSESTool to list all expenses for the business. Use when you need a paginated list of expenses with metadata.

Input Parameters

integer
Page number to retrieve (must be >= 1)
integer
Number of expenses per page (1-100)

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: FINMEI_LIST_INVOICESTool to list invoices. Use when you need a paginated list of invoices with basic details.

Input Parameters

integer
Page number to retrieve (must be >= 1)
integer
Number of invoices per page (1-100)

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: FINMEI_LIST_PAYMENTSLists payment records with optional date filters and limit-and-offset pagination. Results filtered by status are empty. Payments may be drawn from a page of invoices, and pagination is applied to the retrieved results, so the results may be incomplete.

Input Parameters

integer
Number of payments to retrieve (default 20, max 100)
integer
Number of payments to skip for pagination
string ("pending" | "completed" | "failed")
Filter payments by status
string
Filter payments created on or before this date (ISO 8601 format)
string
Filter payments created on or after this date (ISO 8601 format)

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: FINMEI_LIST_PRODUCTSLists Finmei products for browsing or filtering the catalog. Supports optional name and status filters and pagination, with 1 to 100 products per page.

Input Parameters

string
Filter products by name substring.
integer
Page number for pagination (1-indexed).
string ("active" | "inactive")
Filter products by their status.
integer
Number of products per page.

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: FINMEI_UPDATE_CUSTOMERTool to update an existing customer’s details. Use after confirming the customer ID to modify their information.

Input Parameters

string
Full name of the customer
string
Email address of the customer
string
Phone number of the customer
object
Mailing address details
object
Additional metadata for the customer as key-value pairs
string
required
Unique identifier of the customer to update

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: FINMEI_UPDATE_EXPENSEUpdates an existing expense’s date, total, currency, and seller. All four fields are required for each update.

Input Parameters

string
required
Unique identifier of the expense to update. Must be a valid existing expense ID.
string
required
Date of the expense in YYYY-MM-DD format. This field is required.
number
required
Total amount of the expense. Must be non-negative. This field is required.
string
required
Name of the seller from invoice. This field is required.
string
required
Uppercase three letter currency code (ISO 4217 format). Example: USD, EUR, GBP. This field is required.

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: FINMEI_UPDATE_EXPENSE_FILEUpdates the file attachment of an existing expense in Finmei. Use this action when you need to attach or replace a receipt/invoice file for an expense. This endpoint is specifically for updating the file only - use the Update Expense action for updating other expense fields like amount, date, or description. The file is uploaded using multipart/form-data content type and typically should be a PDF or image file of the bill/receipt.

Input Parameters

string
required
Unique identifier of the expense to update the file for. Must be a valid existing expense ID.
object
required
File to upload as the expense attachment (usually PDF or image file of the bill).

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: FINMEI_UPDATE_INVOICETool to update an existing invoice in Finmei. Use when you need to modify invoice details such as buyer information, products, dates, or currency.

Input Parameters

string
Optional custom invoice code or reference
string ("regular_invoice" | "vat_invoice" | "preliminary_invoice" | "preliminary_vat_invoice" | "credit_invoice" | "credit_vat_invoice")
Invoice type. Valid values: ‘regular_invoice’, ‘vat_invoice’, ‘preliminary_invoice’, ‘preliminary_vat_invoice’, ‘credit_invoice’, ‘credit_vat_invoice’
object
Buyer object with customer information
string
Optional notes to appear on the invoice
object
Seller object if not using default
string
Series code/prefix for the invoice
string
ISO 4217 three-letter currency code
string
Payment due date (alias). Format: YYYY-MM-DD
array
Products array with line items for the invoice
string
required
Unique identifier of the invoice to update
string
Date on the invoice. Format: YYYY-MM-DD
string
Payment due date. Format: YYYY-MM-DD
boolean
If true, API will use default seller info instead of requiring seller object

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: FINMEI_UPDATE_PRODUCTUpdates a product’s name, description, price, or currency by ID, requiring at least one update field. Returned details are normalized and may be incomplete or defaulted when the response or subsequent lookup lacks fields.

Input Parameters

string
Updated name for the product. If provided, replaces the existing product name.
number
Updated price for the product in the specified currency. Must be non-negative. If provided, replaces the existing price.
string
Updated currency code for the product price (ISO 4217 format, e.g., USD, EUR, GBP). If provided, replaces the existing currency.
string
required
Unique identifier of the product to update. Must be a valid existing product ID.
string
Updated description for the product. If provided, replaces the existing description.

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