Factuarea APIDevelopers

Tool catalog

All 457 Factuarea MCP tools grouped by domain, with the scope each one requires and its rate-limit category.

The Factuarea MCP server publishes 457 tools across 29 domains. This page is the canonical list; each tool's input schema is discoverable at runtime via tools/list. Every tool maps to the same operation in the REST API Reference.

How to read this catalog

  • Tool — the MCP tool name your agent calls.
  • Scope — the fine-grained scope the credential must hold for the tool to appear in tools/list and to be invocable. See Scopes & permissions.
  • Category — the rate-limit bucket the tool falls into: read, write, destructive, send or generate. See Errors & rate limits.

A credential only sees the tools its scopes cover. An API key with the super-scope * sees all 457; a narrower key or an OAuth token sees a subset.

¹ OAuth-restricted (API key only). 89 tools are reachable only with an API key, never through a third-party OAuth app: the 8 verifactu:write tools, forget_delivery_note_signature (delivery_notes:gdpr_forget), the 13 Payments & gateways tools (the stripe_autoinvoicing:*, payouts:read and integration_events:* scopes are fine-grained, API-key-only scopes), the 3 Emails tools and the 2 API-request-log tools (emails:read and developers:read inspect your own integration's traffic — first-party scopes, never granted by third-party consent), the 17 Managed-companies tools (companies:* and api_keys:* are first-party only, never granted by third-party consent — this includes get_consolidated_workforce), the 4 account-write self-service tools (account:write — creating, rotating or revoking API keys and updating account personalization), the 33 workforce control-horario tools whose write/transition scopes (time_entries:write, absences:write, absences:transition, work_schedules:write) are fine-grained, API-key-only scopes not in the OAuth consent catalog (their read counterparts and employees:write are OAuth-grantable) and delete_automation_rule (automations:delete is deliberately kept out of the OAuth consent catalog; the automation engine's other three scopes — automations:read, automations:write and automation_runs:read — are grantable). OAuth apps therefore reach 368 of the 457 tools. See the channel policy.

² Batch size limit — 200 ids per call. bulk_send_invoices, bulk_send_quotes, bulk_send_proformas and bulk_send_delivery_notes accept at most 200 ids per call — the same limit as their REST counterparts (POST /v1/{resource}/bulk-send). A larger batch is rejected before anything is sent: no email goes out and no job is queued. Split the batch into blocks of 200 and repeat the call. The error message is returned in Spanish, like every other API message, and names two numbers and nothing else — the limit and what you sent — so no id of the batch is echoed back: No puedes enviar más de 200 facturas por lote. Has enviado 201. Divide el lote en bloques de 200 como máximo y repite la llamada.

Domains

Invoices

Sales invoices: search, CRUD, correctives, partial-payment ledger, transitions (paid/sent/void/annul), scheduling, bulk operations, reminders, public links, PDFs and Excel export. (44 tools)

ToolScopeCategory
can_annul_invoiceinvoices:readread
check_invoice_simplified_eligibilityinvoices:readread
export_invoices_excelinvoices:readread
find_invoice_by_external_idinvoices:readread
find_invoice_by_numberinvoices:readread
get_available_quartersinvoices:readread
get_invoiceinvoices:readread
get_invoice_activitiesinvoices:readread
get_invoice_correctivesinvoices:readread
get_invoice_payment_receiptpdfs:readread
get_invoice_pdfpdfs:readread
get_invoice_public_linkinvoices:readread
get_invoice_statsinvoices:readread
get_invoice_statusesinvoices:readread
list_invoice_paymentsinvoices:readread
list_payment_methodsinvoices:readread
preview_invoice_reminderinvoices:readread
search_invoicesinvoices:readread
annul_invoiceinvoices:voidwrite
assign_invoice_real_numberinvoices:writewrite
bulk_change_invoice_statusinvoices:writewrite
bulk_create_invoicesinvoices:writewrite
bulk_delete_invoicesinvoices:deletedestructive
bulk_invoices_pdf_linkpdfs:readgenerate
bulk_send_invoices ²invoices:sendsend
create_corrective_invoiceinvoices:writewrite
create_invoiceinvoices:writewrite
delete_invoiceinvoices:deletedestructive
duplicate_invoiceinvoices:writewrite
mark_invoice_as_paidinvoices:writewrite
mark_invoice_as_sentinvoices:writewrite
mark_invoice_unsentinvoices:writewrite
quarterly_send_emailinvoices:sendsend
register_invoice_paymentinvoices:writewrite
reschedule_invoiceinvoices:writewrite
revert_invoice_paymentinvoices:writewrite
schedule_invoiceinvoices:writewrite
send_invoiceinvoices:sendsend
send_invoice_reminderinvoices:sendsend
substitute_simplified_invoiceinvoices:writewrite
unschedule_invoiceinvoices:writewrite
update_invoiceinvoices:writewrite
update_invoice_public_linkinvoices:writewrite
void_invoiceinvoices:voidwrite

