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

# Cari listesi

> Carileri sayfa sayfa listeler.

Sonuçlar `Data.Items` içinde döner. `pageSize` en fazla **50** olabilir; daha büyük bir değer gönderilirse 50 kullanılır. `search` cari adı, cari kodu ve vergi numarasında arar. Ayrıntılar için [Sayfalama ve arama](/tr/v1/guides/pagination-search).

Liste yanıtında alt kayıtlar (adres, telefon, ...) yer almaz; bunlar için [cari detayı](/tr/v1/customers/get) kullanılır.


## OpenAPI

````yaml api-reference/openapi.tr.json GET /api/v1/customers
openapi: 3.1.1
info:
  title: Noyax API
  description: Server-to-server API for integrations to access Noyax data.
  version: '1.0'
servers:
  - url: https://api.noyax.com
security:
  - Bearer: []
tags:
  - name: Sections
  - name: Warehouses
  - name: Product Critical Stock
  - name: Product groups
  - name: Product Parameter Definitions
  - name: Product Parameters
  - name: Product Prices
  - name: Products
  - name: Cities
  - name: Countries
  - name: Currencies
  - name: Districts
  - name: Shipment Definitions
  - name: Units
  - name: VAT rates
  - name: Customer Addresses
  - name: Customer Bank Accounts
  - name: Customer Definitions
  - name: Customer Group Members
  - name: Customer Links
  - name: Customer Parameters
  - name: Customer Representatives
  - name: Customers
  - name: Customer Statement
  - name: Customer Telephones
paths:
  /api/v1/customers:
    get:
      tags:
        - Customers
      summary: Carileri listele
      description: >-
        Carileri sayfa sayfa döner. Alt kayıtlar (adres, telefon, ...) bu
        listede yoktur; onlar için detay endpoint'ini kullanın.
      parameters:
        - name: page
          in: query
          description: Sayfa numarası, 1'den başlar.
          schema:
            type: integer
            format: int32
            default: 1
        - name: pageSize
          in: query
          description: Sayfa başına kayıt sayısı (en fazla 50).
          schema:
            type: integer
            format: int32
            default: 50
        - name: search
          in: query
          description: Name, CustomerCode ve TaxNumber alanlarında arar.
          schema:
            type: string
        - name: X-UserID
          in: header
          description: >-
            İsteğin adına yapıldığı Noyax kullanıcısının ID'si. Oluşturulan,
            güncellenen ve silinen kayıtların denetim alanlarına yazılır.
          required: true
          schema:
            minimum: 1
            type: integer
            format: int32
        - name: X-CompanyID
          in: header
          description: >-
            Şirketin ID'si. Kullanıcı bu şirkete tanımlı olmalıdır. Bütün okuma
            ve yazma işlemleri bu şirketle sınırlıdır.
          required: true
          schema:
            minimum: 1
            type: integer
            format: int32
        - name: X-PeriodID
          in: header
          description: >-
            Muhasebe döneminin ID'si. Cari endpoint'lerinde isteğe bağlıdır;
            gönderilirse oluşturulan kayıtlara yazılır.
          schema:
            minimum: 1
            type: integer
            format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResultOfPagedResultDtoOfCustomerDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
              example:
                Success: false
                ResultCode: '0201'
                Message: X-UserID header is required.
                Errors:
                  - Code: '0201'
                    Message: X-UserID header is required.
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
              example:
                Success: false
                ResultCode: '0102'
                Message: Token has expired. Obtain a new token using the refresh token.
                Errors:
                  - Code: '0102'
                    Message: >-
                      Token has expired. Obtain a new token using the refresh
                      token.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
              example:
                Success: false
                ResultCode: '0110'
                Message: You do not have permission for this operation.
                Errors:
                  - Code: '0110'
                    Message: You do not have permission for this operation.
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
              example:
                Success: false
                ResultCode: '0120'
                Message: Daily request limit (10000) exceeded.
                Errors:
                  - Code: '0120'
                    Message: Daily request limit (10000) exceeded.
