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.

200: OK Sayfa verileri. Aktiviteler, Cari Hesap kayıtları, borçlar ve alacaklar. içerir.

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

403: Forbidden İzniniz yok.

{ code : 4 }

Cari Hesap Kaydının Aktivitelerini Getir

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

Query Parameters

Name	Type	Description
entry*	string	Cari Hesap kaydının ID'si

200: OK Cari Hesap kaydının aktiviteleri

activities : BookkeepingActivity[]

403: Forbidden İzniniz yok

{ code : 4 }

422: Unprocessable Entity Kayıt bulunamadı

{ code : 1501 }

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

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

Path Parameters

Name	Type	Description
entry*	string	Cari Hesap kaydının ID'si

200: OK Cari Hesap kaydının detayları

entry : BookkeepingEntry

404: Not Found Kayıt bulunamadı

{ code : 1501 }

403: Forbidden İzniniz yok

{ code : 4 }

Cari Hesap Kaydı Ekle

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

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

Request Body

Name	Type	Description
customer*	string	Müşteri ID'si
dueAt	number	Son ödeme tarihi. Bu tarihten önce ödeme yapılması bekleniyor.
paidAmount	number	Toplamın ne kadarı ödeniyor? 0'dan büyük ve toplam tutardan küçük olmalıdır.
desc	string	Alacak veya borç kaydı açıklaması
name*	string	Alacak veya borç kaydı adı
currency*	string	Para birimi. Aşağıdaki değerlerden birini içermelidir: TRY, USD, EUR, GBP, AUD, CAD, CHF, CNY, HKD, NZD, SEK, KRW, SGD, NOK, MXN, INR, ZAR, RUB, BRL, JPY, TWD, DKK, PLN, THB, IDR, HUF, CZK, ILS, PHP, AED, COP, SAR, MYR, RON
amount*	number	Cari hesap bakiyesi. 0'dan büyük olmalıdır.
type*	string	receivable || payable 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.

200: OK Etkinlik, ödeme ve ödeme etkinliği ile yeni kayıt

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

403: Forbidden İzniniz yok

{ code : 4 }

404: Not Found Müşteri bulunamadı

{ code : 303 }

422: Unprocessable Entity Kurumunuzun mevcut planı yetersiz. Paketinizi yükseltmelisiniz.

{ code : 1201 }

422: Unprocessable Entity Para birimi desteklenmiyor

{ code : 1504 }

Cari Hesap Kaydını Güncelle

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

Path Parameters

Name	Type	Description
entry*	string	Cari Hesap kaydının ID'si

Request Body

Name	Type	Description
type*	string	receivable || payable 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.
dueAt	number	Son ödeme tarihi. Bu tarihten önce ödeme yapılması bekleniyor.
desc	string	Alacak veya borç kaydı açıklaması
name*	string	Alacak veya borç kaydı adı
currency*	string	Para birimi. Aşağıdaki değerlerden birini içermelidir: TRY, USD, EUR, GBP, AUD, CAD, CHF, CNY, HKD, NZD, SEK, KRW, SGD, NOK, MXN, INR, ZAR, RUB, BRL, JPY, TWD, DKK, PLN, THB, IDR, HUF, CZK, ILS, PHP, AED, COP, SAR, MYR, RON

200: OK Güncellenmiş kayıt

entry : BookkeepingEntry

403: Forbidden İzniniz yok

{ code : 4 }

422: Unprocessable Entity Ödenen tutar, kayıt tutarından fazla olamaz

{ code : 1503 }

422: Unprocessable Entity Kurumunuzun mevcut planı yetersiz. Paketinizi yükseltmelisiniz.

{ code : 1201 }

404: Not Found Kayıt bulunamadı

{ code: 1501 }

422: Unprocessable Entity Para birimi desteklenmiyor

{ code: 1504 }

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

Name	Type	Description
entry*	string	Cari Hesap kaydının ID'si

200: OK Boş yanıt

403: Forbidden İzniniz yok

{ code : 4 }

422: Unprocessable Entity Kayıt bulunamadı

{ code : 1501 }

422: Unprocessable Entity Kurumunuzun mevcut planı yetersiz. Paketinizi yükseltmelisiniz.

{ code : 1201 }

Ödeme Ekle

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

Path Parameters

Name	Type	Description
entry*	string	Cari Hesap kaydının ID'si

Request Body

Name	Type	Description
paidAmount*	number	Toplamın ne kadarı ödeniyor? 0'dan büyük ve toplam tutardan küçük olmalıdır.
note	string

200: OK Yeni ödeme ve aktivite

{
    payment : BookkeepingPayment,
    activity : BookkeepingActivity
}

403: Forbidden İzniniz yok

{ code : 4 }

404: Not Found Kayıt bulunamadı

{ code : 1501 }

422: Unprocessable Entity Ödenen tutar, kayıt tutarından fazla olamaz

{ code: 1503 }

422: Unprocessable Entity Kurumunuzun mevcut planı yetersiz. Paketinizi yükseltmelisiniz.

{ code : 1201 }

Ödeme Sil

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

Path Parameters

Name	Type	Description
payment*	string	Ödeme ID'si

200: OK Cari hesap aktivitesi

activity : BookkeepingActivity

403: Forbidden İzniniz yok

{ code : 4 }

404: Not Found Ödeme bulunamadı

{ code : 1502 }

422: Unprocessable Entity Kurumunuzun mevcut planı yetersiz. Paketinizi yükseltmelisiniz.

{ code : 1201 }

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