Notas Fiscais

Verificar Dados para Emissão

Confere se uma cobrança tem tudo o que a nota fiscal exige, sem emitir nada. O identificador na URL é o da cobrança, como em POST /v1/invoices/notas/{notaId}/emitir.

ready diz se a emissão passaria agora; pendencias lista em português o que falta — CPF ou CNPJ, nome, valor, endereço, CEP, município (código IBGE), logradouro ou bairro do cliente.

configId traz a configuração fiscal que seria usada, ou null quando nenhuma foi encontrada. Diferente da emissão, aqui a ausência de configuração não é erro.

A conferência é uma rota própria em vez de um parâmetro na rota de emissão: um flag ignorado por engano emitiria a nota de verdade.

Case de uso:

Como plataforma, quero avisar o usuário sobre o cadastro incompleto do cliente antes de tentar emitir a nota e receber a recusa.

POST/v1/invoices/notas/:notaid/verificar-emissao

Base URL Produção:https://api.validapay.com.br

Base URL Sandbox:https://sandbox.validapay.com.br

Authorizations

bearer

Authorization

string · header · required

Cabeçalho de autenticação Bearer no formato Bearer {{token}} onde {{token}} é o seu token OAuth2.

Escopos requeridos

nota.fiscal/write

Path Parameters

Name	Type	Required	Description
notaid	string	Required	Notaid

Body

application/json

Content-Type:application/json

{
  "configId": "unc_1776888897617_ppwgo7oef"
}

Schema

configIdstringOptional

Configuração fiscal a conferir; sem ela vale a da cobrança ou da assinatura

← Anterior

Emitir Nota de uma Cobrança

Cancelar Nota Fiscal

const url = 'https://sandbox.validapay.com.br/v1/invoices/notas/{{notaId}}/verificar-emissao';

const options = {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {{token}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "configId": "unc_1776888897617_ppwgo7oef"
})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response Examples

200200 - pronta para emitir

{
  "invoiceId": "inv_1788101026585_uqaspo7bn",
  "ready": true,
  "pendencias": [],
  "configId": "unc_1788193720141_65g0zh12p",
  "amount": 150.00
}

200200 - com pendências

{
  "invoiceId": "inv_1788101026585_uqaspo7bn",
  "ready": false,
  "pendencias": [
    "CEP do cliente",
    "Município do cliente (código IBGE)"
  ],
  "configId": "unc_1788193720141_65g0zh12p",
  "amount": 150.00
}

← Anterior

Emitir Nota de uma Cobrança

Cancelar Nota Fiscal