New France e-invoicing mandate goes live September 2026 — our implementation is ready. See all mandates →
Getting Started

All endpoints

Every public Clearvo API operation — 265 in all — generated from the same OpenAPI contract the SDKs and MCP server are built from, so this list is always complete. Paths are relative to https://api.clearvo.io and shown with their /v1 prefix. Walkthroughs, examples and field-by-field detail for the main products are on their own pages (see the sidebar); for the full request and response schema of any operation below, use the machine-readable spec: openapi.json.

ℹ
Every request needs an x-api-key header — see Authentication. Endpoints marked Deprecated still work but are being retired.
API Reference

E-Invoicing 43

MethodPathSummary
GET/v1/invoicesList invoices
POST/v1/sendSubmit an invoice
POST/v1/send/bulkBulk CSV submission
GET/v1/statusPoll clearance status
GET/v1/invoices/{id}Get invoice detail
GET/v1/documents/{id}Get invoice XML or PDF
GET/v1/exportBulk export invoices, or export a data-query-tool result set
POST/v1/invoices/{id}/deliverRetry invoice delivery
POST/v1/invoices/{id}/retryRetry an undelivered invoice
POST/v1/invoices/{id}/amend-reportFile an AEAT Spain SII A1 amendment
POST/v1/invoices/{id}/cancel-reportFile an AEAT Spain SII Baja (withdrawal)
PATCH/v1/invoices/{id}/business-statusRecord a customer-lifecycle status on a received invoice
POST/v1/invoices/{id}/resend-notificationResend the customer invoice notification email
POST/v1/invoices/resend-notification/batchResend the customer invoice notification email for multiple invoices
GET/v1/productsList catalogue products
POST/v1/productsCreate a catalogue product
GET/v1/products/{id}Get a catalogue product
PATCH/v1/products/{id}Update a catalogue product
DELETE/v1/products/{id}Delete a catalogue product
GET/v1/mandatesList supported e-invoicing mandates and their required fields
GET/v1/rulesList this entity's active validation rules
POST/v1/rulesAuthor a custom rule (removed)
GET/v1/rules/{ruleCode}Get a single entity rule
PATCH/v1/rules/{ruleCode}Edit a custom rule (removed)
DELETE/v1/rules/{ruleCode}One-click deactivate a rule for this entity
GET/v1/pt/saftDownload the Portugal monthly SAF-T (PT) billing file
POST/v1/fr/inbound/pollPoll France inbound (customer) invoice inbox and resolve outbound status
POST/v1/pl/inbound/pollPoll Poland KSeF inbound (customer) invoice inbox
POST/v1/receive/simulateCreate sample received invoices (sandbox)
POST/v1/receiveSubmit a received (inbound) invoice document
POST/v1/receive/bulkSubmit many received invoice documents at once (async)
GET/v1/receive/bulk/{batchId}Poll one async inbound bulk-receive batch's status
GET/v1/de/inbound-addressGet this entity's DE inbound forwarding email address
POST/v1/mx/inbound/cfdiPush a received CFDI 4.0 document (client_push ingestion)
POST/v1/mx/inbound/pollTrigger a SAT Descarga Masiva poll cycle
GET/v1/mx/sync-statusSAT-pull job health for this entity
POST/v1/br/inbound/pollTrigger a Distribuição DFe poll cycle
GET/v1/br/sync-statusDistribuição DFe poll job health for this entity
PATCH/v1/br/settingsFlip auto-Ciência without re-uploading the certificate
GET/v1/validationsList every check POST /v1/send can emit
GET/v1/send/bulk/{batchId}Get bulk CSV batch status
GET/v1/send/bulk/{batchId}/errorsList structural errors for a bulk CSV batch
POST/v1/br/nfse/inbound/pollTrigger a NFS-e Nacional (ADN) poll cycle
API Reference

Customers 7

MethodPathSummary
GET/v1/customer-reference-typesList customer reference types
GET/v1/customersList customers
POST/v1/customersCreate a customer
GET/v1/customers/{id}Get a customer
PATCH/v1/customers/{id}Update a customer
DELETE/v1/customers/{id}Delete a customer (soft delete)
PUT/v1/customers/by-ref/{customerRef}Create or update a customer by your reference
API Reference

