Get info of a given import | Invofox

const url = 'https://api.invofox.com/v1/ingest/imports/66f580d3bee75c4a542daabb';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "id": "66f580d3bee75c4a542daabb",
  "accountId": "507f1f77bcf86cd799439011",
  "environmentId": "507f1f77bcf86cd799439012",
  "channel": "upload",
  "status": "processed",
  "createdAt": "2023-10-15T10:30:00.000Z",
  "documents": 42,
  "files": [
    {
      "id": "66f580d3bee75c4a542daabb",
      "accountId": "66d721ec7edc0baa3794eec1",
      "environmentId": "66d721f5ee90270bfac654a0",
      "importId": "66d711d737c788ba24e17734",
      "filename": "invoice.pdf",
      "compressed": false,
      "status": "processed",
      "mimeType": "application/pdf",
      "companyId": "66d5dc3afed4f8062c998439",
      "parentFileId": "66f580d3bee75c4a542daabb",
      "documentIds": [
        "66d71d63c9d0d2adc038b076",
        "66d71d63c9d0d2adc038b077"
      ],
      "error": "ERR_UNSUPPORTED_FILE_FORMAT",
      "createdAt": "2024-09-26T10:30:00.000Z",
      "updatedAt": "2024-09-26T10:35:00.000Z",
      "clientData": {
        "userId": "507f1f77bcf86cd799439015",
        "invofoxAccountName": "company-name",
        "invofoxCompanyId": "12345"
      }
    }
  ],
  "clientData": {
    "userId": "507f1f77bcf86cd799439015",
    "invofoxAccountName": "company-name",
    "invofoxCompanyId": "12345"
  },
  "providerInfo": {}
}

Get detailed information of a given import

Authentication

x-api-keystring

API key authentication for programmatic access. Used by server-to-server integrations and API clients.

x-access-tokenstring

Access token authentication for web users. Used by browser-based applications and authenticated user sessions.

Path parameters

importIdstringRequired

The ID of the import

Response

Import details retrieved successfully

idstring

Unique identifier for the import

accountIdstring

Account identifier

environmentIdstring

Environment identifier

channelenum

Import channel

Allowed values:

statusenum

Current processing status of the import

Allowed values:

createdAtstring

Import creation timestamp

documentsdouble>=0

Total number of documents extracted from all files

fileslist of objects

Array of files associated with this import

clientDataobject

Provider-specific information and metadata

providerInfoobject

Errors

404

Not Found Error