Bookkeeping

Definitions of the types and formats of the data used in the endpoints can be found at the bottom of the page.

Endpoints

Get Page

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

Fetches current account, activities and statistics required for bookkeeping.

200: OK Page data. It contains activities, entries, payables and receivables.

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

403: Forbidden You don't have the permission.

{ code : 4 }

Fetch Entry Activities

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

Query Parameters

Name	Type	Description
entry*	String	Entry id

200: OK Entry's activities

BookkeepingActivity[]

403: Forbidden You don't have the permission.

{ code : 4 }

404: Not Found Entry not found

{ code : 1501 }

Fetch Entry Details

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

Path Parameters

Name	Type	Description
entry*	String	Entry id

200: OK Entry's detail

BookkeepingEntry

403: Forbidden You don't have the permission.

{ code : 4 }

404: Not Found Entry not found

{ code : 1501 }

Add Entry

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

Adds a receivable or payable entry for a client.

Request Body

Name	Type	Description
customer*	String	Client id
dueAt	Number	Due date. Payment is expected to be made before this date.
paidAmount	Number	How much of the total is paid? It must be greater than 0 and less than the total amount.
desc	String	Receivable or payable entry description.
name*	String	Receivable or payable entry name.
currency*	String	Currency. It must contain one of the following values: 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	Current account balance. It must be greater than 0.
type*	String	receivable || payable receivable: The payment you will receive from your clients. payable: The payment you will pay to your clients.

200: OK New entry with activity, payment and payment activity

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

403: Forbidden You don't have the permission.

{ code : 4 }

404: Not Found Client not found

{ code : 303 }

422: Unprocessable Entity Your organization's current plan has insufficient. You can upgrade it.

{ code : 1201 }

422: Unprocessable Entity Currency not supported

{ code : 1504 }

Update Entry Details

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

Path Parameters

Name	Type	Description
entry*	String	Entry id

Request Body

Name	Type	Description
type*	String	receivable || payable receivable: The payment you will receive from your clients. payable: The payment you will pay to your clients.
currency*	String	Currency. It must contain one of the following values: 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
name*	String	Receivable or payable entry name.
desc	String	Receivable or payable entry description.
dueAt	Number	Due date. Payment is expected to be made before this date.

200: OK Updated entry

BookkeepingEntry

403: Forbidden You don't have the permission.

{ code : 4 }

422: Unprocessable Entity Paid amount cannot be greater than entry amount

{ code : 1503 }

422: Unprocessable Entity Your organization's current plan has insufficient. You can upgrade it.

{ code : 1201 }

422: Unprocessable Entity Currency not supported

{ code: 1504 }

404: Not Found Entry not found

{ code: 1501 }

Delete Entry

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

All activity and payment records related to this entry is deleted.

Path Parameters

Name	Type	Description
entry*	String	Entry id

200: OK Empty response

403: Forbidden You don't have the permission.

{ code : 4 }

422: Unprocessable Entity Your organization's current plan has insufficient. You can upgrade it.

{ code : 1201 }

404: Not Found Entry not found

{ code: 1501 }

Add Payment

POST https://cubicl.io/api/v1/bookkeeping/payment/{entry}

Path Parameters

Name	Type	Description
entry*	String	Entry id

Request Body

Name	Type	Description
paidAmount*	Number	How much of the total is paid? It must be greater than 0 and less than the total amount.
note	String

200: OK New payment and activity

{
    payment : BookkeepingPayment,
    activity : BookkeepingActivity
}

403: Forbidden You don't have the permission.

{ code : 4 }

404: Not Found Entry not found

{ code : 1501 }

422: Unprocessable Entity Paid amount cannot be greater than entry amount

{ code: 1503 }

422: Unprocessable Entity Your organization's current plan has insufficient. You can upgrade it.

{ code : 1201 }

Delete Payment

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

Path Parameters

Name	Type	Description
payment*	String	Payment id

200: OK Bookkeeping Activity

BookkeepingActivity

403: Forbidden You don't have the permission.

{ code : 4 }

404: Not Found Payment not found

{ code : 1502 }

422: Unprocessable Entity Your organization's current plan has insufficient. You can upgrade it.

{ code : 1201 }

Data

BookkeepingEntry

{
    org : string, // Organization id
    customer : string, // Client id
    /* receivable: The payment you will receive from your clients.
     * payable: The payment you will pay to your clients.
     */
    type : 'receivable' | 'payable',
    amount : number, // Current account balance. It must be greater than 0.
    /* Currency. It must contain one of the following values:
     * 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,
    paidAmount : number,     // How much of the total is paid? It must be greater than zero and less than total amount.
    isPaid : boolean,        // Is completely paid off?
    dueAt : number | null,   // Due date. Payment is expected to be made before this date.
    createdBy : string,      // Id of the user who created the entry.
    createdAt : number,
}

BookkeepingPayment

{
    org : string, // Organization id
    customer : string, // Client id
    amount : number, // Current account balance. It must be greater than 0.
    entry : string, // Bookkeeping Entry id
    note : string | null, // Optional note about the payment
    createdBy : string, // Id of the user who created the entry
    createdAt : number
}

BookkeepingActivity

{
    org : string, // Organization id
    customer : string, // Client id
    entry : string, // Bookkeeping Entry id. Always exists
    payment? : string, // Exists if type is 'payment-received', 'payment-sent' or 'payment-deleted'
    type : 'receivable-created' | 'payable-created' | 'payment-received' | 'payment-sent' | 'payment-deleted',
    data : {
        entryName : string,
        entryDueAt? : number, // Exists if entry dueAt defined
        amount : number, // Current account balance. It must be greater than 0.
        /* Currency. It must contain one of the following values:
         * 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,
        paidAmount? : number, // Exists if type is receivable/payable-created. How much of the total is paid? It must be greater than zero
    },
    createdBy : string // Id of the user who created the entry
    createdAt : number,
}