Pular para o conteúdo principal

Guarda de Documentos Fiscais

Visão Geral

As APIs de Guarda são responsáveis por armazenar os XMLs de documentos fiscais no Emissor Fiscal, atendendo aos requisitos legais de guarda fiscal, sem a necessidade de onerar a base de dados da automação integradora.

São suportados documentos com status:

  • Autorizado
  • Cancelado
  • Inutilizado
  • Denegado

Informações Importantes

  • É possível enviar até 100 documentos por vez.
  • Sempre deverá ser enviada uma lista de objetos.
  • Os XMLs de eventos de cancelamento de NFC-e serão armazenados mediante envio do XML de autorização de uso, não sendo necessário enviar na ordem da emissão. 

Guardas disponíveis

Guarda NF-e​

API responsável por realizar a guarda do XML dos documentos fiscais NF-e. 

Ambientes

Ver: Autenticações

API de Guarda NF-e​

Informações Importantes

  • É possível enviar até 100 documentos por vez.
  • Sempre deverá ser enviada uma lista de objetos.
  • Os XMLs de eventos de cancelamento de NF-e serão armazenados mediante envio do XML de autorização de uso, não sendo necessário enviar na ordem da emissão. 

Detalhamento da API

  • Endpoint:/nfeapi/ReceiveBatchNFCe?api-version=2
  • Método: POST
  • Header:
    • AuthorizationToken: Token de autorização
    • Content-Type: application/json
  • Parâmetros:
    • Cnpj: CNPJ emissor dos documentos
    • XML: XML autorizado pela Sefaz em formato base64

Exemplo de Payload de Envio

[
    {
        "Cnpj":"99999999999999",
        "Xml":"XML do documento em base64"
    }
]

Exemplo de Payload de Retorno

{
    "cStat": "",
    "xMotivo": "",
}

Possíveis Retornos HTTP:

  • 200 - Sucesso
  • 400 – BadRequest
    • Caso tenha algum problema nas informações enviadas, causando falha no Client.
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

Guarda NFC-e​

API responsável por realizar a guarda do XML dos documentos fiscais NFC-e. 

Ambientes

Ver: Autenticações

API de Guarda NFC-e​

  • Endpoint: /nfceapi/ReceiveBatchNFCe?api-version=2
  • Método: POST
  • Header:
    • AuthorizationToken: Token de autorização
    • Content-Type: application/json
  • Parâmetros:
    • Cnpj: CNPJ emissor dos documentos
    • XML: XML autorizado pela Sefaz em formato base64

Exemplo de Payload de Envio

[
    {
        "Cnpj":"99999999999999",
        "Xml":"XML do documento em base64"
    }
]

Exemplo de Payload de Retorno

{
    "cStat": "",
    "xMotivo": "",
}

Possíveis Retornos HTTP:

  • 200 - Sucesso
  • 400 – BadRequest
    • Caso tenha algum problema nas informações enviadas, causando falha no Client.
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

Guarda CF-e​

API responsável pela recepção de documentos no layout CF-e para realização da guarda no Emissor Fiscal.

A guarda de documentos CF-e SAT é mantida exclusivamente para fins de histórico, conformidade legal e recuperação de documentos emitidos em períodos anteriores.

O modelo CF-e está descontinuado para novas emissões desde 31/12/2025, não devendo ser utilizado em novos projetos de integração.

Ambientes

Ver: Autenticações

API de Guarda CF-e​

  • Endpoint: api/cfehubsender/receivecompactcancellationcfe/
  • Método: POST
  • Header:
    • AuthorizationToken: Token de autorização
    • Content-Type: application/x-www-form-urlencoded
  • Body:
    • x-www-form-unlencoded
      • Cnpj: Text
      • XmlSource: Text

Exemplo de Payload de Retorno

Possíveis Retornos HTTP:

  • 200 - Sucesso
  • 400 – BadRequest
    • Caso tenha algum problema nas informações enviadas, causando falha no Client.
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

API de Consulta de CF-e​

API responsável pela consulta de documentos no layout CF-e.

  • Endpoint: api/cfehubservices/Search
  • Método: GET
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/json
  • Parâmetros:
    • Cnpj: CNPJ do emissor
    • nNF: Número do documento
    • Serie: Série do documento
    • GeraDanfe: true|false. Se deve gerar DANFE

Exemplo de Payload de Envio

URL: api/cfehubservices/Search?Cnpj=51111111000119&nNF=5&Serie=2&GeraDanfe=true

Exemplo de Payload de Retorno

{
    "central_Contingencia": false,
    "chNFe": "4321111111111000119650030000001111111111111",
    "codStatus": null,
    "cStat": "135",
    "customTimeToLiveIdentifier": null,
    "dataAlteracao": "2024-12-06T15:02:53.823",
    "desvioConsumoIndevido": false,
    "dhRetorno": "2024-12-13T08:53:31-03:00",
    "isCacheable": false,
    "mensagemInteresse": null,
    "nProt": "143240001111111",
    "retornoIntegradorList": null,
    "tpEvento": null,
    "ultimoDocumento": null,
    "urL_Consulta": null,
    "xmlCompactado": null,
    "xmlEventoCompactado": null,
    "xMotivo": "Evento registrado e vinculado a NF-e",
    "xUrlDanfe": null,
    "xURLDanfeAutorizacao": null
}

Possíveis Retornos HTTP:

  • 200 - Sucesso
  • 400 – BadRequest
    • Caso tenha algum problema nas informações enviadas, causando falha no Client.
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

Este conteúdo foi útil para você?