We're excited to announce the addition of new APIs to our Invoice Parse Analyzer service. These APIs will provide users with enhanced capabilities to manage and interact with their invoice data programmatically. Below is a detailed guide on each new API, including examples of how to use them.

1. Upload Invoice API

Endpoint: https://www.invoice-parse.com/api/upload/v1/

This API allows users to upload an invoice file and parse it using our service.

Method:

POST

Example Request:

curl -X POST "https://www.invoice-parse.com/api/upload/v1/" \
-H "Authorization: Bearer <your_token>" \
-F "file=@/path/to/your/invoice.pdf"
        

Payload:

• file: The invoice file to be uploaded and parsed.

Example Response:

{
    "result": {
        "fields": {
            "VendorName": {
                "content": "Acme Corp"
            },
            "InvoiceTotal": {
                "content": "$123.45"
            },
            // other fields...
        }
    }
}
        

---

2. Delete Invoice API

Endpoint: https://www.invoice-parse.com/api/delete/v1/

This API allows users to delete an invoice and its associated data.

Method:

POST

Example Request:

curl -X POST "https://www.invoice-parse.com/api/delete/v1/" \
-H "Authorization: Bearer <your_token>" \
-H "Content-Type: application/json" \
-d '{
    "upload_id": 82
}'
        

Payload:

• upload_id: The upload ID of the invoice.

Example Response:

{
    "message": "Parse data and associated file deleted successfully."
}
        

---

3. List Parses API

Endpoint: https://www.invoice-parse.com/api/list/v1/

This API allows users to list all their parsed invoices.

Method:

GET

Example Request:

curl -X GET "https://www.invoice-parse.com/api/list/v1/" \
-H "Authorization: Bearer <your_token>"
        

Example Response:

{
    "parses": [
        {
            "id": 1,
            "upload_timestamp": "2024-07-25T12:55:00Z",
            "vendor_name": "Acme Corp",
            "invoice_total": "$123.45"
        },
        {
            "id": 2,
            "upload_timestamp": "2024-07-25T12:56:00Z",
            "vendor_name": "Globex Corporation",
            "invoice_total": "$678.90"
        }
        // other parses...
    ]
}
        

---

4. View Parse Result API

Endpoint: https://www.invoice-parse.com/api/result/v1/

This API retrieves the parsed result of a specific invoice.

Method:

GET

Example Request:

curl -X GET "https://www.invoice-parse.com/api/result/v1/1/" \
-H "Authorization: Bearer <your_token>"
        

Example Response:

{
    "result": {
        "fields": {
            "VendorName": {
                "content": "Acme Corp"
            },
            "InvoiceTotal": {
                "content": "$123.45"
            },
            // other fields...
        }
    }
}
        

---

How to Use

1. Upload Invoice:

   Use the Upload Invoice API to upload and parse your invoice files.

   Ensure your request includes the file parameter with the invoice file you want to upload.

2. Delete Invoice:

   Use the Delete Invoice API to remove an invoice and its associated data.

   Provide the upload_id in the request payload.

3. List All Parses:

   Use the List Parses API to retrieve a list of all parsed invoices.

   This can be useful to get an overview of all invoices processed under your account.

4. View Parse Result:

   Use the View Parse Result API to fetch the detailed parsed data of a specific invoice.

   This will return all the extracted fields and their respective values.

Conclusion

These new APIs provide robust tools for managing your invoice parsing needs. We hope you find them useful and easy to integrate into your existing systems. If you have any questions or need further assistance, please contact us at contact@invoice-parse.com.

Happy parsing!