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

# Fatura kalem şablonları (variables)

> Şirketin fatura kalem şablonlarını listeler; POST /v1/invoices içindeki variables.id / variables.key seçimi bu listeden yapılır. Varsayılan listede pasif/silinmiş şablonlar dönmez. Bilinmeyen filter alanı 400 VALIDATION_FAILED döner.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/invoice-variables
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/invoice-variables:
    get:
      tags:
        - Invoices
      summary: Fatura kalem şablonları (variables)
      description: >-
        Şirketin fatura kalem şablonlarını listeler; POST /v1/invoices içindeki
        variables.id / variables.key seçimi bu listeden yapılır. Varsayılan
        listede pasif/silinmiş şablonlar dönmez. Bilinmeyen filter alanı 400
        VALIDATION_FAILED döner.
      operationId: listInvoiceVariables
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
        - name: sort
          in: query
          required: false
          description: >-
            İzinli alanlar: order, createdAt, updatedAt, lineName. Varsayılan
            order:asc.
          schema:
            type: string
            pattern: ^(order|createdAt|updatedAt|lineName)(:(asc|desc))?$
        - name: q
          in: query
          required: false
          description: Kalem adında (lineName) arama.
          schema:
            type: string
        - name: filter[statusType]
          in: query
          required: false
          description: all, invoice, expense, passive.
          schema:
            type: string
            enum:
              - all
              - invoice
              - expense
              - passive
        - name: filter[material]
          in: query
          required: false
          schema:
            type: string
            enum:
              - gold
              - silver
              - platin
              - paladyum
              - usd
              - eur
              - try
        - name: filter[isDefault]
          in: query
          required: false
          schema:
            type: boolean
        - name: filter[updatedSince]
          in: query
          required: false
          description: ISO-8601; updatedAt >= değer.
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: Başarılı liste yanıtı.
          headers:
            x-request-id:
              schema:
                type: string
                format: uuid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceVariableListResponse'
        '400':
          $ref: '#/components/responses/ValidationFailed'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    InvoiceVariableListResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          type: array
          items:
            $ref: '#/components/schemas/InvoiceVariableItem'
        meta:
          $ref: '#/components/schemas/MetaList'
      required:
        - success
        - data
        - meta
    InvoiceVariableItem:
      type: object
      properties:
        id:
          type: string
          description: Şablon kimliği — variables.id olarak kullanılır.
        key:
          type: string
          nullable: true
          description: Şablon anahtarı — variables.key olarak kullanılır.
        title:
          type: string
          nullable: true
        lineName:
          type: string
          description: Fatura kalem adı.
        material:
          type: string
          enum:
            - gold
            - silver
            - platin
            - paladyum
            - usd
            - eur
            - try
        statusType:
          type: string
          enum:
            - all
            - invoice
            - expense
            - passive
        type:
          type: string
          enum:
            - reason
            - exceptional
            - normal
            - auto
        exchange:
          type: number
          nullable: true
          description: Saflık/kur değeri.
        vatRate:
          type: number
        unitType:
          type: string
          enum:
            - GRM
            - C62
        laborDisabled:
          type: boolean
        laborName:
          type: string
          nullable: true
        laborType:
          type: string
          enum:
            - ratio
            - price
            - fixPrice
          nullable: true
        stockCode:
          type: string
          nullable: true
        isDefault:
          type: boolean
        isManual:
          type: boolean
        order:
          type: integer
        words:
          type: array
          items:
            type: string
        createdAt:
          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
    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)

````