# IDP by Workato - Process document using IDP by Workato action
The Process document using IDP by Workato action extracts structured data from uploaded files using Intelligent Document Processing (IDP) by Workato. Extracted data appears as datapills.
Complete the following steps to set up your IDP by Workato action:
Search for and select IDP by Workato as your connector action after you have set up your trigger.
Choose IDP by Workato as your app
Select Process document using IDP by Workato as your action.
Provide File contents to process.
Process document action
Enter the File name with its extension or specify the type in File type.
Use the File type drop-down menu to select the file type you plan to process. This overrides the inferred type from File name. This connector supports png, jpg, webp, gif, and pdf file types. PDF files must not exceed 15 pages.
Use the Document type drop-down menu to select the document type you plan to process. Available options are Documents, Invoices, and Receipts. Receipts and invoices have a predefined schema you can use directly. Select Documents if you plan to provide your own schema.
Add your JSON schema or enter Fields to identify manually.
Paste or upload your JSON schema
Add fields manuallyClick Save.
# Output
This action returns extracted values and confidence scores. Extracted values contain structured data from the document, while confidence scores indicate the accuracy of the extracted values.
# Extracted values
Extracted values include key details from the document, such as invoice numbers, dates, line items, and total amounts.
Example value output
{
"values": {
"invoice_number": "I-N-V-50513188",
"invoice_date": "17-Sep-2009",
"due_date": "07-Mar-1996",
"order_date": null,
"total_amount": 722.84,
"line_items": [
{
"description": "Cultural identify.",
"quantity": 2,
"price": 21.06,
"product_code": null,
"unit_price": 10.53
},
{
"description": "Sister degree letter.",
"quantity": 4,
"price": 153.6,
"product_code": null,
"unit_price": 38.4
},
{
"description": "Quite always item.",
"quantity": 4,
"price": 131.32,
"product_code": null,
"unit_price": 32.83
},
{
"description": "Shoulder.",
"quantity": 5,
"price": 364,
"product_code": null,
"unit_price": 72.8
},
{
"description": "Wall laugh.",
"quantity": 5,
"price": 38,
"product_code": null,
"unit_price": 7.6
}
],
"vendor_address": "8110 Lee Haven, West Michele, IN 23979 US",
"recipient_address": "838 Harris Ferry, Matthew burgh, MP 10645 US",
"vendor_phone": "+1(193)406-5197",
"vendor_url": "www.Graham-Carrillo-and-Stark.com",
"vendor_gst_number": "24H-D-E7487R-E-S-R-T4",
"vendor_email": "[email protected]",
"recipient_phone": "+1(362)455-4064",
"recipient_url": "https://www.torres.biz/",
"recipient_gst_number": null,
"recipient_email": "[email protected]",
"purchase_order_number": null,
"subtotal": 707.98,
"tax_amount": 14.86,
"discount": null,
"payment_terms": null,
"notes": null,
"shipping_fee": null,
"service_charge": null,
"account_number": "16870634",
"bank_code": null,
"swift_number": "S-B-I-N-I-N-B-B250",
"payment_method": null,
"terms_and_conditions": "Terms and Conditions will be charged if payment is not made within the due date.",
"remaining_calls": 99,
"consumed_calls": 1,
"reset_time": "2024-06-21T02:14:56.000000-07:00"
}
}
# Confidence scores
Confidence scores indicate the model's confidence in the extracted values. A higher score (closer to 1.0) means greater accuracy.
Example confidence scores
{
"confidence_scores": {
"invoice_number": 0.9999498764044592,
"invoice_date": 0.9996482332742705,
"due_date": 0.9999909854763569,
"order_date": 0.9999952766598805,
"total_amount": 0.9999833454831217,
"line_items": [
{
"description": 0.9928496557986662,
"quantity": 0.9137961392004543,
"price": 0.9659621927727069,
"product_code": 0.999996766699321
},
{
"description": 0.9999201908481007,
"quantity": 0.9999195718568064,
"price": 0.9978151698276594,
"product_code": 0.9999995679801468
},
{
"description": 0.9998884805883848,
"quantity": 0.9999804063791609,
"price": 0.9999548387307367,
"product_code": 0.9999996871837311
},
{
"description": 0.9997998524901466,
"quantity": 0.9999720029460075,
"price": 0.9998689017394373,
"product_code": 0.9999999031936844
},
{
"description": 0.9999628251424393,
"quantity": 0.9999601429370041,
"price": 0.9998570904479072,
"product_code": 0.9999998063873687
}
],
"vendor_phone": 0.9110792042231154,
"vendor_url": 0.9452639023666751,
"vendor_gst_number": 0.9992403800587537,
"vendor_email": 0.9990823827609913,
"recipient_phone": 0.9949677082415654,
"recipient_url": 0.9963093776626322,
"recipient_gst_number": 0.9997899093338881,
"recipient_email": 0.9980467902735672,
"purchase_order_number": 0.9999576695636125,
"subtotal": 0.9999805851068317,
"tax_amount": 0.9990580898021001,
"discount": 0.9956880111711502,
"payment_terms": 0.8990708766681919,
"notes": 0.7962851560580655,
"shipping_fee": 0.999827195289032,
"service_charge": 0.9999335967675153,
"account_number": 0.9943227138851094,
"bank_code": 0.9813131412674407,
"swift_number": 0.9913429312416263,
"payment_method": 0.9992365566395588
}
}
# Use cases
The input fields for this action vary depending on the document type. The following examples demonstrate how to configure the input fields for invoices and general documents.
# Process an invoice
Invoices contain structured data such as invoice numbers, dates, line items, and total amounts. This example shows how to configure the Process document using IDP by Workato action to extract key invoice details:
Example invoice configuration
The input fields in this example are based on the following invoice:
Invoice example
The invoice is uploaded to Workato FileStorage. Use the Get file contents in Workato FileStorage action to retrieve it, then process it using the Process document using IDP by Workato action with the following fields:
| Input field | Description |
|---|---|
| File contents | The invoice file. This example maps the File contents datapill from the Get File contents action. |
| File name | Enter the file name with its extension or specify the type in File type. |
| File type | Specify the file type of the document. Supported formats include png, jpg, webp, gif, and PDF. This example uses png. |
| Document type | Set the document type to Invoices. |
| Fields to identify | Define the fields to extract from the file. |
Invoice input fields
# Process a general document
Documents may not follow a fixed structure like invoices. This example shows how to configure the Process document using IDP by Workato action to extract key details from an unstructured document.
Example document configuration
The input fields in this example are based on the following document:
Document example
The document is uploaded to Workato FileStorage. Use the Get file contents in Workato FileStorage action to retrieve it, then process it using the Process document using IDP by Workato action with the following fields:
| Input field | Description |
|---|---|
| File contents | The document file. This example maps the File contents datapill from the Get file contents action. |
| File name | Enter the file name with its extension or specify the type in File type. |
| File type | Specify the file type of the document. Supported formats are png, jpg, webp, gif, and PDF. This example uses PDF. |
| Document type | Set the document type to Documents. |
| Fields to identify | Define the fields to extract from the file. |
Document input fields
Last updated: 4/9/2025, 3:06:04 PM