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ı

Sayfayı Getir

GET https://cubicl.io/api/bookkeeping/page

Cari hesap sayfası için gerekli cari hesap kaydı, aktivite ve istatistikleri getirir.

{
    activities : BookkeepingActivity[],
    entries : BookkeepingEntry[],
    payables : {
        total : number,
        outstanding : number,
        overdue : number,
        currency : string
    },
    receivables : {
        total : number,
        outstanding : number,
        overdue : number,
        currency : string
    }
}

Cari Hesap Kaydının Aktivitelerini Getir

GET https://cubicl.io/api/bookkeeping/activities

Query Parameters

activities : BookkeepingActivity[]

Cari Hesap Kaydının Detaylarını Getir

GET https://cubicl.io/api/bookkeeping/entries/{entry}

Path Parameters

entry : BookkeepingEntry

Cari Hesap Kaydı Ekle

POST https://cubicl.io/api/bookkeeping/entries

Bir müşteriyle ilgili alacak veya borç kaydı ekler.

Request Body

{
    entry : BookkeepingEntry
    entryActivity : BookkeepingActivity,
    payment? : BookkeepingPayment // Exists if paidAmount is given
    paymentActivity? : BookkeepingActivity // Exists if paidAmount is given
}

Cari Hesap Kaydını Güncelle

PUT https://cubicl.io/api/bookkeeping/entries/{entry}

Path Parameters

Request Body

entry : BookkeepingEntry

Cari Hesap Kaydını Sil

DELETE https://cubicl.io/api/bookkeeping/entries/{entry}

Bu cari hesap kaydına ilişkin tüm aktivite ve ödeme kayıtları silinir.

Path Parameters

Ödeme Ekle

POST https://cubicl.io/api/bookkeeping/payment

Path Parameters

Request Body

{
    payment : BookkeepingPayment,
    activity : BookkeepingActivity
}

Ödeme Sil

DELETE https://cubicl.io/api/bookkeeping/payments/{payment}

Path Parameters

activity : BookkeepingActivity

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,
}

Last updated