Accounting

List the bank-reconciliation open positions of the authenticated company.

Returns the list of open booking-detail positions (AR / AP invoices, payments, prepayments, credit notes, general-ledger entries) of the caller's company that match the supplied filters, enriched with partner-name display, business-case message id, computed open amount and a stable booking-detail URI. Used by the bank-reconciliation UI to populate the open-position picker for a selected bank or credit-card transaction. The <code>action</code> parameter selects the multi-condition combinator: <code>search</code> (default) is OR-of-conditions, <code>filter</code> is AND-of-conditions. Tenant and company are derived from the bearer-token session — they are never accepted from the URL. The endpoint is a pure read — idempotent, no side effects. The caller must hold the <code>ACCOUNTING_GET_OPEN_POSITION</code> permission on the company in scope.

get/core/v1/bank-reconciliation/open-positions

Request

  • Base URL: https://api.klara.ch
  • URL: https://api.klara.ch/core/v1/bank-reconciliation/open-positions
  • Auth: one of:
    • API key in header X-API-KEY
    • HTTP bearer

Query parameters

action'search' | 'filter'
Example:filter

Multi-condition combinator. <code>search</code> (default) = OR-of-conditions; <code>filter</code> = AND-of-conditions.

booking-type-codesstring
Example:AR_PREPAYMENT,AR_CREDITNOTE

Comma-separated list of booking-type codes to restrict to. Allowed values: <code>GENERAL_LEDGER</code>, <code>AP_INVOICE</code>, <code>AP_PAYMENT</code>, <code>AR_INVOICE</code>, <code>AR_PAYMENT</code>, <code>AP_PREPAYMENT</code>, <code>AP_PREPAYUSE</code>, <code>AR_PREPAYMENT</code>, <code>AR_PREPAYUSE</code>, <code>AR_CREDITNOTE</code>, <code>AR_CREDITUSE</code>, <code>AP_CREDITNOTE</code>, <code>AP_CREDITUSE</code>, <code>AMORTIZATION</code>, <code>SELLOFF_AMORTIZATION</code>, <code>DELIMIT</code>.

crdr-type'CR' | 'DR'

Restrict to credit (<code>CR</code>) or debit (<code>DR</code>) postings.

credit-card-not-reconciledboolean
Example:true

When <code>true</code>, restricts to credit-card transactions still pending reconciliation.

general-searchstring
Example:Migros

Renamed to <code>search-key</code>. This name is accepted until <b>2027-09-01</b>; when both are sent, <code>search-key</code> wins. After that date, a request sending <code>general-search</code> without <code>search-key</code> is rejected with <b>400</b>.<br/><br/><strong>Deprecated</strong> — use <code>search-key</code> instead. Free-text search across description, partner name, document id and reference fields.

invoice-datestring date
Example:2026-04-15

Exact-match invoice (document) date filter (ISO date <code>yyyy-MM-dd</code>).

partnerstring
Example:/api/luz_person/api/c60d31fa-f335-4957-872a-90b035632081/companies/1/partners/123

Klara partner URI to filter by. Format: <code>/api/luz_person/api/{tenantId}/companies/{companyId}/partners/{partnerId}</code>. Construct from the partner id returned by the public partner endpoints.

payment-datestring date
Example:2026-05-28

Exact-match payment date filter (ISO date <code>yyyy-MM-dd</code>).

payment-date-fromstring date
Example:2026-01-01

Inclusive lower bound of the payment-date range filter (ISO date <code>yyyy-MM-dd</code>).

payment-date-tostring date
Example:2026-06-30

Inclusive upper bound of the payment-date range filter (ISO date <code>yyyy-MM-dd</code>).

position-statusstring
Example:OPEN,PARTLY_CLEARED

Comma-separated list of open-position lifecycle statuses to restrict to. Allowed values: <code>OPEN</code>, <code>PARTLY_PAID</code>, <code>PAID</code>, <code>PARTLY_CLEARED</code>, <code>CLEARED</code>.

search-keystring
Example:Migros

Free-text search across description, partner name, document id and reference fields. Combined with the other filters using the mode selected by <code>action</code>.

tagsstring
Example:vendor-x,q2

Comma-separated list of tag names to filter by (free-form).

Response