Contacts

(26 tools)

Fiscal contacts with cumulative customer, supplier and lead roles. This is the only public MCP surface for third-party identities. The CSV template remains a REST download. See Contacts.

ToolScopeCategory
archive_contactcontacts:deletedestructive
assign_contact_rolecontacts:writewrite
bulk_archive_contactscontacts:deletedestructive
bulk_create_contactscontacts:writewrite
bulk_change_contact_role_statuscontacts:writewrite
bulk_delete_contactscontacts:deletedestructive
change_contact_role_statuscontacts:writewrite
create_contactcontacts:writewrite
delete_contactcontacts:deletedestructive
find_contact_by_external_idcontacts:readread
find_contact_by_tax_idcontacts:readread
get_contactcontacts:readread
get_contact_activitiescontacts:readread
get_contact_statscontacts:readread
get_contact_optionscontacts:readread
import_contactscontacts:writewrite
list_contactscontacts:readread
preview_contacts_importcontacts:writewrite
remove_contact_rolecontacts:deletedestructive
restore_contactcontacts:writedestructive
search_contactscontacts:readread
update_bank_accountscontacts:writewrite
update_contactcontacts:writewrite
update_customer_profilecontacts:writewrite
update_supplier_profilecontacts:writewrite
verify_contact_censuscontacts:readread

Products

Catalog: search, CRUD, configurable options/combinations, stock ledger, presentations, variants, supplier offers, bulk actions, analytics and media. (38 tools)

ToolScopeCategory
download_product_gallery_imageproducts:readread
download_product_videoproducts:readread
find_product_by_external_idproducts:readread
find_product_by_skuproducts:readread
get_productproducts:readread
get_product_activitiesproducts:readread
get_product_sales_analyticsproducts:readread
get_product_statsproducts:readread
low_stock_reportproducts:readread
list_product_configurationsproducts:readread
list_product_optionsproducts:readread
list_product_presentationsproducts:readread
list_product_stock_movementsproducts:readread
list_product_variantsproducts:readread
resolve_catalog_selectionproducts:readread
list_supplier_product_offersproducts:readread
search_productsproducts:readread
bulk_change_product_statusproducts:writewrite
bulk_delete_productsproducts:deletedestructive
bulk_update_stockproducts:writewrite
create_productproducts:writewrite
create_product_presentationproducts:writewrite
create_product_variantproducts:writewrite
create_supplier_product_offerproducts:writewrite
delete_productproducts:deletedestructive
delete_product_gallery_imageproducts:deletedestructive
delete_product_presentationproducts:writedestructive
delete_product_variantproducts:writedestructive
delete_product_videoproducts:deletedestructive
delete_supplier_product_offerproducts:writedestructive
set_preferred_supplier_product_offerproducts:writewrite
toggle_product_activeproducts:writewrite
update_productproducts:writewrite
update_product_presentationproducts:writewrite
update_product_variantproducts:writewrite
update_supplier_product_offerproducts:writewrite
upload_product_gallery_imageproducts:writewrite
upload_product_videoproducts:writewrite

