Skip to main content
POST
Aprova a NF manualmente (override da validação automática)

Authorizations

Authorization
string
header
required

Chave de API (prefixo rstr_) enviada como Authorization: Bearer rstr_....

Path Parameters

invoiceId
string
required
Pattern: ^inv_[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json
reason
string

Justificativa da aprovação manual (override da validação automática), registrada no histórico.

Required string length: 1 - 500
Example:

"Conferido manualmente contra o PDF"

Response

200 - application/json

Default Response

id
string
required

Identificador único da nota fiscal (prefixo inv_ + ULID).

Example:

"inv_01J9Z3K8N2QF4T7B9XP0WMD5RC"

organizationId
string
required

Organização (tenant) dona da nota fiscal.

Example:

"org_01J9Z3K8N2QF4T7B9XP0WMD5RC"

affiliateId
string
required

Afiliado a quem a nota fiscal se refere.

Example:

"aff_01J9Z3K8N2QF4T7B9XP0WMD5RC"

payoutId
string
required

Pagamento (payout) ao qual a nota fiscal está vinculada.

Example:

"pay_01J9Z3K8N2QF4T7B9XP0WMD5RC"

status
enum<string>
required

Status atual da nota fiscal.

Available options:
pending,
processing,
validated,
rejected,
canceled
Example:

"validated"

nfNumber
string | null
required

Número da nota fiscal extraído do arquivo. null até a extração concluir.

Example:

"12345"

nfSeries
string | null
required

Série da nota fiscal extraída do arquivo. null quando ausente.

Example:

"1"

issuerCnpj
string | null
required

CNPJ do emissor extraído do arquivo (normalizado a 14 dígitos). null até a extração concluir.

Example:

"11222333000181"

nfAmountCents
integer | null
required

Valor da NF extraído do arquivo, em centavos (ex.: 1990 = R$19,90). null até a extração concluir.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

25000

recipientName
string | null
required

Nome do tomador/destinatário extraído da NF. null até a extração concluir.

Example:

"Repass Tecnologia LTDA"

nfAccessKey
string | null
required

Chave de acesso da NF (44 dígitos na NF-e; formato próprio na NFS-e Nacional). null quando ausente do documento.

Example:

"35260611222333000181550010000001231123456782"

nfIssuedAt
string<date-time> | null
required

Data de emissão extraída da NF (ISO-8601). null quando ausente.

Example:

"2026-06-20T00:00:00.000Z"

extractionMethod
enum<string> | null
required

Como os dados foram extraídos do arquivo. null até a extração concluir.

Available options:
xml_nfe,
xml_nfse,
ai_pdf,
ai_xml
Example:

"xml_nfse"

extractionError
string | null
required

Código da falha fatal de extração (ex.: unreadable_file). null quando a extração leu o arquivo.

Example:

"unreadable_file"

fileKey
string | null
required

Referência interna do arquivo da NF armazenado. null enquanto não enviado.

Example:

"invoices/inv_01J9Z3K8N2QF4T7B9XP0WMD5RC.pdf"

fileContentType
string | null
required

Tipo MIME do arquivo da NF (PDF ou XML). null enquanto não enviado.

Example:

"application/pdf"

fileSizeBytes
integer | null
required

Tamanho do arquivo da NF em bytes. null enquanto não enviado.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

204800

validationErrors
string[] | null
required

Códigos/mensagens de erro encontrados na validação automática da NF. null quando não houve validação ou ela passou.

Example:
rejectionReason
string | null
required

Motivo da rejeição manual da NF. null quando não rejeitada.

Example:

"Valor da NF diverge do payout"

submittedAt
string<date-time> | null
required

Momento do envio da NF (ISO-8601). null enquanto não enviada.

Example:

"2026-06-13T12:00:00.000Z"

validatedAt
string<date-time> | null
required

Momento da validação da NF (ISO-8601). null quando não validada.

Example:

"2026-06-13T12:00:00.000Z"

rejectedAt
string<date-time> | null
required

Momento da rejeição da NF (ISO-8601). null quando não rejeitada.

Example:

"2026-06-13T12:00:00.000Z"

canceledAt
string<date-time> | null
required

Momento do cancelamento da NF (ISO-8601). null quando não cancelada.

Example:

"2026-06-13T12:00:00.000Z"

createdAt
string<date-time>
required

Data de criação do registro da NF (ISO-8601).

Example:

"2026-06-13T12:00:00.000Z"

updatedAt
string<date-time>
required

Data da última atualização do registro da NF (ISO-8601).

Example:

"2026-06-13T12:00:00.000Z"