Suppliers 6

MethodPathSummary
GET/v1/suppliersList suppliers
POST/v1/suppliersCreate a supplier
GET/v1/suppliers/{id}Get a supplier
PATCH/v1/suppliers/{id}Update a supplier
DELETE/v1/suppliers/{id}Delete a supplier (soft delete)
GET/v1/suppliers/by-ref/{ref}Get a supplier by your reference
API Reference

Company Codes 3

MethodPathSummary
GET/v1/company-codesList company codes
POST/v1/company-codesAdd a company code
PATCH/v1/company-codes/{id}Rename, archive or reactivate a company code
API Reference

Bank Accounts 5

MethodPathSummary
GET/v1/bank-accountsList bank accounts
POST/v1/bank-accountsStore a bank account
GET/v1/bank-accounts/{id}Get a bank account
PATCH/v1/bank-accounts/{id}Update a bank account
DELETE/v1/bank-accounts/{id}Delete a bank account (soft delete)
API Reference

Webhooks 4

MethodPathSummary
POST/v1/webhooks/testSend a test event to a webhook
GET/v1/webhooksList webhook endpoints
POST/v1/webhooksRegister a webhook endpoint
DELETE/v1/webhooksDeactivate a webhook endpoint
API Reference

Integration Tests 9

MethodPathSummary
GET/v1/test-runsList your test runs
POST/v1/test-runsStart a run of your integration tests
GET/v1/test-runs/{id}Get a test run
GET/v1/test-casesList your tests
POST/v1/test-casesAdd a test of your own
GET/v1/test-cases/catalogueGet the choices for adding a test
GET/v1/test-cases/{id}Get one test
PATCH/v1/test-cases/{id}Change one of your tests
DELETE/v1/test-cases/{id}Remove one of your tests
API Reference

Peppol 1

MethodPathSummary
GET/v1/participants/lookupLook up a Peppol participant
API Reference

Tax Number Validation 6

MethodPathSummary
POST/v1/tax-numbers/validateValidate a tax number
POST/v1/tax-numbers/validate-batchValidate multiple tax numbers
POST/v1/tax-numbers/validate-batch/asyncValidate large batches of tax numbers (async)
GET/v1/tax-numbers/validate-batch/{jobId}Poll async batch validation progress
GET/v1/tax-numbers/lookupsList TIN validation history
GET/v1/lookupCompany name lookup
API Reference

Tax Registrations 6

MethodPathSummary
GET/v1/tax/registrationsList tax registrations
POST/v1/tax/registrationsAdd a tax registration
PATCH/v1/tax/registrations/{id}Set collection start date, deregister, or edit details
DELETE/v1/tax/registrations/{id}Delete a tax registration
GET/v1/tax/registrations/field-definitionsGet extra-field requirements for a registration
GET/v1/tax/registrations/coverage-auditUS home-rule locality coverage audit
API Reference

Client Tax Codes 9

MethodPathSummary
GET/v1/tax/client-codes/optionsGet valid field options for a client tax code
GET/v1/tax/client-codes/exemption-reasonsGet candidate exemption-reason codes for a client tax code
GET/v1/tax/codesList/search canonical tax codes
GET/v1/tax/client-codesList client tax codes
POST/v1/tax/client-codesCreate a client tax code
PATCH/v1/tax/client-codes/{id}Update a client tax code
DELETE/v1/tax/client-codes/{id}Delete a client tax code
POST/v1/tax/client-codes/bulkBulk import/upsert client tax codes
GET/v1/tax/client-codes/auditGet a client tax code's audit trail
API Reference

Tax Reporting 9

MethodPathSummary
GET/v1/mandate-transactionsList mandate transactions
GET/v1/mandate-transactions/{id}Get mandate transaction detail
GET/v1/period-reconciliationPeriod reconciliation export
GET/v1/fr/transactions/needs-infoList NEEDS_INFO remediation queue (FR)
PATCH/v1/fr/transactions/needs-info/{id}Resupply a missing field (FR NEEDS_INFO)
GET/v1/tax/reporting-obligationsList tax reporting obligations
PATCH/v1/tax/reporting-obligationsUpdate tax reporting obligations
GET/v1/fr/transactions/exportExport France mandate transactions
PATCH/v1/mandates/obligations/{id}Acknowledge a mandate obligation as handled elsewhere
API Reference

