Retrieve details from a document using Dodocs.
Application
DoDocs
Inputs (what you have)
Name | Description | Data Type | Required? | Example |
Document | Document to retrieve details from | File | Yes | |
Metadata | Metadata to be submitted in JSON format with the provided document | Text (Long) | No |
Outputs (what you get)
Name | Description | Data Type | Required? | Example |
Request ID | The ID of the request. Example: 5b9dcc4a-ac04-4d54-8825-54c0e21adb6b | Text (Short) | No | 5b9dcc4a-ac04-4d54-8825-54c0e21adb6b |
File name | Name of the invoice file. Example: Invoice_123.pdf | Text (Short) | No | Invoice_123.pdf |
Page number | Page number of the document. Example: 1 | Number | No | 1 |
Document type | Type of the document. Example: Invoice | Text (Short) | No | Invoice |
Validation comments | Comments related to document validation | Text (Long) | No | |
Error code | If unsuccessful, the reason for the error. Example: Timeout | Text (Long) | No | Timeout |
Invoice number | Unique invoice identifier. Example: 60607 | Text (Short) | No | 60607 |
Invoice date | Date when the invoice was issued. Example: 2023-03-15 | Date | No | 2023-03-15 |
Vendor name | Name of the vendor. Example: ABC TECHNOLOGIES CORPORATION | Text (Short) | No | ABC TECHNOLOGIES CORPORATION |
Vendor address | Address of the vendor. Example: 244 Fifth Avenue, Suite D81, New York, NY 10001, United States | Text (Long) | No | 244 Fifth Avenue, Suite D81, New York, NY 10001, United States |
Customer name | Name of the customer. Example: XYZ Society | Text (Short) | No | XYZ Society |
Customer address | Address of the customer. Example: 2300 Southern Boulevard, Bronx, NY 10460, United States | Text (Long) | No | 2300 Southern Boulevard, Bronx, NY 10460, United States |
Total amount | Total amount before tax. Example: 6564.0 | Number with decimals | No | 6564 |
Total amount with tax | Total amount including tax. Example: 6587.17 | Number with decimals | No | 6587.17 |
Total tax | Total tax amount on the invoice. Example: 0.0 | Number with decimals | No | |
Vendor tax ID | Tax ID of the vendor | Text (Short) | No | |
Customer tax ID | Tax ID of the customer | Text (Short) | No | |
Attachment ID | Unique identifier of the attachment. Example: c7bebc4f-f5d3-460c-bb06-150c421824df | Text (Short) | No | c7bebc4f-f5d3-460c-bb06-150c421824df |
Line items array | JSON Array of line items included in the invoice. Example: [{ "quantity": 6, "Rate": 1094.0 }] | Text (Long) | No | [{ "quantity": 6, "Rate": 1094.0 }] |
Full output JSON | The full JSON response from Dodocs. Example: [ { "quantity": 6, "Rate": 1094.0, ... } ] | Text (Long) | No | [ { "quantity": 6, "Rate": 1094.0, ... } ] |
Outcomes
Name | Description |
Success | This status is selected if the job has successfully completed. |
Unsuccessful | This status is selected if the job has completed unsuccessfully. |
Requirements
N/A