Skip to main content
GET
/
v2
/
invoices
/
{id}
/
payout-prefill
Get wizard-shaped prefill data for an extracted invoice (decimal-string amount)
curl --request GET \
  --url https://api.example.com/v2/invoices/{id}/payout-prefill
{
  "amount": {
    "currency": "<string>",
    "value": "1234.56"
  },
  "beneficiary": {
    "draft": {
      "accountNumber": "<string>",
      "address": "<string>",
      "addressLine2": "<string>",
      "bic": "<string>",
      "city": "<string>",
      "country": "<string>",
      "iban": "<string>",
      "name": "<string>",
      "postcode": "<string>"
    },
    "matchedBeneficiaryId": "<string>"
  },
  "description": "<string>",
  "dueDate": "<string>",
  "fieldStates": {
    "iban": "needs_review",
    "supplier": "confirmed"
  },
  "invoiceId": "<string>",
  "reference": "<string>",
  "validationErrors": [
    {
      "code": "<string>",
      "fields": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

Path Parameters

​
id
string
required

Invoice UUID

Response

​
amount
object
required
​
beneficiary
object
required
​
description
string | null
required
​
dueDate
string | null
required
​
fieldStates
object
required

Per-field UX state. Keys: supplier, iban, bic, accountNumber, country, currency, amount, reference, dueDate. Values: confirmed | needs_review | missing.

Example:
{
  "iban": "needs_review",
  "supplier": "confirmed"
}
​
invoiceId
string
required
​
reference
string | null
required
​
validationErrors
object[]
required