Get a list of documents | Invofox

const url = 'https://api.invofox.com/documents?filter=%7B%22type%22%3A%7B%22in%22%3A%5B%226827663ca0609723f538dea6%22%5D%7D%2C%22publicState%22%3A%7B%22in%22%3A%5B%22approved%22%5D%7D%2C%22pageCount%22%3A%7B%22eq%22%3A11%7D%7D&select=data%2Ctype%2Ccompany%2CpublicState%2Ccreation&limit=50';
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);
}

{
  "skip": 0,
  "limit": 50,
  "count": 1,
  "result": [
    {
      "_id": "63f341716985fe00080a925f",
      "account": "5f8d0d55b54764421b7156c1",
      "environment": "prod",
      "company": "54aadbb7e79e2aba5d25f3e3",
      "creator": "5f8d0d55b54764421b7156c2",
      "clientData": {
        "orderId": "ORD-20240115-001"
      },
      "type": "invoice",
      "name": "Invoice_20240115_001.pdf",
      "isGroundTruth": false,
      "creation": "2024-01-15T09:30:00Z",
      "images": [
        "https://invofox.blob.core.windows.net/documents/images/63f341716985fe00080a925f-1.png"
      ],
      "original": "https://invofox.blob.core.windows.net/documents/originals/63f341716985fe00080a925f.pdf?sv=2023-01-01&sr=b&sig=exampleSignature",
      "mimetype": "application/pdf",
      "data": {
        "invoiceNumber": {
          "value": "INV-2024-001",
          "confidence": 0.98
        },
        "totalAmount": {
          "value": 1500.75,
          "confidence": 0.95
        },
        "currency": {
          "value": "USD",
          "confidence": 1
        },
        "issueDate": {
          "value": "2024-01-14",
          "confidence": 1
        }
      },
      "publicState": "processing",
      "confidence": "high",
      "processInfo": {
        "result": "verified"
      },
      "validationInfo": {
        "errors": [
          {
            "severity": "high",
            "code": "ERR_FILE_TOO_BIG",
            "timestamp": "2024-01-15T09:30:00Z",
            "user": "5f8d0d55b54764421b7156c3",
            "info": {
              "maxSizeMB": 50,
              "actualSizeMB": 52.3
            },
            "fields": [
              {
                "name": "fileSize",
                "prefix": "",
                "index": 0,
                "groupIndex": 0,
                "splitIndex": 0
              }
            ]
          }
        ],
        "result": "valid",
        "comments": "File size exceeds recommended limit but accepted.",
        "validator": "5f8d0d55b54764421b7156c3"
      },
      "approvalInfo": {
        "beginning": "2024-01-15T09:30:00Z",
        "result": "approved",
        "comments": "Approved after manual review.",
        "appliedWorkflow": {
          "workflowId": "wf-2024-invoice-approval"
        },
        "steps": [
          {
            "date": "2024-01-15T10:00:00Z",
            "type": "manualReview",
            "info": {
              "reviewer": "5f8d0d55b54764421b7156c3",
              "notes": "All data verified."
            }
          }
        ]
      },
      "import": {
        "ref": "imp-20240115-001",
        "channel": "email",
        "info": {
          "sourceEmail": "invoices@client.com"
        }
      },
      "exports": [
        {
          "timestamp": "2024-01-16T08:00:00Z",
          "ref": "exp-20240116-001",
          "summary": [
            {
              "exportType": "accountingSystem",
              "status": "success"
            }
          ]
        }
      ],
      "geometry": {
        "pages": [
          {
            "width": 8.5,
            "height": 11,
            "unit": "inch",
            "angle": 0
          }
        ],
        "boxes": {}
      },
      "deleted": false,
      "duplicated": false
    }
  ]
}

Authentication

x-api-keystring

API Key authentication via header

Query parameters

filterstringOptional

