> ## 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.

# Cari hesap listesi

> Şirkete ait cari hesapları sayfalı, filtreli ve sıralı listeler. Bilinmeyen filter alanı 400 VALIDATION_FAILED döner. Muhasebe/e-ticaret incremental senkronizasyonu için filter[updatedSince] + sort=updatedAt:asc önerilir.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/customers
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/customers:
    get:
      tags:
        - Customers
      summary: Cari hesap listesi
      description: >-
        Şirkete ait cari hesapları sayfalı, filtreli ve sıralı listeler.
        Bilinmeyen filter alanı 400 VALIDATION_FAILED döner. Muhasebe/e-ticaret
        incremental senkronizasyonu için filter[updatedSince] +
        sort=updatedAt:asc önerilir.
      operationId: listCustomers
      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, lastDate,
            updatedAt, nameSurname. Varsayılan createdDate:asc.
          schema:
            type: string
            pattern: ^(createdDate|lastDate|updatedAt|nameSurname)(:(asc|desc))?$
          example: updatedAt:asc
        - name: q
          in: query
          required: false
          description: >-
            Serbest metin arama. Numerik değer idNo tam eşleşmesi, metin değer
            nameSurname içinde büyük/küçük harf duyarsız arama yapar.
          schema:
            type: string
        - name: filter[idType]
          in: query
          required: false
          description: Kayıt türüne göre filtre.
          schema:
            type: string
            enum:
              - person
              - company
        - name: filter[idCardType]
          in: query
          required: false
          description: >-
            Belge türüne göre filtre. idCard seçimi; alanı eksik, null veya boş
            olan legacy kayıtları da kapsar.
          schema:
            type: string
            enum:
              - idCard
              - passport
              - dlCard
              - other
        - name: filter[recordLevel]
          in: query
          required: false
          description: >-
            Kayıt seviyesi: 0 kayıt yok (alanı olmayan kayıtları da kapsar), 1
            normal, 2 güvenli, 3 riskli, 4 yasaklı.
          schema:
            type: integer
            minimum: 0
            maximum: 4
        - name: filter[isVerify]
          in: query
          required: false
          description: Müşteri tanı (doğrulama) durumuna göre filtre.
          schema:
            type: boolean
        - name: filter[isValid]
          in: query
          required: false
          description: Kimlik doğrulama (TCKN/NVI) durumuna göre filtre.
          schema:
            type: boolean
        - name: filter[isPhoto]
          in: query
          required: false
          description: Fotoğraf/belge görseli varlığına göre filtre.
          schema:
            type: boolean
        - name: filter[saveType]
          in: query
          required: false
          description: Kaydın oluşma kaynağına göre filtre.
          schema:
            type: string
            enum:
              - bank
              - manual
              - idCard
              - accord
        - name: filter[label]
          in: query
          required: false
          description: Tekil etiket ile filtre.
          schema:
            type: string
        - name: filter[updatedSince]
          in: query
          required: false
          description: >-
            ISO-8601 tarih; yalnız bu tarihte veya sonra güncellenen kayıtlar
            döner (updatedAt >=).
          schema:
            type: string
            format: date-time
          example: '2026-09-01T00:00:00.000Z'
      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/CustomerListResponse'
        '400':
          description: Doğrulama hatası (geçersiz sayfalama, sort, filter veya q).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Kimlik doğrulama başarısız.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Beklenmeyen sunucu hatası.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    CustomerListResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          type: array
          items:
            $ref: '#/components/schemas/CustomerListItem'
        meta:
          $ref: '#/components/schemas/MetaList'
      required:
        - success
        - data
        - meta
    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
    CustomerListItem:
      type: object
      properties:
        id:
          type: string
          description: Kayıt kimliği (ObjectId).
        idNo:
          type: string
          description: TCKN / VKN / belge numarası. Tam ve maskesiz döner.
        idType:
          type: string
          enum:
            - person
            - company
        idCardType:
          type: string
          enum:
            - idCard
            - passport
            - dlCard
            - other
          description: dlCard = ehliyet.
        nameSurname:
          type: string
        phone:
          type: string
          nullable: true
        email:
          type: string
          nullable: true
        nationality:
          type: string
          example: TR
        countries:
          type: string
          nullable: true
        states:
          type: string
          nullable: true
        cities:
          type: string
          nullable: true
        labels:
          type: array
          items:
            type: string
        recordLevel:
          type: integer
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
          description: 0 kayıt yok, 1 normal, 2 güvenli, 3 riskli, 4 yasaklı.
        isVerify:
          type: boolean
          description: Müşteri tanı (doğrulama) durumu.
        isValid:
          type: boolean
          description: Kimlik doğrulama (TCKN/NVI) durumu.
        isPhoto:
          type: boolean
          description: Fotoğraf/belge görseli varlığı.
        saveType:
          type: string
          enum:
            - bank
            - manual
            - idCard
            - accord
          description: Kaydın oluşma kaynağı.
        createdDate:
          type: string
          format: date-time
        lastDate:
          type: string
          format: date-time
        updatedAt:
          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
    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
    MetaBase:
      type: object
      properties:
        requestId:
          type: string
          format: uuid
        timestamp:
          type: string
          format: date-time
      required:
        - requestId
        - timestamp
    ErrorDetail:
      type: object
      properties:
        field:
          type: string
        rule:
          type: string
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: >-
        Kullanıcı adı apiUserId, parola secretKey. Authorization: Basic
        base64(apiUserId:secretKey)

````