Price lists

Customer and document pricing: manage active/retired items, compact selector options and resolve configurable catalog selections. (13 tools)

ToolScopeCategory
get_price_listprice_lists:readread
get_price_list_optionsprice_lists:readread
list_price_list_itemsprice_lists:readread
list_price_listsprice_lists:readread
resolve_catalog_priceprice_lists:readread
resolve_many_catalog_pricesprice_lists:readread
create_price_listprice_lists:writewrite
delete_price_listprice_lists:writedestructive
delete_price_list_itemprice_lists:writedestructive
purge_retired_price_list_itemprice_lists:writedestructive
reassign_retired_price_list_itemprice_lists:writewrite
update_price_listprice_lists:writewrite
upsert_price_list_itemprice_lists:writewrite

Quotes

Quotes: search, CRUD, accept/reject, send, convert to invoice, bulk operations, lookup by external ID, public links and PDFs. (20 tools)

ToolScopeCategory
find_quote_by_external_idquotes:readread
get_quotequotes:readread
get_quote_pdfpdfs:readread
get_quote_public_linkquotes:readread
get_quote_statsquotes:readread
get_quote_statusesquotes:readread
search_quotesquotes:readread
accept_quotequotes:transitionwrite
bulk_change_quote_statusquotes:transitionwrite
bulk_delete_quotesquotes:deletedestructive
bulk_quotes_pdf_linkpdfs:readgenerate
bulk_send_quotes ²quotes:sendsend
convert_quotequotes:transitionwrite
create_quotequotes:writewrite
delete_quotequotes:deletedestructive
duplicate_quotequotes:writewrite
reject_quotequotes:transitionwrite
send_quotequotes:sendsend
update_quotequotes:writewrite
update_quote_public_linkquotes:writewrite

Pro-forma invoices

Pro-formas: search, CRUD, accept/reject, send, convert, bulk operations, lookup by external ID, public links and PDFs. (20 tools)

ToolScopeCategory
find_proforma_by_external_idproformas:readread
get_proformaproformas:readread
get_proforma_pdfpdfs:readread
get_proforma_public_linkproformas:readread
get_proforma_statsproformas:readread
get_proforma_statusesproformas:readread
search_proformasproformas:readread
accept_proformaproformas:transitionwrite
bulk_change_proforma_statusproformas:transitionwrite
bulk_delete_proformasproformas:deletedestructive
bulk_proformas_pdf_linkpdfs:readgenerate
bulk_send_proformas ²proformas:sendsend
convert_proformaproformas:transitionwrite
create_proformaproformas:writewrite
delete_proformaproformas:deletedestructive
duplicate_proformaproformas:writewrite
reject_proformaproformas:transitionwrite
send_proformaproformas:sendsend
update_proformaproformas:writewrite
update_proforma_public_linkproformas:writewrite

Delivery notes

Delivery notes: search, CRUD, deliver/cancel/sign, convert, send, bulk operations, lookup by external ID, public links, PDFs and GDPR signature erasure. (22 tools)

ToolScopeCategory
find_delivery_note_by_external_iddelivery_notes:readread
get_delivery_notedelivery_notes:readread
get_delivery_note_pdfpdfs:readread
get_delivery_note_public_linkdelivery_notes:readread
get_delivery_note_statsdelivery_notes:readread
get_delivery_note_statusesdelivery_notes:readread
search_delivery_notesdelivery_notes:readread
bulk_change_delivery_note_statusdelivery_notes:transitionwrite
bulk_delete_delivery_notesdelivery_notes:deletedestructive
bulk_delivery_notes_pdf_linkpdfs:readgenerate
bulk_send_delivery_notes ²delivery_notes:writesend
cancel_delivery_notedelivery_notes:transitionwrite
convert_delivery_notedelivery_notes:transitionwrite
create_delivery_notedelivery_notes:writewrite
delete_delivery_notedelivery_notes:deletedestructive
duplicate_delivery_notedelivery_notes:writewrite
forget_delivery_note_signaturedelivery_notes:gdpr_forget ¹destructive
mark_delivery_note_delivereddelivery_notes:transitionwrite
send_delivery_notedelivery_notes:writesend
sign_delivery_notedelivery_notes:transitionwrite
update_delivery_notedelivery_notes:writewrite
update_delivery_note_public_linkdelivery_notes:writewrite

