Pular para o conteúdo principal

Consulta de chamadas - Conciliação

Esta API tem como objetivo fornecer transparência e rastreabilidade às automações que interagem com a Solução Fiscal. Por meio desta rota, é possível consultar todas as solicitações de emissão enviadas para o serviço, permitindo identificar:

  • A nota fiscal gerada a partir de um IDVenda; ou
  • Os motivos de não emissão, caso nenhuma nota tenha sido associada.

Essa funcionalidade é essencial para automações responsáveis pela gestão da numeração de documentos fiscais, especialmente em cenários onde possam ocorrer falhas de comunicação entre sistemas. A consulta possibilita verificar até qual ponto a Solução Fiscal recebeu as informações e quais dados precisam ser reenviados para garantir a consistência do processo.

Vale ressaltar que apesar do nome da API ser Conciliação de Venda ela serve para rastrear todas as chamadas realizadas, não apenas as com finalidade de venda. 

Detalhamento da API

  • Endpoint:  /MiddlewareServices/SalesConciliation/Search 
  • Método: GET
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/json 

Parâmetros de pesquisa:

CampoDescriçãoObrigatório
CNPJCNPJ do emissorSim
NfSerieNúmero de série dos documentos fiscaisNão
NfModeloModelo do documento fiscal. Opções:
55 - Nota Fiscal Eletrônica (NF-e) 
65 - Nota Fiscal de Consumidor Eletrônica (NFC-e)
Não
PeriodoVendasInicioPeríodo inicial das vendas (AAAA-MM-DD)Sim
PeriodoVendasFimPeríodo final das vendas (AAAA-MM-DD)Sim
DocumentsPorPageTotal de documentos por páginaNão
PageNumberNúmero da página a ser retornadaNão

Período máximo

O período de consulta decorrido entre os parâmetros PeriodoVendasInicio e PeriodoVendasFim deve ser igual ou inferior a 30 dias.

Exemplo Payload de Retorno

{
"cabecalho": {
"cnpj": "11111111111111",
"documentos": 179,
"documentosRetornados": 2,
"pagina": 1,
"titulo": "Conciliação de Vendas de 10/11/2025 à 10/12/2025",
"totalPaginas": 90
},
"vendas": [
{
"id": "e1babb3b-c578-4506-97bb-da3b477abcba",
"nfModelo": 65,
"nfNumero": 900357,
"serie": "2",
"cStat": "100",
"xMotivo": "Autorizado o uso da NF-e",
"dataCriacao": "2025-11-11T11:57:03.7933333"
},
{
"id": "a39ca46f-c0a8-4b25-83cb-5e953e654f74",
"nfModelo": 65,
"nfNumero": 900358,
"serie": "2",
"cStat": "135",
"xMotivo": "Evento registrado e vinculado a NF-e",
"dataCriacao": "2025-11-11T11:57:15.74"
}
]
}

Possíveis retornos HTTP

  • 200 - Sucesso
  • 400 – BadRequest
    • Caso tenha algum problema nas informações enviadas, causando falha na Solução Fiscal 
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

Este conteúdo foi útil para você?