API Documentation > IntelliDocs 2.0 API > QuickStart guide.
In this quickstart tutorial you are going to find a step-by-step guide to quickly process a sample invoice using IntelliDocs. Along the way, you’ll learn key concepts and techniques that are fundamental to use the API for multiple tasks, including:
- What is an IntelliDocs API Key
- How to select a document to be processed
- How to send documents to be processed
Without further ado, let’s get started.
Prerequisites
- Go to the ElectroNeek Platform Home page. Look for the IntelliDocs tile and click on it.
You can also access it under the "Automation Hub" in the navigation menu by clicking on IntelliDocs > Document Streams
- After clicking on this, you will be taken to the IntelliDocs Web Portal to explore its features. If you're accessing the platform for the first time, you'll see that no document stream has been created yet. Once you have access, you can manage customers, API keys and the number of pages available for processing.
- To create a single document stream click on the "Add Document Stream" button. Then, provide "Document Stream Name", Limit Type, "Page limit", and a Document description that includes the model and related data that want to be extracted separated in fields. The page limit here is the maximum number of pages available for processing this document Stream per the limit type. For the Balance type, the usage counter will never be reset as opposed to Monthly and Yearly which reset the counter every month or year.
- Here is an example of how to describe an Invoice document:
Field | Field Type | Description |
---|---|---|
Model Description | An Invoice is a commercial document issued by a seller to a buyer, relating to a sale transaction and indicating the products, quantities, and agreed prices for products or services the seller had provided the buyer. It serves as a request for payment and may include details about tax, payment terms, and other relevant transaction information. | |
InvoiceNumber | Text | Unique identifier for the invoice, often located at the top of the document. |
InvoiceDate | Text | The date when the invoice was issued. Format can vary, but commonly localized in US date format mm/dd/yyyy. |
SellerName | Text | The name of the entity issuing the invoice, typically found at the top or in a header section. |
BuyerName | Text | The name of the entity to whom the invoice is billed, often located near the top or in a header section. |
SubTotal | Number | The total before taxes and additional fees, often found above the Total Amount field. |
TaxAmount | Number | The total tax applied on the transaction, it is typically located near the Total Amount field. |
TotalAmount | Number | The total amount due for payment, typically located at the bottom of the invoice, including all fees and taxes. |
DueDate | Text | The specific date by which payment should be made, often located in the payment terms section. |
PaymentTerms | Text | Terms that specify the payment deadline and conditions are found either at the bottom or in a footer section. |
ProductDescriptions | Table | Descriptions of each item or service provided, are usually listed in the body of the invoice. |
Column Name | Column Type | Column Description |
ProductItemDescription | Text | Description of each item or service listed. |
ProductQuantities | Number | Quantities for each item or service listed. |
UnitPrices | Number | Prices per unit for each item or service. |
LineTotal | Number | Total price for all units of this item. |
Important: The description can be customized to get the expected result. Think about it as a context provided to the AI to identify the required information from the document. You can also use this field to provide instructions on how the information will be provided, for instance: provide the date in DD-MMM-YYYY format.
- Once you've entered the required information, click the "Save" button. You'll see a new row created on the table, indicating the creation of a new document stream.
- On the right side of the page, you can visually check the API key by clicking on the eye icon. You can easily copy the API Key by clicking the clipboard icon.
Testing a Document Stream in IntelliDocs
To test a Document Stream with an example, follow the provided instructions below:
- Go to Test Recognition
-
Select the document you want to process.
-
Select the Document Stream for the selected document type.
-
Click Extract to process the document.
-
Once the document is processed, the result will be shown on the screen:
-
Visual Result: This view will display the result in a human-readable format. It will
-
API Response: This is the output that ElectroNeek Studio Pro will receive when using Extract Document Data activity or when using the IntelliDocs API.
-