Reporting Batches 6

MethodPathSummary
GET/v1/reporting-batchesList reporting batches (Spain SII, France e-reporting, and any other batching regime)
GET/v1/reporting-batches/{id}Get one Spain SII reporting batch with its records
POST/v1/reporting-batches/{id}/confirmConfirm a reporting batch for submission
POST/v1/reporting-batches/{id}/excludeExclude one record from a Spain SII reporting batch
GET/v1/sii/reconciliationLatest AEAT Spain SII Consulta reconciliation run's id and condensed status
GET/v1/sii/reconciliation/{id}Fetch one AEAT Spain SII Consulta reconciliation run
API Reference

Exemption Certificates 6

MethodPathSummary
GET/v1/tax/exemptionsList exemption certificates
POST/v1/tax/exemptionsCreate an exemption certificate
GET/v1/tax/exemptions/{id}Get an exemption certificate
PATCH/v1/tax/exemptions/{id}Update an exemption certificate
DELETE/v1/tax/exemptions/{id}Delete an exemption certificate (soft delete)
POST/v1/tax/exemptions/{id}/documentUpload certificate document
API Reference

Tax Calculations 27

MethodPathSummary
GET/v1/tax/calculateList tax calculations
POST/v1/tax/calculateCalculate tax
POST/v1/duties/quoteQuote import duties
POST/v1/duties/estimateEstimate duties for one product across destinations
GET/v1/tax/calculate/{id}/import-settlementList a calculation's import settlements
POST/v1/tax/calculate/{id}/import-settlementRecord what customs actually charged
GET/v1/duties/settlement-varianceEstimate-versus-entry variance by destination and precision
GET/v1/tax/calculation-ledgerList calculation requests (ledger)
GET/v1/tax/calculate/importList CSV import batches
POST/v1/tax/calculate/importBulk import transactions from CSV
GET/v1/tax/calculate/import/{batchId}Get an import batch's status and transactions
DELETE/v1/tax/calculate/import/{batchId}Cancel an import batch
GET/v1/tax/calculate/import/{batchId}/errorsDownload an import batch's errored transactions
POST/v1/tax/calculate/{id}/refundMark a calculation as refunded, fully or partially
GET/v1/tax/obligationsList tax obligations
PATCH/v1/tax/obligations/{id}Update a tax obligation
GET/v1/tax/productsList classified products
POST/v1/tax/productsClassify a product
PATCH/v1/tax/products/{id}Update product classification
DELETE/v1/tax/products/{id}Delete a product classification
POST/v1/tax/products/{id}/restoreRestore a deleted product classification
POST/v1/tax/products/bulkBulk classify products
GET/v1/tax/settingsGet tax calculation settings
PATCH/v1/tax/settingsUpdate tax calculation settings
GET/v1/tax/categoriesList tax categories
GET/v1/tax/jurisdictionsList supported tax jurisdictions
GET/v1/usageGet billable usage for the current billing period
API Reference

Entities 8

MethodPathSummary
GET/v1/entities/fact-definitionsGet entity-level fact definitions
GET/v1/entitiesList entities
POST/v1/entitiesCreate an entity
GET/v1/entities/{id}Get an entity
PATCH/v1/entities/{id}Update an entity
POST/v1/entities/{id}/logoUpload or replace an entity's logo
DELETE/v1/entities/{id}/logoRemove an entity's logo
GET/v1/requirementsGet country e-invoicing requirements
API Reference

Authority Credentials 40

