Cari Hareket Listeleme
Belirtilen cariye ait hesap hareketlerini listeler.
Endpoint
GET /kolaybi/v1/associates/{associate_id}/transactions
Parametreler
| Parametre | Tip | Zorunlu | Açıklama |
|---|---|---|---|
associate_id | integer | Evet | Hareketleri görüntülenecek cari ID'si |
Örnekler
- cURL
- JavaScript
- PHP
- Python
- C#
curl -X GET "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/associates/1/transactions" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Channel: YOUR_CHANNEL"
async function getAssociateTransactions(associateId) {
const response = await fetch(
`https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/associates/${associateId}/transactions`,
{
method: "GET",
headers: {
Authorization: `Bearer ${accessToken}`,
Channel: channel,
},
}
);
return await response.json();
}
// Kullanım
const transactions = await getAssociateTransactions(1);
function getAssociateTransactions($associateId) {
$url = "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/associates/{$associateId}/transactions";
$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
$transactions = getAssociateTransactions(1);
import requests
def get_associate_transactions(associate_id):
url = f"https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/associates/{associate_id}/transactions"
headers = {
"Authorization": f"Bearer {access_token}",
"Channel": channel
}
response = requests.get(url, headers=headers)
return response.json()
# Kullanım
transactions = get_associate_transactions(1)
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;
using Newtonsoft.Json;
async Task<dynamic> GetAssociateTransactionsAsync(int associateId)
{
using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get,
$"https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/associates/{associateId}/transactions");
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 transactions = await GetAssociateTransactionsAsync(1);
Yanıt
- Başarılı Yanıt
{
"data": {
"transactionables": [
{
"id": 135,
"transaction_id": 13548,
"transaction_type": {
"group": "sale",
"value": "debt",
"key": "DEBT",
"description": "Borç"
},
"payment_method": {
"group": "cash",
"value": "cash",
"key": "CASH",
"description": "Nakit"
},
"transaction_subtype": {
"value": "debt",
"key": "DEBT",
"description": "Borç"
},
"due_date": "2024-12-20 11:48:24",
"issue_date": "2024-07-31 11:48:24",
"cash_flow_direction": 1,
"amount": 3400,
"currency": "try",
"exchange_rate": 1,
"exchange_amount": 3400,
"quote_currency": "try",
"description": "Satış Faturası",
"cumulative": 6000,
"serial_no": "KBI20240000000234",
"projects": "PROJE 1, PROJE 2",
"commercial_docs": [
{
"id": 56,
"name": "CommercialDoc",
"commercial_doc_type": {
"group": "sale",
"value": "sale_waybill",
"key": "SALE_WAYBILL",
"description": "Satış İrsaliyesi"
},
"total_remaining": 0,
"created_at": "2024-07-31 11:00:00",
"is_closed": true
}
],
"cheques": [
{
"id": 56,
"cheque_type": "Verilen Çek"
}
],
"bonds": [
{
"id": 56,
"cheque_type": "Verilen Senet"
}
],
"vaults": "Ana Kasa"
}
],
"calculations": [
{
"debt": 3000,
"receivable": 2000,
"amount": 1000,
"currency": "try",
"exchange_debt": 3000,
"exchange_receivable": 2000,
"exchange_amount": 1000
}
]
}
}
Yanıt Alanları
| Alan | Tip | Açıklama |
|---|---|---|
transactionables | array | Cari harekete ait satır listesi |
transactionables[].id | integer | Hareket kayıt ID'si |
transactionables[].transaction_id | integer | İşleme ait benzersiz ID |
transactionables[].transaction_type | object | İşlem türü (group, value, description) |
transactionables[].payment_method | object | Ödeme yöntemi |
transactionables[].transaction_subtype | object | İşlem alt türü |
transactionables[].due_date | string | Vade tarihi (YYYY-MM-DD HH:mm:ss) |
transactionables[].issue_date | string | İşlem tarihi |
transactionables[].cash_flow_direction | integer | İşlem yönü (1/0/-1) |
transactionables[].amount | number | İşlem tutarı |
transactionables[].currency | string | İşlem para birimi |
transactionables[].exchange_rate | number | Kullanılan kur oranı |
transactionables[].exchange_amount | number | Döviz karşılığı |
transactionables[].quote_currency | string | Takip para birimi |
transactionables[].description | string | Açıklama |
transactionables[].cumulative | number | İşlem sonrası kümülatif bakiye |
transactionables[].serial_no | string | Belge seri numarası |
transactionables[].projects | string | İlişkili projeler |
transactionables[].commercial_docs | array | İlişkili ticari belgeler listesi |
transactionables[].cheques | array | Çek detayları |
transactionables[].bonds | array | Senet detayları |
transactionables[].vaults | string | Kullandığı kasa/banka adı |
calculations | array | Cari bakiyesine dair hesap özetleri |
calculations[].debt | number | Toplam borç |
calculations[].receivable | number | Toplam alacak |
calculations[].amount | number | Net tutar |
calculations[].currency | string | Para birimi (boş ise genel toplam) |
calculations[].exchange_debt | number | Döviz borç |
calculations[].exchange_receivable | number | Döviz alacak |
calculations[].exchange_amount | number | Döviz net tutarı |