Cari Detay

Belirtilen carinin detay bilgilerini getirir.

Endpoint

GET /kolaybi/v1/associates/{id}

Parametreler

Parametre	Tip	Zorunlu	Açıklama
id	integer	Evet	Detayı görüntülenecek cari ID'si

Örnekler

cURL

curl -X GET "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/associates/1" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Channel: YOUR_CHANNEL"

JavaScript

async function getAssociateDetail(associateId) {
  const response = await fetch(
    `https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/associates/${associateId}`,
    {
      method: "GET",
      headers: {
        Authorization: `Bearer ${accessToken}`,
        Channel: channel,
      },
    }
  );

  return await response.json();
}

// Kullanım
const associate = await getAssociateDetail(1);

PHP

function getAssociateDetail($associateId) {
    $url = "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/associates/{$associateId}";

    $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);
}

// Kullanım
$associate = getAssociateDetail(1);

Python

import requests

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

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

# Kullanım
associate = get_associate_detail(1)

C#

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

async Task<dynamic> GetAssociateDetailAsync(int associateId)
{
    using var client = new HttpClient();

    var request = new HttpRequestMessage(HttpMethod.Get,
        $"https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/associates/{associateId}");

    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 associate = await GetAssociateDetailAsync(1);

Yanıt

Başarılı Yanıt

{
  "data": {
    "id": 123,
    "name": "Örnek",
    "surname": "Cari",
    "full_name": "Örnek Cari",
    "code": "CAR000001",
    "identity_no": "1234567890",
    "tax_office": "Örnek Vergi Dairesi",
    "associate_type": "customer",
    "status": "active",
    "phone": "+905001234567",
    "email": "ornek@example.com",
    "country": "Türkiye",
    "tags": [
      {
        "id": 1,
        "name": "Örnek Etiket",
        "description": "Etiket açıklaması"
      }
    ],
    "address": [
      {
        "id": 1,
        "address": "Örnek Mah. Test Sok. No:1",
        "coutry_name": "Türkiye",
        "postal_code": "34000",
        "is_abroad": false,
        "building_name": null,
        "number": null,
        "street": null,
        "address_type": "invoice",
        "city": "İstanbul",
        "district": "Kadıköy"
      }
    ],
    "balances": [
      {
        "currency": "try",
        "balance": 1500,
        "tantamount": 1500
      }
    ]
  }
}

Yanıt Alanları

Alan	Tip	Açıklama
id	integer	Cari ID
name	string	Cari adı
surname	string	Cari soyadı
full_name	string	Cari tam adı
code	string	Cari kodu
identity_no	string	TCKN/VKN
tax_office	string	Vergi dairesi
associate_type	string	Cari tipi
status	string	Cari durumu
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ığı