Checks

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.

POST

GetChecks

curl --request POST \
  --url https://api.orionpanel.com/GetChecks \
  --header 'Content-Type: application/json' \
  --header 'Token: <api-key>' \
  --data '
{
  "start_date": "{{start_date}}",
  "end_date": "{{end_date}}",
  "branch": "{{branch}}",
  "number": 0,
  "table_no": ""
}
'

import requests

url = "https://api.orionpanel.com/GetChecks"

payload = {
    "start_date": "{{start_date}}",
    "end_date": "{{end_date}}",
    "branch": "{{branch}}",
    "number": 0,
    "table_no": ""
}
headers = {
    "Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    start_date: '{{start_date}}',
    end_date: '{{end_date}}',
    branch: '{{branch}}',
    number: 0,
    table_no: ''
  })
};

fetch('https://api.orionpanel.com/GetChecks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.orionpanel.com/GetChecks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'start_date' => '{{start_date}}',
    'end_date' => '{{end_date}}',
    'branch' => '{{branch}}',
    'number' => 0,
    'table_no' => ''
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.orionpanel.com/GetChecks"

	payload := strings.NewReader("{\n  \"start_date\": \"{{start_date}}\",\n  \"end_date\": \"{{end_date}}\",\n  \"branch\": \"{{branch}}\",\n  \"number\": 0,\n  \"table_no\": \"\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.orionpanel.com/GetChecks")
  .header("Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"start_date\": \"{{start_date}}\",\n  \"end_date\": \"{{end_date}}\",\n  \"branch\": \"{{branch}}\",\n  \"number\": 0,\n  \"table_no\": \"\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orionpanel.com/GetChecks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"start_date\": \"{{start_date}}\",\n  \"end_date\": \"{{end_date}}\",\n  \"branch\": \"{{branch}}\",\n  \"number\": 0,\n  \"table_no\": \"\"\n}"

response = http.request(request)
puts response.read_body

{
  "ResultCode": 200,
  "Data": [
    {}
  ],
  "ResultMessage": "OK"
}

Authorizations

Token

string

header

required

GetToken servisinden dönen, 1 gün geçerli oturum token'ı. Diğer tüm servisler için zorunludur.

Body

application/json

start_date

string

required

Example:

"{{start_date}}"

end_date

string

required

Example:

"{{end_date}}"

branch

string

required

Example:

"{{branch}}"

number

integer

required

Example:

0

table_no

string

required

Example:

""

Response

200 - application/json

Başarılı

ResultCode

integer

Example:

200

Data

object[]

ResultMessage

string

Example:

"OK"

⌘I

GetChecks

curl --request POST \
  --url https://api.orionpanel.com/GetChecks \
  --header 'Content-Type: application/json' \
  --header 'Token: <api-key>' \
  --data '
{
  "start_date": "{{start_date}}",
  "end_date": "{{end_date}}",
  "branch": "{{branch}}",
  "number": 0,
  "table_no": ""
}
'

import requests

url = "https://api.orionpanel.com/GetChecks"

payload = {
    "start_date": "{{start_date}}",
    "end_date": "{{end_date}}",
    "branch": "{{branch}}",
    "number": 0,
    "table_no": ""
}
headers = {
    "Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    start_date: '{{start_date}}',
    end_date: '{{end_date}}',
    branch: '{{branch}}',
    number: 0,
    table_no: ''
  })
};

fetch('https://api.orionpanel.com/GetChecks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.orionpanel.com/GetChecks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'start_date' => '{{start_date}}',
    'end_date' => '{{end_date}}',
    'branch' => '{{branch}}',
    'number' => 0,
    'table_no' => ''
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.orionpanel.com/GetChecks"

	payload := strings.NewReader("{\n  \"start_date\": \"{{start_date}}\",\n  \"end_date\": \"{{end_date}}\",\n  \"branch\": \"{{branch}}\",\n  \"number\": 0,\n  \"table_no\": \"\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.orionpanel.com/GetChecks")
  .header("Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"start_date\": \"{{start_date}}\",\n  \"end_date\": \"{{end_date}}\",\n  \"branch\": \"{{branch}}\",\n  \"number\": 0,\n  \"table_no\": \"\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orionpanel.com/GetChecks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"start_date\": \"{{start_date}}\",\n  \"end_date\": \"{{end_date}}\",\n  \"branch\": \"{{branch}}\",\n  \"number\": 0,\n  \"table_no\": \"\"\n}"

response = http.request(request)
puts response.read_body

{
  "ResultCode": 200,
  "Data": [
    {}
  ],
  "ResultMessage": "OK"
}