Purchase invoices

Vendor bills: search, CRUD, mark paid, partial-payment ledger, bulk operations, pending/overdue lists, lookup by external ID, file attachments and payment receipts. (18 tools)

create_purchase_invoice and update_purchase_invoice accept the measured-line contract (purchase_measurement, discount_percent, price_source, source_line_index); duplicating from source_purchase_invoice_id also requires purchase_invoices:read. See Measured purchase lines.

ToolScopeCategory
download_purchase_invoice_filepurchase_invoices:readread
find_purchase_invoice_by_external_idpurchase_invoices:readread
get_purchase_invoicepurchase_invoices:readread
get_purchase_invoice_payment_receiptpdfs:readread
get_purchase_invoice_statspurchase_invoices:readread
list_overdue_purchase_invoicespurchase_invoices:readread
list_pending_purchase_invoicespurchase_invoices:readread
list_purchase_invoice_paymentspurchase_invoices:readread
search_purchase_invoicespurchase_invoices:readread
attach_purchase_invoice_filepurchase_invoices:writewrite
bulk_change_purchase_invoice_statuspurchase_invoices:transitionwrite
bulk_delete_purchase_invoicespurchase_invoices:deletedestructive
create_purchase_invoicepurchase_invoices:writewrite
delete_purchase_invoicepurchase_invoices:deletedestructive
delete_purchase_invoice_filepurchase_invoices:writewrite
mark_purchase_invoice_paidpurchase_invoices:transitionwrite
register_purchase_invoice_paymentpurchase_invoices:transitionwrite
update_purchase_invoicepurchase_invoices:writewrite

Recurring invoices

Recurring templates: search, CRUD, create from an invoice, activate/pause/resume/cancel/skip, preview, lookup by external ID, logs and activity. (17 tools)

ToolScopeCategory
find_recurring_invoice_by_external_idrecurring_invoices:readread
get_recurring_invoicerecurring_invoices:readread
get_recurring_invoice_statsrecurring_invoices:readread
list_recurring_invoice_activitiesrecurring_invoices:readread
list_recurring_invoice_logsrecurring_invoices:readread
preview_recurring_invoicerecurring_invoices:readread
search_recurring_invoicesrecurring_invoices:readread
activate_recurring_invoicerecurring_invoices:transitionwrite
bulk_delete_recurring_invoicesrecurring_invoices:deletedestructive
cancel_recurring_invoicerecurring_invoices:transitionwrite
create_recurring_invoicerecurring_invoices:writewrite
create_recurring_invoice_from_invoicerecurring_invoices:writewrite
delete_recurring_invoicerecurring_invoices:deletedestructive
pause_recurring_invoicerecurring_invoices:transitionwrite
resume_recurring_invoicerecurring_invoices:transitionwrite
skip_recurring_invoicerecurring_invoices:writewrite
update_recurring_invoicerecurring_invoices:writewrite

Series

Numbering series (immutable for fiscal continuity): search, create, archive/unarchive, set default, bootstrap the four default series of a brand-new company, stats and activity. (12 tools)

ToolScopeCategory
find_series_by_codeseries:readread
get_default_series_for_typeseries:readread
get_seriesseries:readread
get_series_activitiesseries:readread
get_series_statsseries:readread
list_active_seriesseries:readread
search_seriesseries:readread
archive_seriesseries:writewrite
bootstrap_seriesseries:writewrite
create_seriesseries:writewrite
mark_series_as_defaultseries:writewrite
unarchive_seriesseries:writewrite

Taxes

