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.
Fetch Entry Activities
GET
https://cubicl.io/api/v1/bookkeeping/activities
Query Parameters
entry*
String
Entry id
Fetch Entry Details
GET
https://cubicl.io/api/v1/bookkeeping/entries/{entry}
Path Parameters
entry*
String
Entry id
Add Entry
POST
https://cubicl.io/api/v1/bookkeeping/entries
Adds a receivable or payable entry for a client.
Request Body
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.
Update Entry Details
PUT
https://cubicl.io/api/v1/bookkeeping/entries/{entry}
Path Parameters
entry*
String
Entry id
Request Body
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.
Delete Entry
DELETE
https://cubicl.io/api/v1/bookkeeping/entries/{entry}
All activity and payment records related to this entry is deleted.
Path Parameters
entry*
String
Entry id
Add Payment
POST
https://cubicl.io/api/v1/bookkeeping/payment/{entry}
Path Parameters
entry*
String
Entry id
Request Body
paidAmount*
Number
How much of the total is paid? It must be greater than 0 and less than the total amount.
note
String
Delete Payment
DELETE
https://cubicl.io/api/v1/bookkeeping/payments/{payment}
Path Parameters
payment*
String
Payment id
Data
BookkeepingEntry
BookkeepingPayment
BookkeepingActivity
Last updated
Was this helpful?