Cari Hesap Listeleme

Şirketinize ait cari hesap kayıtlarını listeleme ve filtreleme.

Endpoint

GET /kolaybi/v1/associates

Parametreler

Parametre	Tip	Açıklama
code	string	Cari kodu ile filtreleme
name	string	Cari adı ile filtreleme
surname	string	Cari soyadı ile filtreleme
active	boolean	Cari durumuna göre filtreleme
identity_no	string	TCKN/VKN ile filtreleme
email	string	E-posta ile filtreleme
group	AssociateGroup	Cari grubu ile filtreleme
source	string	Pazaryeri/kanal ile filtreleme (bkz. Cari Hesap Oluşturma)
tag_ids	array	Etiket ID listesi ile filtreleme (tag_ids[0], tag_ids[1])

Örnekler

cURL

# Tüm cari hesaplar
curl -X GET "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/associates" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Channel: YOUR_CHANNEL"

# Müşteri grubu
curl -X GET "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/associates?group=customer" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Channel: YOUR_CHANNEL"

JavaScript

async function listAssociates(filters = {}) {
  const params = new URLSearchParams(filters);
  const response = await fetch(
    `https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/associates?${params}`,
    {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        Channel: channel,
      },
    }
  );
  return await response.json();
}

// Kullanım
const customers = await listAssociates({ group: "customer" });

PHP

function listAssociates($filters = []) {
    $url = 'https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/associates';
    if (!empty($filters)) {
        $url .= '?' . http_build_query($filters);
    }

    $ch = curl_init();
    curl_setopt_array($ch, [
        CURLOPT_URL => $url,
        CURLOPT_HTTPHEADER => [
            'Authorization: Bearer ' . $accessToken,
            'Channel: ' . $channel
        ],
        CURLOPT_RETURNTRANSFER => true
    ]);

    $response = curl_exec($ch);
    curl_close($ch);
    return json_decode($response, true);
}

Python

import requests

def list_associates(filters=None):
    url = "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/associates"
    headers = {
        "Authorization": f"Bearer {access_token}",
        "Channel": channel
    }

    response = requests.get(url, headers=headers, params=filters)
    return response.json()

# Kullanım
customers = list_associates({"group": "customer"})

C#

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;
using Newtonsoft.Json;

async Task<dynamic> ListAssociatesAsync(Dictionary<string, string> filters = null)
{
    using var client = new HttpClient();

    var url = "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/associates";
    if (filters != null && filters.Count > 0)
    {
        var query = await new FormUrlEncodedContent(filters).ReadAsStringAsync();
        url += "?" + query;
    }

    var request = new HttpRequestMessage(HttpMethod.Get, url);
    request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", accessToken);
    request.Headers.Add("Channel", channel);

    var response = await client.SendAsync(request);
    var content = await response.Content.ReadAsStringAsync();
    return JsonConvert.DeserializeObject<dynamic>(content);
}

// Kullanım
var customers = await ListAssociatesAsync(new Dictionary<string, string> { { "group", "customer" } });

Yanıt

Başarılı Yanıt

{
  "data": [
    {
      "id": 1,
      "name": "Ahmet",
      "surname": "Yılmaz",
      "code": "CAR000018",
      "identity_no": "4688765486",
      "tax_office": "SAİMBEYLİ MAL MÜDÜRLÜĞÜ",
      "associate_type": "customer",
      "phone": "+905123456789",
      "email": "ahmet@example.com",
      "country": "Türkiye",
      "tags": [
        {
          "id": 9,
          "name": "AA",
          "description": "Açıklama"
        }
      ],
      "address": [
        {
          "id": 5,
          "address": "Mesudiye mah. No:10",
          "coutry_name": "Türkiye",
          "postal_code": "09000",
          "is_abroad": false,
          "building_name": null,
          "number": null,
          "street": null,
          "address_type": "invoice",
          "city": "Aydın",
          "district": "Efeler"
        }
      ],
      "balances": [
        {
          "currency": "try",
          "balance": 3400,
          "tantamount": 3400
        }
      ]
    }
  ]
}

Yanıt Alanları

Alan	Tip	Açıklama
id	integer	Cari ID
name	string	Cari adı
surname	string	Cari soyadı
code	string	Cari kodu
identity_no	string	TCKN/VKN
tax_office	string	Vergi dairesi
associate_type	string	Cari tipi
phone	string	Telefon
email	string	E-posta
country	string	Cari ülke bilgisi
tags	array	Etiket listesi
address	array	Adres bilgileri
balances	array	Bakiye bilgileri

Etiket Alanları (tags)

Alan	Tip	Açıklama
id	integer	Etiket ID değeri
name	string	Etiket adı
description	string	Etiket açıklaması (varsa)

Adres Alanları (address)

Alan	Tip	Açıklama
id	integer	Adrese ait ID
address	string	Adres satırı
country_name	string	Ülke adı
postal_code	string	Posta kodu
is_abroad	boolean	Yurt dışı adres bilgisi
building_name	string	Bina adı
number	number	Bina numarası
street	string	Sokak
address_type	string	Adres tipi (invoice, delivery vb.)
city	string	Şehir
district	string	İlçe

Bakiye Alanları (balances)

Alan	Tip	Açıklama
currency	string	Para birimi
balance	number	Carinin para birimine göre bakiyesi
tantamount	number	Cari bakiyesinin şirket para birimindeki karşılığı