MethodPathSummary
GET/v1/ar/credentialsGet Argentina AFIP credentials
POST/v1/ar/credentialsRegister Argentina AFIP credentials
DELETE/v1/ar/credentialsRemove Argentina AFIP credentials
GET/v1/it/profileGet Italy Regime Fiscale
PUT/v1/it/profileSet Italy Regime Fiscale
GET/v1/pl/credentialsGet Poland KSeF credentials
POST/v1/pl/credentialsRegister Poland KSeF credentials
DELETE/v1/pl/credentialsRemove Poland KSeF credentials
GET/v1/pt/credentialsGet Portugal AT credentials
POST/v1/pt/credentialsRegister Portugal AT credentials
DELETE/v1/pt/credentialsRemove Portugal AT credentials
GET/v1/fr/credentialsGet France platform credentials
POST/v1/fr/credentialsRegister the entity's French tax number and read its activation status
GET/v1/mx/credentialsRetrieve the stored e.firma's status (no key material)
POST/v1/mx/credentialsRegister or update the entity's SAT e.firma (sat_pull mode)
DELETE/v1/mx/credentialsRemove the stored e.firma
GET/v1/hu/credentialsGet Hungary NAV credentials
POST/v1/hu/credentialsRegister Hungary NAV credentials
DELETE/v1/hu/credentialsRemove Hungary NAV credentials
GET/v1/gr/credentialsGet Greece AADE myDATA credentials
POST/v1/gr/credentialsRegister Greece AADE myDATA credentials
DELETE/v1/gr/credentialsRemove Greece AADE myDATA credentials
GET/v1/ro/credentialsGet Romania ANAF e-Factura credentials
POST/v1/ro/credentialsRegister Romania ANAF e-Factura credentials
DELETE/v1/ro/credentialsRemove Romania ANAF e-Factura credentials
GET/v1/eg/credentialsGet Egypt ETA credentials
POST/v1/eg/credentialsRegister Egypt ETA credentials
DELETE/v1/eg/credentialsRemove Egypt ETA credentials
GET/v1/il/credentialsGet Israel ITA credentials
POST/v1/il/credentialsRegister Israel ITA credentials
DELETE/v1/il/credentialsRemove Israel ITA credentials
GET/v1/jo/credentialsGet Jordan JoFotara credentials
POST/v1/jo/credentialsRegister Jordan JoFotara credentials
DELETE/v1/jo/credentialsRemove Jordan JoFotara credentials
GET/v1/br/credentialsRetrieve the stored e-CNPJ's status (no key material)
POST/v1/br/credentialsRegister or update the entity's e-CNPJ A1 certificate
DELETE/v1/br/credentialsRemove the stored e-CNPJ
GET/v1/my/credentialsGet Malaysia MyInvois authorization status
POST/v1/my/credentialsRegister/verify Malaysia MyInvois intermediary authorization
DELETE/v1/my/credentialsRemove Malaysia MyInvois authorization
API Reference

Integrations 7

MethodPathSummary
POST/v1/integrations/woocommerce/disconnectDisconnect the WooCommerce integration
PATCH/v1/integrations/woocommerce/tax-toggleEnable or disable checkout tax calculation for WooCommerce
POST/v1/integrations/woocommerce/connectConnect a WooCommerce store
POST/v1/integrations/woocommerce/syncTrigger a WooCommerce sync
POST/v1/integrations/coupa/tax-calloutCoupa Tax Call Out receiver
POST/v1/integrations/business-central/registerRegister a Business Central connection
POST/v1/integrations/business-central/push-resultReport the outcome of a Business Central invoice push
API Reference

Team 1

MethodPathSummary
POST/v1/team/invitesInvite a team member
API Reference

Setup 2

MethodPathSummary
GET/v1/setup/statusGet account setup status
GET/v1/healthAvailability check
API Reference

Data Query Tool 2

MethodPathSummary
GET/v1/query/fieldsGet the data query tool's filterable fields, operators, and enum values
POST/v1/queryRun a filtered, paginated query over einvoicing_records, tax_calculations, or tax_calculation_line_items
API Reference

Rules Engine 32

MethodPathSummary
GET/v1/rules-engine/schemaDescribe the rules-engine vocabulary
GET/v1/rules-engine/rulesList rules
POST/v1/rules-engine/rulesCreate a rule
POST/v1/rules-engine/rules/simulateSimulate a not-yet-saved rule
GET/v1/rules-engine/rules/{id}Read a rule
PATCH/v1/rules-engine/rules/{id}Edit a rule
POST/v1/rules-engine/rules/{id}/activateActivate a rule
POST/v1/rules-engine/rules/{id}/suppressSuppress a platform-default rule
DELETE/v1/rules-engine/rules/{id}/suppressRemove this scope's suppression of a platform-default rule
POST/v1/rules-engine/rules/{id}/moveReorder a rule
GET/v1/rules-engine/rules/{id}/versionsA rule's edit history
POST/v1/rules-engine/rules/{id}/simulateSimulate an existing rule
GET/v1/rules-engine/propertiesList custom property definitions
POST/v1/rules-engine/propertiesDefine a custom property
PATCH/v1/rules-engine/properties/{id}Edit a custom property's label, or deprecate/reactivate it
GET/v1/rules-engine/templatesList starter rule templates
GET/v1/rules-engine/templates/{id}Read a template
PUT/v1/rules-engine/templates/{id}Instantiate a template
GET/v1/rules-engine/datasetsList reference datasets
POST/v1/rules-engine/datasetsCreate a reference dataset
GET/v1/rules-engine/datasets/{id}Read a dataset's metadata
GET/v1/rules-engine/datasets/{id}/rowsA page of a dataset's rows
POST/v1/rules-engine/datasets/{id}/rowsUpsert a dataset row
DELETE/v1/rules-engine/datasets/{id}/rows/{rowKey}Delete a dataset row
POST/v1/rules-engine/datasets/{id}/importTwo-phase CSV import
GET/v1/rules-engine/datasets/{id}/exportExport a dataset as CSV
GET/v1/rules-engine/mappingsList field mappings
GET/v1/rules-engine/mappings/{id}Read a field mapping
PATCH/v1/rules-engine/mappings/{id}Edit a field mapping
POST/v1/rules-engine/mappings/resetReset field mappings to defaults
GET/v1/rules-engine/traceFull rules-engine execution trace
GET/v1/rules-engine/platform-changesRecent platform (Global/Tenant) rule changes
API Reference

Filings 19

MethodPathSummary
GET/v1/filingsList filings
GET/v1/filings/{id}Get a filing
GET/v1/filings/{id}/documents/{docId}Download a document of a live filing
POST/v1/filings/{id}/approveApprove a filing for submission
POST/v1/filings/{id}/undoUndo an approval (before submission)
POST/v1/filings/{id}/pausePause a filing
POST/v1/filings/{id}/resumeResume a paused filing
POST/v1/filings/sandbox/generateBuild a sandbox filing on demand
POST/v1/filings/{id}/skipSkip a filing (closes it as NOT_FILED)
POST/v1/filings/{id}/prepaymentRecord an amount already paid for the period
GET/v1/filings/{id}/change-requestsList change requests sent to operations
POST/v1/filings/{id}/change-requestsAsk operations to change a filing
GET/v1/filings/{id}/csvSummary by authority (CSV), ending in a TOTAL row
GET/v1/filings/{id}/transactions.csvThe transaction lines frozen into the filing (CSV)
GET/v1/filings/{id}/proofProof-of-filing document
GET/v1/filings/setupsWhere filing setup stands for each registration, and the next step
GET/v1/filings/bank-accountThe account the tax authority debits (last four digits only)
GET/v1/tax/registrations/{id}/filingThe filing setup for a registration
PUT/v1/tax/registrations/{id}/filingRequest, defer or stop filing for a registration
API Reference

Filing Data Upload 7

MethodPathSummary
GET/v1/filings/upload/monthsThe months you can add data to, with their window state
GET/v1/filings/upload/months/{month}Files, counts, window and lock for one month
POST/v1/filings/upload/months/{month}/filesAdd a data file to a month
DELETE/v1/filings/upload/months/{month}/files/{fileId}Remove a file you added, while the month is open
GET/v1/filings/upload/months/{month}/files/{fileId}/error-reportA fresh download link for the error and warning report of a file
POST/v1/filings/upload/months/{month}/processConfirm all data is added and process the month once
GET/v1/filings/upload/templateThe upload template (CSV, XLSX or JSON)