Schema BankTransactionAssignmentSuggestion

BankTransactionAssignmentSuggestion (object)

Field

Type

Description

bank_transaction*

object

Field

Type

Description

amount_assignable_cents*

integer

Amount in cents that can still be assigned to payables (0 when fully assigned, private, or no assignment required)

amount_cents*

integer

Signed; positive = credit, negative = debit

assignment_status*

string

Derived from allocations, linked transfer, is_private, and is_no_assignment_required. open, partially_assigned, fully_assigned, private, no_assignment_required, transfer

string

open
partially_assigned
fully_assigned
private
no_assignment_required
transfer

auto_detected*

boolean

Automatically detected e.g. by import or matching

bank_account_id*

integer

—

counterparty_account_number

string

—

counterparty_bank_code

string

—

counterparty_name

string

—

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

currency_code

string

—

external_id

string

—

id*

integer

—

is_no_assignment_required*

boolean

User-marked as not requiring document assignment (e.g. zero-amount transactions)

is_private*

boolean

User-marked as private (no business assignment)

linked_transfer

object

Summary of the paired bank transaction in an internal account transfer (Umbuchung).

Field	Type	Description
amount_cents*	integer	Signed; positive = credit, negative = debit
bank_account_id*	integer	—
counterparty_name	string	—
currency_code	string	—
id*	integer	—
reference	string	—
transaction_date*	string	Timestamp in W3C format, will be saved in UTC time +00:00

locked_at

string

Timestamp in W3C format, will be saved in UTC time +00:00

memo

string

—

reference

string

—

source*

string

manual, csv, api

transaction_date*

string

Timestamp in W3C format, will be saved in UTC time +00:00

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

value_date

string

Date in Y-m-d format

suggestion*

object

Field

Type

Description

amount_open_cents*

integer

Open amount on the document in cents

amount_total_cents*

integer

Total document amount in cents (e.g. sum gross or dunning fee)

contact_avatar

object

Field	Type	Description
url	string	—

contact_company_name

string

—

contact_first_name

string

—

contact_id

integer

—

contact_last_name

string

—

contact_name

string

—

contact_number

integer

—

currency_code

string

—

document_date

string (date)

—

document_subject

string

Document subject or title when available (invoice, credit note, dunning)

match_reasons*

string[]

Why this document was suggested (amount exact match, counterparty name, and/or document number in reference/memo)

array

Elements

string

amount
counterparty
document_number

payable_id*

integer

—

payable_label*

string

—

payable_type*

string

Invoice
CreditNote
Dunning

suggested_amount_cents*

integer

Suggested booking amount in cents (positive, capped by open amount and assignable remainder)

suggestions*

object[]

All matching documents for this transaction, best match first

array

Elements

Field

Type

Description

amount_open_cents*

integer

Open amount on the document in cents

amount_total_cents*

integer

Total document amount in cents (e.g. sum gross or dunning fee)

contact_avatar

object

Field	Type	Description
url	string	—

contact_company_name

string

—

contact_first_name

string

—

contact_id

integer

—

contact_last_name

string

—

contact_name

string

—

contact_number

integer

—

currency_code

string

—

document_date

string (date)

—

document_subject

string

Document subject or title when available (invoice, credit note, dunning)

match_reasons*

string[]

Why this document was suggested (amount exact match, counterparty name, and/or document number in reference/memo)

array

Elements

string

amount
counterparty
document_number

payable_id*

integer

—

payable_label*

string

—

payable_type*

string

Invoice
CreditNote
Dunning

suggested_amount_cents*

integer

Suggested booking amount in cents (positive, capped by open amount and assignable remainder)

Example (JSON)

{
  "bank_transaction": {
    "id": 0,
    "bank_account_id": 0,
    "transaction_date": "2025-01-14T13:51:15.000Z",
    "value_date": "2025-01-14T00:00:00.000Z",
    "amount_cents": 0,
    "currency_code": "string",
    "source": "string",
    "assignment_status": "open",
    "amount_assignable_cents": 0,
    "is_private": true,
    "is_no_assignment_required": true,
    "auto_detected": true
  },
  "suggestion": {
    "payable_type": "Invoice",
    "payable_id": 0,
    "payable_label": "string",
    "contact_id": 0,
    "contact_name": "string",
    "contact_first_name": "string",
    "amount_total_cents": 0,
    "amount_open_cents": 0,
    "match_reasons": [
      "amount"
    ],
    "suggested_amount_cents": 0
  },
  "suggestions": [
    {
      "payable_type": "Invoice",
      "payable_id": 0,
      "payable_label": "string",
      "contact_id": 0,
      "contact_name": "string",
      "contact_first_name": "string",
      "amount_total_cents": 0,
      "amount_open_cents": 0,
      "match_reasons": [
        "amount"
      ],
      "suggested_amount_cents": 0
    }
  ]
}