> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sarraf.pro/llms.txt
> Use this file to discover all available pages before exploring further.

# Banka hesapları ve bakiyeleri

> Şirketin gerçek banka hesaplarını (bank=true; kasa/pos/kredi hariç) bakiye ve son sorgu bilgisiyle listeler. Arşivli hesaplar varsayılan olarak dönmez; filter[archived]=true ile sorgulanabilir. Bu modelde updatedAt alanı olmadığından updatedSince desteklenmez; tazelik sinyali lastCheckAt alanıdır.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/bank-accounts
openapi: 3.0.3
info:
  title: Sarraf API v1
  version: 1.0.0
  description: >-
    Sarraf sürümlü dış API yüzeyi. Bu sürüm salt okunurdur; e-ticaret siteleri
    ve muhasebe programları için mevcut kayıtların okunmasını sağlar. Kimlik
    doğrulama mevcut dış API ile aynıdır: HTTP Basic,
    base64(apiUserId:secretKey). Tüm yanıtlar sabit zarf formatındadır: başarılı
    yanıtta success/data/meta, hatalı yanıtta
    success/error{code,message,details}/traceId. Her yanıtta x-request-id
    başlığı döner ve traceId ile aynıdır.
servers:
  - url: https://api.sarraf.pro
    description: Canlı ortam
security:
  - BasicAuth: []
tags:
  - name: Customers
    description: Cari hesaplar — listeleme, detay ve müşteri tanı formatında oluşturma
    x-group: Müşteriler
  - name: Bank accounts
    description: Banka hesapları, bakiyeler ve sorgu tetikleme
    x-group: Banka
  - name: Bank transactions
    description: Gelen/giden banka hareketleri — detayda gömülü MASAK özeti
    x-group: Banka
  - name: Invoices
    description: Sistem üzerinden kesilen faturalar ve kalem şablonları
    x-group: Faturalar
  - name: Expenses
    description: Gider pusulası kayıtları
    x-group: Giderler
  - name: Compliance
    description: >-
      Müşteri tanı formları, kimlik belgeleri, yaptırım sorguları, sicil,
      denetim ve IDV kayıtları
    x-group: Uyum (Compliance)
paths:
  /v1/bank-accounts:
    get:
      tags:
        - Bank accounts
      summary: Banka hesapları ve bakiyeleri
      description: >-
        Şirketin gerçek banka hesaplarını (bank=true; kasa/pos/kredi hariç)
        bakiye ve son sorgu bilgisiyle listeler. Arşivli hesaplar varsayılan
        olarak dönmez; filter[archived]=true ile sorgulanabilir. Bu modelde
        updatedAt alanı olmadığından updatedSince desteklenmez; tazelik sinyali
        lastCheckAt alanıdır.
      operationId: listBankAccounts
      parameters:
        - name: page
          in: query
          required: false
          description: Sayfa numarası (en az 1).
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: pageSize
          in: query
          required: false
          description: Sayfa başına kayıt (1-100).
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
        - name: sort
          in: query
          required: false
          description: >-
            Sıralama: alan:asc|desc. İzinli alanlar: createdDate, name, balance.
            Varsayılan createdDate:asc.
          schema:
            type: string
            pattern: ^(createdDate|name|balance)(:(asc|desc))?$
        - name: q
          in: query
          required: false
          description: Hesap adında büyük/küçük harf duyarsız arama.
          schema:
            type: string
        - name: filter[archived]
          in: query
          required: false
          description: Arşiv durumu. Verilmezse yalnız arşivsiz hesaplar döner.
          schema:
            type: boolean
        - name: filter[currency]
          in: query
          required: false
          description: Para birimi (büyük harfe normalize edilir).
          schema:
            type: string
          example: TRY
        - name: filter[bankCode]
          in: query
          required: false
          description: Banka kodu.
          schema:
            type: string
        - name: filter[isApi]
          in: query
          required: false
          description: 'true: yalnız banka entegrasyonu bağlı hesaplar.'
          schema:
            type: boolean
      responses:
        '200':
          description: Başarılı liste yanıtı.
          headers:
            x-request-id:
              description: İstek kimliği; yanıt gövdesindeki meta.requestId ile aynıdır.
              schema:
                type: string
                format: uuid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankAccountListResponse'
        '400':
          $ref: '#/components/responses/ValidationFailed'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    BankAccountListResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          type: array
          items:
            $ref: '#/components/schemas/BankAccountListItem'
        meta:
          $ref: '#/components/schemas/MetaList'
      required:
        - success
        - data
        - meta
    BankAccountListItem:
      type: object
      properties:
        id:
          type: string
          description: Kayıt kimliği (ObjectId).
        name:
          type: string
          description: Hesap adı.
        bankName:
          type: string
          nullable: true
        bankCode:
          type: string
          nullable: true
        code:
          type: string
          nullable: true
          description: Hesap kodu.
        iban:
          type: string
          nullable: true
        currency:
          type: string
          example: TRY
        type:
          type: string
          enum:
            - cash
            - bank
            - pos
            - credit
        default:
          type: boolean
          description: Varsayılan hesap mı.
        isApi:
          type: boolean
          description: Banka entegrasyonu bağlı mı.
        isDemo:
          type: boolean
          description: Demo hesap mı.
        limit:
          type: number
          description: Sorgulama limiti.
        balance:
          type: number
          description: Güncel bakiye (son sorgudaki).
        lastCheckAt:
          type: string
          format: date-time
          nullable: true
          description: Son banka sorgusu zamanı.
        lastTransactionAt:
          type: string
          format: date-time
          nullable: true
          description: Son çekilen hareketin zamanı.
        lastCheckStatus:
          type: boolean
          nullable: true
          description: Son sorgu başarılı mı.
        lastCheckMessage:
          type: string
          nullable: true
          description: Banka cevabı.
        lastCheckSize:
          type: integer
          description: Son sorguda çekilen hareket sayısı.
        createdDate:
          type: string
          format: date-time
    MetaList:
      allOf:
        - $ref: '#/components/schemas/MetaBase'
        - type: object
          properties:
            page:
              type: integer
            limit:
              type: integer
            total:
              type: integer
            pages:
              type: integer
          required:
            - page
            - limit
            - total
            - pages
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          $ref: '#/components/schemas/ErrorBody'
        traceId:
          type: string
          format: uuid
          description: x-request-id başlığı ile aynı değer.
      required:
        - success
        - error
        - traceId
    MetaBase:
      type: object
      properties:
        requestId:
          type: string
          format: uuid
        timestamp:
          type: string
          format: date-time
      required:
        - requestId
        - timestamp
    ErrorBody:
      type: object
      properties:
        code:
          type: string
          enum:
            - VALIDATION_FAILED
            - AUTH_INVALID_CREDENTIALS
            - AUTH_FORBIDDEN
            - RESOURCE_NOT_FOUND
            - CONFLICT
            - UPSTREAM_ERROR
            - INTERNAL_ERROR
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetail'
      required:
        - code
        - message
        - details
    ErrorDetail:
      type: object
      properties:
        field:
          type: string
        rule:
          type: string
  responses:
    ValidationFailed:
      description: Doğrulama hatası (geçersiz parametre).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Kimlik doğrulama başarısız.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Beklenmeyen sunucu hatası.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: >-
        Kullanıcı adı apiUserId, parola secretKey. Authorization: Basic
        base64(apiUserId:secretKey)

````