Retrieve the tax results of your companies, period by period, via the Brinta Tax Entries API.
A tax entry is one line of a tax assessment: an amount payable, a credit balance carried forward, an adjustment, a payment, a withholding. Brinta uses them to fill in the tax filings that depend on them, and writes its own when it generates a filing.
Typical uses:
- Opening balances. You join Brinta in the middle of the year and your previous filings were made outside the platform. Send the credit balances still available so the next filing carries them forward.
- Adjustments and payments from your ERP. Your tax team books adjustments, deductions or payments in your own system. Send them instead of uploading a file every period.
- Reading the results. Retrieve what a period's filings produced (payable, credits, balances) to reconcile them with your ledger.
Endpoints
| Method | Path | Use |
|---|---|---|
GET | /tax-entries/ | List tax entries |
The values accepted in tax_type, entry_type and location are listed in Tax Entry Codes.
In each specific filing's guide you will find what each entry represents in that filing.
Fields
What each field of a tax entry means. Key marks the fields of the composite key: together they decide whether an entry you send is new or replaces an existing one.
Conceptually, each entry answers a few questions about one figure of a tax assessment:
- Whose tax is it?
company_idorcompany_external_idis the taxpayer that files it.origin_company_external_idis used when the figure comes from another establishment, such as a branch, but is reported under this company. - Which tax, and where?
tax_typenames the tax andlocationthe jurisdiction that collects it. The same tax in two states is two entries. - What role does the figure play?
entry_typesays whether it is owed, deducted, carried forward, adjusted or paid. For an adjustment,adjustment_typesays which kind.entry_codeis the official code the filing uses for that line, such as an adjustment code or a credit type.tax_codeis the authority's code for the tax itself, for example the code used to pay it. - Which period does it belong to?
start_periodandend_periodare the assessment period the figure counts towards, not the day it was booked or paid.due_date_periodis when it has to be paid. - How much, and how was it reached?
amountis the figure.taxable_amountandtax_rateshow where it came from (base times rate), when that applies. - What backs it?
referenced_invoice_idandreferenced_invoice_keytie it to a specific document, such as an adjustment for one invoice.account_idandproduct_idtie it to an account or a financial instrument, for obligations reported at that level. - What else should a reader know?
descriptionis the label people see when they review the entry.metadataholds extra attributes a specific filing needs and that have no field of their own.
The table below is the reference for each field.
| Field | Required | Key | Meaning | Example |
|---|---|---|---|---|
company_id / company_external_id | One of them | Yes | Company the entry is filed for: its Brinta id or the id in your system. Sent once per request, not per entry. | CLI-98765 |
tax_type | Yes | Yes | Tax the entry belongs to. See Tax Entry Codes. | ICMS |
entry_type | Yes | Yes | What the amount represents: payable, credit balance, adjustment, payment... See Tax Entry Codes. | credit balance |
location | Yes | Yes | Jurisdiction the tax is assessed in, as an ISO code: country, state or municipality. | BR-SP |
amount | Yes | No | Amount of the entry in the local currency. | 48300.00 |
start_period | Yes | Yes | First day of the period the entry belongs to. | 2026-08-01 |
end_period | Yes | Yes | Last day of that period. | 2026-08-31 |
due_date_period | No | No | Date the tax is due. | 2026-09-20 |
taxable_amount | No | No | Taxable base the amount was calculated on. | 268333.33 |
tax_rate | No | No | Rate applied to the taxable base. | 18 |
tax_code | No | No | Tax code defined by the tax authority for this entry. | 046-2 |
entry_code | No | Yes | Code that identifies the entry inside the filing, such as an adjustment code or a credit type. | SP020799 |
adjustment_type | No | No | Kind of adjustment, for entries of an adjustment entry_type. | other credits |
description | No | Yes | Free text, saved up to 191 characters. Rewording it makes it a different entry. | Estorno de debito |
referenced_invoice_id | No | Yes | Brinta id of the invoice the entry refers to. | 97fdfda8-e4b0-402c-b1dd-871a565a24ee |
referenced_invoice_key | No | Yes | Fiscal key of that invoice, such as the NF-e access key. | 3526 0812 ... |
origin_company_external_id | No | Yes | Company the entry originates from, when it is not the one it is filed for (a branch, for example). | CLI-98765-02 |
account_id | No | No | Account the entry relates to, for obligations reported per account (DeRE). | 1.1.01.001 |
product_id | No | No | Product or financial instrument the entry relates to, for obligations reported per instrument (DeRE). | CDB-2026-001 |
metadata | No | No | Extra information as key-value pairs; values must be strings. | {"payment_reference": "GARE-2026-08-0012"} |
Brinta adds these fields when you list entries; you never send them:
| Field | Meaning |
|---|---|
id | Brinta id of this version of the entry. Use it to update the entry. |
active | true for the current version; false once it was replaced or deleted. |
editable | false for entries generated by a Brinta filing, which cannot be updated. |
Tax Entry Codes
Values accepted by the Tax Entries API. Send them exactly as written here: they are case sensitive and a value outside the list is rejected.
The concept behind each value varies from filing to filing. The meanings below are general; each filing's guide describes what an entry represents in that filing.
entry_type
entry_typeWhat the amount represents.
entry_type | Meaning |
|---|---|
payable | Tax due for the period. |
debit | Tax debits of the period (output tax). |
credit | Tax credits of the period (input tax). |
other debits | Debits outside the regular operations of the period. |
credit balance | Credit available at the end of the period, carried forward to the next. |
adjustment | Adjustment to the tax due. Use adjustment_type and entry_code to say which one. |
adjustment detail | Breakdown of an adjustment. |
credit adjustment | Adjustment to the credits of the period. |
taxable amount adjustment | Adjustment to the taxable base. |
contribution adjustment | Adjustment to a contribution (for example PIS/COFINS in Brazil). |
withholding | Tax withheld from a third party. |
withholding credit | Tax withheld from you, usable as a credit. |
payment | Payment of the tax. |
tax losses CF | Tax losses carried forward. |
informative | Informative amount that does not change the tax due. |
other | Anything not covered above. |
location
locationThe jurisdiction the entry belongs to, as an ISO code:
| Level | Format | Example |
|---|---|---|
| Country | ISO 3166-1 alpha-2 | BR, AR, MX, CO |
| State | ISO 3166-2 | BR-SP, AR-N |
| Municipality | ISO 3166-2 plus the city name | CO-ATL-Barranquilla |
Use the level the tax is assessed at: BR for PIS/COFINS, BR-SP for ICMS in São Paulo.
