Cubicl Kılavuzu
Search…
⌃K

Cari Hesap Kaydı

Uç noktalarında kullanılan verilerin türleri ve formatlarının tanımları sayfanın alt kısmında bulunabilir.

Uç Noktaları

get
https://cubicl.io/api/bookkeeping
/page
Sayfayı Getir
get
https://cubicl.io/api/bookkeeping
/activities
Cari Hesap Kaydının Aktivitelerini Getir
get
https://cubicl.io/api/bookkeeping
/entries/{entry}
Cari Hesap Kaydının Detaylarını Getir
post
https://cubicl.io/api/bookkeeping
/entries
Cari Hesap Kaydı Ekle
put
https://cubicl.io/api/bookkeeping
/entries/{entry}
Cari Hesap Kaydını Güncelle
delete
https://cubicl.io/api/bookkeeping
/entries/{entry}
Cari Hesap Kaydını Sil
post
https://cubicl.io/api/bookkeeping
/payment
Ödeme Ekle
delete
https://cubicl.io/api/bookkeeping
/payments/{payment}
Ödeme Sil

Veriler

BookkeepingEntry

{
org : string, // Kurum ID'si
customer : string, // Müşteri ID'si
/* receivable: Cari hesap alacak bakiyesi. Cubicl kullanıcısının
* bir ürün veya hizmet karşılığında müşterilerinden aldığı ödeme.
*
* payable: Cari hesap borç bakiyesi. Cubicl kullanıcısının
* bir müşteriye bir ürün veya hizmet karşılığında yaptığı ödeme.
*/
type : 'receivable' | 'payable',
amount : number, // Cari hesap bakiyesi. 0'dan büyük olmalıdır.
/* Para birimi. Aşağıdaki değerleri içerebilir:
* TRY, USD, EUR, GBP, AUD, CAD, CHF, CNY, HKD, NZD, SEK,
* KRW, SGD, NOK, MXN, INR, ZAR, RUB, BRL, JPY, TWD, DKK,
* THB, IDR, HUF, CZK, ILS, PHP, AED, COP, SAR, MYR, RON
*/
currency : string,
name : string,
desc : string | null,
// Toplamın ne kadarı ödeniyor? 0'dan büyük ve toplam tutardan küçük olmalıdır.
paidAmount : number,
// Tamamen ödendi mi?
isPaid : boolean,
// Son ödeme tarihi. Bu tarihten önce ödeme yapılması bekleniyor.
dueAt : number | null,
// Kaydı oluşturan kullanıcının ID'si
createdBy : string,
createdAt : number,
}

BookkeepingPayment

{
org : string, // Kurum ID'si
customer : string, // Müşteri ID'si
amount : number, // Cari hesap bakiyesi. 0'dan büyük olmalıdır.
entry : string, // Cari hesap kayıt ID'si
note : string | null, // Ödeme hakkında isteğe bağlı not
createdBy : string, // Kaydı oluşturan kullanıcının ID'si
createdAt : number
}

BookkeepingActivity

{
org : string, // Kurum ID'si
customer : string, // Müşteri ID'si
entry : string, // // Cari hesap kayıt ID'si. Her zaman gereklidir.
// Tip 'payment-received', 'payment-sent' veya 'payment-deleted' ise gereklidir.
payment? : string,
type : 'receivable-created' | 'payable-created' | 'payment-received' | 'payment-sent' | 'payment-deleted',
data : {
entryName : string,
entryDueAt? : number, // 'dueAt' tanımlanmışsa gereklidir.
amount : number, // Cari hesap bakiyesi. 0'dan büyük olmalıdır.
/* Para birimi. Aşağıdaki değerleri içerebilir:
* TRY, USD, EUR, GBP, AUD, CAD, CHF, CNY, HKD, NZD, SEK,
* KRW, SGD, NOK, MXN, INR, ZAR, RUB, BRL, JPY, TWD, DKK,
* THB, IDR, HUF, CZK, ILS, PHP, AED, COP, SAR, MYR, RON
*/
currency : string,
// Tip 'payment-received', 'payment-sent' veya 'payment-deleted' ise gereklidir.
// Toplamın ne kadarı ödeniyor? 0'dan büyük ve toplam tutardan küçük olmalıdır.
paidAmount? : number,
createdBy : string // Kaydı oluşturan kullanıcının ID'si
createdAt : number,
}