Tax Entries Introduction

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

MethodPathUse
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_id or company_external_id is the taxpayer that files it. origin_company_external_id is used when the figure comes from another establishment, such as a branch, but is reported under this company.
  • Which tax, and where? tax_type names the tax and location the jurisdiction that collects it. The same tax in two states is two entries.
  • What role does the figure play? entry_type says whether it is owed, deducted, carried forward, adjusted or paid. For an adjustment, adjustment_type says which kind. entry_code is the official code the filing uses for that line, such as an adjustment code or a credit type. tax_code is the authority's code for the tax itself, for example the code used to pay it.
  • Which period does it belong to? start_period and end_period are the assessment period the figure counts towards, not the day it was booked or paid. due_date_period is when it has to be paid.
  • How much, and how was it reached? amount is the figure. taxable_amount and tax_rate show where it came from (base times rate), when that applies.
  • What backs it? referenced_invoice_id and referenced_invoice_key tie it to a specific document, such as an adjustment for one invoice. account_id and product_id tie it to an account or a financial instrument, for obligations reported at that level.
  • What else should a reader know? description is the label people see when they review the entry. metadata holds extra attributes a specific filing needs and that have no field of their own.

The table below is the reference for each field.

FieldRequiredKeyMeaningExample
company_id / company_external_idOne of themYesCompany the entry is filed for: its Brinta id or the id in your system. Sent once per request, not per entry.CLI-98765
tax_typeYesYesTax the entry belongs to. See Tax Entry Codes.ICMS
entry_typeYesYesWhat the amount represents: payable, credit balance, adjustment, payment... See Tax Entry Codes.credit balance
locationYesYesJurisdiction the tax is assessed in, as an ISO code: country, state or municipality.BR-SP
amountYesNoAmount of the entry in the local currency.48300.00
start_periodYesYesFirst day of the period the entry belongs to.2026-08-01
end_periodYesYesLast day of that period.2026-08-31
due_date_periodNoNoDate the tax is due.2026-09-20
taxable_amountNoNoTaxable base the amount was calculated on.268333.33
tax_rateNoNoRate applied to the taxable base.18
tax_codeNoNoTax code defined by the tax authority for this entry.046-2
entry_codeNoYesCode that identifies the entry inside the filing, such as an adjustment code or a credit type.SP020799
adjustment_typeNoNoKind of adjustment, for entries of an adjustment entry_type.other credits
descriptionNoYesFree text, saved up to 191 characters. Rewording it makes it a different entry.Estorno de debito
referenced_invoice_idNoYesBrinta id of the invoice the entry refers to.97fdfda8-e4b0-402c-b1dd-871a565a24ee
referenced_invoice_keyNoYesFiscal key of that invoice, such as the NF-e access key.3526 0812 ...
origin_company_external_idNoYesCompany the entry originates from, when it is not the one it is filed for (a branch, for example).CLI-98765-02
account_idNoNoAccount the entry relates to, for obligations reported per account (DeRE).1.1.01.001
product_idNoNoProduct or financial instrument the entry relates to, for obligations reported per instrument (DeRE).CDB-2026-001
metadataNoNoExtra 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:

FieldMeaning
idBrinta id of this version of the entry. Use it to update the entry.
activetrue for the current version; false once it was replaced or deleted.
editablefalse 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

What the amount represents.

entry_typeMeaning
payableTax due for the period.
debitTax debits of the period (output tax).
creditTax credits of the period (input tax).
other debitsDebits outside the regular operations of the period.
credit balanceCredit available at the end of the period, carried forward to the next.
adjustmentAdjustment to the tax due. Use adjustment_type and entry_code to say which one.
adjustment detailBreakdown of an adjustment.
credit adjustmentAdjustment to the credits of the period.
taxable amount adjustmentAdjustment to the taxable base.
contribution adjustmentAdjustment to a contribution (for example PIS/COFINS in Brazil).
withholdingTax withheld from a third party.
withholding creditTax withheld from you, usable as a credit.
paymentPayment of the tax.
tax losses CFTax losses carried forward.
informativeInformative amount that does not change the tax due.
otherAnything not covered above.

location

The jurisdiction the entry belongs to, as an ISO code:

LevelFormatExample
CountryISO 3166-1 alpha-2BR, AR, MX, CO
StateISO 3166-2BR-SP, AR-N
MunicipalityISO 3166-2 plus the city nameCO-ATL-Barranquilla

Use the level the tax is assessed at: BR for PIS/COFINS, BR-SP for ICMS in São Paulo.