Core API

Document types

Pass document_type in your request to select the parsing mode.

Each type uses an optimised AI prompt tuned for that document's structure. Omitting document_type defaults to invoice.

Invoice

invoice

Standard vendor invoices, bills, and tax invoices.

curl -X POST https://api.lumiparser.com/v1/invoices \
  -H "Authorization: Bearer inv_live_YOUR_KEY" \
  -F "file=@invoice.pdf" \
  -F "document_type=invoice"

Extracted fields

Field	Description
vendor_name	Company issuing the invoice
vendor_address	Vendor street address
vendor_email	Vendor contact email
vendor_phone	Vendor contact phone
invoice_number	Unique invoice identifier
invoice_date	Date invoice was issued (ISO 8601)
due_date	Payment due date (ISO 8601)
payment_terms	e.g. Net 30, Due on receipt
line_items[]	Array of {description, quantity, unit_price, total}
subtotal	Pre-tax total
tax_rate	Decimal e.g. 0.08 for 8%
tax_amount	Calculated tax
discount	Discount amount if present
grand_total	Final amount due
currency	3-letter ISO code e.g. USD
po_number	Purchase order reference
bank_details	Payment bank details if shown

Receipt

receipt

Point-of-sale receipts, e-receipts, and payment confirmations.

curl -X POST https://api.lumiparser.com/v1/invoices \
  -H "Authorization: Bearer inv_live_YOUR_KEY" \
  -F "file=@receipt.jpg" \
  -F "document_type=receipt"

Extracted fields

Field	Description
merchant_name	Store or business name
merchant_address	Store address
merchant_phone	Store phone number
receipt_number	Transaction or receipt number
date	Transaction date (ISO 8601)
time	Transaction time
line_items[]	Array of {description, quantity, unit_price, total}
subtotal	Pre-tax amount
tax_amount	Tax charged
tip_amount	Tip if applicable
total_amount	Total paid
currency	3-letter ISO code
payment_method	e.g. Visa, Cash, Apple Pay
card_last_four	Last 4 digits of card if present

Purchase Order

purchase_order

PO documents from buyers to suppliers.

curl -X POST https://api.lumiparser.com/v1/invoices \
  -H "Authorization: Bearer inv_live_YOUR_KEY" \
  -F "file=@purchase-order.pdf" \
  -F "document_type=purchase_order"

Extracted fields

Field	Description
po_number	PO identifier
po_date	Date PO was issued (ISO 8601)
delivery_date	Expected delivery date
buyer_name	Buying company name
buyer_address	Buyer address
buyer_contact	Buyer contact info
supplier_name	Supplying company name
supplier_address	Supplier address
supplier_contact	Supplier contact info
line_items[]	Array of {description, sku, quantity, unit_price, total}
subtotal	Pre-tax total
tax_amount	Tax amount
shipping_cost	Shipping cost if shown
grand_total	Total order value
currency	3-letter ISO code
payment_terms	e.g. Net 30
delivery_terms	e.g. FOB, CIF, DDP

Bank Statement

bank_statement

Monthly bank statements with transaction history.

curl -X POST https://api.lumiparser.com/v1/invoices \
  -H "Authorization: Bearer inv_live_YOUR_KEY" \
  -F "file=@statement.pdf" \
  -F "document_type=bank_statement"

Extracted fields

Field	Description
bank_name	Name of the bank
account_holder	Account owner name
account_number	Masked account number
account_type	e.g. Checking, Savings
statement_period_start	Start of statement period (ISO 8601)
statement_period_end	End of statement period (ISO 8601)
opening_balance	Balance at period start
closing_balance	Balance at period end
currency	3-letter ISO code
transactions[]	Array of {date, description, reference, amount, balance, category}
total_credits	Sum of all deposits
total_debits	Sum of all withdrawals (negative)
total_transactions	Count of transactions