API REST pública disponilizada visando a integração com outros sistemas dos clientes.

Requisitos

• Conectividade com a internet recomendada de 2 mbits ou superior, para comunicação com a solução na nuvem
• Firewall / Proxy liberados para o domínio:

https://api.conexaonfe.com.br (porta 443)

Ou para os IPs:

54.233.82.38
54.94.232.14

Autenticação

• Request

    Method: GET
    Headers: 
        Id-Integracao: "{id-integracao}"
    Endpoint: https://api.conexaonfe.com.br/v1/autenticacao

• Response

    Status: 200
    Body:
    {
        "token": "{jwt_token}"
    }

O token retornado na autenticação deve ser utilizado em todas as chamadas, com o header Authorization.

Nas chamadas dos outros serviços, caso seja retornado status 403, a autenticação deve ser chamada novamente, atualizando o Token.

Capturas

API que permite gerir a captura de NFe e CTe dos estabelecimentos da conta. Existe a possibilidade de fazer a busca ordenada, passando Query Params de pagina e quantidade.

Listar Capturas

Lista todos os estabelecimentos da conta, com suas respectivas capturas.

• Request

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/dfes-capturas

• Response

    Status: 200
    Body: 
    {
        "cpf_cnpj": "94261534000120",
        "nome": "Empresa 1",
        "capturas": {
            "nfe": true,
            "cte": false
        }
    },
    {
        "cpf_cnpj": "94261534000300",
        "nome": "Empresa 2",
        "capturas": {
            "nfe": true,
            "cte": true
        }
    },
    {....}

Buscar captura

Busca as capturas do estabelecimento, passando o CNPJ/CPF por parametro.

• Request

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/dfes-capturas/{cnpj-cpf}

• Response

    Status: 200
    Body: 
    {
        "cpf_cnpj": "94261534000120",
        "nome": "Empresa 1",
        "capturas": {
            "nfe": true,
            "cte": false
        }
    }

Caso o estabelecimento informado não seja encontrado, o response trará Status: 404 Not Found.

Inserir captura

Insere as capturas de NFe e CTe do estabelecimento informado no Body do request.

