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

# GetChecks

> - GetCheks servisi ile gönderdiğiniz tarih aralığındaki tüm çeklere (adisyonlara), tahsilatlara ve harcamalara erişebilirsiniz.
    

**Orion Pos üzerinde 3 tip adisyon bulunuyor.**

- Adisyonlar (Satış)
    
    - Standart satışların oluştuğu adisyonlar.
        
    - Ürün bilgilerini içerir.
        
        - Her ürünün Orion Pos üzerindeki numarasını (nümerik) içerir.
            
        - Aynı zamanda entegrasyon için alfanümerik olarak tanımlanan ‘IntegrationCode’ bilgisini içerir.
            
    - Her biri bir ya da birden fazla ödeme tipiyle kapanabilir.
        
        - Örneğin Nakit, Kredi Kartı, Ödenmez ya da Cari Hesap (veresiye)
            
- Tahsilatlar
    
    - Cari-veresiye kapatılan borçlu hesapların borç ödeme bilgilerini içerir.
        
- Harcamalar
    
    - Kasa üzerinden para çıkışlarının gösterildiği çeklerdir.
        

**Request Parameters**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| start_date | string (yyyy-MM-dd) | ✅ Yes | Query başlangıç tarihi |
| end_date | string (yyyy-MM-dd) | ✅ Yes | Query bitiş tarihi |
| branch | string | ✅ Yes | Şube kodu |
| number | integer | ❌ No | Belirli bir çek numarasını sorgulamak için kullanılabilir |
| table_no | string | ❌ No | Belirli bir masa için çekleri filtrelemek için kullanılabilir |

**RESPONSE**

- Çek kayıtlarında "Address", "Fiscal" ve "Invoice" null gelebilir.
    
- Çek objesinin içerisindeki "Items" ve "Condiments" objesi aynı sınıftan gelmektedir.
    
- İndirim objesindeki "Type": "Discount" veya "TaxDiscount" (Tevkifat indirimi ya da Vergi istisnası) olarak gelmektedir.
    
- Çek kısmında "Id" şube bazında unique ancak "CheckNumber" gün bazında unique şeklinde dizayn edilmiştir.
    
- "OutletInfo" Çekin bulunduğu gelir merkezini temsil etmektedir. Örn: "Restoran", "Kafe".
    
- "State": "Closed" veya "Open" gelmektedir.
    
- "Info" alanı cari hesap kullanılan çeklerde cari ismi ile aynıdır.
    
- "BusinessDate" çalışma günü anlamı taşımaktadır. Request olarak gönderdiğiniz tarihler "BusinessDate" e göre filtrelenmektedir.
    
- "IsReturn" true ise Çek iade edilmiştir.
    
    - İade çeklerinde tüm değerler iadesi yapılan çekin ters değerlisidir (negatif).
        
- "Invoice" objesi, çek karşılığında fatura kesilmişse fatura bilgilerini içerir.
    
- "Fiscal" işletmede yazarkasa entegrasyonu varsa çekin tahsil edildiği Yazarkasaya ait bilgileri içermektedir.
    
- "Address" paket servislerde veya carilere ait Çeklerde müşterinin adres bilgisini içermektedir.
    
- "Items" çek detayına ait ürünleri içerir.
    
    - "Items" içerisindeki "Condiments" ürün ilavelerini içerir.
        
- "Payments" çeke ait ödemelerin bilgilerini içermektedir.
    
- "OfficialReceiptNumber" alanı resmi adisyon numarasıdır.



## OpenAPI

````yaml /openapi.yaml post /GetChecks
openapi: 3.0.3
info:
  title: ORIONPOS API
  version: 1.0.0
  description: >-
    # 📄 Genel Bakış


    ORIONPOS API Entegrasyonu, ORIONPOS ile entegre olmak isteyen yazılımların
    satış, cari, ürün bilgileri gibi bir çok işlemin aktarımı ve senkronize
    edilmesine olanak sağlar.


    - ORIONPOS on-premise çalışan bir sistem olduğu için gönderdiğiniz tüm
    istekler tarafımızdan hedef Restorana iletilmektedir. Hedef restoranın
    server bilgisayarının kapalı olması, internetinin olmaması, internetinin
    yavaş olması, server bilgisayarının gereksinimleri karşılayamaması gibi
    durumlarda bu hizmetlerin kontrolünü sağlamanızı öneririz.
        

    <img
    src="https://content.pstmn.io/0f35216a-4f73-4d2e-9cb2-fbdc1802c634/T3Jpb25BUElEb2vDvG1hbi5wbmc=">


    **API İstek Limitleri**


    Sistem kararlılığını korumak ve tüm kullanıcılar için adil kullanım sağlamak
    amacıyla API üzerinde kullanıcı bazlı aşağıdaki istek limitleri
    uygulanmaktadır:


    - Dakikada maksimum **60 istek**
        
    - Saniyede maksimum **10 istek**
        

    Bu limitlerin aşılması durumunda istekler sistem tarafından geçici olarak
    reddedilebilir veya sınırlandırılabilir.


    İstemci tarafında bu limitlere uygun olacak şekilde istek kontrolü ve tekrar
    deneme (retry) mekanizmalarının uygulanması önerilir.
