Skip to main content
POST
This endpoint requires multipart/form-data with a PDF file upload. The interactive playground cannot send file uploads; use Insomnia/Postman for testing.

Overview

Upload a PDF invoice and attach it to a claim. When you upload a PDF, it is stored and linked to the claim, and OCR attempts to extract invoice data and populate the invoice record.
PDF files only: Only PDF format is accepted. Other file formats (images, Word, Excel, etc.) will be rejected.

Request Format

  • Content-Type: multipart/form-data
  • Required field: file (PDF only)
  • Optional text fields: invoice_number, total_amount, maturity_date, issue_date, invoice_issuer, invoice_recipient, subject, invoice_amount_net, creditor_reminder_fees_incurred

Authentication

Requires API Token authentication via Bearer token.

Path Parameters

string
required
UUID of the claim you are attaching an invoice to

Request Body (Multipart Form)

file
required
PDF invoice file to upload. Only PDF format is accepted.
string
Invoice number
string
Gross amount of the invoice (maps to invoice_amount_gross)
string
Due date in ISO 8601 format (maps to invoice_due_date)
string
Issue date in ISO 8601 format (maps to invoice_issue_date)
string
Invoice issuer name
string
Invoice recipient name
string
Optional subject/description
string
Net amount
string
Reminder fees

Testing Instructions

  1. Create a new request: Method POST, URL /openapi/claims//invoices
  2. Auth tab: Type Bearer, Token = your API token
  3. Body tab: Type Multipart Form
    • Add field file with type File, select your .pdf (original filename is automatically preserved)
    • Optional text fields: invoice_number, total_amount, maturity_date, issue_date, invoice_issuer, invoice_recipient, subject, invoice_amount_net, creditor_reminder_fees_incurred
  4. Send request and verify 201 response
Filename Preservation: When using multipart/form-data, the original PDF filename is automatically preserved.The Mintlify playground cannot send multipart/form-data with files. Use Insomnia/Postman for testing.

Examples

cURL
JavaScript
Python

Responses

Notes

  • This endpoint only accepts PDF file uploads via multipart/form-data
  • OCR runs on uploaded PDFs and may populate invoice fields automatically
  • The invoice amount will automatically update the claim’s total_claim_amount via database triggers

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

claim_id
string<uuid>
required

UUID of the claim to attach invoice to

Body

multipart/form-data
file
file
required

Invoice PDF file to upload (only PDF files are accepted)

invoice_number
string

Invoice number/reference

total_amount
number

Total invoice amount (gross) in EUR

maturity_date
string<date>

Invoice due/maturity date

issue_date
string<date>

Invoice issue/creation date

invoice_issuer
string

Name of the invoice issuer (creditor)

invoice_recipient
string

Name of the invoice recipient (debtor)

subject
string

Invoice subject/description

invoice_amount_net
number

Net invoice amount (before tax)

creditor_reminder_fees_incurred
number

Reminder fees already incurred by creditor

Response

Invoice created

success
boolean
data
object