List of open positions matching the filters. Empty array when nothing matches.

idinteger

Booking-detail row id (database primary key).

bookingHeaderIdinteger

Id of the booking header this detail belongs to.

bookingHeaderCommentstring

Free-text comment of the booking header.

businessCaseIdinteger

Id of the parent business case.

accountCodestring

Numeric account code on which the booking is posted.

accountLinkDisplaystring

Localized account label.

crdrTypeobject

Credit / debit indicator.

descriptionstring

Free-text description of the booking line.

bookingTypeCodeobject

Stable booking-type code of the underlying business case.

openPositionStatusobject

Open-position lifecycle status.

amountnumber

Gross posted amount of the booking line.

partialPaymentAmountnumber

Sum of payments / clearings already applied to this position.

openAmountnumber

Computed remaining amount still to be cleared (<code>amount - partialPaymentAmount</code>).

vatAmountnumber

VAT amount included in the gross posting.

vatRatenumber

VAT rate applied to the line as a decimal (e.g. <code>0.077</code>).

vatRateDisplaystring

Localized VAT-rate display string.

vatBookingDetailLinkstring

Self-link of the companion VAT booking-detail line, when present.

vatBookingDetailboolean

Whether this row is itself a derived VAT booking-detail line.

foreignCurrencyAmountnumber

Posted amount in the document's foreign currency, when applicable.

foreignCurrencyUnitstring

ISO-4217 currency code of <code>foreignCurrencyAmount</code>.

tagsstring

Free-form tag string attached to the booking line.

documentDatestring date

Document (invoice) date of the underlying business case.

bookingDatestring date

Date the booking was journaled.

paidDatestring date

Date the position was last (partially) paid, if any.

dueDatestring date

Due date for payment.

paymentDatestring date

Effective payment date of the booking line.

servicePeriodFromstring date

Inclusive lower bound of the service period this booking covers.

servicePeriodTostring date

Inclusive upper bound of the service period this booking covers.

createDatestring date-time

Timestamp at which the booking detail was created.

updateDatestring date-time

Timestamp at which the booking detail was last updated.

documentIdstring[]

List of document ids attached to the booking line.

partnerNamestring

Resolved partner display name for the position.

bookingDetailUristring

Stable URI of the booking-detail row, for cross-service linking.

orderManagementInvoiceLinkstring

Self-link of the linked order-management invoice, when applicable.

orderManagementInvoiceNumberstring

Resolved order-management invoice number for display.

msgIdstring

Business-case message id, used by the eletter / inbox subsystems.

creditorReferencestring

Creditor reference (Swiss QR-IBAN reference number) of the position.

isrReferencestring

ISR reference of the position, when applicable.

isrMemberstring

ISR member number, when applicable.

partnerIbanstring

IBAN of the partner / counterparty.

endToEndIdstring

End-to-end identifier carried on the bank transaction.

Example response

[
  {
    "id": 98765,
    "bookingHeaderId": 4321,
    "bookingHeaderComment": "Invoice 2026-0123 from Migros AG",
    "businessCaseId": 12345,
    "accountCode": "1100",
    "accountLinkDisplay": "Forderungen aus L+L",
    "description": "Rechnung Nr. 2026-0123",
    "amount": 1250,
    "openAmount": 1250,
    "vatAmount": 94.05,
    "vatRate": 0.081,
    "vatRateDisplay": "8.1 %",
    "foreignCurrencyAmount": 1250,
    "foreignCurrencyUnit": "EUR",
    "tags": "test manual",
    "documentDate": "2026-04-15",
    "bookingDate": "2026-04-15",
    "paidDate": "2026-05-10",
    "dueDate": "2026-05-15",
    "paymentDate": "2026-05-12",
    "servicePeriodFrom": "2026-04-01",
    "servicePeriodTo": "2026-04-30",
    "createDate": "2026-04-15T08:30:00",
    "updateDate": "2026-05-12T14:15:00",
    "documentId": [
      "1771764"
    ],
    "partnerName": "Migros AG",
    "bookingDetailUri": "/api/luz_accounting/api/{tenantId}/companies/{companyId}/booking-headers/4321/booking-details/98765",
    "orderManagementInvoiceNumber": "INV-2026-0123",
    "msgId": "MSG-7788"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.