BrizoConsol API Documentation
Everything a system needs to send its own data to BrizoConsol, and to read back what BrizoConsol holds.
This documentation states the API's contract: the paths, the bodies, the answers and the refusals a caller relies on. Each resource has one page carrying both directions - what a write accepts and what a read answers - so nothing about a resource lives in two places. Anything not built is named under “Not available” with nothing written about it — a page describing behaviour that cannot be called would be worse than no page.
Getting started
Create a credential
The screen, who may use it, and what the secret can do.
Get a token
Exchanging a credential for an access token, and renewing it.
Authentication
Tokens
Lifetimes, refresh, rotation, and every refusal.
Errors
The messages the API returns and what each one means.
Scopes
One per resource and action:
write to send, read to receive.
Limits
Endpoints
Vocabulary
Organisations
The companies behind the credential, and what you may read from each.
Account types
The system account types an account can carry.
Sections
The section tree statements are built from.
Tags
The accounting-standard tags an account can carry.
Currencies
The currency list and the group rate settings.
KPIs
The KPI names a company defines, and one KPI’s figures.
Periods and years
The months and years a company can report.
The data
Accounts
Send the accounts, and read back every code with its type and status.
Trial balance
Send a month of debit and credit, and read it back per account.
Statements
The profit and loss, the balance sheet and the cash flow for a month.
Invoices
Sales documents and their lines: sent, and read back.
Bills
Purchase documents and their lines: sent, and read back.
Journal lines
Ledger lines, journal by journal: sent, and read back.
Operational data
Headcount, volume, revenue per seat: sent, and read back by dataset.
Exchange rates
The rate a month used, and the rates it was built from.
Consolidation
CTA, NCI, journal vouchers, adjustments and intercompany pairs.
Request history
What was sent, what it wrote, and the records behind it.