Skip to main content
GET
Cari ekstresi
Salt okunur rapordur: bu sayfadaki hiçbir şey API üzerinden oluşturulamaz, güncellenemez ya da silinemez. Yanıtta iki liste bulunur: Lines (hareket dökümü) ve Totals (döviz başına genel toplam).
  • StartDate ve EndDate zorunludur (1023/1024) ve belge tarihine göre (her ikisi de dahil) aralığı belirler. EndDate, StartDate’ten önce olamaz (1025).
  • CurrencyId, hem Lines’ı hem Totals’ı tek bir dövize daraltır; boş bırakılırsa tüm dövizler döner.
  • Lines belge tarihine, sonra iç belge sırasına göre sıralanır.
  • Lines[].Balance, döviz başına koşan bakiyedir: o dövizde, bu satır dahil o ana kadarki kümülatif Borç − Alacak değeridir; dövizler arası birleşik tek bir toplam değildir. Cari birden fazla dövizde hareket görmüşse, her döviz kendi bakiye sırasına sahiptir.
  • Totals, Lines’ta görülen her döviz için bir satır içerir; ilgili dövizdeki tüm tarih aralığının genel toplamını (Borç toplamı eksi Alacak toplamı) taşır — bu değer, o dövizdeki son satırın Balance’ına eşittir. Her satırda ayrıca dövizin kısa kodu ve şirketin varsayılan dövizi olup olmadığı bulunur.
  • Lines[].TransactionType, ham belge tipi kodudur; TransactionTypeName, aşağıdaki tablodan çözülmüş İngilizce adıdır.
  • Lines[].TransactionAmount/TransactionCurrencyId, satırın kendi Debit/Credit/CurrencyId alanlarından farklı olabilecek durumlarda (ör. banka hesabının kendi döviziyle yapılan ama cariye başka bir dövizle yansıyan bir havale) belgenin asıl tutarını ve dövizini taşır. Satırın kendi dövizi zaten belgenin dövizi ise null döner — bu, fatura/sipariş satırlarının çoğunda beklenen bir durumdur, eksik veri değildir.
  • Lines[].InstallmentCount, bu hareketle ilişkili taksit sayısıdır; taksit yoksa 0’dır.

Hareket tipleri

TransactionType, satırın arkasındaki belge türünü gösterir.

Yetkilendirmeler

Authorization
string
header
gerekli

Access token obtained from the Noyax auth service with your API key.

Başlıklar

X-UserID
integer<int32>
gerekli

İsteğin adına yapıldığı Noyax kullanıcısının ID'si. Oluşturulan, güncellenen ve silinen kayıtların denetim alanlarına yazılır.

Gerekli aralık: x >= 1
X-CompanyID
integer<int32>
gerekli

Şirketin ID'si. Kullanıcı bu şirkete tanımlı olmalıdır. Bütün okuma ve yazma işlemleri bu şirketle sınırlıdır.

Gerekli aralık: x >= 1
X-PeriodID
integer<int32>

Muhasebe döneminin ID'si. Cari endpoint'lerinde isteğe bağlıdır; gönderilirse oluşturulan kayıtlara yazılır.

Gerekli aralık: x >= 1

Yol Parametreleri

customerId
string<uuid>
gerekli

Cari ID'si.

Sorgu Parametreleri

startDate
string<date-time>

Zorunlu. Tarih aralığının başlangıcı (dahil).

endDate
string<date-time>

Zorunlu. Tarih aralığının bitişi (dahil). StartDate'ten önce olamaz.

currencyId
string<uuid>

Yalnızca bu dövizdeki satırları döner, GET /api/v1/definitions/currencies içinden. Boş bırakılırsa tüm dövizler döner.

Yanıt

OK

Success
boolean
gerekli

İşlemin başarılı olup olmadığı.

Örnek:

true

ResultCode
string
gerekli

Başarıda "0000". Hatada ilk hatanın kodu; hataların tamamı Errors içinde listelenir.

Örnek:

"0000"

Data
object
gerekli

Response data. Null when Success is false.

Message
null | string

Success false olduğunda hata mesajı. Bütün hataların mesajları tek metinde birleştirilir.