Get wizard-shaped prefill data for an extracted invoice

GET

invoices

{id}

payout-prefill

curl --request GET \
  --url https://api.example.com/v1/invoices/{id}/payout-prefill

{
  "amount": {
    "currency": "<string>",
    "minor": 123
  },
  "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

string

required

Invoice UUID

Response

amount

object

required

Show child attributes

beneficiary

object

required

Show child attributes

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

Show child attributes

Get wizard-shaped prefill data for an extracted invoice (decimal-string amount)Combines the OCR extraction, validation errors, and beneficiary match into the payload the SendMoneyWizard consumes. The amount is a decimal string in major units. Returns 409 if the extraction is not yet ready; the client should poll GET /v1/invoices/:id. Supersedes the deprecated v1 endpoint, which returns the amount as integer minor units.

Get wizard-shaped prefill data for an extracted invoice

curl --request GET \
  --url https://api.example.com/v1/invoices/{id}/payout-prefill

{
  "amount": {
    "currency": "<string>",
    "minor": 123
  },
  "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>"
    }
  ]
}