Tax rates (global catalog): search, CRUD-lite, defaults, in-use checks, tax/total calculations and the read-only AEAT tax catalog (regimes, exemption causes, IRPF rates and the legal VAT ↔ equivalence-surcharge pairs). (16 tools)

ToolScopeCategory
calculate_taxtaxes:readread
calculate_totalstaxes:readread
check_tax_in_usetaxes:readread
get_active_taxestaxes:readread
get_taxtaxes:readread
get_tax_catalogtaxes:readread
get_tax_defaults_for_documenttaxes:readread
get_tax_statstaxes:readread
get_taxes_by_typetaxes:readread
get_taxes_for_purchasestaxes:readread
get_taxes_for_salestaxes:readread
search_taxestaxes:readread
create_taxtaxes:writewrite
set_tax_as_defaulttaxes:writewrite
set_tax_default_for_documenttaxes:writewrite
toggle_tax_activetaxes:writewrite

VeriFactu

AEAT SIF: records, events, chain validation, retry, subsanación of rejected records, certificates, settings, responsible declaration and AEAT access log. (27 tools)

ToolScopeCategory
find_verifactu_record_by_csvverifactu:readread
find_verifactu_record_by_huellaverifactu:readread
find_verifactu_record_by_invoice_numberverifactu:readread
get_active_company_certificateverifactu:readread
get_aeat_access_recordverifactu:readread
get_declaracion_responsableverifactu:readread
get_declaracion_responsable_historyverifactu:readread
get_invoice_verifactuverifactu:readread
get_verifactu_activitiesverifactu:readread
get_verifactu_configverifactu:readread
get_verifactu_eventverifactu:readread
get_verifactu_event_summaryverifactu:readread
get_verifactu_recordverifactu:readread
get_verifactu_statsverifactu:readread
list_aeat_access_recordsverifactu:readread
list_company_certificatesverifactu:readread
list_verifactu_eventsverifactu:readread
search_verifactu_recordsverifactu:readread
validate_verifactu_chainverifactu:readread
activate_company_certificateverifactu:write ¹write
create_invoice_verifactuverifactu:write ¹write
retry_verifactu_eventverifactu:write ¹write
retry_verifactu_recordverifactu:write ¹write
revoke_company_certificateverifactu:write ¹write
subsanar_verifactu_recordverifactu:write ¹write
update_verifactu_settingsverifactu:write ¹write
upload_company_certificateverifactu:write ¹write

FacturaE (FACe)

B2G electronic invoicing: download the FacturaE 3.2.2 XML of an invoice and manage its FACe submissions (submit, track, cancel). (5 tools)

ToolScopeCategory
get_face_submissionfacturae:readread
list_invoice_face_submissionsfacturae:readread
cancel_face_submissionfacturae:writewrite
get_invoice_facturae_linkfacturae:readgenerate
send_invoice_to_facefacturae:writewrite

Tax reports

AEAT filings computed from your own invoicing data: generate Modelo 303, 347 and 130 as the official positional file, a PDF or a review workbook; preview the breakdown without persisting anything; and read the generation history, stats, activity and files. (9 tools)

ToolScopeCategory
download_tax_reporttax_reports:readread
find_tax_report_by_periodtax_reports:readread
get_tax_report_activitiestax_reports:readread
get_tax_report_historytax_reports:readread
get_tax_report_statstax_reports:readread
preview_tax_reporttax_reports:readread
generate_tax_report_130tax_reports:writegenerate
generate_tax_report_303tax_reports:writegenerate
generate_tax_report_347tax_reports:writegenerate

Only txt_aeat is filed with the AEAT; the PDF and the workbook are review material built from the same calculation. See Tax reports.

Webhooks & events

Webhook endpoints, deliveries, secret rotation, ping/replay, test events, and the published event catalog. (13 tools)

ToolScopeCategory
get_eventevents:readread
get_webhook_deliverywebhooks:readread
get_webhook_endpointwebhooks:readread
list_eventsevents:readread
list_webhook_deliverieswebhooks:readread
search_webhook_endpointswebhooks:readread
create_webhook_endpointwebhooks:writewrite
delete_webhook_endpointwebhooks:deletewrite
ping_webhook_endpointwebhooks:writewrite
replay_webhook_deliverywebhooks:writewrite
rotate_webhook_secretwebhooks:writewrite
test_webhook_endpointwebhooks:writewrite
update_webhook_endpointwebhooks:writewrite

