Invoice Integration
This guide describes the different ways you can get invoices into the Nooxit system.
Overview
There are three main methods to upload invoices to Nooxit:
- PDF Receiver API - Programmatically upload PDFs via REST API
- Manual Upload - Upload invoices through the web interface
- Email Pipeline - Automatically process invoices from email
Method 1: PDF Receiver API
The PDF Receiver API allows you to programmatically upload invoice PDFs to Nooxit. This is the recommended method for automated integrations.
API Documentation
The complete API specification is available below:
Key Endpoints
- POST
/v1/pdf-receiver/add-pdf- Upload a PDF invoice to the system - POST
/v1/pdf-receiver/get-pdf- Retrieve a PDF that was previously uploaded
Getting Started
- Authenticate with the Nooxit API using the X-API-KEY with the key that was given to you
- Use the
add-pdfendpoint to upload your invoice PDF - The system will process the PDF and extract invoice information
- You'll receive a unique identifier that you can use to track the invoice
For detailed request/response schemas and examples, refer to the API documentation above.
Method 2: Manual Upload
You can upload invoices manually through the Nooxit web application.
Steps
- Navigate to app.prod.aws.nooxit.com
- Log in with your credentials
- Use the upload interface to select and upload invoice PDFs
- The system will automatically process uploaded invoices
This method is ideal for: - One-off invoice uploads - Testing and validation - Situations where API integration is not yet available
Method 3: Email Pipeline
The email pipeline allows you to automatically process invoices received via email. This is the most hands-off approach for ongoing invoice processing.
Setup
To connect the email pipeline, follow the instructions in the Emails section.
How It Works
- Configure your email account to forward invoices to a designated Nooxit email address
- The email pipeline automatically:
- Receives emails with invoice attachments
- Extracts PDF attachments
- Processes and extracts invoice data
- Makes the invoice available in your system
This method is ideal for: - High-volume invoice processing - Automated workflows - Reducing manual intervention
Getting Invoice Processing Results
After an invoice is uploaded and processed by Nooxit, you can retrieve the extracted invoice information in two ways:
Method 1: Auto-Transmission via ERP APIs
If your ERP system is configured with Nooxit, the processed invoice information is automatically transmitted to your ERP through its standard APIs. This is the most seamless integration method.
How it works: - Once an invoice is processed, Nooxit automatically sends the extracted data to your ERP system - The transmission happens through your ERP's standard API endpoints - No additional polling or API calls are required from your side
This method is ideal for: - Fully automated workflows - Real-time invoice processing - ERP systems with established Nooxit integrations
Method 2: Storage Service API
You can programmatically retrieve invoice information using the Storage Service API. This gives you full control over when and how you access the processed invoice data.
API Documentation
The complete Storage Service API specification is available below:
Key Endpoint
- GET
/v1/storage-service/get-invoice-information- Retrieve processed invoice information
Usage
- Use the invoice identifier you received when uploading the PDF (from the PDF Receiver API)
- Call the
get-invoice-informationendpoint with the required parameters: invoiceId- The invoice identifier- The API either returns the complete invoice information including, or an error if it still processing
This method is ideal for: - Custom integrations - On-demand data retrieval - Systems that need to poll for results - When auto-transmission is not configured
Diagrams
API In - API Out Flow
This diagram shows the flow when using the PDF Receiver API to upload invoices and retrieving results via the Storage Service API:
flowchart LR
A["Customer System"] -->|"POST /v1/pdf-receiver/add-pdf<br/>(Invoice PDF)"| B["Nooxit PDF Receiver API"]
B -->|"Invoice ID"| A
B -->|"Process Invoice"| C["Nooxit Processing Engine"]
C -->|"Extract Invoice Data"| D["Nooxit Storage"]
A -->|"GET /v1/storage-service/get-invoice-information<br/>(Invoice ID)"| E["Nooxit Storage Service API"]
E -->|"Invoice Information"| A
D --> E
Email In - ERP System Flow
This diagram shows the automated flow when invoices are received via email and automatically transmitted to your ERP system:
flowchart LR
A["Email Server"] -->|"Email with<br/>PDF Attachment"| B["Nooxit Email Pipeline"]
B -->|"Extract PDF"| C["Nooxit Processing Engine"]
C -->|"Extract Invoice Data"| D["Nooxit Storage"]
D -->|"Auto-Transmit"| E["ERP System API"]
E -->|"Invoice Data"| F["ERP System / Workflow Solution"]
Next Steps
- For API integration: Review the PDF Receiver API documentation above
- For email setup: See the Emails section
- For manual uploads: Visit app.prod.aws.nooxit.com