Skip to main content
GET
List tax documents
This is where you follow a document you issued: it appears with the status WAITINGFORAUTHORIZATION and moves on its own to AUTHORIZED or DENIED. Each item carries the externalId you sent when you issued it, so you can match it to your own record. Amounts are in reais. Every filter is optional, and the filters you send combine: a document must match all of them. Send status and type as a comma-separated list (status=AUTHORIZED,DENIED) or by repeating the parameter. customerName matches any part of the customer’s name, ignoring case, while customerDocument must match the whole CPF or CNPJ as it was written at issuance (your value is also tried without punctuation). Without environment, real (LIVE) and homologation (TEST) documents are listed together. Dates compare full timestamps in UTC, so a date without a time (2026-10-31) means 00:00 UTC. To include the whole last day of a range, send the end bound as 2026-10-31T23:59:59.999Z. Results are paginated, newest first, 50 per page unless you send limit (1 to 100). See Pagination.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization whose tax documents you want to list.

Format: UUID

Query Parameters

status
enum<string>[]

Only documents in one of these statuses. Send several as a comma-separated list or by repeating the parameter. Matched case-insensitively.


Example (comma-separated list): ?status=AUTHORIZED,DENIED

Available options:
WAITINGFORAUTHORIZATION,
REQUESTINGAUTHORIZATION,
AUTHORIZATIONREQUESTED,
AUTHORIZATIONPROCESS,
AWAITINGFILEGENERATION,
AUTHORIZED,
DENIED,
REQUESTINGCANCELLATION,
CANCELLATIONREQUESTED,
CANCELLATIONPROCESS,
AWAITINGFILECANCELATION,
CANCELED,
CANCELLATIONDENIED
type
enum<string>[]

Only documents of one of these types. Send several as a comma-separated list or by repeating the parameter. Matched case-insensitively.


Example: ?type=NFSE

Available options:
NFSE
environment
enum<string>

LIVE for real documents, TEST for homologation documents (no fiscal value). Omit to list both.

Available options:
LIVE,
TEST
issuedAtStart
string<date-time>

Only documents issued on or after this moment. A date without a time (2026-10-01) means 00:00 UTC.

issuedAtEnd
string<date-time>

Only documents issued on or before this moment. Must not be before issuedAtStart. To include a whole day, send T23:59:59.999Z of that day.

competenceDateStart
string<date-time>

Only documents whose competence date is on or after this moment. A date without a time means 00:00 UTC.

competenceDateEnd
string<date-time>

Only documents whose competence date is on or before this moment. Must not be before competenceDateStart. To include a whole day, send T23:59:59.999Z of that day.

rpsNumberStart
number

Only documents whose RPS number is greater than or equal to this one.

rpsNumberEnd
number

Only documents whose RPS number is less than or equal to this one. Must not be less than rpsNumberStart.

customerName
string

Only documents whose customer name contains this text (case-insensitive).

Maximum string length: 200
customerDocument
string

Only documents of the customer with this CPF or CNPJ. An exact match, not a partial one, against the document as it was written when the tax document was issued: your value is tried as you send it and also with its punctuation removed.

Maximum string length: 20
next
string

Cursor returned as next by the previous page. Omit for the first page; a value you did not get from the API is rejected.

limit
integer
default:50

Page size.

Required range: 1 <= x <= 100

Response

Successful response

A page of tax documents, newest first.

items
object[]
required

The tax documents of this page, newest first.

next
string | null
required

Cursor of the next page: send it as next to get the following page. null when this is the last page.

Example:

"68a7c1f2a3b4c5d6e7f80912"