Record payment
The tebio platform is designed for automated payment processing (as a result of bill runs). However, there are two specific use cases in which a payment receipt must be manually recorded or confirmed in the system by an employee:
- Manual capture of a payment: A customer has settled their outstanding invoice in a way that is not automatically processed by the system (for example, in cash, cash on delivery or through a manual external transfer).
- Manual confirmation of an incoming payment (Finalize Payment): A payment transaction runs via a configured external method (e.g. SEPA direct debit (external)), for which the system does not receive any automated status feedback from the house bank. Here the successful (or failed) payment transaction must be confirmed manually.
When do I need this function?
Section titled “When do I need this function?”Use this feature if you:
- Want to record a cash payment at the point of sale (POS) and link it to an existing invoice.
- Having to manually add an incoming payment to the bank account (that was not recorded through an automated reconciliation).
- For the external payment methods direct debit and bank transfer (with status model FINALIZE_DRIVEN_STATUS) you must confirm the completion of the transaction.
Requirements and limitations
Section titled “Requirements and limitations”Depending on the use case, different system requirements apply so that the corresponding buttons are displayed:
For Capture Payment
Section titled “For Capture Payment”- Invoice type: It must be a regular invoice (type = invoice).
- Status: The invoice status (Settlement Status) must be
Nicht ausgeglichen(Not Settled) orTeilweise ausgeglichen(Settled Partially). - Accounting: The invoice must have already been successfully transferred to the financial journal (a
journalEntryUuidmust be present).
For “Confirm receipt of payment” (Finalize Payment)
Section titled “For “Confirm receipt of payment” (Finalize Payment)”- Payment method: The underlying payment method must be an external method such as bank transfer (
EXTERNAL_SEPA) or direct debit (EXTERNAL_DIRECT_DEBIT). - Status model: The system must be configured to
FINALIZE_DRIVEN_STATUSfor this method (see also Configure payment methods). - Transaction Status: The specific payment transaction must have the status
Ausstehend(PENDING).
Step-by-step instructions
Section titled “Step-by-step instructions”Case 1: Manual capture (capture payment)
Section titled “Case 1: Manual capture (capture payment)”- Open the detailed view of the desired open invoice.
- Go to the Payments tab.
- Click on the green button Enter payment.
- The “Manual entry of a payment for an open invoice” dialog opens.
- Enter the exact amount.
- Select the appropriate payment method (e.g. “Cash (external)” or “Cash on delivery (external)”).
- Click Enter Payment to complete the process. The payment will now be offset against the invoice.
Case 2: Confirmation of receipt of payment (Finalize Payment)
Section titled “Case 2: Confirmation of receipt of payment (Finalize Payment)”- Either navigate to the Payments tab in the invoice details or access the global Transaction Detail View of the specific payment.
- Click the Confirm Payment button next to or below the pending transaction.
- A dialog (“Set final status for a payment transaction”) opens.
- Select whether the money has been received:
- OK, payment received (full amount): Sets final status to successful (
CLOSED_OK). - FAILED, payment not received: Sets final status to failed (
CLOSED_FAILED).
- OK, payment received (full amount): Sets final status to successful (
- Confirm your selection with Confirm.
Notes and typical errors
Section titled “Notes and typical errors”- Automatic cancellation if the deadline is exceeded: If the status of external payments (FINALIZE_DRIVEN_STATUS) is not manually set to “OK” or “FAILED” within a defined period (default: 14 days), the system automatically marks the payment as failed (
CLOSED_FAILED). - Partial payments: When manually recording a payment (capture), an amount that is smaller than the total claim can also be specified. The settlement status then remains at
Teilweise ausgeglichenuntil the remaining amount has been posted.
Result
Section titled “Result”The receipt of payment has been properly recorded and the pending transaction has been finalized. The corresponding statuses (invoice settlement or transaction status) have been updated and are also available in the financial journal (accounting).
API Notes
Section titled “API Notes”For integration into third-party systems (such as POS cash registers or external bank reconciliations), the API offers dedicated endpoints for both use cases:
| End point | Method | Description | OperationId |
|---|---|---|---|
/v1/finance/manual-payment | POST | Enter manual payment | startManualPayment |
/v2/payment/transaction/finalize | PATCH | Confirm payment transaction manually | finalizePayment |
Related topics
Section titled “Related topics”- View billing details
- Configure payment methods (Note: This article may still need to be created)
- Check incoming payments