components:
  schemas:
    DataResultOfPagedResultDtoOfCustomerDto:
      required:
        - Success
        - ResultCode
        - Data
      type: object
      properties:
        Success:
          type: boolean
          description: İşlemin başarılı olup olmadığı.
          example: true
        ResultCode:
          type: string
          description: >-
            Başarıda "0000". Hatada ilk hatanın kodu; hataların tamamı Errors
            içinde listelenir.
          example: '0000'
        Message:
          type:
            - 'null'
            - string
          description: >-
            Success false olduğunda hata mesajı. Bütün hataların mesajları tek
            metinde birleştirilir.
        Data:
          $ref: '#/components/schemas/PagedResultDtoOfCustomerDto'
    ErrorResult:
      type: object
      properties:
        Success:
          type: boolean
          description: İşlemin başarılı olup olmadığı.
          example: false
        ResultCode:
          type:
            - 'null'
            - string
          description: >-
            Başarıda "0000". Hatada ilk hatanın kodu; hataların tamamı Errors
            içinde listelenir.
        Message:
          type:
            - 'null'
            - string
          description: >-
            Success false olduğunda hata mesajı. Bütün hataların mesajları tek
            metinde birleştirilir.
        Errors:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/ResultError'
          description: >-
            Kodlarıyla birlikte bütün hatalar. Yalnızca Success false olduğunda
            bulunur.
    PagedResultDtoOfCustomerDto:
      type: object
      properties:
        Page:
          type: integer
          description: Bulunduğunuz sayfa numarası.
          format: int32
          example: 1
        PageSize:
          type: integer
          description: Sayfa başına kayıt sayısı.
          format: int32
          example: 50
        TotalCount:
          type: integer
          description: Sorguya uyan toplam kayıt sayısı.
          format: int32
          example: 128
        Items:
          type: array
          items:
            $ref: '#/components/schemas/CustomerDto'
          description: Bu sayfadaki kayıtlar.
      description: Response data. Null when Success is false.
    ResultError:
      required:
        - Code
        - Message
      type: object
      properties:
        Code:
          type: string
          description: Hata kodu. Tam liste için sonuç kodları sayfasına bakın.
        Message:
          type: string
          description: Hata açıklaması.
    CustomerDto:
      type: object
      properties:
        Id:
          type: string
          description: Cari ID'si.
          format: uuid
        CustomerCode:
          type:
            - 'null'
            - string
          description: >-
            Zorunlu. Şirket içinde benzersizdir. Oluştururken "Next"
            gönderirseniz kod, şirketin cari numarası serisinden üretilir.
          example: '0000382026'
        Name:
          type:
            - 'null'
            - string
          description: Zorunlu. Cari adı.
          example: Örnek Ticaret A.Ş.
        TaxNumber:
          type:
            - 'null'
            - string
          description: >-
            Zorunlu. Yalnızca rakam: 10 haneli vergi kimlik numarası (VKN) ya da
            11 haneli T.C. kimlik numarası (TCKN).
          example: '1234567890'
        TaxOffice:
          type:
            - 'null'
            - string
          description: Vergi dairesi adı.
          example: Kadıköy
        InvoiceTitle:
          type:
            - 'null'
            - string
          description: Faturalarda kullanılan ünvan. Boş bırakılırsa Name alanı kullanılır.
          example: Örnek Ticaret Anonim Şirketi
        Note:
          type:
            - 'null'
            - string
          description: >-
            Serbest metin not. ShowNoteOn* alanlarından biri true ise
            zorunludur.
          example: Deliveries on weekdays only.
        DueDays:
          type: integer
          description: Gün olarak vade. 0'dan küçük olamaz.
          format: int32
          example: 30
        DiscountRate:
          type: number
          description: Varsayılan iskonto oranı (%), 0 ile 100 arasında.
          format: double
          example: 5
        Blacklisted:
          type: boolean
          description: Cariyi kara listeye alır.
          example: false
        MovementType:
          type: integer
          description: >-
            1: Satıcı, 2: Alıcı, 3: Satıcı ve alıcı. 0 gönderilirse 1 olarak
            kaydedilir.
          format: int32
          example: 2
        RiskLimit:
          type: number
          description: Risk limiti tutarı. 0'dan küçük olamaz. 0, risk limiti yok demektir.
          format: double
          example: 250000
        RiskControl:
          type: integer
          description: >-
            Risk limitinin nasıl kontrol edileceği. 1: Mevcut bakiye, 2: Satış
            tutarı. RiskLimit 0'dan büyükse 1 ya da 2 olmalıdır.
          format: int32
          example: 1
        RiskAction:
          type: integer
          description: >-
            Risk limiti aşıldığında ne olacağı. 0: Devam et, 1: Kullanıcıyı
            uyar, 2: İşlemi durdur.
          format: int32
          example: 1
        EInvoiceUser:
          type: boolean
          description: Carinin e-fatura mükellefi olup olmadığı.
          example: true
        EInvoiceScenario:
          type: integer
          description: >-
            E-fatura senaryosu. EInvoiceUser true ise 1-9, değilse 0 olmalıdır.
            1: Ticari, 2: Temel, 3: İhracat, 4: Kamu, 5: HKS, 6: Enerji, 7:
            İlaç/Tıbbi cihaz, 8: Yatırım teşvik, 9: IDIS.
          format: int32
          example: 1
        ShipmentDefinitionId:
          type:
            - 'null'
            - string
          description: >-
            GET /api/v1/definitions/shipment-definitions ile dönen bir sevkiyat
            tanımının ID'si.
          format: uuid
        SharingCodeId:
          type:
            - 'null'
            - string
          description: >-
            Cariyi kimlerin görebileceğini sınırlayan paylaşım kodu. Boş
            bırakılırsa herkes görür; doldurulursa kullanıcının paylaşım
            kodlarından biri olmalıdır.
          format: uuid
        ShowNoteOnQuote:
          type: boolean
          description: Notu tekliflerde göster.
          example: false
        ShowNoteOnOrder:
          type: boolean
          description: Notu siparişlerde göster.
          example: false
        ShowNoteOnWaybill:
          type: boolean
          description: Notu irsaliyelerde göster.
          example: true
        ShowNoteOnInvoice:
          type: boolean
          description: Notu faturalarda göster.
          example: false
        IdentitySchemes:
          type: array
          items:
            $ref: '#/components/schemas/IdentitySchemeDto'
          description: >-
            Ek kimlik numaraları (ör. MERSISNO). Her SchemeID yalnızca bir kez
            gönderilebilir.
        CreateDate:
          type:
            - 'null'
            - string
          description: Oluşturulma tarihi.
          format: date-time
        ModifyDate:
          type:
            - 'null'
            - string
          description: Son değişiklik tarihi.
          format: date-time
    IdentitySchemeDto:
      type: object
      properties:
        SchemeID:
          type:
            - 'null'
            - string
          description: UBL kimlik şeması kodu, ör. MERSISNO, TICARETSICILNO, MUSTERINO.
          example: MERSISNO
        Value:
          type:
            - 'null'
            - string
          description: Zorunlu. Kimlik numarasının değeri.
          example: '0123456789000015'
  securitySchemes:
    Bearer:
      type: http
      description: Access token obtained from the Noyax auth service with your API key.
      scheme: bearer
      bearerFormat: JWT

````