Payment Assignment

Payment Assignment links a Payment Transaction to an open document (invoice, credit note, …) or an order, so open items can be cleared.

Assignments can be created:

• Automatically — after categorization, using Matching Rules and the Merchant Payment Account assignment configuration

• Manually — in the webportal or via API

• As batch assignment — one payment clears several documents/orders → Batch Payment Assignment

  

Assignment status

On the Payment Transaction:

On each assignment record (API): ASSIGNED or REVERSED. Origin can be AUTOMATED or MANUAL. Assignments may happen before settlement (beforeSettlement) in full-service flows.

Targets

You can assign to:

• a document (invoice, credit note, deposit invoice, …) — targetIdentType: DOCUMENT
• an order — targetIdentType: ORDER (typical for deposits / down payments)

Manual assignment

Go to: Payment > Transactions

1. Find the transaction (filter by sender, amount, category, booking/value date, …).
2. Ensure it has an assignable category (Actions → Assign category if needed).
3. Actions → Assign payment, or open Details → Assign payment.
4. Choose target type invoice / document or order.
5. Select the target and Save.

The transaction status becomes partially or completely assigned depending on amounts.

Change category after clarification

If a payment was categorized incorrectly (e.g. clarification case) and you need another category:

1. Reverse / unassign existing assignments first.
2. Change the category.
3. Assign again to the correct document or order.

You cannot change the category while the transaction is still assigned.

Reverse an assignment

Reversing frees the assigned amount back onto the transaction (assignableLeftoverAmount is recalculated).

• Webportal: reverse/unassign from the transaction / assignment UI where available
• API: POST /v2/payment-assignments/{ident}/actions/reverse
  → Reverse payment assignment

Automatic assignment

1. Create Matching Rules (regex strategies) that extract document/order idents from the payment text.
2. Attach strategies (with priority) to the Merchant Payment Account assignment configuration.
3. Configure whether overpayment / underpayment auto-assignment is allowed for documents and/or orders.

When a categorized, assignable settlement/transaction arrives, instellix tries the strategies in priority order.

API

Assign

POST /v2/payment-assignments
Scope: accounts-receivable-management-write

→ Assign Payment

Related APIs

• Query payment assignments
• Retrieve payment assignment
• MPA assignment configuration
• Regex matching strategies

---

Related articles

• Payment Categories
• Matching Rules
• Batch Payment Assignment
• Payment Transactions
• Settlements