Skip to main content
Retrieve a paginated list of your invoices with optional filtering.

​
Endpoint

GET /api/invoices

​
Query Parameters

ParameterTypeDefaultDescription
pageinteger1Page number
limitinteger50Items per page (max 100)
supplierstring-Filter by supplier name (partial match)
statusstring-Filter by processing status
reviewStatusstring-Filter by review status
currencystring-Filter by currency code
vatRatenumber-Filter by VAT rate
dateFromstring-Invoice date range start (ISO 8601)
dateTostring-Invoice date range end (ISO 8601)
keywordstring-Search across multiple fields
clientIdstring-Filter by client ID

​
Example Request

curl -X GET "https://vatextract.com/api/invoices?page=1&limit=20&supplier=Acme" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

{
  "invoices": [
    {
      "id": "inv_abc123",
      "supplierName": "Acme Corp",
      "invoiceNumber": "INV-2024-001",
      "invoiceDate": "2024-01-10T00:00:00Z",
      "dueDate": "2024-02-10T00:00:00Z",
      "totalAmount": 1250.00,
      "vatAmount": 250.00,
      "vatRate": 20,
      "netAmount": 1000.00,
      "currency": "EUR",
      "status": "completed",
      "reviewStatus": "NOT_REVIEWED",
      "createdAt": "2024-01-15T10:30:00Z",
      "clientId": "client_xyz789",
      "client": {
        "id": "client_xyz789",
        "name": "My Client"
      }
    }
  ],
  "total": 156,
  "page": 1,
  "limit": 20,
  "totalPages": 8
}

​
Response Fields

FieldTypeDescription
invoicesarrayList of invoice objects
totalintegerTotal number of invoices matching filters
pageintegerCurrent page number
limitintegerItems per page
totalPagesintegerTotal number of pages

​
Invoice Object

FieldTypeDescription
idstringUnique invoice ID
supplierNamestringVendor company name
invoiceNumberstringInvoice identifier
invoiceDatestringIssue date (ISO 8601)
dueDatestringPayment due date
totalAmountnumberGrand total
vatAmountnumberTax amount
vatRatenumberVAT percentage
netAmountnumberPre-tax amount
currencystringISO currency code
statusstringprocessing, completed, failed
reviewStatusstringNOT_REVIEWED, IN_REVIEW, REVIEWED, APPROVED

​
Status Values

​
Processing Status

ValueDescription
processingOCR in progress
completedExtraction finished
failedExtraction failed

​
Review Status

ValueDescription
NOT_REVIEWEDNot yet reviewed
IN_REVIEWCurrently being reviewed
REVIEWEDReview completed
APPROVEDApproved for processing