Query filter in JSON format. Supports filtering by document properties with operators. **Filter by company:** ```json {"company": {"eq": "507f1f77bcf86cd799439011"}} ``` **Filter by public state (single value):** ```json {"publicState": {"in": ["approved"]}} ``` **Filter by multiple states:** ```json {"publicState": {"in": ["approved", "exported"]}} ``` **Filter by document type:** ```json {"type": {"in": ["6827663ca0609723f538dea6", "6827663ca0609723f538deca"]}} ``` **Filter by page count:** ```json {"pageCount": {"eq": 11}} ``` **Filter by date range:** ```json {"creation": {"gte": "2024-01-01T00:00:00.000Z", "lte": "2024-12-31T23:59:59.999Z"}} ``` **Filter by data fields:** ```json {"data.totalAmount": {"gte": 1000}} ``` **Combine multiple filters:** ```json { "type": {"in": ["6827663ca0609723f538dea6"]}, "publicState": {"in": ["approved"]}, "pageCount": {"eq": 11} } ``` **Filter by client data:** ```json {"clientData.externalId": {"eq": "ORDER-123"}} ``` **Available operators:** - `eq` - Equals - `ne` - Not equals - `gt` - Greater than - `gte` - Greater than or equal - `lt` - Less than - `lte` - Less than or equal - `in` - Value in array

sortstringOptional

Field to sort documents by. Prefix with - for descending order (e.g., -creation for newest first).

selectlist of stringsOptional

Comma-separated fields to include in the response. You can specify any field path using dot notation. **Common fields:** `_id`, `company`, `publicState`, `type`, `data`, `data.invoiceNumber`, `clientData`, `creation`, `confidence`, `pageCount` **Examples:** - To get basic info: `_id,publicState,type` - To get specific data fields: `_id,data.invoiceNumber,data.totalAmount` - To get all data: `data,type,company,confidence,publicState,creation`

skipdoubleOptionalDefaults to 0

(List pagination element) number of documents to skip of the list .The list is made up of documents that comply with the terms have been defined in the query.The skips start from the top of the list.

limitdoubleOptional<=500Defaults to 50

(List pagination element) total number of documents to retrieve (max. 500) of the list.The retrieval starts from the established position by the value of the param skip.

Response

List of documents

skipdouble

limitdouble

countdouble

resultlist of objects

Errors

400

Bad Request Error

429

Too Many Requests Error

500

Internal Server Error

1	{"company": {"eq": "507f1f77bcf86cd799439011"}}

1	{"publicState": {"in": ["approved"]}}

1	{"publicState": {"in": ["approved", "exported"]}}

1	{"type": {"in": ["6827663ca0609723f538dea6", "6827663ca0609723f538deca"]}}

1	{"pageCount": {"eq": 11}}

{"creation": {"gte": "2024-01-01T00:00:00.000Z", "lte": "2024-12-31T23:59:59.999Z"}}

1	{"data.totalAmount": {"gte": 1000}}

{
  "type": {"in": ["6827663ca0609723f538dea6"]},
  "publicState": {"in": ["approved"]},
  "pageCount": {"eq": 11}
}

1	{"clientData.externalId": {"eq": "ORDER-123"}}

Query filter in JSON format. Supports filtering by document properties with operators.

Filter by company:

1 {"company": {"eq": "507f1f77bcf86cd799439011"}}

Filter by public state (single value):

1 {"publicState": {"in": ["approved"]}}

Filter by multiple states:

1 {"publicState": {"in": ["approved", "exported"]}}

Filter by document type:

1 {"type": {"in": ["6827663ca0609723f538dea6", "6827663ca0609723f538deca"]}}

Filter by page count:

1 {"pageCount": {"eq": 11}}

Filter by date range:

1 {"creation": {"gte": "2024-01-01T00:00:00.000Z", "lte": "2024-12-31T23:59:59.999Z"}}

Filter by data fields:

1 {"data.totalAmount": {"gte": 1000}}

Combine multiple filters:

1 {
2   "type": {"in": ["6827663ca0609723f538dea6"]},
3   "publicState": {"in": ["approved"]},
4   "pageCount": {"eq": 11}
5 }

Filter by client data:

1 {"clientData.externalId": {"eq": "ORDER-123"}}

Available operators:

eq - Equals
ne - Not equals
gt - Greater than
gte - Greater than or equal
lt - Less than
lte - Less than or equal
in - Value in array

1	{
2	"type": {"in": ["6827663ca0609723f538dea6"]},
3	"publicState": {"in": ["approved"]},
4	"pageCount": {"eq": 11}
5	}