---
title: "Invoice extraction"
method: POST
path: "/v1/invoice"
tags: ["Invoice extraction"]
---

# Invoice extraction

`POST /v1/invoice`

## Request

- Base URL: `https://api.thecompound.tech`
- URL: `https://api.thecompound.tech/v1/invoice`
- Auth: HTTP bearer

ParseRail converts an invoice, whether PDF, photo, or text, into the vendor, dates, PO refs, tax, totals, and clean line items.

Cost: 8 credits ($0.08) — charged only on success.

Accepts `async: true` for long documents — see the **Async & webhooks** guide.

## Headers

- `ParseRail-Dry-Run` '1' | 'true'
- `Idempotency-Key` string

## Request body

- object: Provide exactly one of: file, fileUrl, or text.
  - `file` object: Inline document.
    - `data` string, required: Base64-encoded file bytes.
    - `mimeType` string, required
  - `fileUrl` string, uri: Provide a public URL to a PDF or image.
  - `text` string: Provide raw text if you already have it.

## Response `200`

The call succeeded. The response contains result fields and a usage envelope. With `ParseRail-Dry-Run: 1` the body is a DryRun object instead.

- union
  - object
    - `vendor` object, required
      - `name` string, required
      - `address` string, nullable
      - `taxId` string, nullable
    - `customer` string, nullable
    - `invoiceNumber` string, nullable
    - `poNumber` string, nullable
    - `issueDate` string, nullable: YYYY-MM-DD.
    - `dueDate` string, nullable: YYYY-MM-DD.
    - `currency` string, nullable: ISO code, e.g. USD.
    - `subtotal` number, nullable
    - `tax` number, nullable
    - `total` number, nullable
    - `paymentTerms` string, nullable
    - `lineItems` object[], required
      - `description` string, required
      - `quantity` number, nullable
      - `unitPrice` number, nullable
      - `amount` number, required
    - `usage` Usage, required
      - `credits` integer, required: Credits burned by this call.
      - `balanceRemaining` integer, required: Wallet balance after the charge.
  - DryRun: A dry run: auth, the per-key throttle, body validation and the balance precheck ran. No model ran and nothing was charged.
    - `dryRun` true, required
    - `valid` true, required: The body passed validation. An invalid body returns 400 instead.
    - `endpoint` string, required
    - `wouldCharge` integer, required: Credits a successful live call would charge.
    - `balance` integer, required: Your wallet balance now.
    - `liveStatus` 200 | 202 | 402, required: The status a live call with this body would get: 402 when the balance or the key's monthly cap cannot cover it, 202 for `async: true`, else 200.
    - `keyCapRemaining` integer: Present when the key carries a monthly cap: credits left under it this month.
    - `usage` Usage, required
      - `credits` integer, required: Credits burned by this call.
      - `balanceRemaining` integer, required: Wallet balance after the charge.
    - `requestId` string, required

## Other responses

- `202`: Accepted (`async: true`). The job is queued. Poll `GET /v1/jobs/{id}` or wait for the callback. Credits are charged when it succeeds, never on enqueue.
- `400`: Invalid request body.
- `401`: Missing or invalid API key.
- `402`: `insufficient_credits`: the balance cannot cover the call. `spend_cap_reached`: the key has reached its monthly cap. Nothing is charged.
- `429`: Rate limit exceeded.

---

[API](https://skmtc.dev/thecompound/apis/parserail.md) · [All operations](https://skmtc.dev/thecompound/apis/parserail/llms.txt) · [OpenAPI document](https://skmtc.dev/thecompound/apis/parserail/revisions/7895a3b7812b?raw)