Get Multiple Tax Entries

get

https://api.brinta.com/tax-entries/

Lists the tax entries of one company whose period falls inside the requested range, newest period first, with cursor pagination. If neither company field is sent, the company of the token is used.

Query Params

company_id

uuid

Id (UUID) of the company on BRINTA's system. If neither company field is sent, the company of the token is used. Do not send both.

company_external_id

string

Id of the company on the client's system. If neither company field is sent, the company of the token is used. Do not send both.

period_from

date

required

Start of the period range (YYYY-MM-DD). Entries whose start_period is on or after it.

period_to

date

required

End of the period range (YYYY-MM-DD). Entries whose end_period is on or before it.

tax_type

string

Only entries of this tax. See Tax Entry Codes.

entry_type

string

Only entries of this type. See Tax Entry Codes.

location

string

Only entries of this jurisdiction (ISO code, exact match: BR does not include BR-SP).

active

boolean

Defaults to true

true returns the current entries; false returns the ones that were replaced or deleted.

limit

integer

1 to 100

Defaults to 50

Page size. Default 50, maximum 100 (higher values are capped at 100).

cursor

string

Pagination cursor. Use page.next_cursor from the previous response.

Responses

400

Invalid request: a missing or invalid parameter, both company identifiers, or period_from not earlier than period_to.

401

Missing or invalid token.

404

The company does not exist or is not in your token's group.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK