Skip to main content
Invofox logo
  • Category: documents & ocr
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: INVOFOX
  • Version: 20261030_00

Tools

Slug: INVOFOX_CREATE_COMPANYCreate a managed company collection used to organize document processing.

Input Parameters

string
required
Company’s display name.
string
required
Company tax identifier. Invofox may normalize its punctuation.
object
Optional caller-owned metadata to associate with the company.
string
required
Two-letter ISO 3166-1 alpha-2 country 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: INVOFOX_DELETE_COMPANYPermanently delete one managed company by ID. This destructive operation cannot be undone.

Input Parameters

string
required
Managed company ID to permanently 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: INVOFOX_GET_DOCUMENTGet one processed document with extracted fields, confidence, processing metadata, and signed source or image URLs.

Input Parameters

string
required
Processed document ID returned by an import, file, or document-list response.

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: INVOFOX_GET_DOCUMENT_TEXTReturn plain OCR text for each page of a processed document.

Input Parameters

string
required
Processed document ID whose page text should be returned.

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: INVOFOX_GET_IMPORTGet an asynchronous import’s status, document count, and file processing records after documents were queued.

Input Parameters

string
required
Import ID returned when documents were queued.

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: INVOFOX_LIST_COMPANIESFind managed companies by country, tax ID, or name using bounded offset pagination.

Input Parameters

string
Filter by company name.
integer
Maximum companies in this page; the provider does not publish a maximum.
string
Filter by tax identifier.
string
Continuation cursor returned by a previous call; omit for the first page.
string
Filter by two-letter country 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: INVOFOX_LIST_DOCUMENTSFind processed documents using extraction-field filters, sorting, field selection, and bounded offset pagination.

Input Parameters

string
Field to sort by; prefix the field with ’-’ for descending order.
integer
Maximum documents in this page (1-500).
object
Optional filter object using eq, ne, gt, gte, lt, lte, or in against document fields, data fields, or clientData fields. Keys and nested keys must use the provider’s documented spellings.
array
Document fields to return.
string
Continuation cursor returned by a previous call; omit for the first page. When continuing, repeat the same filter, sort, and select values.

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: INVOFOX_PROCESS_DOCUMENTS_BY_URLQueue one or more documents from public HTTPS URLs for asynchronous extraction. Returns the import and file IDs needed to track processing.

Input Parameters

object
Optional processing settings and metadata applied across all files.
array
required
One or more documents to download and process asynchronously.

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: INVOFOX_SET_DOCUMENT_STATEMove a document to pending correction, approved, discarded, or exported. Approval, discard, and export may trigger irreversible downstream workflows.

Input Parameters

string
required
Document ID whose business workflow state should change.
string ("pendingCorrection" | "approved" | "discarded" | "exported")
required
Exact target state. Use pendingCorrection, approved, discarded, or exported. Approval, discard, and export may trigger irreversible downstream workflows.

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: INVOFOX_UPDATE_DOCUMENTCorrect extracted document fields, update client metadata, or do both for an existing processed document.

Input Parameters

object
Corrected extraction fields using the document type’s field names. Provide data, client_data, or both.
object
Caller-owned metadata to associate with the document. Provide data, client_data, or both.
string
required
Document ID 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