Upload

Extract Invoice

Reads a supplier invoice and returns the fields needed to register it as an invoice payable: amount, currency, due date, vendor, line items and the payment options printed on it. Every field is nullable and nothing is guessed; numbers that fail format validation come back null. The result prefills a form, it is not a payable. Limited to 60 requests per minute per instance.

post/v1/upload/extract

Query parameters

instance_idstring

Instance ID. When provided, the request must be authenticated with an API key scoped to this instance. When omitted, a dashboard (Clerk) session is required.

Response

Fields read from the invoice

amountinteger nullable required

Total due in cents of currency.

currencystring nullable required

due_datestring nullable required

YYYY-MM-DD.

invoice_numberstring nullable required

Example response

{
  "amount": 425000,
  "currency": "USD",
  "due_date": "2026-09-15",
  "invoice_number": "INV-2026-081",
  "payment_options": [
    {
      "type": "ach"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.