NFS-e
Consultar NFS-e emitida por clave
Busca un documento emitido por la clave de acceso de 50 dígitos; la respuesta es idéntica a la consulta por `id`.
GET
/openapi/v2/empresas/{empresaId}/nfse/emitidas/{chaveAcesso}Requiere las cabeceras de firma
token, timestamp y sign, vea Autenticación.Para conciliación por clave: cuando tiene la clave de acceso (del XML, de la DANFSe o de una contraparte) pero no el id del integrador. La respuesta es exactamente la misma que Consultar NFS-e, que busca por id; solo no aparece el estado Falha, porque una tarea que falló antes de la numeración no tiene clave. Los documentos antiguos de São Paulo no tienen clave de 50 dígitos y no se encuentran aquí: concilie por id o identificacaoDps, o recorra la lista de emitidas.
Parámetros de ruta
empresaId* | string | Identificador de la empresa |
chaveAcesso* | string | Clave de acceso |
* Campo obligatorio
200
Documento encontrado. Los campos de hecho se van rellenando conforme avanza el estado; los escenarios por estado están en Consultar NFS-e.
id | string | Id del documento |
status | string | Estado del documento |
motivoStatus | string | Veredicto |
numero | int | Número de la NFS-e |
serie | string | Serie |
numeroDps | int | Número de la DPS |
chaveAcesso | string | Clave de acceso |
identificacaoDps | string | Identificador de la DPS |
codigoVerificacao | string | Código de verificación |
dataEmissao | string | Fecha de emisión |
dataAutorizacao | string | Fecha de autorización |
padraoMunicipal | string | Estándar municipal |
atualizadoEm | string | Último cambio de estado |
chaveSubstituida | string | Clave de la nota sustituida |
chaveSubstituta | string | Clave de la nota sustituta |
linkXml | string | Enlace del XML oficial |
linkDanfse | string | Enlace de la DANFSe |
| array | Eventos posteriores a la autorización |
nfse | object | Eco de la solicitud aceptada |
statusEstado del documento
| Valores | Significado |
|---|---|
| Pendente | Aceptado, todavía sin veredicto; cubre la cola, el envío y la conciliación |
| Autorizada | Emitida con éxito; puede cancelarse o sustituirse |
| Negada | Rechazada por la autoridad; motivoStatus trae el código y la descripción; terminal |
| EmProcessoDeCancelamento | Solicitud de análisis de cancelación aceptada, a la espera del municipio; concedida pasa a Cancelada, denegada vuelve a Autorizada |
| Cancelada | Cancelada; terminal |
| Substituida | Sustituida por otra nota; chaveSubstituta trae la nueva clave; terminal |
padraoMunicipalEstándar municipal
| Valores | Significado |
|---|---|
| Nacional | Estándar nacional: emisor nacional y distribución nacional |
| Paulistana | Sistema propio del municipio de São Paulo |
eventos[].tipoTipo del evento
La lista acompaña los eventos oficiales y puede crecer.
| Valores | Significado |
|---|---|
| Cancelamento | Cancelación registrada por el prestador (101101) |
| CancelamentoPorSubstituicao | Cancelada por haber sido sustituida por otra nota (105102) |
| PedidoAnalise | Solicitud de análisis fiscal de cancelación (101103) |
| AnaliseDeferida | El municipio concedió la cancelación (105104) |
| AnaliseIndeferida | El municipio denegó la cancelación (105105) |
| CancelamentoDeOficio | Cancelación de oficio por el municipio (305101) |
| Bloqueio | Bloqueo de oficio por el municipio (305102) |
| Desbloqueio | Desbloqueo de oficio por el municipio (305103) |
| Confirmacao | Una de las partes confirmó la nota, o confirmación tácita del municipio (202201 / 203202 / 204203 / 205204) |
| Rejeicao | Una de las partes rechazó la nota (202205 / 203206 / 204207) |
| RejeicaoAnulada | El municipio anuló un rechazo (205208) |
| Outro | Evento oficial aún no modelado; el código real está en status |
eventos[].codigoCódigo oficial del evento
| Valores | Significado |
|---|---|
| 101101 | Cancelación por el prestador |
| 105102 | Cancelación por sustitución |
| 101103 | Solicitud de análisis fiscal de cancelación |
| 105104 | Análisis concedida |
| 105105 | Análisis denegada |
| 305101 | Cancelación de oficio |
| 305102 | Bloqueo de oficio |
| 305103 | Desbloqueo de oficio |
| 202201 | Confirmación por el prestador |
| 203202 | Confirmación por el tomador |
| 204203 | Confirmación por el intermediario |
| 205204 | Confirmación tácita por el municipio |
| 202205 | Rechazo por el prestador |
| 203206 | Rechazo por el tomador |
| 204207 | Rechazo por el intermediario |
| 205208 | Rechazo anulado por el municipio |
| 000000 | Evento oficial aún no modelado; el código real está en status |
| Código | HTTP | |
|---|---|---|
| 10018003 | 404 | Documento no encontrado: la clave no pertenece a esta empresa. Verifique chaveAcesso y empresaId. Los documentos antiguos de São Paulo no tienen clave de 50 dígitos y no se encuentran aquí. |
| 10003000 | 404 | empresaId no existe o no pertenece a esta aplicación. |
