Finance

List the bank accounts of the authenticated company.

Returns the bank accounts of the company resolved from the bearer JWT, optionally filtered by business <code>type</code>. The caller must hold the <code>FINANCE_BANK_ACCOUNT</code> permission on the target company. The result is sorted by Swiss-bank name then IBAN. This operation is idempotent and read-only — it can be safely retried.

get/core/v1/company-bank-accounts

Request

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

Query parameters

iban-numberstring
Example:CH7109000000252946932

Optional IBAN filter. When provided, the response contains the single matching bank account (returned as a one-element array for a uniform response shape) or HTTP 404 if no account exists with that IBAN. Spaces in the IBAN are tolerated. When provided, the <code>type</code> parameter is ignored.

type'AR' | 'AP' | 'HR'
Example:AR

Optional business-type filter. Allowed values: <code>AR</code> (Accounts Receivable), <code>AP</code> (Accounts Payable), <code>HR</code> (Salary / HR payments). When omitted, all bank accounts are returned. Ignored when <code>iban-number</code> is provided.

Response

Bank accounts of the authenticated company.

idinteger

Internal database id of the bank account.

companyIdinteger

KLARA company id this bank account belongs to.

shortNamestring

User-defined short label for the bank account.

ibanNumberstring

IBAN in pretty-printed form (groups of 4 characters).

qrIbanNumberstring

QR-IBAN (only set when markedQrIban is true).

currencystring

ISO-style currency code. Allowed values: CHF, CHW.

wirAcceptanceRatenumber

WIR acceptance percentage (0–100).

markedHRPaymentboolean

Default account for salary / HR payments.

markedARAccountboolean

Default account for Accounts Receivable.

markedAPAccountboolean

Default account for Accounts Payable.

markedPaymentSlipboolean

ESR / red payment-slip enabled.

markedQrInvoiceboolean

QR-invoice payment enabled.

markedQrIbanboolean

QR-IBAN flow enabled.

participantNumberstring

ESR participant number (only when markedPaymentSlip).

customerIdentificationNumberstring

ESR customer identification number (only when markedPaymentSlip and not PostFinance).

printParticipantNumberboolean

Print the participant number on payment slips.

printBankAddressboolean

Print the bank address on payment slips.

printBeneficiaryboolean

Print the beneficiary on payment slips.

esrPrintingTypestring

ESR printing type. Allowed values: INTEGRATE, SEPARATE.

contractNumberstring

Bank contract number.

batchBookingstring

Batch-booking preference. Allowed values: DEFAULT, ACTIVE, INACTIVE.

debitAdvicestring

Debit-advice preference. Allowed values: DEFAULT, NO_ADVICE, SINGLE_ADVICE, ADVICE_WITHOUT_DETAILS, ADVICE_WITH_DETAIL.

notMarkedSalaryPaymentsboolean

When true, exclude this bank account from salary-payment runs.

Example response

[
  {
    "id": 1,
    "companyId": 1,
    "shortName": "PostFinance CHF",
    "ibanNumber": "CH71 0900 0000 2529 4693 2",
    "qrIbanNumber": "CH44 3199 9123 0008 8901 2",
    "currency": "CHF",
    "markedARAccount": true,
    "markedQrInvoice": true,
    "participantNumber": "01-12345-6",
    "customerIdentificationNumber": "123456",
    "esrPrintingType": "INTEGRATE",
    "batchBooking": "DEFAULT",
    "debitAdvice": "DEFAULT",
    "swissBank": {
      "id": 100,
      "group": "1",
      "bankClearingNumber": "100",
      "branchId": "1",
      "sicNumber": "100000",
      "headOfficeNumber": "100",
      "bankClearingType": "1",
      "language": "de",
      "shortName": "PostFinance AG",
      "name": "PostFinance AG",
      "address": "Mingerstrasse 20",
      "postalAddress": "Postfach",
      "place": "Bern",
      "phone": "+41 58 338 25 00",
      "dailingCode": "41"
    }
  }
]

Changes

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