Reports

Reports #

Reports represent the output of the service. They present information aggregated from the financial data collected via Transactions, Balances and other Resources in a summarised, concise and standardised format that can easily be interpreted by a host of stakeholders in accordance with the provisions of the International Financial Reporting Standards. The service provides four standard Financial Statements: Income Statement, Balance Sheet, CashFlow Statement and the Trial Balance.

Income Statement #

The Income Statement, also known as The Profit and Loss is the report that illustrates the performance of the Entity over a period of time, i.e how much profit or loss the Entity experienced during the period. If a period is not specified, the report returns the performance of the Entity from the beginning of the current Reporting Period to date.

Request #

curl --location --request GET 'api.microbooks.io/books/v1/reports/income-statement'
import requests

url = "https://api.microbooks.io/books/v1/reports/income-statement"
body = {}
headers = {"Authorization": "Bearer <bearer_token>"}

response = requests.request("GET", url, headers=headers, json=body)

print(response.text)
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://api.microbooks.io/books/v1/reports/income-statement',
    'headers': {'Authorization': 'Bearer <bearer_token>'},
    'body': '{}'
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
$client = new Client();
$body = '{}';
$request = new Request('GET', 'https://api.microbooks.io/books/v1/reports/income-statement', 
    [headers' => ['Authorization' => 'Bearer <bearer_token>']], 
    $body
);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
var client = new RestClient("https://api.microbooks.io/books/v1/reports/income-statement");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
var body = null;
request.AddParameter("text/plain", body,  ParameterType.RequestBody);
request.AddHeader("Authorization", "Bearer " + <bearer_token>);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Response #

{
    "status": "success",
    "income_statement": {
        "reportingPeriod": {
            "uuid": "65487ec2-8d78-47a7-be8f-2363aec4fad0",
            "id": 1,
            "entity_id": 1,
            "period_count": 0,
            "status": "OPEN",
            "calendar_year": 2022,
            "closing_date": null
        },
        "balances": {
            "debit": 260,
            "credit": 450,
            "OPERATING_REVENUES": {
                "OPERATING_REVENUE": -245
            },
            "NON_OPERATING_REVENUES": {
                "NON_OPERATING_REVENUE": -205
            },
            "OPERATING_EXPENSES": {
                "OPERATING_EXPENSE": 100
            },
            "NON_OPERATING_EXPENSES": {
                "DIRECT_EXPENSE": 70,
                "OVERHEAD_EXPENSE": 70,
                "OTHER_EXPENSE": 20
            }
        },
        "accounts": {
            "OPERATING_REVENUES": {
                "OPERATING_REVENUE": {
                    "Operating Revenue": {
                        "accounts": [
                            {
                                "uuid": "7b7d42c4-edda-4e1f-a025-8ceb1f24248a",
                                "id": 2,
                                "entity_id": 1,
                                "category_id": null,
                                "currency_id": 1,
                                "code": 4,
                                "name": "General Stanton",
                                "description": null,
                                "account_type": "Operating Revenue",
                                "opening_balance": 0,
                                "balance_movement": 200,
                                "closing_balance": -200
                            },
                            {
                                "uuid": "d8a7dd81-a35a-42b4-872c-ace65625f0f7",
                                "id": 7,
                                "entity_id": 1,
                                "category_id": null,
                                "currency_id": 1,
                                "code": 7,
                                "name": "Dr. Lawrence Rosenbaum",
                                "description": null,
                                "account_type": "Operating Revenue",
                                "opening_balance": 0,
                                "balance_movement": -55,
                                "closing_balance": 55
                            },
                            {
                                "uuid": "9fefaeca-bc68-4dde-a004-06aee2af8385",
                                "id": 10,
                                "entity_id": 1,
                                "category_id": null,
                                "currency_id": 1,
                                "code": 9,
                                "name": "Ms. Carli Wiza",
                                "description": null,
                                "account_type": "Operating Revenue",
                                "opening_balance": 0,
                                "balance_movement": 100,
                                "closing_balance": -100
                            }
                        ],
                        "total": -245,
                        "category_id": "default"
                    }
                }
            },
            "NON_OPERATING_REVENUES": {
                "NON_OPERATING_REVENUE": {
                    "Non Operating Revenue": {
                        "accounts": [
                            {
                                "uuid": "a2a6f80a-9007-4882-847d-d0ef61cf2d4a",
                                "id": 11,
                                "entity_id": 1,
                                "category_id": null,
                                "currency_id": 1,
                                "code": 3,
                                "name": "Chelsea Reilly",
                                "description": null,
                                "account_type": "Non Operating Revenue",
                                "opening_balance": 0,
                                "balance_movement": 5,
                                "closing_balance": -5
                            },
                            {
                                "uuid": "4cd41d07-1b34-46fd-b6b9-538e6b709783",
                                "id": 13,
                                "entity_id": 1,
                                "category_id": null,
                                "currency_id": 1,
                                "code": 3,
                                "name": "Lyric Crist",
                                "description": null,
                                "account_type": "Non Operating Revenue",
                                "opening_balance": 0,
                                "balance_movement": 200,
                                "closing_balance": -200
                            }
                        ],
                        "total": -205,
                        "category_id": "default"
                    }
                }
            },
            "OPERATING_EXPENSES": {
                "OPERATING_EXPENSE": {
                    "Operating Expense": {
                        "accounts": [
                            {
                                "uuid": "10eb7db6-5d94-4e75-b937-b0f71e5661cd",
                                "id": 17,
                                "entity_id": 1,
                                "category_id": null,
                                "currency_id": 1,
                                "code": 5,
                                "name": "Kieran Koch III",
                                "description": null,
                                "account_type": "Operating Expense",
                                "opening_balance": 0,
                                "balance_movement": -100,
                                "closing_balance": 100
                            }
                        ],
                        "total": 100,
                        "category_id": "default"
                    }
                }
            },
            "NON_OPERATING_EXPENSES": {
                "DIRECT_EXPENSE": {
                    "Direct Expense": {
                        "accounts": [
                            {
                                "uuid": "65568084-a671-4a95-9e57-5b4ef972e48f",
                                "id": 21,
                                "entity_id": 1,
                                "category_id": null,
                                "currency_id": 1,
                                "code": 7,
                                "name": "Sandra Pfeffer III",
                                "description": null,
                                "account_type": "Direct Expense",
                                "opening_balance": 0,
                                "balance_movement": -70,
                                "closing_balance": 70
                            }
                        ],
                        "total": 70,
                        "category_id": "default"
                    }
                },
                "OVERHEAD_EXPENSE": {
                    "Overhead Expense": {
                        "accounts": [
                            {
                                "uuid": "87d0cf32-9efb-4272-96dc-874cbff894a8",
                                "id": 25,
                                "entity_id": 1,
                                "category_id": null,
                                "currency_id": 1,
                                "code": 2,
                                "name": "Michelle Corkery",
                                "description": null,
                                "account_type": "Overhead Expense",
                                "opening_balance": 0,
                                "balance_movement": -70,
                                "closing_balance": 70
                            }
                        ],
                        "total": 70,
                        "category_id": "default"
                    }
                },
                "OTHER_EXPENSE": {
                    "Other Expense": {
                        "accounts": [
                            {
                                "uuid": "e9859310-76e6-455d-89e0-1737ef3cfc62",
                                "id": 29,
                                "entity_id": 1,
                                "category_id": null,
                                "currency_id": 1,
                                "code": 2,
                                "name": "Dr. Jason Conn",
                                "description": null,
                                "account_type": "Other Expense",
                                "opening_balance": 0,
                                "balance_movement": -70,
                                "closing_balance": 70
                            },
                            {
                                "uuid": "a44ab597-1a30-4e69-836f-504ef724e8fa",
                                "id": 33,
                                "entity_id": 1,
                                "category_id": null,
                                "currency_id": 1,
                                "code": 0,
                                "name": "Hilda Wuckert III",
                                "description": null,
                                "account_type": "Other Expense",
                                "opening_balance": 0,
                                "balance_movement": 50,
                                "closing_balance": -50
                            }
                        ],
                        "total": 20,
                        "category_id": "default"
                    }
                }
            }
        },
        "totals": {
            "OPERATING_REVENUES": -245,
            "NON_OPERATING_REVENUES": -205,
            "OPERATING_EXPENSES": 100,
            "NON_OPERATING_EXPENSES": 160
        },
        "results": {
            "GROSS_PROFIT": 145,
            "TOTAL_REVENUE": 350,
            "NET_PROFIT": 190
        },
        "period": {
            "startDate": "2022-01-01 00:00:00",
            "endDate": "2022-10-24T20:13:45.000000Z"
        }
    }
}

Variations #

Html Version #

The Income Statement can be retrieved in HTML format by calling the endpoint with the format parameter set to html.

curl --location --request GET 'api.microbooks.io/books/v1/reports/income-statement?format=html'
import requests

url = "https://api.microbooks.io/books/v1/reports/income-statement?format=html"
body = {}
headers = {"Authorization": "Bearer <bearer_token>"}

response = requests.request("GET", url, headers=headers, json=body)

print(response.text)
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://api.microbooks.io/books/v1/reports/income-statement?format=html',
    'headers': {'Authorization': 'Bearer <bearer_token>'},
    'body': '{}'
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
$client = new Client();
$body = '{}';
$request = new Request('GET', 'https://api.microbooks.io/books/v1/reports/income-statement?format=html', 
    [headers' => ['Authorization' => 'Bearer <bearer_token>']], 
    $body
);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
var client = new RestClient("https://api.microbooks.io/books/v1/reports/income-statement?format=html");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
var body = null;
request.AddParameter("text/plain", body,  ParameterType.RequestBody);
request.AddHeader("Authorization", "Bearer " + <bearer_token>);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

PDF Version #

The Income Statement can be retrieved in pdf format by calling the endpoint with the format parameter set to pdf.

curl --location --request GET 'api.microbooks.io/books/v1/reports/income-statement?format=pdf'
import requests

url = "https://api.microbooks.io/books/v1/reports/income-statement?format=pdf"
body = {}
headers = {"Authorization": "Bearer <bearer_token>"}

response = requests.request("GET", url, headers=headers, json=body)

print(response.text)
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://api.microbooks.io/books/v1/reports/income-statement?format=pdf',
    'headers': {'Authorization': 'Bearer <bearer_token>'},
    'body': '{}'
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
$client = new Client();
$body = '{}';
$request = new Request('GET', 'https://api.microbooks.io/books/v1/reports/income-statement?format=pdf', 
    [headers' => ['Authorization' => 'Bearer <bearer_token>']], 
    $body
);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
var client = new RestClient("https://api.microbooks.io/books/v1/reports/income-statement?format=pdf");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
var body = null;
request.AddParameter("text/plain", body,  ParameterType.RequestBody);
request.AddHeader("Authorization", "Bearer " + <bearer_token>);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Balance Sheet #

The Balance Sheet, also known as The Statement of Financial Position persents the finsncial health of the Entity by comparing its Assets owned Liabilities owed .

Request #

curl --location --request GET 'api.microbooks.io/books/v1/reports/balance-sheet'
import requests

url = "https://api.microbooks.io/books/v1/reports/balance-sheet"
body = {}
headers = {"Authorization": "Bearer <bearer_token>"}

response = requests.request("GET", url, headers=headers, json=body)

print(response.text)
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://api.microbooks.io/books/v1/reports/balance-sheet',
    'headers': {'Authorization': 'Bearer <bearer_token>'},
    'body': '{}'
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
$client = new Client();
$body = '{}';
$request = new Request('GET', 'https://api.microbooks.io/books/v1/reports/balance-sheet', 
    [headers' => ['Authorization' => 'Bearer <bearer_token>']], 
    $body
);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
var client = new RestClient("https://api.microbooks.io/books/v1/reports/balance-sheet");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
var body = null;
request.AddParameter("text/plain", body,  ParameterType.RequestBody);
request.AddHeader("Authorization", "Bearer " + <bearer_token>);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Response #

{
    "status": "success",
    "balance_Sheet": {
        "reportingPeriod": {
            "uuid": "cc3f7e6c-b5b8-497d-95e7-0d415cd8ca0f",
            "id": 1,
            "entity_id": 1,
            "period_count": 7,
            "status": "OPEN",
            "calendar_year": 2022,
            "closing_date": null
        },
        "balances": {
            "debit": 100,
            "credit": 100,
            "ASSETS": {
                "INVENTORY": 100
            },
            "LIABILITIES": {
                "CURRENT_LIABILITY": -100
            }
        },
        "accounts": {
            "ASSETS": {
                "INVENTORY": {
                    "Inventory": {
                        "accounts": [
                            {
                                "uuid": "e34774c8-2fd9-4114-add4-75e4a60eab3c",
                                "id": 1,
                                "entity_id": 1,
                                "category_id": null,
                                "currency_id": 1,
                                "code": 9,
                                "name": "Isabell Bernhard V",
                                "description": null,
                                "account_type": "Inventory",
                                "opening_balance": 100,
                                "balance_movement": 0,
                                "closing_balance": 100
                            }
                        ],
                        "total": 100,
                        "category_id": "default"
                    }
                }
            },
            "LIABILITIES": {
                "CURRENT_LIABILITY": {
                    "Current Liability": {
                        "accounts": [
                            {
                                "uuid": "106a1f62-7429-4437-802d-7544dac06993",
                                "id": 3,
                                "entity_id": 1,
                                "category_id": null,
                                "currency_id": 1,
                                "code": 9,
                                "name": "Letitia Gottlieb",
                                "description": null,
                                "account_type": "Current Liability",
                                "opening_balance": -100,
                                "balance_movement": 0,
                                "closing_balance": -100
                            }
                        ],
                        "total": -100,
                        "category_id": "default"
                    }
                }
            }
        },
        "totals": {
            "ASSETS": 100,
            "LIABILITIES": -100
        },
        "results": {
            "NET_ASSETS": 0,
            "TOTAL_EQUITY": 0
        },
        "period": {
            "endDate": "2022-01-01T00:00:00.000000Z",
            "startDate": "2022-01-01T00:00:00.000000Z"
        }
    }
}

Variations #

Html Version #

The Balance Sheet can be retrieved in HTML format by calling the endpoint with the format parameter set to html.

curl --location --request GET 'api.microbooks.io/books/v1/reports/balance-sheet?format=html'
import requests

url = "https://api.microbooks.io/books/v1/reports/balance-sheet?format=html"
body = {}
headers = {"Authorization": "Bearer <bearer_token>"}

response = requests.request("GET", url, headers=headers, json=body)

print(response.text)
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://api.microbooks.io/books/v1/reports/balance-sheet?format=html',
    'headers': {'Authorization': 'Bearer <bearer_token>'},
    'body': '{}'
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
$client = new Client();
$body = '{}';
$request = new Request('GET', 'https://api.microbooks.io/books/v1/reports/balance-sheet?format=html', 
    [headers' => ['Authorization' => 'Bearer <bearer_token>']], 
    $body
);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
var client = new RestClient("https://api.microbooks.io/books/v1/reports/balance-sheet?format=html");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
var body = null;
request.AddParameter("text/plain", body,  ParameterType.RequestBody);
request.AddHeader("Authorization", "Bearer " + <bearer_token>);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

PDF Version #

The Balance Sheet can be retrieved in pdf format by calling the endpoint with the format parameter set to pdf.

curl --location --request GET 'api.microbooks.io/books/v1/reports/balance-sheet?format=pdf'
import requests

url = "https://api.microbooks.io/books/v1/reports/balance-sheet?format=pdf"
body = {}
headers = {"Authorization": "Bearer <bearer_token>"}

response = requests.request("GET", url, headers=headers, json=body)

print(response.text)
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://api.microbooks.io/books/v1/reports/balance-sheet?format=pdf',
    'headers': {'Authorization': 'Bearer <bearer_token>'},
    'body': '{}'
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
$client = new Client();
$body = '{}';
$request = new Request('GET', 'https://api.microbooks.io/books/v1/reports/balance-sheet?format=pdf', 
    [headers' => ['Authorization' => 'Bearer <bearer_token>']], 
    $body
);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
var client = new RestClient("https://api.microbooks.io/books/v1/reports/balance-sheet?format=pdf");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
var body = null;
request.AddParameter("text/plain", body,  ParameterType.RequestBody);
request.AddHeader("Authorization", "Bearer " + <bearer_token>);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Cashflow Statement #

The Cashflow Statement connects the Income Statement and Balance sheet by translating the Net Profit/Loss result of the former into the movements of balances in the Accounts in the latter, with particular emphasis on the movement of the liquid (Cash) Accounts. If Transactions have been prepared properly the END_CASH_BALANCE and CASHBOOK_BALANCE values should be equal.

Request #

curl --location --request GET 'api.microbooks.io/books/v1/reports/cash-flow'
import requests

url = "https://api.microbooks.io/books/v1/reports/cash-flow"
body = {}
headers = {"Authorization": "Bearer <bearer_token>"}

response = requests.request("GET", url, headers=headers, json=body)

print(response.text)
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://api.microbooks.io/books/v1/reports/cash-flow',
    'headers': {'Authorization': 'Bearer <bearer_token>'},
    'body': '{}'
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
$client = new Client();
$body = '{}';
$request = new Request('GET', 'https://api.microbooks.io/books/v1/reports/cash-flow', 
    [headers' => ['Authorization' => 'Bearer <bearer_token>']], 
    $body
);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
var client = new RestClient("https://api.microbooks.io/books/v1/reports/cash-flow");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
var body = null;
request.AddParameter("text/plain", body,  ParameterType.RequestBody);
request.AddHeader("Authorization", "Bearer " + <bearer_token>);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Response #

{
    "status": "success",
    "cashflow_statement": {
        "reportingPeriod": {
            "uuid": "ec9f90aa-869e-4ac2-aff6-b8d99af5caee",
            "id": 1,
            "entity_id": 1,
            "period_count": 6,
            "status": "OPEN",
            "calendar_year": 2022,
            "closing_date": null
        },
        "balances": {
            "PROVISIONS": 50,
            "RECEIVABLES": -530,
            "PAYABLES": 298,
            "TAXATION": 112,
            "CURRENT_ASSETS": -100,
            "CURRENT_LIABILITIES": 100,
            "NON_CURRENT_ASSETS": -150,
            "NON_CURRENT_LIABILITIES": 100,
            "EQUITY": 100,
            "PROFIT": 700,
            "NET_CASH_FLOW": 680,
            "START_CASH_BALANCE": 100
        },
        "results": {
            "OPERATIONS_CASH_FLOW": 630,
            "INVESTMENT_CASH_FLOW": -150,
            "FINANCING_CASH_FLOW": 200,
            "CASHBOOK_BALANCE": 780,
            "END_CASH_BALANCE": 780
        },
        "period": {
            "startDate": "2022-01-01T00:00:00.000000Z",
            "endDate": "2022-10-25T20:22:31.000000Z"
        }
    }
}

Variations #

Html Version #

The Cashflow Statement can be retrieved in HTML format by calling the endpoint with the format parameter set to html.

curl --location --request GET 'api.microbooks.io/books/v1/reports/cash-flow?format=html'
import requests

url = "https://api.microbooks.io/books/v1/reports/cash-flow?format=html"
body = {}
headers = {"Authorization": "Bearer <bearer_token>"}

response = requests.request("GET", url, headers=headers, json=body)

print(response.text)
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://api.microbooks.io/books/v1/reports/cash-flow?format=html',
    'headers': {'Authorization': 'Bearer <bearer_token>'},
    'body': '{}'
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
$client = new Client();
$body = '{}';
$request = new Request('GET', 'https://api.microbooks.io/books/v1/reports/cash-flow?format=html', 
    [headers' => ['Authorization' => 'Bearer <bearer_token>']], 
    $body
);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
var client = new RestClient("https://api.microbooks.io/books/v1/reports/cash-flow?format=html");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
var body = null;
request.AddParameter("text/plain", body,  ParameterType.RequestBody);
request.AddHeader("Authorization", "Bearer " + <bearer_token>);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

PDF Version #

The Cashflow Statement can be retrieved in pdf format by calling the endpoint with the format parameter set to pdf.

curl --location --request GET 'api.microbooks.io/books/v1/reports/cash-flow?format=pdf'
import requests

url = "https://api.microbooks.io/books/v1/reports/cash-flow?format=pdf"
body = {}
headers = {"Authorization": "Bearer <bearer_token>"}

response = requests.request("GET", url, headers=headers, json=body)

print(response.text)
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://api.microbooks.io/books/v1/reports/cash-flow?format=pdf',
    'headers': {'Authorization': 'Bearer <bearer_token>'},
    'body': '{}'
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
$client = new Client();
$body = '{}';
$request = new Request('GET', 'https://api.microbooks.io/books/v1/reports/cash-flow?format=pdf', 
    [headers' => ['Authorization' => 'Bearer <bearer_token>']], 
    $body
);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
var client = new RestClient("https://api.microbooks.io/books/v1/reports/cash-flow?format=pdf");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
var body = null;
request.AddParameter("text/plain", body,  ParameterType.RequestBody);
request.AddHeader("Authorization", "Bearer " + <bearer_token>);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Trial Balance #

The Trial Balance compares the closing balances of all the Accounts of the Entity, grouping them between Income Statement and the Balance Sheet types. If the transactions have been recorded appropriately, the total Debit and Credit balances should be equal.

Request #

curl --location --request GET 'api.microbooks.io/books/v1/reports/trial-balance'
import requests

url = "https://api.microbooks.io/books/v1/reports/trial-balance"
body = {}
headers = {"Authorization": "Bearer <bearer_token>"}

response = requests.request("GET", url, headers=headers, json=body)

print(response.text)
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://api.microbooks.io/books/v1/reports/trial-balance',
    'headers': {'Authorization': 'Bearer <bearer_token>'},
    'body': '{}'
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
$client = new Client();
$body = '{}';
$request = new Request('GET', 'https://api.microbooks.io/books/v1/reports/trial-balance', 
    [headers' => ['Authorization' => 'Bearer <bearer_token>']], 
    $body
);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
var client = new RestClient("https://api.microbooks.io/books/v1/reports/trial-balance");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
var body = null;
request.AddParameter("text/plain", body,  ParameterType.RequestBody);
request.AddHeader("Authorization", "Bearer " + <bearer_token>);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Response #

{
    "status": "success",
    "trial_balance": {
        "reportingPeriod": {
            "uuid": "489e0a03-da26-4765-8038-82ae76eebd3b",
            "id": 1,
            "entity_id": 1,
            "period_count": 9,
            "status": "OPEN",
            "calendar_year": 2022,
            "closing_date": null
        },
        "balances": {
            "debit": 2100,
            "credit": 2100
        },
        "accounts": {
            "INCOME_STATEMENT": {
                "OPERATING_REVENUE": {
                    "accounts": [
                        {
                            "uuid": "c92bf1ef-67f7-43d2-a29b-7e914d2fd5f0",
                            "id": 26,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 0,
                            "name": "Dr. Julius Lesch",
                            "description": null,
                            "account_type": "OPERATING_REVENUE",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:25:59",
                            "updated_at": "2022-10-24 20:25:59",
                            "closing_balance": {
                                "1": -100
                            }
                        },
                        {
                            "uuid": "fbb7012a-20f0-44cb-b38b-c86c5dd9d8f5",
                            "id": 53,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 7,
                            "name": "Austin Kihn PhD",
                            "description": null,
                            "account_type": "OPERATING_REVENUE",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:26:00",
                            "updated_at": "2022-10-24 20:26:00",
                            "closing_balance": {
                                "1": -100
                            }
                        }
                    ],
                    "balance": -200
                },
                "NON_OPERATING_REVENUE": {
                    "accounts": [
                        {
                            "uuid": "4ee0b108-d2a6-45d3-92c6-fcd95ad6d898",
                            "id": 52,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 1,
                            "name": "Loma Funk",
                            "description": null,
                            "account_type": "NON_OPERATING_REVENUE",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:26:00",
                            "updated_at": "2022-10-24 20:26:00",
                            "closing_balance": {
                                "1": 100
                            }
                        },
                        {
                            "uuid": "6b146251-112b-48c6-9606-77af93bdf800",
                            "id": 60,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 7,
                            "name": "Prof. Arden Balistreri",
                            "description": null,
                            "account_type": "NON_OPERATING_REVENUE",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:26:00",
                            "updated_at": "2022-10-24 20:26:00",
                            "closing_balance": {
                                "1": -100
                            }
                        }
                    ],
                    "balance": 0
                },
                "OPERATING_EXPENSE": {
                    "accounts": [
                        {
                            "uuid": "f2dfedf6-0870-4541-b09c-b2a02da2a1ac",
                            "id": 56,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 5,
                            "name": "Shaylee Glover",
                            "description": null,
                            "account_type": "OPERATING_EXPENSE",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:26:00",
                            "updated_at": "2022-10-24 20:26:00",
                            "closing_balance": {
                                "1": 100
                            }
                        }
                    ],
                    "balance": 100
                },
                "DIRECT_EXPENSE": {
                    "accounts": [
                        {
                            "uuid": "54e1728b-61bb-4061-b3fe-86b21b0f17c2",
                            "id": 63,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 3,
                            "name": "Jacey Medhurst",
                            "description": null,
                            "account_type": "DIRECT_EXPENSE",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:26:00",
                            "updated_at": "2022-10-24 20:26:00",
                            "closing_balance": {
                                "1": 100
                            }
                        }
                    ],
                    "balance": 100
                },
                "OVERHEAD_EXPENSE": {
                    "accounts": [
                        {
                            "uuid": "254ce028-a17a-4bc6-83c0-d8e21e43c888",
                            "id": 66,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 1,
                            "name": "Otha Rosenbaum I",
                            "description": null,
                            "account_type": "OVERHEAD_EXPENSE",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:26:00",
                            "updated_at": "2022-10-24 20:26:00",
                            "closing_balance": {
                                "1": 100
                            }
                        }
                    ],
                    "balance": 100
                },
                "OTHER_EXPENSE": {
                    "accounts": [
                        {
                            "uuid": "6b8b87be-7ea5-4afe-90b3-6e335f56e303",
                            "id": 70,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 5,
                            "name": "Donald Lemke",
                            "description": null,
                            "account_type": "OTHER_EXPENSE",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:26:00",
                            "updated_at": "2022-10-24 20:26:00",
                            "closing_balance": {
                                "1": 100
                            }
                        }
                    ],
                    "balance": 100
                }
            },
            "BALANCE_SHEET": {
                "NON_CURRENT_ASSET": {
                    "accounts": [
                        {
                            "uuid": "11be990e-a29e-414b-9f4f-8ca8d0e454d8",
                            "id": 1,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 8,
                            "name": "Prof. Noah Ferry II",
                            "description": null,
                            "account_type": "NON_CURRENT_ASSET",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:25:59",
                            "updated_at": "2022-10-24 20:25:59",
                            "closing_balance": {
                                "1": 300
                            }
                        }
                    ],
                    "balance": 300
                },
                "PAYABLE": {
                    "accounts": [
                        {
                            "uuid": "9cf670df-e14f-47d2-9314-252cb6ef00f0",
                            "id": 3,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 5,
                            "name": "Diego D'Amore",
                            "description": null,
                            "account_type": "PAYABLE",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:25:59",
                            "updated_at": "2022-10-24 20:25:59",
                            "closing_balance": {
                                "1": -100
                            }
                        },
                        {
                            "uuid": "cda170dc-89b4-41bd-be66-f1a9ba95bffb",
                            "id": 23,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 8,
                            "name": "Mr. Michel Yundt",
                            "description": null,
                            "account_type": "PAYABLE",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:25:59",
                            "updated_at": "2022-10-24 20:25:59",
                            "closing_balance": {
                                "1": 100
                            }
                        },
                        {
                            "uuid": "4b0a6b0e-bb8b-4d18-9064-25206085880c",
                            "id": 41,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 6,
                            "name": "Lazaro Schumm DDS",
                            "description": null,
                            "account_type": "PAYABLE",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:26:00",
                            "updated_at": "2022-10-24 20:26:00",
                            "closing_balance": {
                                "1": -400
                            }
                        }
                    ],
                    "balance": -400
                },
                "CURRENT_ASSET": {
                    "accounts": [
                        {
                            "uuid": "5fbdc948-7800-48b1-8949-370a52ae6b75",
                            "id": 9,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 7,
                            "name": "Amaya Kautzer",
                            "description": null,
                            "account_type": "CURRENT_ASSET",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:25:59",
                            "updated_at": "2022-10-24 20:25:59",
                            "closing_balance": {
                                "1": 100
                            }
                        }
                    ],
                    "balance": 100
                },
                "INVENTORY": {
                    "accounts": [
                        {
                            "uuid": "9c11e2d8-9f38-42c3-a816-d2e056ab366f",
                            "id": 10,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 2,
                            "name": "Baylee Wolf",
                            "description": null,
                            "account_type": "INVENTORY",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:25:59",
                            "updated_at": "2022-10-24 20:25:59",
                            "closing_balance": {
                                "1": 200
                            }
                        },
                        {
                            "uuid": "c9696ad1-b6e4-4fa9-891a-c58ab5baca77",
                            "id": 36,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 4,
                            "name": "Reyes Hand",
                            "description": null,
                            "account_type": "INVENTORY",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:25:59",
                            "updated_at": "2022-10-24 20:25:59",
                            "closing_balance": {
                                "1": 100
                            }
                        }
                    ],
                    "balance": 300
                },
                "BANK": {
                    "accounts": [
                        {
                            "uuid": "b2abcf20-48d0-489e-8b82-8bbc3227d5ca",
                            "id": 12,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 15,
                            "code": 2,
                            "name": "Lowell Brakus",
                            "description": null,
                            "account_type": "BANK",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:25:59",
                            "updated_at": "2022-10-24 20:25:59",
                            "closing_balance": {
                                "1": -100
                            }
                        },
                        {
                            "uuid": "9431276a-76fc-47ea-87fd-82e490d3f366",
                            "id": 17,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 15,
                            "code": 1,
                            "name": "Torrey Wyman",
                            "description": null,
                            "account_type": "BANK",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:25:59",
                            "updated_at": "2022-10-24 20:25:59",
                            "closing_balance": {
                                "1": 100
                            }
                        },
                        {
                            "uuid": "d4c2dca1-31e1-44be-ba80-4c4529d4cf1e",
                            "id": 57,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 65,
                            "code": 4,
                            "name": "Eliezer Vandervort",
                            "description": null,
                            "account_type": "BANK",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:26:00",
                            "updated_at": "2022-10-24 20:26:00",
                            "closing_balance": {
                                "1": -100
                            }
                        },
                        {
                            "uuid": "e05d8d39-a3d3-4fab-b6ac-cea77e6d1c6c",
                            "id": 67,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 65,
                            "code": 3,
                            "name": "Prof. Philip Jones",
                            "description": null,
                            "account_type": "BANK",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:26:00",
                            "updated_at": "2022-10-24 20:26:00",
                            "closing_balance": {
                                "1": -100
                            }
                        }
                    ],
                    "balance": -200
                },
                "RECEIVABLE": {
                    "accounts": [
                        {
                            "uuid": "e5272438-38f9-4a55-887b-733c9ce766b2",
                            "id": 24,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 2,
                            "name": "Cheyenne Collier",
                            "description": null,
                            "account_type": "RECEIVABLE",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:25:59",
                            "updated_at": "2022-10-24 20:25:59",
                            "closing_balance": {
                                "1": 300
                            }
                        },
                        {
                            "uuid": "ed971d0c-fc12-41d1-9c4e-a7d07f2cef6d",
                            "id": 62,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 3,
                            "name": "Greyson Huels",
                            "description": null,
                            "account_type": "RECEIVABLE",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:26:00",
                            "updated_at": "2022-10-24 20:26:00",
                            "closing_balance": {
                                "1": 100
                            }
                        }
                    ],
                    "balance": 400
                },
                "NON_CURRENT_LIABILITY": {
                    "accounts": [
                        {
                            "uuid": "97a98308-afd9-4e52-9f02-264da074eb5c",
                            "id": 29,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 0,
                            "name": "Alana Beatty",
                            "description": null,
                            "account_type": "NON_CURRENT_LIABILITY",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:25:59",
                            "updated_at": "2022-10-24 20:25:59",
                            "closing_balance": {
                                "1": -200
                            }
                        }
                    ],
                    "balance": -200
                },
                "EQUITY": {
                    "accounts": [
                        {
                            "uuid": "0a6ad9f5-d080-4b18-8da5-537835af1d6b",
                            "id": 32,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 6,
                            "name": "Billy Frami",
                            "description": null,
                            "account_type": "EQUITY",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:25:59",
                            "updated_at": "2022-10-24 20:25:59",
                            "closing_balance": {
                                "1": 100
                            }
                        },
                        {
                            "uuid": "13975445-b7f3-453c-8d93-794f976c92ef",
                            "id": 49,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 0,
                            "name": "Karli Rempel IV",
                            "description": null,
                            "account_type": "EQUITY",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:26:00",
                            "updated_at": "2022-10-24 20:26:00",
                            "closing_balance": {
                                "1": -200
                            }
                        }
                    ],
                    "balance": -100
                },
                "CONTROL": {
                    "accounts": [
                        {
                            "uuid": "37aa879a-8065-4bcc-903e-89663d27e905",
                            "id": 33,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 4,
                            "name": "Mr. Brandon Schimmel",
                            "description": null,
                            "account_type": "CONTROL",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:25:59",
                            "updated_at": "2022-10-24 20:25:59",
                            "closing_balance": {
                                "1": -200
                            }
                        }
                    ],
                    "balance": -200
                },
                "CURRENT_LIABILITY": {
                    "accounts": [
                        {
                            "uuid": "2a503773-b138-4c4e-be60-107cd633c8b9",
                            "id": 37,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 8,
                            "name": "Reinhold Eichmann DVM",
                            "description": null,
                            "account_type": "CURRENT_LIABILITY",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:25:59",
                            "updated_at": "2022-10-24 20:25:59",
                            "closing_balance": {
                                "1": -200
                            }
                        },
                        {
                            "uuid": "140edb8d-d9d0-424a-98d0-d2255dde9c68",
                            "id": 40,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 5,
                            "name": "Lexus Koss",
                            "description": null,
                            "account_type": "CURRENT_LIABILITY",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:25:59",
                            "updated_at": "2022-10-24 20:25:59",
                            "closing_balance": {
                                "1": 100
                            }
                        }
                    ],
                    "balance": -100
                },
                "RECONCILIATION": {
                    "accounts": [
                        {
                            "uuid": "cee26c97-36e7-4a8a-8ab8-f59dfa07c2c6",
                            "id": 45,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 8,
                            "name": "Lyla Abshire",
                            "description": null,
                            "account_type": "RECONCILIATION",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:26:00",
                            "updated_at": "2022-10-24 20:26:00",
                            "closing_balance": {
                                "1": -200
                            }
                        }
                    ],
                    "balance": -200
                },
                "CONTRA_ASSET": {
                    "accounts": [
                        {
                            "uuid": "b2b05c29-3fcc-480a-9593-4e38d5f1d8c3",
                            "id": 48,
                            "entity_id": 1,
                            "category_id": null,
                            "currency_id": 1,
                            "code": 9,
                            "name": "Humberto McKenzie",
                            "description": null,
                            "account_type": "CONTRA_ASSET",
                            "destroyed_at": null,
                            "deleted_at": null,
                            "created_at": "2022-10-24 20:26:00",
                            "updated_at": "2022-10-24 20:26:00",
                            "closing_balance": {
                                "1": 100
                            }
                        }
                    ],
                    "balance": 100
                }
            }
        },
        "results": {
            "INCOME_STATEMENT": {
                "debit": 500,
                "credit": 300
            },
            "BALANCE_SHEET": {
                "debit": 1600,
                "credit": 1800
            }
        },
        "endDate": "2022-12-31T00:00:00.000000Z"
    }
}

Variations #

Html Version #

The Trial Balance can be retrieved in HTML format by calling the endpoint with the format parameter set to html.

curl --location --request GET 'api.microbooks.io/books/v1/reports/trial-balance?format=html'
import requests

url = "https://api.microbooks.io/books/v1/reports/trial-balance?format=html"
body = {}
headers = {"Authorization": "Bearer <bearer_token>"}

response = requests.request("GET", url, headers=headers, json=body)

print(response.text)
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://api.microbooks.io/books/v1/reports/trial-balance?format=html',
    'headers': {'Authorization': 'Bearer <bearer_token>'},
    'body': '{}'
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
$client = new Client();
$body = '{}';
$request = new Request('GET', 'https://api.microbooks.io/books/v1/reports/trial-balance?format=html', 
    [headers' => ['Authorization' => 'Bearer <bearer_token>']], 
    $body
);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
var client = new RestClient("https://api.microbooks.io/books/v1/reports/trial-balance?format=html");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
var body = null;
request.AddParameter("text/plain", body,  ParameterType.RequestBody);
request.AddHeader("Authorization", "Bearer " + <bearer_token>);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

PDF Version #

The Cashflow Statement can be retrieved in pdf format by calling the endpoint with the format parameter set to pdf.

curl --location --request GET 'api.microbooks.io/books/v1/reports/trial-balancew?format=pdf'
import requests

url = "https://api.microbooks.io/books/v1/reports/trial-balance?format=pdf"
body = {}
headers = {"Authorization": "Bearer <bearer_token>"}

response = requests.request("GET", url, headers=headers, json=body)

print(response.text)
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://api.microbooks.io/books/v1/reports/trial-balance?format=pdf',
    'headers': {'Authorization': 'Bearer <bearer_token>'},
    'body': '{}'
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
$client = new Client();
$body = '{}';
$request = new Request('GET', 'https://api.microbooks.io/books/v1/reports/trial-balance?format=pdf', 
    [headers' => ['Authorization' => 'Bearer <bearer_token>']], 
    $body
);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
var client = new RestClient("https://api.microbooks.io/books/v1/reports/trial-balance?format=pdf");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
var body = null;
request.AddParameter("text/plain", body,  ParameterType.RequestBody);
request.AddHeader("Authorization", "Bearer " + <bearer_token>);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Errors #

Below are the Errors that are returned by the Report Resources.

Detail CodeNameDefinition
101Missing EntityFinancial Statements are scoped to an Entity and thus must have one provided