• Request

    Method: POST
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/dfes-capturas
    Body:
    {
        "cpf_cnpj": "94261534000300",
        "capturas": {
            "nfe": true,
            "cte": true
    }

• Response

    Status: 201
    Body: 
    {
        "cpf_cnpj": "94261534000300",
        "nome": "Empresa 1",
        "capturas": {
            "nfe": true,
            "cte": true
        }
    }

Caso o estabelecimento informado não seja encontrado, o response trará Status: 404 Not Found.

Alterar captura

Altera as capturas de NFe e CTe do estabelecimento, passando o CNPJ/CPF por parametro.

• Request

    Method: PUT
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/dfes-capturas/{cnpj-cpf}
    Body:
    {
    "capturas": {
        "nfe": true,
        "cte": false
    }

• Response

    Status: 200
    Body: 
    {
        "cpf_cnpj": "94261534000300",
        "nome": "Empresa 1",
        "capturas": {
            "nfe": true,
            "cte": false
        }
    }

Caso o estabelecimento informado não seja encontrado, o response trará Status: 404 Not Found.

Certificados

API que permite a manutenção dos Certificados cadastrados na conta do usuário.

Listar certificados

Lista todos os certificados vinculados aos CNPJs da conta. Existe a possibilidade de fazer a busca ordenada, passando Query Params de pagina e quantidade.

• Request

    Method: GET
    Headers: 
        Id-Integracao: "{id-integracao}"
    Endpoint: https://api.conexaonfe.com.br/v1/certificados

• Response

    Status: 200
    Body: 
    {
        "documento": "86585319856734",
        "nome": "Certificado1.pfx",
        "estabelecimentos": [
            {
                "documento": "86585319856136",
                "nome": "Empresa1"
            },
            {
                "documento": "86585319856993",
                "nome": "Empresa2"
            },
            {
                "documento": "86585319856856",
                "nome": "Empresa3"
            },
        ]
    },
    {
        "documento": "61234560987613",
        "nome": "Certificado2.pfx",
        "estabelecimentos": [
            {
                "documento": "61234560987136",
                "nome": "Empresa1"
            },
            {
                "documento": "61234560987993",
                "nome": "Empresa2"
            },
        ...

Buscar certificado

Busca o certificado passando o CNPJ como parametro.

• Request

    Method: GET
    Headers: 
        Id-Integracao: "{id-integracao}"
    Endpoint: https://api.conexaonfe.com.br/v1/certificados/{cnpj-cpf-certificado}

• Response

    Status: 200
    Body: 
    {
        "documento": "86585319856734",
        "nome": "Certificado1.pfx",
        "estabelecimentos": [
            {
                "documento": "86585319856136",
                "nome": "Empresa1"
            },
            {
                "documento": "86585319856993",
                "nome": "Empresa2"
            },
            {
                "documento": "86585319856856",
                "nome": "Empresa3"
            },
        ]
    },

Caso o certificado não seja encontrado o response trará Status: 404 Not Found.

Inserir certificado

Insere um certificado, informando os campos previstos no Body do Request e vincula o mesmo aos estabelecimentos com a mesma raiz de CNPJ.

• Request

    Method: POST
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/certificados
    Body:
    {
        "nomeCertificado": "Empresa1.pfx",
        "senha": "12341@",
        "arquivoBase64":"MIACAQMwgAYJKoZIhvcNAQcBoIAEgiOqMIIjpjCCHdsGCSqGSIb3DQEHBqCCHcwwgh3IAgEAMIIdwQYJKoZIhvcNAQcBMCgGCiqGSIb3DQEMAQYwGgQU1QGG7hvIMFg1y6IRcgpe/XxUvUQCAgQAgIIdiBn/NPSiRsKQeHe0MV29kWyKh1dD2P4YCad1N6i9zaU3284VX6Ux1bkqerltmYXDzccF9YueCJXObNieWpTKPtRppDtaaqWhFwgKffZSG75Gqgd3I6jQ4pItBPoQ/o0qgQ8vDqvv8gn3jDT9PRNzZHVzctlZwziJUPsEDd8ztpjm4K2FJ2NMniYmN0nECl7...",
    }

• Response

    Status: 201
    Body: 
    {
        "documento": "86585319856734",
        "nome": "Certificado1.pfx",
        "estabelecimentos": [
            {
                "documento": "86585319856136",
                "nome": "Empresa1"
            },
            {
                "documento": "86585319856993",
                "nome": "Empresa2"
            },
            {
                "documento": "86585319856856",
                "nome": "Empresa3"
            },
        ]
    },

Desativar certificado

Desativa a captura de DFe's do certificado em questão, remove o vinculo do certificado com o estabelecimento, passando o CNPJ-CPF como paramentro.

• Request

    Method: DELETE
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/certificados/{cnpj-cpf}

• Response

    Status: 204

Caso o certificado informado não seja encontrado, o response trará Status: 404 Not Found.

DFe

Disponibiliza acesso a todos os documentos fiscais da conta do usuário (NFe, NFSe, NFCe, CTe, Manifestos, CCe, etc.). Essa API precisa de liberação junto à equipe da ConexãoNF-e.

Download

Disponbiliza os xmls para download, sempre recebendo o último código integrada na consulta anterior. No primeiro request deve-se enviar o 0.

• Request para baixar os XMLs

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/dfes?ultimo-codigo=0

• Response

    Status: 200
    Body:
    {
        "arquivos":[
            {
                "nomeArquivo":"12345678901234567890123456789012345678901234-proceventonfe.xml",
                "arquivo":"<procEventoNFe xmlns=\"http://www.portalfiscal.inf.br/nfe\" versao=\"1.00\"><evento xmlns=\"http://www.portalfiscal.inf.br/nfe\" versao=\"1.00\">.....</procEventoNFe>",
                "codigo":4142
            },
            {
                "nomeArquivo":"12345678901234567890123456789012345678901234-nfeproc.xml",
                "arquivo":"<nfeProc xmlns=\"http://www.portalfiscal.inf.br/nfe\" versao=\"1.00\">.....</nfeProc>",
                "codigo":6059
            }
        ]
    }

• Request para baixar os XMLs convertidos em JSON

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/dfes?ultimo-codigo=421422&formato=json

• Response

    Status: 200
    Body:
    {
        "arquivos":[
            {
                "nomeArquivo":"12345678901234567890123456789012345678901234-proceventonfe.xml",
                "arquivo": {
                    "nfeProc": {
                        ...
                        "NFe": {
                            "xmlns": "http://www.portalfiscal.inf.br/nfe",
                            "infNFe": {
                                "infAdic": {
                                    "infCpl": "Cod.Cliente: 1234|RETORNO DE MERCADORIA REFERENTE A NOTA FISCAL ICMS DIFERIDO CFE DECRETO 37.699/97"
                                }
                                ...
                            }
                        }
                    }
                },    
                "codigo":4142
            },
            {
                "nomeArquivo":"12345678901234567890123456789012345678901234-nfeproc.xml",
                "arquivo": {
                    "nfeProc": {
                        ...
                        "NFe": {
                            "xmlns": "http://www.portalfiscal.inf.br/nfe",
                            "infNFe": {
                                "infAdic": {
                                    "infCpl": "Cod.Cliente: 1234|RETORNO DE MERCADORIA REFERENTE A NOTA FISCAL ICMS DIFERIDO CFE DECRETO 37.699/97"
                                }
                                ...
                            }
                        }
                    }
                }, 
                "nsuEmpresa":6059
            }
        ]
    }

• Request para baixar os XMLs apenas de um CNPJ/CPF específico.

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/dfes?ultimo-codigo=0&cnpj-cpf=12345678901234

A partir do momento que a API retornar status HTTP 204 - No Content, quer dizer que chegou no fim da fila dos documentos.

Os arquivos que são disponibilizados contém "\" para caracteres de escape para não quebrar o formato de retorno do JSON. Portanto, devem ser tratados no momento da leitura.

Código por data

Disponibiliza um código NSU a partir de uma data especificada por parametro no Endpoint.

É necessário passar a data no formato "yyyy-MM-dd".

• Request

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/dfes/codigo-por-data/{data}

• Response

    Status: 200
    Body: 
    {
        "codigo": 342680026
    }

Caso a data seja passada no formato errado a API retornará status 400 Bad Request.

Ultimo código NSU

Disponibiliza o último código NSU registrado.

• Request

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/dfes/ultimo-codigo

• Response

    Status: 200
    Body: 
    {
        "ultimo-codigo": 342680026
    }

Download DFe Por chave de Acesso

Disponibiliza o XML do documento.

• Request

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/dfes/{chaveAcesso}

• Response

    Status: 200
    Body: 
    {
    <nfeProc versao="4.00" xmlns="http://www.portalfiscal.inf.br/nfe">
        <NFe xmlns="http://www.portalfiscal.inf.br/nfe">
            <infNFe Id="NFe4322020326952800015955001000020873..." versao="4.00">
                <ide>
                    <cUF>43</cUF>
                    <cNF>70554750</cNF>
                    <natOp>VENDA DE MERCADORIA</natOp>
                    <mod>55</mod>
                    <serie>1</serie>
                    ...
    }

Download de Manifesto por Chave de Acesso

Disponibiliza o XML do evento.

• Request

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/dfes/{chaveAcesso}/manifestos

• Response

{
    "manifestos": {
        "manifesto": "versao=\"1.00\"> versao=\"1.00\"><infEvento Id=\"ID2102101723100135292100018655001000133807192909203801\">
                      <cOrgao>91</cOrgao><tpAmb>1</tpAmb><CNPJ>11127711000229</CNPJ>
                      <chNFe>17231001352921000186550010001338071929092038</chNFe>
                      <dhEvento>2023-10-05T11:02:24-03:00</dhEvento><tpEvento>210210
                      </tpEvento><nSeqEvento>1</nSeqEvento><verEvento>1.00</verEvento>
                      <detEvento versao=\"1.00\"><descEvento>Ciencia da Operacao</descEvento>
                      </detEvento></infEvento><Signature xmlns=\"http://www.w3.org/2000/09/xmldsig#\">
                      <SignedInfo>
                      ...
      }
}

• Request para baixar os XMLs convertidos em JSON

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/dfes/{chaveAcesso}/manifestos?formato=json

• Response

{
    "manifestos": {
        "manifesto": {
            "procEventoNFe": {
                "xmlns": "http://www.portalfiscal.inf.br/nfe",
                "evento": {
                    "xmlns": "http://www.portalfiscal.inf.br/nfe",
                    "infEvento": {
                        "cOrgao": 12,
                        "dhEvento": "00-00-00T00:00:00-00:00",
                        "nSeqEvento": 1,
                        "detEvento": {
                            "descEvento": "Ciencia da Operacao",
                            "versao": 1
                        },
                        "CNPJ": 12345678901234,
                        "Id": "ID12345678901234567890123456789012345678901234567890",
                        "chNFe": "123456789012345678901234567890123456789",
                        "tpAmb": 1,
                        "verEvento": 1,
                        "tpEvento": 210210
                    },
                    "versao": 1
                },
                "retEvento": {
                    "infEvento": {
                        "nProt": 1234567890123,
                        "nSeqEvento": 1,
                        "verAplic": "AN_1.6.1",
                        "xMotivo": "Evento registrado e vinculado a NF-e",
                        "chNFe": "123456789012345678901234567890123456789",
                        "tpAmb": 1,
                        "CNPJDest": 12345678901234,
                        "cStat": 135,
                        "cOrgao": 12,
                        "xmlns": "http://www.portalfiscal.inf.br/nfe",
                        "xEvento": "Ciencia da Operacao",
                        "dhRegEvento": "0000-00-00T00:00:00-00:00",
                        "Id": "ID12345678901234",
                        "tpEvento": 210210
                    },
                    "versao": 1
                },
                "versao": 1
            }
        }
    }
}

DF-e Status

API que retorna o status do DF-e.

Retornar status do DF-e

Retorna o status do documento fiscal de acordo com a chave de acesso.

• Request

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/dfes/{chaveAcesso}/status

• Response

    Status: 200
    Body: 
    {
        "status": "AUTORIZADA"
    }

DF-e Detalhes

API que retorna as informações básicas do DF-e, de acordo com a chave de acesso.

Informações básicas de NF-e, NFC-e, CT-e, CT-e OS

• Request

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/dfes/{chaveAcesso}/detalhes

• Response

    Status: 200
    Body: 
    {
        "numero": "123456",
        "serie": "10",
        "dataEmissao": "14/03/2023 01:06:22"
        "valorTotalDaNota": "1000.0"
    }

Caso o documento não seja encontrado, o response trará Status: 404 Not Found.

O response Status: 400 Bad Request significa que a chave de acesso é inválida.

Informações básicas de NFS-e

• Request

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/dfes/detalhes-nfse?numeroNfse=12345&codigoVerificacao=ABC12345&cnpjPrestador=96837651000100
    Parâmetros:
        - numeroNfse: 12345,
        - codigoVerificacao: ABC12345,
        - cnpjPrestador: 96837651000100

• Response

    Status: 200
    Body: 
    {
        "numero": "123456",
        "serie": "E",
        "dataEmissao": "14/03/2023 01:06:22"
    }

Caso o documento não seja encontrado, o response trará Status: 404 Not Found.

DF-e Detalhes + dados do XML

API que retorna as informações básicas do DF-e, com o adicional de alguns dados relevantes do XML, de acordo com a chave de acesso.

Informações de CT-e, CT-e OS

• Request

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/dfes/{chaveAcesso}/detalhes/xml

• Response CT-e

    Status: 200
    Body: 
        {
    "numero": "15",
    "serie": "1",
    "dataEmissao": "12/12/2023 15:19:07",
    "valorTotalDaNota": "1110.0",
    "codMunicipioOrigem": "5213087",
    "codMunicipioDestino": "5220207",
    "modal": "01",
    "tipoServico": "0",
    "finalidade": "0",
    "forma": "1",
    "cfop": "5353",
    "naturezaPrestacao": "PRESTACAO DE SERVICO",
    "valorToma": null,
    "nfeRelacionada": [
        "52231203840360000123450010000343451000123456"
    ],
    "valorTotalCarga": "53100.00",
    "produtoPredominante": "OLEO DIESEL B S500 COMUM",
    "outrasCaracteristicasCarga": null,
    "unidadeCarga": "04",
    "medidaCarga": "LITRAGEM",
    "quantidadeCarga": "10000.0000",
    "nomeEmitente": "COMBUSTIVEIS LTDA",
    "documentoEmitente": "34457879000132",
    "ufEmitente": "GO",
    "inscricaoEstadualEmitente": "107860562",
    "nomeDestinatario": "INCORPORACOES LTDA",
    "documentoDestinatario": "12329711000123",
    "ufDestinatario": "GO",
    "inscricaoEstadualDestinatario": "105094161",
    "nomeRemetente": "DIESEL COMPANY",
    "documentoRemetente": "09870360000123",
    "ufRemetente": "GO",
    "inscricaoEstadualRemetente": "101776411",
    "nomeExpedidor": null,
    "documentoExpedidor": null,
    "ufExpedidor": null,
    "inscricaoEstadualExpedidor": null,
    "nomeRecebedor": null,
    "documentoRecebedor": null,
    "ufRecebedor": null,
    "inscricaoEstadualRecebedor": null,
    "nomeTomador": "DIESEL COMPANY",
    "documentoTomador": "03840360000190",
    "ufTomador": "GO",
    "inscricaoEstadualTomador": "101776411"
}

• Response NF-e

Status: 200
Body: 
{
    "numero": "1234",
    "serie": "2",
    "dataEmissao": "01/05/2023 20:54:17",
    "valorTotalDaNota": "3000.0",
    "nomeEmitente": "Empresa XYZ",
    "cnpjEmitente": "10382859001892",
    "ufEmitente": "SP",
    "nomeDestinatario": "Empresa ABC",
    "cnpjDestinatario": "82461532802871",
    "ufDestinatario": "RS",
    "informacoesAdicionais": "Informaçes adicionais do documento",
    "itens": [
        {
            "codProduto": "12345",
            "descProduto": "Produto X",
            "ncmsh": "63048230",
            "cst": "40",
            "cfop": "6920",
            "unidade": "UN",
            "quantidade": "30.0000",
            "valorUnitario": "100.0000000000",
            "valorTotal": "3000.00",
            "bcIcms": "10.0",
            "valorIcms": "10.0",
            "valorIpi": "10.0",
            "aliqIcms": "10.0",
            "aliqIpi": "10.0"
        }
    ]
}

Caso o documento não seja encontrado, o response trará Status: 404 Not Found.

O response Status: 400 Bad Request significa que a chave de acesso é inválida.

DF-e Consulta Chave de Acesso

API que retorna a chave de acesso e o tipo do documento, através de parâmetros exemplificados abaixo.

• Request

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/dfes/consulta-chave?cnpjEmissor={ncpjEmissor}&numero={numero-documento}&serie={serie}&tipoDoc={tipoDoc}

     Parâmetros:
    - cnpjEmissor: 94261534000890,
    - numero: 1234,
    - serie: 1,
    - tipoDoc: NFE/CTE/CTE_OS

• Response

    Status: 200
    Body: 
    {
        "chaveAcesso": "43230394261534000115550020005956621995881123",
        "tipoDocumento": "NFE"
    }   

Caso o response seja status 404 Not Found, significa que o documento não foi encontrado.

Documento Auxiliar (DANFE, DANFCE, DACTE, DANFSE)

Disponibiliza acesso aos PDFs dos documentos auxiliares (DANFE, DANFCE, DACTE, DANFSE) baseados nos XMLs armazenados do portal. Onde é enviado somente a chave do documento, com exceção da DANFSE, a API busca do repositório do usuário o xml e gera o PDF. Essa API precisa de liberação junto à equipe da ConexãoNF-e.

Gerar

Gera o PDF através da chave de acesso do documento (NFe, NFCe, CTe, CTe OS). Para gerar a DANFSE de documentos disponibilizados pelos municípios, é necessário passar os parâmetros indicados abaixo. Para gerar o PDF de NFSEs disponibilizadas pelo ambiente nacional, deve-se utilizar o mesmo endpoint disponível para NFe, NFCe, CTe e CTe OS, passando no lugar da chave de acesso o número encontrado na tag "chave" presente no XML.

• Request (DANFE, DANFCE, DACTE, DANFSE(Nacional))

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/documento-auxiliar/{chave-de-acesso}/gerar

• Request (DANFSE)

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/documento-auxiliar/gerar-danfse?numeroNfse={numeroNfse}&codigoVerificacao={codigoVerificacao}&cnpjPrestador={cnpjPrestador}
    Parâmetros:
        - numeroNfse: 12345,
        - codigoVerificacao: ABC12345,
        - cnpjPrestador: 96837651000100

• Response

    Status: 200
    Body: PDF (binário) do documento

• Response

    Status: 204
    PDF não gerado devido ao documento estar cancelado

Caso apresente algum status 4xx, provavelmente o arquivo não foi encontrado na sua conta ou o usuário utilizado para se autenticar não possui permissão no CNPJ do documento.

Estabelecimentos

API que permite a manutenção dos CNPJs e CPFs cadastrados na conta do usuário.

Listar estabelecimentos

Lista todos os estabelecimentos vinculados à empresa. Existe a possibilidade de fazer a busca ordenada, passando Query Params de pagina e quantidade.

• Request

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/estabelecimentos?pagina=1&quantidade=50

• Response

    Status: 200
    Body: 
    {
        "cnpjCpf": "12345678987654",
        "nome": "Empresa 1",
        "razaoSocial": "Empresa Y",
        "inscricaoEstadual": "127307766111",
        "inscricaoMunicipal": "127307766111",
        "cep": "89212007",
        "endereco": "Rua xyz",
        "numero": "123",
        "complemento": "Fundos",
        "bairro": "Abcd",
        "codCidadeIbge": 1712009,
        "nomeCidadeIbge": "LAJEADO",
        "configs": {
            "nfeManifestoCienciaAuto": false
        },
        "capturas": {
            "capturaNfe": false,
            "capturaCte": false
        }
    },
    {
        "cnpjCpf": "12345678987456",
        "nome": "Empresa 2",
        "razaoSocial": "Empresa z",
        ...

Buscar estabelecimento

Retorna um estabelecimento de acordo com o CNPJ-CPF passado como parametro.

• Request

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/estabelecimentos/{cnpj-cpf}

• Response

    Status: 200
    Body: 
    {
        "cnpjCpf": "12345678987654",
        "nome": "Empresa 1",
        "razaoSocial": "Empresa A",
        "inscricaoEstadual": "127307766111",
        "inscricaoMunicipal": "127307766111",
        "cep": "89212007",
        "endereco": "Rua xyz",
        "numero": "123",
        "complemento": "Fundos",
        "bairro": "Abcd",
        "codCidadeIbge": 1712009,
        "nomeCidadeIbge": "LAJEADO",
        "configs": {
            "nfeManifestoCienciaAuto": false
        },
        "capturas": {
            "capturaNfe": false,
            "capturaCte": false
        }
    },

Caso o estabelecimento informado não seja encontrado, o response trará Status: 404 Not Found.

Inserir estabelecimento

Insere um estabelecimento, informando os campos previstos no Body do Request.

• Request

    Method: POST
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/estabelecimentos
    Body:
    {
        "cnpjCpf": "12345678987654",
        "nome": "Empresa 1",
        "razaoSocial": "Empresa A",
        "inscricaoEstadual": "127307766111",
        "inscricaoMunicipal": "127307766111",
        "cep": "89212007",
        "endereco": "Rua xyz",
        "numero": "123",
        "complemento": "Fundos",
        "bairro": "Abcd",
        "codCidadeIbge": 1712009,
        "configs": {
            "nfeManifestoCienciaAuto": false
        },
        "capturas": {
            "capturaNfe": false,
            "capturaCte": false
        }
    },

Neste primeiro momento, não será possível cadastrar um estabelecimento com as "configs" ou "capturas" ativas, ou seja, marcadas com true.

• Response

    Status: 201
    Body: 
    Estabelecimento criado com sucesso.

Caso ocorra algum erro referente aos campos do body, o Response trará Status: 500 Server Error.

Atualizar estabelecimento

Atualiza o estabelecimento passando o Body exemplificado no Request, com as atualizações pretendidas.

• Request

    Method: PUT
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/estabelecimentos
    Body:
    {
        "cnpjCpf": "12345678987654",
        "nome": "Empresa 1",
        "razaoSocial": "Empresa A",
        "inscricaoEstadual": "127307766111",
        "inscricaoMunicipal": "127307766111",
        "cep": "89212007",
        "endereco": "Rua xyz",
        "numero": "123",
        "complemento": "Fundos",
        "bairro": "Abcd",
        "codCidadeIbge": 1712009,
        "configs": {
            "nfeManifestoCienciaAuto": false
        },
        "capturas": {
            "capturaNfe": false,
            "capturaCte": false
        }
    },

• Response

    Status: 200
    Body: 
    Estabelecimento atualizado com sucesso.

Caso o estabelecimento informado não seja encontrado, o response trará Status: 404 Not Found. Se o Response for Status: 500 Server Error, o erro será referente a algum campo no Body.

Desativar estabelecimento

Desativa o estabelecimento passando o CNPJ-CPF como paramentro.

• Request

    Method: POST
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/estabelecimentos/{cnpj-cpf}/desativar

• Response

    Status: 204

Caso o estabelecimento informado não seja encontrado, o response trará Status: 404 Not Found.

Estabelecimentos do usuário

Disponibiliza acesso aos CNPJs/CPFs que o usuário tem permissão para integrar ao ERP.

O produto no request é referente ao módulo do sistema que está fazendo a consulta.
Opções:

INTEGRADOR_RM
FEED_PROTHEUS
FEED_DATASUL

Caso a conta não possua plano com integração com o ERP, será retornado o status: 204 (No Content).

• Request

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/integrador-erp/estabelecimentos/{produto}

• Response

    Status: 200
    Body:
    {
        "documentos": [
            "01010101101",
            "01010101102",
            "010101011011010101010"
        ]
    }

Flag ERP

Lançar no ERP

Possibilita a atualização da Flag Erp, quando passar "flagErp": true, o documento será lançado, quando "flagErp": false, o lançamento é cancelado. Para lançar uma NFS-e disponibilizada pelos municípios, é necessário passar parâmetros adicionais ao invés da chave de acesso. Para NFS-e emitidas em ambiente nacional, no lugar da chave de acesso, deve-se passar o número encontrado na tag "chave" do XML

• Request para lançar (NF-e, NFC-e, CT-e, CT-e OS, NFS-e Nacional)

    Method: PUT
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/dfes-lancamento-erp/{chave-acesso}
    Body:
    {     
        "flagErp": true/false,
        "codUsuarioErp": "99",     
        "nomeUsuarioErp": "Fulano",
        "data": "1646150400000"
    }

• Request para lançar (NFS-e)

    Method: PUT
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/dfes-lancamento-erp/nfse
    Body:
    {     
        "flagErp": true/false,
        "codUsuarioErp": "99",     
        "nomeUsuarioErp": "Fulano",
        "data": "1646150400000",
        "numeroNfse": 12345,
        "codigoVerificacao": "ABC12345",
        "cnpjPrestador": "96837651000100"
    }

A data deverá ser passada no formato de milissegundos.

• Response

    Status: 200
    Body:
    {
        "status": "2",
        "statusDescricao": "A notificação de erp foi aplicada"
    }

• Response

    Status: 200
    Body:
    {
        "status": "3",
        "statusDescricao": "A notificação de erp foi arquivada"
    }

Consulta ERP

Faz a consulta pra saber se o documento em questão está lançado ou não. Para consultar o lançamento de NFS-e disponibilizada pelo ambiente nacional, deve-se passar no lugar da "chave-acesso", o número encontrado na tag "chave" do XML.

• Request para Consultar

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/dfes-lancamento-erp/{chave-acesso}

• Response

    Status: 200
    Body:
    {
        "message": "Documento lancado",
        "status": "ok"
    }

• Response

    Status: 200
    Body:
    {
        "errorType": "NO_CONTENT",
        "errorMessage": "Documento nao esta lancado no ERP"
    }

• Response

    Status: 404
    Body:
    {
        "errorType": "RESOURCE_NOT_FOUND",
        "errorMessage": "Documento nao encontrado"
    }

Manifestos e Desacordo de CTe

API que permite fazer o manifesto de NF-e Recebidas e desacordo de CT-e recebidos.

Inserir Manifesto

Faz a emissão do manifesto/desacordo junto à Sefaz, de acordo com o código de evento, passando os dados previstos no body do request. Justificativa deve ter, no mínimo, 15 caracteres e é obrigatória em caso de operação não realizada (NF-e) e desacordo da operação (CT-e).

Os codTipoEvento de manifesto são, respectivamente:

1. 210210: Manifesto de ciência da operação
2. 210200: Manifesto de confirmação da operação
3. 210220: Manifesto de desconhecimento da operação
4. 210240: Manifesto de operação não realizada
5. 610110: Desacordo da operação (CT-e)

• Request

    Method: POST
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/manifesto
    Body:
    {
        "chaveAcessoNFe": "35220432143933000124550010002236141296841234",
        "codTipoEvento": "210200",
        "data":1654277688000,
        "codUsuarioErp":"1234",
        "nomeUsuarioErp":"Fulano",
        "descricao":"Lançado via API",
        "justificativa": ""
    }

• Response

    Status: 201
    Body: 
    Sucesso, executada a integracao com a Sefaz.

Caso a nota ainda não conste em nosso sistema, a solicitação será arquivada e executada automaticamente assim que a NFe chegar no sistema.

• Response

    Status: 202
    Body: 
    A solicitação foi arquivada.

Não é necessário reenviar a request quando o status for 202, pois ele deve ser tratado com o sucesso, mas só não foi executado ainda devido a ausência do documento de origem.

Marcador

Permite consultar os marcadores criados em Administrar >> Marcadores.

Listar Marcadores

Lista os marcadores criados por tipo de documento.

• Request

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/tag/{tipo-documento}

Códigos do Tipo Documento:

NFE - NFe Emitida
NFR - NFe Recebida
NFT - NF-e Transportada
NFCE - NFC-e Emitida
CTE_ENVOLVIDO - CTe Envolvido
CTE_RECEBIDO - CTe Recebido
CTEOSR - CTe OS Recebido
NFSER - NFS-e Recebida (Tomada)

• Response

    Status: 200
    Body: 
    [
        {
            "codTag": 2665,
            "codParceiro": 63,
            "codTipo": "NFR",
            "tag": "Faltou Pagamento",
            "cor": "label-info",
            "descricao": "Faltou pagar"
        }
    ]

O campo codTag é que será utilizado nos request para vínculo do marcador com o documento fiscal.

Caso ocorra algum erro de negócio, será retornado status 4xx com a respestiva mensagem.

Marcador Documento

Permite gerir os vínculos de marcadores aos documentos fiscais.

Listar Marcadores

Lista os marcadores vínculados ao documento, passando a chave de acesso como parâmetro. Quando se tratar de NFS-e, deve-se usar a chave de acesso disponível na tag Chave do XML.

• Request

    Method: GET
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/tag-documento/{chave-acesso}

• Response

    Status: 200
    Body: 
    [
        {
            "codTag": 2665,
            "codParceiro": 63,
            "codTipo": "NFR",
            "tag": "Faltou Pagamento",
            "cor": "label-info",
            "descricao": "Faltou pagar"
            "data": "2022-09-24",
            "nomeUsuario": "Sergio Silva"
        }
    ]

Caso ocorra algum erro de negócio, será retornado status 4xx com a respestiva mensagem.

Cadastrar Marcador

Faz o vínculo do marcador ao documento.

Necessário enviar a chave de acesso do documento e o código da TAG que será vinculada.
O código da TAG pode ser consultado na API de listagem de Marcadores por tipo de documento.
A observação é opcional.

• Request

    Method: POST
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/tag-documento
    Body:
    {     
        "chave":"99999999999999999999999999999999999999999999",
        "observacao":"Observação do documento",     
        "codTag": 123
    }

• Response

    Status: 200
    Body: 
    {
        "message": "Marcador cadastrado com sucesso",
        "status": "ok"
    }

Excluir Marcador

Exclui o vínculo do marcador ao documento.

Assim como o vínculo do Marcador, na exclusão é necessário enviar a Chave de Acesso do documento, juntamente com o código da Tag que será excluída.

• Request

    Method: DELETE
    Headers: 
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/tag-documento/{chave-acesso}/{cod-tag}

• Response

    Status: 200
    Body: 
    {
        "message": "Marcador removido com sucesso",
        "status": "ok"
    }

Caso ocorra algum erro de negócio, será retornado status 4xx com a respestiva mensagem.

NFe

NF-e Recebidas Consulta Chave de Acesso

API que retorna as chaves de acesso de NFe-Recebidas, a partir de uma data inicial e uma data final. A data deve ser passada no formato yyyy-MM-dd e a diferença entre as datas não pode ser superior a dez dias.

• Request

    Method: GET
    Headers:
        Authorization: "Bearer {jwt_token}"
    Endpoint: https://api.conexaonfe.com.br/v1/nfe/recebidas/por-data-emissao/{data-inicial}/{data-final}

• Response

Status: 200
Body: 
[
    {
        "chaveAcesso": "26230989637490014448550010006593087679999999",
        "tipoDocumento": "NFE"
    },
    {
        "chaveAcesso": "26230920965644000121550030000569717218888888",
        "tipoDocumento": "NFE"
    },
    {
        "chaveAcesso": "26230920965644000121550030000569697107777777",
        "tipoDocumento": "NFE"
    },
    {
        "chaveAcesso": "25230908540403000135550010000839541066666666",
        "tipoDocumento": "NFE"
    }
]