Automations

The automation engine: rules in the when → if → do shape, the immutable versions of each rule's definition, the dry run that reports what a rule would do without doing it, the run history with its steps and their typed discard reasons, replay of a parked step or of a whole run, the trigger/action catalog with the fields each trigger exposes, and the monthly execution quota. Gated by the automations module. (18 tools)

replay_automation_run and replay_automation_run_step run the steps for real: they send emails, deliver webhooks and call third parties. This is not a harmless retry — confirm with the user before calling them. The work is queued, so the response confirms it was accepted, not that it finished: check the outcome with get_automation_run or list_automation_run_steps.

ToolScopeCategory
dry_run_automation_ruleautomations:readread
get_automation_catalogautomations:readread
get_automation_ruleautomations:readread
get_automation_rule_versionautomations:readread
get_automation_runautomation_runs:readread
get_automation_trigger_fieldsautomations:readread
get_automation_usageautomations:readread
list_automation_rule_versionsautomations:readread
list_automation_rulesautomations:readread
list_automation_run_stepsautomation_runs:readread
list_automation_runsautomation_runs:readread
activate_automation_ruleautomations:writewrite
create_automation_ruleautomations:writewrite
delete_automation_ruleautomations:delete ¹destructive
pause_automation_ruleautomations:writewrite
replay_automation_runautomations:writewrite
replay_automation_run_stepautomations:writewrite
update_automation_ruleautomations:writewrite

Account

Account fiscal identity and personalization: verify the company's registered name + NIF against the AEAT census, read personalization templates and update account personalization. (4 tools)

ToolScopeCategory
get_account_billingaccount:readread
get_account_personalization_templatesaccount:readread
update_account_personalizationaccount:write ¹write
verify_account_censusaccount:readwrite

API keys

Self-service API keys for your own tenant: list, create, get, rotate the secret and revoke. The secret is returned once, at creation and rotation. (5 tools)

ToolScopeCategory
get_api_keyaccount:readread
list_api_keysaccount:readread
create_api_keyaccount:write ¹write
revoke_api_keyaccount:write ¹write
rotate_api_key_secretaccount:write ¹write

Managed companies

Accountant (gestoría) mode: manage the master tenant's child companies and their child API keys — create/list/show/update/delete, activate/deactivate, seat-charge preview, provisioning status, per-company API keys, and a consolidated workforce-compliance summary across the child companies. (17 tools)

ToolScopeCategory
get_companycompanies:read ¹read
get_company_api_keyapi_keys:read ¹read
get_company_creation_statuscompanies:read ¹read
get_company_seat_charge_previewcompanies:read ¹read
get_consolidated_workforcecompanies:read ¹read
list_companiescompanies:read ¹read
list_company_api_keysapi_keys:read ¹read
activate_companiescompanies:write ¹write
activate_companycompanies:write ¹write
create_companycompanies:write ¹write
create_company_api_keyapi_keys:write ¹write
deactivate_companycompanies:write ¹write
delete_companycompanies:delete ¹write
revoke_company_api_keyapi_keys:write ¹write
rotate_company_api_key_secretapi_keys:write ¹write
update_companycompanies:write ¹write
verify_company_creationcompanies:write ¹write

Payments & gateways

Payment and store integrations: Stripe auto-invoicing, connected accounts, payouts, the integration event inbox, WooCommerce and Shopify store management and diagnostics. These tools are API-key-only. Availability also depends on the company’s modules and provider configuration. (20 tools)

replay_integrations_event has a real fiscal effect. If the cause that blocked invoicing is now resolved, replaying a parked event can issue an actual invoice, with its series number and its VeriFactu submission. It is not a harmless retry: confirm with the user before calling it. It does not duplicate invoices — the replay goes through the same idempotency check as the original attempt.

