Şirket Listeleme

İlgili access_token'a ait şirketler listelenir.

Endpoint

GET /kolaybi/v1/companies

Parametreler

Bu endpoint herhangi bir parametre almaz.

Örnekler

cURL

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

JavaScript

async function listCompanies() {
  const response = await fetch(
    "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/companies",
    {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        Channel: channel,
      },
    }
  );
  return await response.json();
}

// Kullanım
const companies = await listCompanies();

PHP

function listCompanies() {
    $url = 'https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/companies';

    $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_companies():
    url = 'https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/companies'
    headers = {
        'Authorization': f'Bearer {access_token}',
        'Channel': channel
    }

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

# Kullanım
companies = list_companies()

C#

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

async Task<dynamic> ListCompaniesAsync()
{
    using var client = new HttpClient();

    var request = new HttpRequestMessage(HttpMethod.Get,
        "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/companies");

    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 companies = await ListCompaniesAsync();

Yanıt

{
  "data": [
    {
      "company_id": 5,
      "company_name": "KolayBi",
      "identity_no": "01234567890",
      "tax_office": "FEKE MAL MÜDÜRLÜĞÜ",
      "logo": "YsZbc6sXoFVP/zJ8SDl3849VlBeSHEn/Y765qnRK1hkTMm+R7u665yZJP7ik",
      "phone": "+905123456789",
      "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"
      },
      "company_currency": "TRY",
      "e_invoice_activated_at": "2018-12-20 11:48:24",
      "is_activated": true,
      "auto_netting_enabled": true,
      "is_invoice_resendble": false
    }
  ]
}

Yanıt Alanları

Alan	Tip	Açıklama
company_id	integer	Şirkete ait ID değeri
company_name	string	Şirket adı
identity_no	string	Şirketin VKN/TCKN numarası
tax_office	string	Vergi dairesi
logo	string	Şirket logosu
phone	string	Şirkete ait telefon numarası
address	object	Şirket adres bilgileri
company_currency	string	Şirketin para birimi
e_invoice_activated_at	string	E-Fatura aktifleştirme tarihi
is_activated	boolean	E-Fatura entegrasyonu aktif olup olmadığı
auto_netting_enabled	boolean	Otomatik mahsuplaşmanın açık olup olmadığı
is_invoice_resendble	boolean	Fatura resend endpointini destekleyip desteklemediği