servers:
  - url: https://api.orionpanel.com
    description: Üretim (Production)
security:
  - Token: []
tags:
  - name: Authorization
  - name: Branches
  - name: Parameters
  - name: Checks
  - name: Items
paths:
  /GetChecks:
    post:
      tags:
        - Checks
      summary: GetChecks
      description: >-
        - GetCheks servisi ile gönderdiğiniz tarih aralığındaki tüm çeklere
        (adisyonlara), tahsilatlara ve harcamalara erişebilirsiniz.
            

        **Orion Pos üzerinde 3 tip adisyon bulunuyor.**


        - Adisyonlar (Satış)
            
            - Standart satışların oluştuğu adisyonlar.
                
            - Ürün bilgilerini içerir.
                
                - Her ürünün Orion Pos üzerindeki numarasını (nümerik) içerir.
                    
                - Aynı zamanda entegrasyon için alfanümerik olarak tanımlanan ‘IntegrationCode’ bilgisini içerir.
                    
            - Her biri bir ya da birden fazla ödeme tipiyle kapanabilir.
                
                - Örneğin Nakit, Kredi Kartı, Ödenmez ya da Cari Hesap (veresiye)
                    
        - Tahsilatlar
            
            - Cari-veresiye kapatılan borçlu hesapların borç ödeme bilgilerini içerir.
                
        - Harcamalar
            
            - Kasa üzerinden para çıkışlarının gösterildiği çeklerdir.
                

        **Request Parameters**


        | Field | Type | Required | Description |

        | --- | --- | --- | --- |

        | start_date | string (yyyy-MM-dd) | ✅ Yes | Query başlangıç tarihi |

        | end_date | string (yyyy-MM-dd) | ✅ Yes | Query bitiş tarihi |

        | branch | string | ✅ Yes | Şube kodu |

        | number | integer | ❌ No | Belirli bir çek numarasını sorgulamak için
        kullanılabilir |

        | table_no | string | ❌ No | Belirli bir masa için çekleri filtrelemek
        için kullanılabilir |


        **RESPONSE**


        - Çek kayıtlarında "Address", "Fiscal" ve "Invoice" null gelebilir.
            
        - Çek objesinin içerisindeki "Items" ve "Condiments" objesi aynı
        sınıftan gelmektedir.
            
        - İndirim objesindeki "Type": "Discount" veya "TaxDiscount" (Tevkifat
        indirimi ya da Vergi istisnası) olarak gelmektedir.
            
        - Çek kısmında "Id" şube bazında unique ancak "CheckNumber" gün bazında
        unique şeklinde dizayn edilmiştir.
            
        - "OutletInfo" Çekin bulunduğu gelir merkezini temsil etmektedir. Örn:
        "Restoran", "Kafe".
            
        - "State": "Closed" veya "Open" gelmektedir.
            
        - "Info" alanı cari hesap kullanılan çeklerde cari ismi ile aynıdır.
            
        - "BusinessDate" çalışma günü anlamı taşımaktadır. Request olarak
        gönderdiğiniz tarihler "BusinessDate" e göre filtrelenmektedir.
            
        - "IsReturn" true ise Çek iade edilmiştir.
            
            - İade çeklerinde tüm değerler iadesi yapılan çekin ters değerlisidir (negatif).
                
        - "Invoice" objesi, çek karşılığında fatura kesilmişse fatura
        bilgilerini içerir.
            
        - "Fiscal" işletmede yazarkasa entegrasyonu varsa çekin tahsil edildiği
        Yazarkasaya ait bilgileri içermektedir.
            
        - "Address" paket servislerde veya carilere ait Çeklerde müşterinin
        adres bilgisini içermektedir.
            
        - "Items" çek detayına ait ürünleri içerir.
            
            - "Items" içerisindeki "Condiments" ürün ilavelerini içerir.
                
        - "Payments" çeke ait ödemelerin bilgilerini içermektedir.
            
        - "OfficialReceiptNumber" alanı resmi adisyon numarasıdır.
      operationId: GetChecks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                start_date:
                  type: string
                  example: '{{start_date}}'
                end_date:
                  type: string
                  example: '{{end_date}}'
                branch:
                  type: string
                  example: '{{branch}}'
                number:
                  type: integer
                  example: 0
                table_no:
                  type: string
                  example: ''
              required:
                - start_date
                - end_date
                - branch
                - number
                - table_no
            example:
              start_date: '{{start_date}}'
              end_date: '{{end_date}}'
              branch: '{{branch}}'
              number: 0
              table_no: ''
      responses:
        '200':
          description: Başarılı
          content:
            application/json:
              schema:
                type: object
                properties:
                  ResultCode:
                    type: integer
                    example: 200
                  Data:
                    type: array
                    items:
                      type: object
                  ResultMessage:
                    type: string
                    example: OK
      security:
        - Token: []
components:
  securitySchemes:
    Token:
      type: apiKey
      in: header
      name: Token
      description: >-
        GetToken servisinden dönen, 1 gün geçerli oturum token'ı. Diğer tüm
        servisler için zorunludur.

````