ToolScopeCategory
get_integrations_eventintegration_events:read ¹read
get_payoutpayouts:read ¹read
get_stripe_autoinvoicing_configstripe_autoinvoicing:read ¹read
get_stripe_connected_accountstripe_autoinvoicing:read ¹read
list_integrations_eventsintegration_events:read ¹read
list_stripe_autoinvoiced_correctivesstripe_autoinvoicing:read ¹read
list_stripe_autoinvoiced_paymentsstripe_autoinvoicing:read ¹read
list_stripe_connected_accountsstripe_autoinvoicing:read ¹read
search_payoutspayouts:read ¹read
disconnect_stripe_connected_accountstripe_autoinvoicing:write ¹write
replay_integrations_eventintegration_events:write ¹write
update_stripe_autoinvoicing_configstripe_autoinvoicing:write ¹write
update_stripe_connected_accountstripe_autoinvoicing:write ¹write
list_storesstores:read ¹read
get_storestores:read ¹read
connect_storestores:write ¹write
update_storestores:write ¹write
disconnect_storestores:write ¹write
test_woocommerce_store_connectionwoocommerce_store:write ¹write
test_shopify_store_connectionshopify_store:write ¹write

Emails

Sent-email log: list the emails Factuarea sent on the company's behalf (invoices, quotes, delivery notes, payment reminders), read one by its id, and summarise the outcome for a batch of up to 100 documents in a single call. Use it to answer "did the email for this invoice go out?" and to investigate failed sends. (3 tools)

The status describes the hand-off to the outgoing SMTP server, not actual delivery. sent means the outgoing mail server accepted the message — it can still bounce or land in spam without Factuarea ever knowing. There is no delivered, bounced or opened state: queued, sending, sent and failed are the only ones. Never state that the recipient received, opened or read the message.

ToolScopeCategory
get_emailsemails:read ¹read
get_emails_indicatorsemails:read ¹read
list_emailsemails:read ¹read

API request logs

Your own integration's traffic against the public v1 API over the last 30 days: list the calls with their method, path, status code, duration, API-key prefix and environment, filtering by errors only or by any of those fields, and read a single one by its request_id — the opaque identifier every response returns in its header. Use it to debug an integration: what it called, when, with which status and how long it took. Headers, body and query string are not stored and are never returned. (2 tools)

ToolScopeCategory
get_developers_request_logsdevelopers:read ¹read
list_developers_request_logsdevelopers:read ¹read

Employees

Workforce roster: search, CRUD-lite (create/update/deactivate/reactivate), stats and the invitation lifecycle (send/resend/cancel and list employee invitations). Gated by the control_horario module. (12 tools)

ToolScopeCategory
find_employee_by_external_idemployees:readread
get_employeeemployees:readread
get_employee_statsemployees:readread
list_employee_invitationsemployees:readread
search_employeesemployees:readread
cancel_employee_invitationemployees:writewrite
create_employeeemployees:writewrite
deactivate_employeeemployees:writewrite
reactivate_employeeemployees:writewrite
resend_employee_invitationemployees:writewrite
send_employee_invitationemployees:writewrite
update_employeeemployees:writewrite

Employee seats

Employee-seat add-on billing: the per-contract seat subscription — preview and read the seat charge and billing, subscribe, change the seat quantity and cancel the add-on. Gated by the control_horario module. (5 tools)

ToolScopeCategory
get_employee_seat_billingemployees:readread
preview_employee_seat_chargeemployees:readread
cancel_employee_seat_addonemployees:writewrite
change_employee_seat_quantityemployees:writewrite
subscribe_employee_seat_addonemployees:writewrite

Work schedules

Weekly work schedules and their assignments: search, CRUD, archive/unarchive, assign/unassign to employees, and read an employee's effective schedule. Gated by the control_horario module. (11 tools)

