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
identity_no	string	TCKN/VKN ile filtreleme
email	string	E-posta ile filtreleme
group	AssociateGroup	Cari grubu ile filtreleme

Not: Tüm grup değerleri için bkz. AssociateGroup veri tipi.

Ö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": "CAR001",
      "identity_no": "12345678901",
      "associate_type": "customer",
      "phone": "+905123456789",
      "email": "ahmet@example.com",
      "address": [...],
      "balances": [...]
    }
  ]
}

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
associate_type	string	Cari tipi
phone	string	Telefon
email	string	E-posta
address	array	Adres bilgileri
balances	array	Bakiye bilgileri