Skip to main content
GET
Get the NFSe configuration
Only admins of the organization or of the realm can read it. An organization has at most one NFSe configuration; without one, no NFSe is issued automatically.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization the NFSe configuration belongs to.

Format: UUID

Response

Successful response

The organization's NFSe configuration.

event
enum<string>
required

Which billing event issues an NFSe: INVOICE_CLOSED (one per invoice, when it closes), INVOICE_PAID (one per invoice, when it is paid) or PAYMENT_RECEIVED (one per payment settled on an invoice).

Available options:
INVOICE_PAID,
INVOICE_CLOSED,
PAYMENT_RECEIVED
Example:

"INVOICE_PAID"

issWithheldAtSource
boolean
required

Whether the customer withholds the ISS at source.

Example:

false

environment
enum<string>
required

LIVE for real NFSe, TEST for homologation documents with no fiscal value.

Available options:
TEST,
LIVE
Example:

"LIVE"

createdAt
string<date-time>
required

When the configuration was created.

Example:

"2026-08-07T19:45:17.204Z"

competence
enum<string>

Which date becomes the competence date of each NFSe: EVENT_DATE, CREATED_AT, CLOSED_AT, DUE_AT, PAID_AT or EFFECTIVE_AT. Absent on a configuration created before this field existed: its NFSe take the day the invoice was last updated.

Available options:
EVENT_DATE,
CREATED_AT,
CLOSED_AT,
DUE_AT,
PAID_AT,
EFFECTIVE_AT
Example:

"PAID_AT"

observation
string

Free text printed on every NFSe. Absent on a configuration created before this field existed, which prints none.

Example:

"Serviços prestados conforme contrato."

operationNature
string

Nature of the operation, stored with every NFSe but not printed on it. Absent on a configuration created before this field existed, which stores Prestação de Serviços.

Example:

"Prestação de Serviços"