ToolScopeCategory
get_employee_work_schedulework_schedules:readread
get_work_schedulework_schedules:readread
get_work_schedule_statswork_schedules:readread
list_work_schedule_assignmentswork_schedules:readread
search_work_scheduleswork_schedules:readread
archive_work_schedulework_schedules:write ¹write
assign_work_schedulework_schedules:write ¹write
create_work_schedulework_schedules:write ¹write
unarchive_work_schedulework_schedules:write ¹write
unassign_work_schedulework_schedules:write ¹write
update_work_schedulework_schedules:write ¹write

Time tracking

Time clock (RD-ley 8/2019): clock in/out with pauses, manual entries, the time-correction workflow, balances and monthly time sheets, the tamper-evident monthly register close (close/reopen/seal, signature, chain validation) and its exports, plus payroll exports. Gated by the control_horario module. (29 tools)

ToolScopeCategory
export_closed_registertime_entries:readread
get_current_time_entry_sessiontime_entries:readread
get_employee_time_balancetime_entries:readread
get_monthly_close_reporttime_entries:readread
get_monthly_register_signaturetime_entries:readread
get_monthly_time_record_closetime_entries:readread
get_monthly_time_sheettime_entries:readread
get_team_time_balance_summarytime_entries:readread
get_time_correctiontime_entries:readread
get_time_entrytime_entries:readread
get_time_tracking_settingstime_entries:readread
search_monthly_time_record_closestime_entries:readread
search_time_correctionstime_entries:readread
search_time_entriestime_entries:readread
validate_time_record_chaintime_entries:readread
export_payrollpayroll_exports:readread
list_payroll_export_formatspayroll_exports:readread
approve_time_correctiontime_entries:write ¹write
clock_intime_entries:write ¹write
clock_outtime_entries:write ¹write
close_monthly_time_recordtime_entries:write ¹write
pause_time_entrytime_entries:write ¹write
record_manual_time_entrytime_entries:write ¹write
reject_time_correctiontime_entries:write ¹write
reopen_monthly_time_recordtime_entries:write ¹write
request_time_correctiontime_entries:write ¹write
resume_time_entrytime_entries:write ¹write
seal_monthly_time_recordtime_entries:write ¹write
update_time_tracking_settingstime_entries:write ¹write

Absences

Absences: types, policies (with carryover configuration and assignments), requests (create/approve/reject/cancel), balances and the team absence calendar. Gated by the control_horario module. (25 tools)

ToolScopeCategory
get_absence_balanceabsences:readread
get_absence_calendarabsences:readread
get_absence_policyabsences:readread
get_absence_requestabsences:readread
get_absence_typeabsences:readread
list_absence_policy_assignmentsabsences:readread
search_absence_balancesabsences:readread
search_absence_policiesabsences:readread
search_absence_requestsabsences:readread
search_absence_typesabsences:readread
archive_absence_policyabsences:write ¹write
archive_absence_typeabsences:write ¹write
assign_absence_policyabsences:write ¹write
configure_absence_policy_carryoverabsences:write ¹write
create_absence_policyabsences:write ¹write
create_absence_requestabsences:write ¹write
create_absence_typeabsences:write ¹write
unarchive_absence_policyabsences:write ¹write
unarchive_absence_typeabsences:write ¹write
unassign_absence_policyabsences:write ¹write
update_absence_policyabsences:write ¹write
update_absence_typeabsences:write ¹write
approve_absence_requestabsences:transition ¹write
cancel_absence_requestabsences:transition ¹write
reject_absence_requestabsences:transition ¹write

Presence

Presence: the live presence board and per-employee / daily presence state. Gated by the control_horario module. (3 tools)

ToolScopeCategory
get_employee_presencepresence:readread
get_live_presencepresence:readread
list_daily_presencepresence:readread

Holidays

Holidays: read the company holiday calendar and resolve the holidays applicable to an employee's region (CCAA). Gated by the control_horario module. (3 tools)

ToolScopeCategory
get_holidayholidays:readread
list_holidaysholidays:readread
resolve_applicable_holidaysholidays:readread

On this page

Need a hand?Contact support