A Autenticação

Todos os métodos exigem 4 parâmetros obrigatórios de autenticação.

Parâmetros obrigatórios em toda chamada

p_CNPJSoftwareHouse	string	CNPJ da Software House cadastrada na API NeXT
p_CNPJCliente	string	CNPJ do cliente emitente
p_Token	string	Token de autenticação fornecido na contratação
p_Ambiente	int	`1` = Produção, `2` = Homologação, `3` = Simulação

O formato de envio da NF-e por TXT utiliza o padrão INI do ACBr. Consulte a documentação do ACBr para o layout completo dos campos.

E Endpoints

Serviço	Endpoint
NF-e / NFC-e / MD-e	https://www.apinext.com.br/ws/nfe.asmx
NFS-e	https://www.apinext.com.br/ws/nfse.asmx
Boletos	https://www.apinext.com.br/ws/boleto.asmx
Pix	https://www.apinext.com.br/ws/pix.asmx
GNRe	https://www.apinext.com.br/ws/gnre.asmx
MDF-e	https://www.apinext.com.br/ws/mdfe.asmx
CT-e	https://www.apinext.com.br/ws/cte.asmx
DC-e	https://www.apinext.com.br/ws/dce.asmx
NFCom	https://www.apinext.com.br/ws/nfcom.asmx
NFAg	https://www.apinext.com.br/ws/nfag.asmx
NFGás	https://www.apinext.com.br/ws/nfgas.asmx
Financeiro	https://www.apinext.com.br/ws/financeiro.asmx
Utilitários	https://www.apinext.com.br/ws/nfeutil.asmx

NFS-e: cada prefeitura adota um padrão de integração próprio — a API trata essa diferença, mas o padrão define quais campos e eventos estão disponíveis. Consulte o padrão da sua cidade antes de integrar.

N NF-e / NFC-e

SOAP /ws/nfe.asmx

Emissão, eventos e consultas de NF-e (modelo 55) e NFC-e (modelo 65).

Método	Descrição
Disponibilidade	Verifica se o serviço da API NeXT está no ar
CertificadoUpload	Envia o certificado digital A1 usado na assinatura da NF-e
Config	Configura UF, CSC e forma de emissão
ConfigEmail	Configura os dados de envio de e-mail da NF-e
ConfigParams	Configura as opções de impressão do DANFE
ConfigModeloDANFe	Define o modelo de DANFE utilizado na impressão
ConfigSoftwareHouse	Registra os dados da Software House e o CSRT
NFeLogotipoEnviar	Envia o logotipo impresso no DANFE
NFeLogotipoExcluir	Remove o logotipo cadastrado
ChaveAcessoGerar	Monta a chave de acesso de 44 dígitos a partir dos dados da nota
EnviarNFeTXT	Transmite a NF-e a partir do TXT/INI (conteúdo em string)
EnviarNFeTXTObj	Transmite a NF-e a partir do TXT/INI (conteúdo em bytes)
EnviarNFeTXTObj2	Transmite a NF-e a partir do TXT/INI e devolve também o XML gerado
EnviarNFeXML	Transmite a NF-e a partir do XML já montado (conteúdo em string)
EnviarNFeXMLObj	Transmite a NF-e a partir do XML já montado (conteúdo em bytes)
Cancelamento	Cancela uma NF-e autorizada, mediante justificativa
CartaCorrecao	Registra uma Carta de Correção Eletrônica (CC-e)
CartaCorrecaoObj	Registra uma CC-e a partir do XML do evento
Inutilizacao	Inutiliza uma faixa de numeração não utilizada
StatusServico	Consulta o status do serviço da SEFAZ da UF
ConsultaSituacao	Consulta a situação de uma NF-e pela chave de acesso
ConsultaRecibo	Consulta o resultado do processamento pelo número do recibo
ConsultaCadastro	Consulta o cadastro de contribuinte na SEFAZ
NFePDF	Gera o PDF do DANFE de uma NF-e autorizada
NFePDFEvento	Gera o PDF do DANFE de um evento (cancelamento, CC-e)
NFePDFInutilizacao	Gera o PDF do comprovante de inutilização
NFeXML	Devolve o XML autorizado da NF-e
NFeEmailEnvio	Envia por e-mail o XML e o PDF de uma NF-e autorizada
GTINConsulta	Consulta o cadastro centralizado de GTIN/EAN da SEFAZ
NCMConsulta	Consulta a descrição de um código NCM
NCMLista	Devolve a tabela completa de NCM em arquivo
NCMLista2	Devolve a tabela completa de NCM como texto
CESTLista	Devolve a tabela completa de CEST em arquivo
CESTLista2	Devolve a tabela completa de CEST como texto
IBPT	Baixa a tabela IBPT de uma UF (carga tributária aproximada)
IBPTVersao	Informa a versão vigente da tabela IBPT

Configuração

Disponibilidade

Verifica se o serviço da API NeXT está no ar

▾

Retorno:bool — true se o serviço está disponível

CertificadoUpload

Envia o certificado digital A1 usado na assinatura da NF-e

▾

Parâmetro	Tipo	Dir	Descrição
p_DocBin	Byte[]	IN	Conteúdo do certificado A1 (.pfx) em bytes
p_NomeEmpresa	string	IN	Razão social da empresa emitente
p_UF	string	IN	UF do emitente
p_CSC	string	IN	Código de Segurança do Contribuinte (NFC-e)
p_TokenCSC	string	IN	Identificador do CSC
p_ArquivoCertificado	string	IN	Nome do arquivo do certificado
p_SenhaCertificado	string	IN	Senha do certificado A1
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

Config

Configura UF, CSC e forma de emissão

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF do emitente
p_CSC	string	IN	Código de Segurança do Contribuinte (NFC-e)
p_IdCSC	string	IN	Identificador do CSC
p_NomeEmpresa	string	IN	Razão social da empresa emitente
p_FormaEmissao	int	IN	Forma de emissão (1 = Normal, 9 = Contingência off-line)
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigEmail

Configura os dados de envio de e-mail da NF-e

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF do emitente
p_CSC	string	IN	Código de Segurança do Contribuinte (NFC-e)
p_IdCSC	string	IN	Identificador do CSC
p_NomeEmpresa	string	IN	Razão social da empresa emitente
p_FormaEmissao	int	IN	Forma de emissão (1 = Normal, 9 = Contingência off-line)
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigParams

Configura as opções de impressão do DANFE

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF do emitente
p_NomeEmpresa	string	IN	Razão social da empresa emitente
p_QCom	int	IN	Casas decimais da quantidade comercial
p_VUnCom	int	IN	Casas decimais do valor unitário
p_ImprimeNomeFantasia	int	IN	1 = imprime o nome fantasia no DANFE
p_ExibeEAN	int	IN	1 = exibe o código EAN no DANFE
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigModeloDANFe

Define o modelo de DANFE utilizado na impressão

▾

Parâmetro	Tipo	Dir	Descrição
p_ModeloDANFe	int	IN	Modelo do DANFE utilizado na impressão
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigSoftwareHouse

Registra os dados da Software House e o CSRT

▾

Parâmetro	Tipo	Dir	Descrição
p_CNPJSW	string	IN	CNPJ da Software House
p_RazaoSocial	string	IN	Razão social da Software House
p_NomeFantasia	string	IN	Nome fantasia da Software House
p_WebSite	string	IN	Site da Software House
p_Email	string	IN	E-mail de contato da Software House
p_Telefone	string	IN	Telefone de contato da Software House
p_Responsavel	string	IN	Nome do responsável técnico
p_CSRT	string	IN	Código de Segurança do Responsável Técnico
p_IdCSRT	string	IN	Identificador do CSRT
p_Software	string	IN	Nome do sistema integrador
p_Versao	string	IN	Versão do sistema integrador
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

NFeLogotipoEnviar

Envia o logotipo impresso no DANFE

▾

Retorno:bool — true quando a operação foi concluída com sucesso

NFeLogotipoExcluir

Remove o logotipo cadastrado

▾

Retorno:bool — true quando a operação foi concluída com sucesso

Emissão e envio

ChaveAcessoGerar

Monta a chave de acesso de 44 dígitos a partir dos dados da nota

▾

Parâmetro	Tipo	Dir	Descrição
p_TipoEmissao	int	IN	Tipo de emissão (1 = Normal, 9 = Contingência)
p_UF	string	IN	UF do emitente
p_DataEmissao	DateTime	IN	Data de emissão da nota
p_Serie	int	IN	Série da nota
p_NumeroNF	long	IN	Número da nota fiscal
p_CodigoNF	long	IN	Código numérico aleatório da nota (cNF)
p_ModeloNF	int	IN	Modelo do documento (55 = NF-e, 65 = NFC-e)
p_ChNFe	string	OUT	Chave de acesso de 44 dígitos
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

EnviarNFeTXT

Transmite a NF-e a partir do TXT/INI (conteúdo em string)

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF do emitente
p_IdLote	int	IN	Identificador do lote de envio
p_TXTNFe	string	IN	Conteúdo TXT/INI da NF-e no padrão ACBr
p_ChNFe	string	IN	Chave de acesso de 44 dígitos
p_EnvioEmail	bool	IN	true = envia a nota por e-mail ao destinatário
p_Email	string	IN	E-mail do destinatário da nota
p_EmailCopia	string	IN	E-mails em cópia, separados por ponto e vírgula
p_DANFeTipo	int	IN	0 = Sem PDF, 1 = Retrato, 2 = Paisagem
p_CodStatus	int	OUT	Código de status da SEFAZ (100 = Autorizada)
p_DhRecbto	string	OUT	Data/hora do recebimento pela SEFAZ
p_NProt	string	OUT	Número do protocolo de autorização
p_NRec	string	OUT	Número do recibo do lote
p_ChNFeRet	string	OUT	Chave de acesso devolvida pela SEFAZ
p_DigVal	string	OUT	Digest value da assinatura
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_XMLRet	Byte[]	OUT	XML de retorno da SEFAZ
p_XMLAutorizado	Byte[]	OUT	XML autorizado (procNFe), pronto para guarda
p_PDFNFe	Byte[]	OUT	PDF do DANFE

Retorno:bool — true quando a nota foi autorizada

EnviarNFeTXTObj

Transmite a NF-e a partir do TXT/INI (conteúdo em bytes)

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF do emitente
p_IdLote	int	IN	Identificador do lote de envio
p_TXTNFe	Byte[]	IN	Conteúdo TXT/INI da NF-e no padrão ACBr
p_ChNFe	string	IN	Chave de acesso de 44 dígitos
p_Email	string	IN	E-mail do destinatário da nota
p_EmailCopia	string	IN	E-mails em cópia, separados por ponto e vírgula
p_DANFeTipo	int	IN	0 = Sem PDF, 1 = Retrato, 2 = Paisagem
p_CodStatus	int	OUT	Código de status da SEFAZ (100 = Autorizada)
p_DhRecbto	string	OUT	Data/hora do recebimento pela SEFAZ
p_NProt	string	OUT	Número do protocolo de autorização
p_NRec	string	OUT	Número do recibo do lote
p_ChNFeRet	string	OUT	Chave de acesso devolvida pela SEFAZ
p_DigVal	string	OUT	Digest value da assinatura
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_XMLRet	Byte[]	OUT	XML de retorno da SEFAZ
p_XMLAutorizado	Byte[]	OUT	XML autorizado (procNFe), pronto para guarda
p_PDFNFe	Byte[]	OUT	PDF do DANFE

Retorno:bool — true quando a nota foi autorizada

EnviarNFeTXTObj2

Transmite a NF-e a partir do TXT/INI e devolve também o XML gerado

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF do emitente
p_IdLote	long	IN	Identificador do lote de envio
p_TXTNFe	Byte[]	IN	Conteúdo TXT/INI da NF-e no padrão ACBr
p_ChNFe	string	IN	Chave de acesso de 44 dígitos
p_Email	string	IN	E-mail do destinatário da nota
p_EmailCopia	string	IN	E-mails em cópia, separados por ponto e vírgula
p_DANFeTipo	int	IN	0 = Sem PDF, 1 = Retrato, 2 = Paisagem
p_CodStatus	int	OUT	Código de status da SEFAZ (100 = Autorizada)
p_DhRecbto	string	OUT	Data/hora do recebimento pela SEFAZ
p_NProt	string	OUT	Número do protocolo de autorização
p_NRec	string	OUT	Número do recibo do lote
p_ChNFeRet	string	OUT	Chave de acesso devolvida pela SEFAZ
p_DigVal	string	OUT	Digest value da assinatura
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_XMLGerado	Byte[]	OUT	XML da NF-e gerado a partir do TXT
p_XMLRet	Byte[]	OUT	XML de retorno da SEFAZ
p_XMLAutorizado	Byte[]	OUT	XML autorizado (procNFe), pronto para guarda
p_PDFNFe	Byte[]	OUT	PDF do DANFE

Retorno:bool — true quando a nota foi autorizada

EnviarNFeXML

Transmite a NF-e a partir do XML já montado (conteúdo em string)

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF do emitente
p_IdLote	long	IN	Identificador do lote de envio
p_XMLNFe	string	IN	Conteúdo XML da NF-e
p_ChNFe	string	IN	Chave de acesso de 44 dígitos
p_EnvioEmail	bool	IN	true = envia a nota por e-mail ao destinatário
p_Email	string	IN	E-mail do destinatário da nota
p_EmailCopia	string	IN	E-mails em cópia, separados por ponto e vírgula
p_DANFeTipo	int	IN	0 = Sem PDF, 1 = Retrato, 2 = Paisagem
p_CodStatus	int	OUT	Código de status da SEFAZ (100 = Autorizada)
p_DhRecbto	string	OUT	Data/hora do recebimento pela SEFAZ
p_NProt	string	OUT	Número do protocolo de autorização
p_NRec	string	OUT	Número do recibo do lote
p_ChNFeRet	string	OUT	Chave de acesso devolvida pela SEFAZ
p_DigVal	string	OUT	Digest value da assinatura
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_XMLRet	Byte[]	OUT	XML de retorno da SEFAZ
p_XMLAutorizado	Byte[]	OUT	XML autorizado (procNFe), pronto para guarda
p_PDFNFe	Byte[]	OUT	PDF do DANFE

Retorno:bool — true quando a nota foi autorizada

EnviarNFeXMLObj

Transmite a NF-e a partir do XML já montado (conteúdo em bytes)

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF do emitente
p_IdLote	long	IN	Identificador do lote de envio
p_XMLNFe	Byte[]	IN	Conteúdo XML da NF-e
p_ChNFe	string	IN	Chave de acesso de 44 dígitos
p_EnvioEmail	bool	IN	true = envia a nota por e-mail ao destinatário
p_Email	string	IN	E-mail do destinatário da nota
p_EmailCopia	string	IN	E-mails em cópia, separados por ponto e vírgula
p_DANFeTipo	int	IN	0 = Sem PDF, 1 = Retrato, 2 = Paisagem
p_CodStatus	int	OUT	Código de status da SEFAZ (100 = Autorizada)
p_DhRecbto	string	OUT	Data/hora do recebimento pela SEFAZ
p_NProt	string	OUT	Número do protocolo de autorização
p_NRec	string	OUT	Número do recibo do lote
p_ChNFeRet	string	OUT	Chave de acesso devolvida pela SEFAZ
p_DigVal	string	OUT	Digest value da assinatura
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_XMLRet	Byte[]	OUT	XML de retorno da SEFAZ
p_XMLAutorizado	Byte[]	OUT	XML autorizado (procNFe), pronto para guarda
p_PDFNFe	Byte[]	OUT	PDF do DANFE

Retorno:bool — true quando a nota foi autorizada

Eventos

Cancelamento

Cancela uma NF-e autorizada, mediante justificativa

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF do emitente
p_NProt	string	IN	Número do protocolo de autorização
p_ChNFe	string	IN	Chave de acesso de 44 dígitos
p_IdLote	long	IN	Identificador do lote de envio
p_NSeqEvento	int	IN	Número sequencial do evento
p_XJust	string	IN	Justificativa (mínimo de 15 caracteres)
p_Email	string	IN	E-mail do destinatário da nota
p_CodStatus	int	OUT	Código de status da SEFAZ (100 = Autorizada)
p_DhRegEvento	string	OUT	Data/hora do registro do evento
p_NProtRet	string	OUT	Protocolo do evento registrado
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_XEvento	string	OUT	Descrição do evento registrado
p_TpEvento	int	OUT	Código do tipo de evento
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_XMLRet	Byte[]	OUT	XML de retorno da SEFAZ
p_XMLAutorizado	Byte[]	OUT	XML autorizado (procNFe), pronto para guarda
p_PDFCancelamento	Byte[]	OUT	PDF do comprovante de cancelamento

Retorno:bool — true quando o cancelamento foi homologado

CartaCorrecao

Registra uma Carta de Correção Eletrônica (CC-e)

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF do emitente
p_ChNFe	string	IN	Chave de acesso de 44 dígitos
p_IdLote	long	IN	Identificador do lote de envio
p_NSeqEvento	int	IN	Número sequencial do evento
p_XCorrecao	string	IN	Texto da correção (mínimo de 15 caracteres)
p_CodStatus	int	OUT	Código de status da SEFAZ (100 = Autorizada)
p_DhRegEvento	string	OUT	Data/hora do registro do evento
p_NProt	string	OUT	Número do protocolo de autorização
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_XEvento	string	OUT	Descrição do evento registrado
p_TpEvento	int	OUT	Código do tipo de evento
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_XMLRet	Byte[]	OUT	XML de retorno da SEFAZ
p_PDFEvento	Byte[]	OUT	PDF do comprovante do evento

Retorno:bool — true quando a operação foi concluída com sucesso

CartaCorrecaoObj

Registra uma CC-e a partir do XML do evento

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF do emitente
p_ChNFe	string	IN	Chave de acesso de 44 dígitos
p_IdLote	long	IN	Identificador do lote de envio
p_NSeqEvento	int	IN	Número sequencial do evento
p_XMLCorrecao	Byte[]	IN	XML do evento de correção
p_CodStatus	int	OUT	Código de status da SEFAZ (100 = Autorizada)
p_DhRegEvento	string	OUT	Data/hora do registro do evento
p_NProt	string	OUT	Número do protocolo de autorização
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_XEvento	string	OUT	Descrição do evento registrado
p_TpEvento	int	OUT	Código do tipo de evento
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_XMLRet	Byte[]	OUT	XML de retorno da SEFAZ
p_PDFEvento	Byte[]	OUT	PDF do comprovante do evento

Retorno:bool — true quando a operação foi concluída com sucesso

Inutilizacao

Inutiliza uma faixa de numeração não utilizada

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF do emitente
p_ModeloDFe	int	IN	Modelo do documento (55 = NF-e, 65 = NFC-e)
p_NNFIni	long	IN	Número inicial da faixa a inutilizar
p_NNFFin	long	IN	Número final da faixa a inutilizar
p_Serie	int	IN	Série da nota
p_XJust	string	IN	Justificativa (mínimo de 15 caracteres)
p_CodStatus	int	OUT	Código de status da SEFAZ (100 = Autorizada)
p_DhRecbto	string	OUT	Data/hora do recebimento pela SEFAZ
p_NProt	string	OUT	Número do protocolo de autorização
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_XMLRet	Byte[]	OUT	XML de retorno da SEFAZ
p_PDFInutilizacao	Byte[]	OUT	PDF do comprovante de inutilização

Retorno:bool — true quando a faixa foi inutilizada

Consultas

StatusServico

Consulta o status do serviço da SEFAZ da UF

▾

Parâmetro	Tipo	Dir	Descrição
p_CodStatus	int	OUT	Código de status da SEFAZ (100 = Autorizada)
p_DhRecbto	string	OUT	Data/hora do recebimento pela SEFAZ
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConsultaSituacao

Consulta a situação de uma NF-e pela chave de acesso

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF do emitente
p_ChNFe	string	IN	Chave de acesso de 44 dígitos
p_CodStatus	int	OUT	Código de status da SEFAZ (100 = Autorizada)
p_DhRecbto	string	OUT	Data/hora do recebimento pela SEFAZ
p_Protocolo	string	OUT	Protocolo de autorização da nota consultada
p_DigVal	string	OUT	Digest value da assinatura
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_XMLRet	Byte[]	OUT	XML de retorno da SEFAZ

Retorno:bool — true quando a operação foi concluída com sucesso

ConsultaRecibo

Consulta o resultado do processamento pelo número do recibo

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF do emitente
p_NRec	string	IN	Número do recibo do lote
p_CodStatus	int	OUT	Código de status da SEFAZ (100 = Autorizada)
p_DhRecbto	string	OUT	Data/hora do recebimento pela SEFAZ
p_ChNFe	string	OUT	Chave de acesso de 44 dígitos
p_Protocolo	string	OUT	Protocolo de autorização da nota
p_DigVal	string	OUT	Digest value da assinatura
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_XMLRet	Byte[]	OUT	XML de retorno da SEFAZ

Retorno:bool — true quando a operação foi concluída com sucesso

ConsultaCadastro

Consulta o cadastro de contribuinte na SEFAZ

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF do emitente
p_CNPJConsulta	string	IN	CNPJ a consultar
p_IEConsulta	string	IN	Inscrição estadual a consultar
p_CodStatus	int	OUT	Código de status da SEFAZ (100 = Autorizada)
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_XMLRet	Byte[]	OUT	XML de retorno da SEFAZ
p_CadIE	string	OUT	Inscrição estadual do contribuinte
p_CadCNPJ	string	OUT	CNPJ do contribuinte
p_CadUF	string	OUT	UF do contribuinte
p_CadSit	int	OUT	Situação cadastral (1 = Habilitado)
p_CadNome	string	OUT	Razão social do contribuinte
p_CadFantasia	string	OUT	Nome fantasia do contribuinte
p_CadRegApur	string	OUT	Regime de apuração
p_CadCNAE	string	OUT	CNAE principal
p_CadDtIni	string	OUT	Data de início da atividade
p_CadDtSit	string	OUT	Data da situação cadastral
p_CadEndereco	string	OUT	Logradouro do contribuinte
p_CadEndNro	string	OUT	Número do endereço
p_CadEndBairro	string	OUT	Bairro
p_CadEndMunicipio	string	OUT	Município
p_CadEndMunicCod	int	OUT	Código IBGE do município
p_CadEndCep	string	OUT	CEP

Retorno:bool — true quando a operação foi concluída com sucesso

Impressão, XML e e-mail

NFePDF

Gera o PDF do DANFE de uma NF-e autorizada

▾

Parâmetro	Tipo	Dir	Descrição
p_ChNFe	string	IN	Chave de acesso de 44 dígitos
p_DANFeTipo	int	IN	0 = Sem PDF, 1 = Retrato, 2 = Paisagem
p_Regerar	bool	IN	true = regera o arquivo mesmo que já exista
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_PDFNFe	Byte[]	OUT	PDF do DANFE

Retorno:bool — true quando o PDF foi gerado

NFePDFEvento

Gera o PDF do DANFE de um evento (cancelamento, CC-e)

▾

Parâmetro	Tipo	Dir	Descrição
p_ChNFe	string	IN	Chave de acesso de 44 dígitos
p_NSeqEvento	int	IN	Número sequencial do evento
p_Regerar	bool	IN	true = regera o arquivo mesmo que já exista
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_PDFEvento	Byte[]	OUT	PDF do comprovante do evento

Retorno:bool — true quando a operação foi concluída com sucesso

NFePDFInutilizacao

Gera o PDF do comprovante de inutilização

▾

Parâmetro	Tipo	Dir	Descrição
p_ChInu	string	IN	Chave da inutilização
p_Regerar	bool	IN	true = regera o arquivo mesmo que já exista
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_PDFInutilizacao	Byte[]	OUT	PDF do comprovante de inutilização

Retorno:bool — true quando a operação foi concluída com sucesso

NFeXML

Devolve o XML autorizado da NF-e

▾

Parâmetro	Tipo	Dir	Descrição
p_ChNFe	string	IN	Chave de acesso de 44 dígitos
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_XMLNFe	Byte[]	OUT	Conteúdo XML da NF-e

Retorno:bool — true quando o XML foi localizado

NFeEmailEnvio

Envia por e-mail o XML e o PDF de uma NF-e autorizada

▾

Parâmetro	Tipo	Dir	Descrição
p_ChNFe	string	IN	Chave de acesso de 44 dígitos
p_EmailDestinatario	string	IN	E-mail do destinatário
p_EmailCopia	string	IN	E-mails em cópia, separados por ponto e vírgula
p_TituloMensagem	string	IN	Assunto da mensagem
p_Mensagem	string	IN	Corpo da mensagem

Retorno:bool — true quando a operação foi concluída com sucesso

Tabelas fiscais

GTINConsulta

Consulta o cadastro centralizado de GTIN/EAN da SEFAZ

▾

Parâmetro	Tipo	Dir	Descrição
p_EAN	string	IN	Código GTIN/EAN a consultar
p_CodStatus	int	OUT	Código de status da SEFAZ (100 = Autorizada)
p_DhResp	string	OUT	Data/hora da resposta
p_XProd	string	OUT	Descrição do produto cadastrada no GTIN
p_CEST	string	OUT	CEST vinculado ao GTIN
p_NCM	string	OUT	NCM vinculado ao GTIN
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

NCMConsulta

Consulta a descrição de um código NCM

▾

Parâmetro	Tipo	Dir	Descrição
p_NCM	string	IN	Código NCM a consultar
p_NCMOut	string	OUT	Código NCM normalizado
p_NCMDescricao	string	OUT	Descrição do NCM
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

NCMLista

Devolve a tabela completa de NCM em arquivo

▾

Parâmetro	Tipo	Dir	Descrição
p_NCMLista	Byte[]	OUT	Tabela NCM completa
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

NCMLista2

Devolve a tabela completa de NCM como texto

▾

Parâmetro	Tipo	Dir	Descrição
p_NCMLista	string	OUT	Tabela NCM completa
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

CESTLista

Devolve a tabela completa de CEST em arquivo

▾

Parâmetro	Tipo	Dir	Descrição
p_CESTTabela	Byte[]	OUT	Tabela CEST completa
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

CESTLista2

Devolve a tabela completa de CEST como texto

▾

Parâmetro	Tipo	Dir	Descrição
p_CESTTabela	string	OUT	Tabela CEST completa
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

IBPT

Baixa a tabela IBPT de uma UF (carga tributária aproximada)

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF do emitente
p_Versao	string	IN	Versão da tabela IBPT desejada (vazio = mais recente)
p_IBPTTabela	Byte[]	OUT	Tabela IBPT da UF informada
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

IBPTVersao

Informa a versão vigente da tabela IBPT

▾

Parâmetro	Tipo	Dir	Descrição
p_Versao	string	OUT	Versão vigente da tabela IBPT
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

M Manifestação do Destinatário (MD-e)

SOAP /ws/nfe.asmx

Eventos de manifestação e distribuição de NF-e de entrada recebidas. Os métodos ficam no endpoint da NF-e.

Método	Descrição
CienciaOperacao	Manifesta ciência da operação — apenas informa que a NF-e foi vista
ConfirmacaoOperacao	Confirma a operação: a mercadoria ou serviço foi efetivamente recebido
DesconhecimentoOperacao	Registra que a empresa desconhece a operação informada na NF-e
OperacaoNaoRealizada	Registra que a operação não se concretizou, mediante justificativa
ManifestacaoDestinatario	Registra qualquer um dos quatro eventos de manifestação, informando o código do evento
ConsultaNFeRecebida	Baixa os documentos destinados ao CNPJ a partir de um NSU (distribuição DFe)

Eventos de manifestação

CienciaOperacao

Manifesta ciência da operação — apenas informa que a NF-e foi vista

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF do destinatário
p_ChNFe	string	IN	Chave de acesso da NF-e recebida (44 dígitos)
p_IdLote	long	IN	Identificador do lote de envio do evento
p_DhEvento	string	IN	Data/hora do evento (formato AAAA-MM-DDTHH:MM:SS-03:00)
p_NSeqEvento	int	IN	Número sequencial do evento, começando em 1
p_CodStatus	int	OUT	Código de status devolvido pela SEFAZ (135 = Evento registrado e vinculado)
p_DhRegEvento	string	OUT	Data/hora do registro do evento na SEFAZ
p_NProt	string	OUT	Número do protocolo do evento
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_XEvento	string	OUT	Descrição do evento registrado
p_TpEvento	int	OUT	Código do tipo de evento confirmado pela SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_XMLRet	Byte[]	OUT	XML de retorno da SEFAZ com o evento registrado

Retorno:bool — true quando o evento foi registrado na SEFAZ

ConfirmacaoOperacao

Confirma a operação: a mercadoria ou serviço foi efetivamente recebido

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF do destinatário
p_ChNFe	string	IN	Chave de acesso da NF-e recebida (44 dígitos)
p_IdLote	long	IN	Identificador do lote de envio do evento
p_DhEvento	string	IN	Data/hora do evento (formato AAAA-MM-DDTHH:MM:SS-03:00)
p_NSeqEvento	int	IN	Número sequencial do evento, começando em 1
p_CodStatus	int	OUT	Código de status devolvido pela SEFAZ (135 = Evento registrado e vinculado)
p_DhRegEvento	string	OUT	Data/hora do registro do evento na SEFAZ
p_NProt	string	OUT	Número do protocolo do evento
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_XEvento	string	OUT	Descrição do evento registrado
p_TpEvento	int	OUT	Código do tipo de evento confirmado pela SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_XMLRet	Byte[]	OUT	XML de retorno da SEFAZ com o evento registrado

Retorno:bool — true quando o evento foi registrado na SEFAZ

DesconhecimentoOperacao

Registra que a empresa desconhece a operação informada na NF-e

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF do destinatário
p_ChNFe	string	IN	Chave de acesso da NF-e recebida (44 dígitos)
p_IdLote	long	IN	Identificador do lote de envio do evento
p_DhEvento	string	IN	Data/hora do evento (formato AAAA-MM-DDTHH:MM:SS-03:00)
p_NSeqEvento	int	IN	Número sequencial do evento, começando em 1
p_CodStatus	int	OUT	Código de status devolvido pela SEFAZ (135 = Evento registrado e vinculado)
p_DhRegEvento	string	OUT	Data/hora do registro do evento na SEFAZ
p_NProt	string	OUT	Número do protocolo do evento
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_XEvento	string	OUT	Descrição do evento registrado
p_TpEvento	int	OUT	Código do tipo de evento confirmado pela SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_XMLRet	Byte[]	OUT	XML de retorno da SEFAZ com o evento registrado

Retorno:bool — true quando o evento foi registrado na SEFAZ

OperacaoNaoRealizada

Registra que a operação não se concretizou, mediante justificativa

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF do destinatário
p_ChNFe	string	IN	Chave de acesso da NF-e recebida (44 dígitos)
p_IdLote	long	IN	Identificador do lote de envio do evento
p_DhEvento	string	IN	Data/hora do evento (formato AAAA-MM-DDTHH:MM:SS-03:00)
p_NSeqEvento	int	IN	Número sequencial do evento, começando em 1
p_XJust	string	IN	Justificativa, mínimo de 15 caracteres
p_CodStatus	int	OUT	Código de status devolvido pela SEFAZ (135 = Evento registrado e vinculado)
p_DhRegEvento	string	OUT	Data/hora do registro do evento na SEFAZ
p_NProt	string	OUT	Número do protocolo do evento
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_XEvento	string	OUT	Descrição do evento registrado
p_TpEvento	int	OUT	Código do tipo de evento confirmado pela SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_XMLRet	Byte[]	OUT	XML de retorno da SEFAZ com o evento registrado

Retorno:bool — true quando o evento foi registrado na SEFAZ

ManifestacaoDestinatario

Registra qualquer um dos quatro eventos de manifestação, informando o código do evento

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF do destinatário
p_EventoTipo	int	IN	Código do evento (210200 = Confirmação, 210210 = Ciência, 210220 = Desconhecimento, 210240 = Não Realizada)
p_ChNFe	string	IN	Chave de acesso da NF-e recebida (44 dígitos)
p_IdLote	long	IN	Identificador do lote de envio do evento
p_DhEvento	string	IN	Data/hora do evento (formato AAAA-MM-DDTHH:MM:SS-03:00)
p_NSeqEvento	int	IN	Número sequencial do evento, começando em 1
p_XJust	string	IN	Justificativa, mínimo de 15 caracteres
p_CodStatus	int	OUT	Código de status devolvido pela SEFAZ (135 = Evento registrado e vinculado)
p_DhRegEvento	string	OUT	Data/hora do registro do evento na SEFAZ
p_NProt	string	OUT	Número do protocolo do evento
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_XEvento	string	OUT	Descrição do evento registrado
p_TpEvento	int	OUT	Código do tipo de evento confirmado pela SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_XMLRet	Byte[]	OUT	XML de retorno da SEFAZ com o evento registrado

Retorno:bool — true quando o evento foi registrado na SEFAZ

Distribuição de documentos (DFe)

ConsultaNFeRecebida

Baixa os documentos destinados ao CNPJ a partir de um NSU (distribuição DFe)

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF do destinatário que está consultando
p_NSU	long	IN	Número sequencial único a partir do qual consultar
p_porUltNSU	bool	IN	true = consulta a partir do último NSU processado; false = consulta o NSU informado
p_CodStatus	int	OUT	Código de status devolvido pela SEFAZ (135 = Evento registrado e vinculado)
p_DhResp	string	OUT	Data/hora da resposta da SEFAZ
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_indCont	int	OUT	1 = ainda há documentos a baixar; repita a chamada com o novo ultNSU
p_ultNSU	long	OUT	Último NSU processado nesta consulta
p_maxNSU	long	OUT	Maior NSU disponível na SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_TXTRet	Byte[]	OUT	Documentos devolvidos em formato TXT
p_XMLRet	Byte[]	OUT	XML com os documentos devolvidos pela distribuição DFe

Retorno:bool — true quando a consulta retornou documentos

S NFS-e

SOAP /ws/nfse.asmx

Nota Fiscal de Serviço Eletrnica. Cobertura de mais de 4.600 prefeituras.

Método	Descrição
CertificadoUpload	Envia o certificado digital A1 usado na assinatura da NFS-e
Config	Configura município, inscrição municipal e credenciais do provedor
ConfigParams	Configura os dados cadastrais do prestador exibidos na nota
ConfigParamsWS	Configura apenas as credenciais de acesso ao WebService municipal
NFSeLogotipoEnviar	Envia o logotipo impresso no PDF da NFS-e
NFSeLogotipoExcluir	Remove o logotipo cadastrado
InformacoesProvedor	Informa o provedor do município e os serviços que ele disponibiliza
EnviarNFSe	Transmite um lote de RPS e devolve a NFS-e autorizada
CancelarNFSe	Cancela uma NFS-e autorizada
ConsultaNFSe	Consulta a NFS-e pelo número da DPS (layout nacional)
ConsultaNFSeRPS	Consulta a NFS-e a partir do RPS que a originou
ConsultaRPSLote	Consulta o resultado do processamento de um lote de RPS
ConsultaSituacao	Consulta a situação de um lote enviado
ConsultarEvento	Consulta um evento vinculado à NFS-e (layout nacional)
ConsultaServicoTomado	Lista as NFS-e tomadas em um período, no provedor municipal
ConsultaServicoTomadoADN	Consulta documentos no ADN nacional a partir de um NSU
ConsultaServicoTomadoADNEventos	Consulta os eventos de um documento no ADN nacional
NFSePDF	Gera o PDF da NFS-e autorizada
NFSeXML	Devolve o XML da NFS-e autorizada
NFSeRPSPDF	Gera o PDF a partir dos dados do RPS, antes da autorização

Configuração

CertificadoUpload

Envia o certificado digital A1 usado na assinatura da NFS-e

▾

Parâmetro	Tipo	Dir	Descrição
p_DocBin	Byte[]	IN	Conteúdo do certificado A1 (.pfx) em bytes
p_ArquivoCertificado	string	IN	Nome do arquivo do certificado
p_SenhaCertificado	string	IN	Senha do certificado A1
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

Config

Configura município, inscrição municipal e credenciais do provedor

▾

Parâmetro	Tipo	Dir	Descrição
p_CodMunicipio	int	IN	Código IBGE do município emissor
p_CNPJMunicipio	string	IN	CNPJ da prefeitura, quando o provedor exige
p_InscricaoMunicipal	string	IN	Inscrição municipal do prestador
p_WSUser	string	IN	Usuário de acesso ao WebService municipal
p_WSSenha	string	IN	Senha de acesso ao WebService municipal
p_WSFraseSecr	string	IN	Frase secreta exigida por alguns provedores
p_WSChaveAcesso	string	IN	Chave de acesso fornecida pela prefeitura
p_WSChaveAutoriz	string	IN	Chave de autorização fornecida pela prefeitura
p_InscricaoEstadual	string	IN	Inscrição estadual do prestador
p_CRT	int	IN	Código do Regime Tributário (1 = Simples Nacional, 2 = Simples excesso, 3 = Regime Normal)
p_LayoutNacional	int	IN	1 = utiliza o layout nacional da NFS-e
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigParams

Configura os dados cadastrais do prestador exibidos na nota

▾

Parâmetro	Tipo	Dir	Descrição
p_RazaoSocial	string	IN	Razão social do prestador
p_NomeFantasia	string	IN	Nome fantasia do prestador
p_Endereco	string	IN	Logradouro do prestador
p_Numero	string	IN	Número do endereço
p_CEP	string	IN	CEP do prestador
p_Bairro	string	IN	Bairro do prestador
p_Complemento	string	IN	Complemento do endereço
p_Municipio	string	IN	Município do prestador
p_UF	string	IN	UF do prestador
p_Telefone	string	IN	Telefone do prestador
p_Email	string	IN	E-mail do prestador
p_CodMunicipio	int	IN	Código IBGE do município emissor
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigParamsWS

Configura apenas as credenciais de acesso ao WebService municipal

▾

Parâmetro	Tipo	Dir	Descrição
p_WSUser	string	IN	Usuário de acesso ao WebService municipal
p_WSSenha	string	IN	Senha de acesso ao WebService municipal
p_WSFraseSecr	string	IN	Frase secreta exigida por alguns provedores
p_WSChaveAcesso	string	IN	Chave de acesso fornecida pela prefeitura
p_WSChaveAutoriz	string	IN	Chave de autorização fornecida pela prefeitura
p_InscricaoEstadual	string	IN	Inscrição estadual do prestador
p_CRT	int	IN	Código do Regime Tributário (1 = Simples Nacional, 2 = Simples excesso, 3 = Regime Normal)
p_LayoutNacional	int	IN	1 = utiliza o layout nacional da NFS-e
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

NFSeLogotipoEnviar

Envia o logotipo impresso no PDF da NFS-e

▾

Retorno:bool — true quando a operação foi concluída com sucesso

NFSeLogotipoExcluir

Remove o logotipo cadastrado

▾

Retorno:bool — true quando a operação foi concluída com sucesso

InformacoesProvedor

Informa o provedor do município e os serviços que ele disponibiliza

▾

Parâmetro	Tipo	Dir	Descrição
p_AutenticacoesRequeridas	string	OUT	Formas de autenticação exigidas pelo provedor
p_IdentificacaoProvedor	string	OUT	Nome do provedor do município
p_Particularidades	string	OUT	Particularidades do provedor
p_ServicosDisponibilizados	string	OUT	Serviços que o provedor disponibiliza
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

Emissão e cancelamento

EnviarNFSe

Transmite um lote de RPS e devolve a NFS-e autorizada

▾

Parâmetro	Tipo	Dir	Descrição
p_NumLote	long	IN	Número do lote de RPS
p_TXT	Byte[]	IN	Conteúdo TXT/INI do RPS no padrão ACBr
p_Protocolo	string	OUT	Protocolo devolvido no envio do lote
p_CodVerificacao	string	OUT	Código de verificação da NFS-e
p_Situacao	int	OUT	Situação do lote ou da nota
p_DataAutorizacao	string	OUT	Data/hora da autorização
p_NumNFS	long	OUT	Número da NFS-e gerada
p_NumLoteRetorno	long	OUT	Número do lote devolvido pela prefeitura
p_Link	string	OUT	Link público para consulta da NFS-e
p_XMLRetorno	Byte[]	OUT	XML de retorno do provedor municipal
p_NFSXML	Byte[]	OUT	XML da NFS-e autorizada
p_NFSPDF	Byte[]	OUT	PDF da NFS-e
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando o lote foi transmitido com sucesso

CancelarNFSe

Cancela uma NFS-e autorizada

▾

Parâmetro	Tipo	Dir	Descrição
p_NumNFSe	long	IN	Número da NFS-e
p_ChNFSe	string	IN	Chave de acesso da NFS-e
p_TXT	Byte[]	IN	Conteúdo TXT/INI do RPS no padrão ACBr
p_CodVerificacao	string	OUT	Código de verificação da NFS-e
p_XMLRetorno	Byte[]	OUT	XML de retorno do provedor municipal
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a NFS-e foi cancelada

Consultas

ConsultaNFSe

Consulta a NFS-e pelo número da DPS (layout nacional)

▾

Parâmetro	Tipo	Dir	Descrição
p_NumDPS	string	IN	Número da DPS (Declaração de Prestação de Serviços)
p_ChNFSe	string	OUT	Chave de acesso da NFS-e
p_XMLNFSe	Byte[]	OUT	XML da NFS-e
p_NFSPDF	Byte[]	OUT	PDF da NFS-e
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConsultaNFSeRPS

Consulta a NFS-e a partir do RPS que a originou

▾

Parâmetro	Tipo	Dir	Descrição
p_NumRPS	long	IN	Número do RPS
p_Serie	int	IN	Série do RPS
p_Tipo	int	IN	Tipo do RPS
p_Protocolo	string	IN	Protocolo devolvido no envio do lote
p_ChNFSe	string	IN	Chave de acesso da NFS-e
p_CodVerificacao	string	OUT	Código de verificação da NFS-e
p_Situacao	int	OUT	Situação do lote ou da nota
p_NumNFSe	long	OUT	Número da NFS-e
p_NumNotaSubstituidora	long	OUT	Número da nota que substituiu esta, quando houver
p_DataEmissaoNFSe	string	OUT	Data de emissão da NFS-e
p_XMLRetorno	Byte[]	OUT	XML de retorno do provedor municipal
p_NFSXML	Byte[]	OUT	XML da NFS-e autorizada
p_NFSPDF	Byte[]	OUT	PDF da NFS-e
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConsultaRPSLote

Consulta o resultado do processamento de um lote de RPS

▾

Parâmetro	Tipo	Dir	Descrição
p_NumLote	long	IN	Número do lote de RPS
p_Protocolo	string	IN	Protocolo devolvido no envio do lote
p_CodVerificacao	string	OUT	Código de verificação da NFS-e
p_ProtocoloRetorno	string	OUT	Protocolo devolvido pela consulta
p_Situacao	int	OUT	Situação do lote ou da nota
p_NumNFSe	long	OUT	Número da NFS-e
p_LinkNFSe	string	OUT	Link público para consulta da NFS-e
p_XMLRetorno	Byte[]	OUT	XML de retorno do provedor municipal
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConsultaSituacao

Consulta a situação de um lote enviado

▾

Parâmetro	Tipo	Dir	Descrição
p_NumLote	long	IN	Número do lote de RPS
p_Protocolo	string	IN	Protocolo devolvido no envio do lote
p_ProtocoloRetorno	string	OUT	Protocolo devolvido pela consulta
p_Situacao	int	OUT	Situação do lote ou da nota
p_XMLRetorno	Byte[]	OUT	XML de retorno do provedor municipal
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConsultarEvento

Consulta um evento vinculado à NFS-e (layout nacional)

▾

Parâmetro	Tipo	Dir	Descrição
p_ChNFSe	string	IN	Chave de acesso da NFS-e
p_TipoEvento	int	IN	Código do tipo de evento
p_SeqEvento	int	IN	Número sequencial do evento
p_ChNFSeRetorno	string	OUT	Chave de acesso devolvida pela consulta
p_TipoEventoRetorno	int	OUT	Tipo de evento devolvido pela consulta
p_NumPedRegEv	int	OUT	Número do pedido de registro do evento
p_DataHoraRecebimento	string	OUT	Data/hora do recebimento do evento
p_XMLEvento	Byte[]	OUT	XML do evento
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

Serviços tomados

ConsultaServicoTomado

Lista as NFS-e tomadas em um período, no provedor municipal

▾

Parâmetro	Tipo	Dir	Descrição
p_InscrMun	string	IN	Inscrição municipal do tomador
p_Pagina	int	IN	Página a retornar
p_TipoPeriodo	int	IN	Tipo do período consultado (emissão, competência ou processamento)
p_DataInicial	string	IN	Data inicial do período
p_DataFinal	string	IN	Data final do período
p_XMLNFSe	Byte[]	OUT	XML da NFS-e
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConsultaServicoTomadoADN

Consulta documentos no ADN nacional a partir de um NSU

▾

Parâmetro	Tipo	Dir	Descrição
p_NSU	long	IN	Número sequencial único a partir do qual consultar
p_CNPJConsulta	string	IN	CNPJ do tomador a consultar
p_Lote	bool	IN	true = retorna os documentos em lote
p_StatusProc	int	OUT	Código de status do processamento no ADN
p_StatusProcDesc	string	OUT	Descrição do status do processamento
p_UltimoNSU	long	OUT	Último NSU disponível no ADN
p_QtdDocumentos	int	OUT	Quantidade de documentos devolvidos
p_DataHoraProc	string	OUT	Data/hora do processamento
p_VersaoAplic	string	OUT	Versão da aplicação do ADN
p_JSONRet	Byte[]	OUT	Retorno bruto do ADN em JSON
p_XMLDocumentos	Byte[]	OUT	XML dos documentos devolvidos
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConsultaServicoTomadoADNEventos

Consulta os eventos de um documento no ADN nacional

▾

Parâmetro	Tipo	Dir	Descrição
p_ChaveAcesso	string	IN	Chave de acesso do documento no ADN
p_StatusProc	int	OUT	Código de status do processamento no ADN
p_StatusProcDesc	string	OUT	Descrição do status do processamento
p_QtdDocumentos	int	OUT	Quantidade de documentos devolvidos
p_DataHoraProc	string	OUT	Data/hora do processamento
p_VersaoAplic	string	OUT	Versão da aplicação do ADN
p_JSONRet	Byte[]	OUT	Retorno bruto do ADN em JSON
p_XMLDocumentos	Byte[]	OUT	XML dos documentos devolvidos
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

Impressão e XML

NFSePDF

Gera o PDF da NFS-e autorizada

▾

Parâmetro	Tipo	Dir	Descrição
p_NumNFSe	long	IN	Número da NFS-e
p_DataEmissaoYMD	string	IN	Data de emissão no formato AAAA-MM-DD
p_ChNFSe	string	IN	Chave de acesso da NFS-e
p_Regerar	bool	IN	true = regera o arquivo mesmo que já exista
p_NFSPDF	Byte[]	OUT	PDF da NFS-e
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando o PDF foi gerado

NFSeXML

Devolve o XML da NFS-e autorizada

▾

Parâmetro	Tipo	Dir	Descrição
p_NumNFSe	long	IN	Número da NFS-e
p_DataEmissaoYMD	string	IN	Data de emissão no formato AAAA-MM-DD
p_ChNFSe	string	IN	Chave de acesso da NFS-e
p_NFSXML	Byte[]	OUT	XML da NFS-e autorizada
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando o XML foi localizado

NFSeRPSPDF

Gera o PDF a partir dos dados do RPS, antes da autorização

▾

Parâmetro	Tipo	Dir	Descrição
p_NumLote	long	IN	Número do lote de RPS
p_NumNFSe	long	IN	Número da NFS-e
p_NumRPS	long	IN	Número do RPS
p_Serie	int	IN	Série do RPS
p_Tipo	int	IN	Tipo do RPS
p_DataEmissaoYMD	string	IN	Data de emissão no formato AAAA-MM-DD
p_CodVerificacao	string	IN	Código de verificação da NFS-e
p_Situacao	int	IN	Situação do lote ou da nota
p_Regerar	bool	IN	true = regera o arquivo mesmo que já exista
p_NFSPDF	Byte[]	OUT	PDF da NFS-e
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

B Boletos

SOAP /ws/boleto.asmx

Integração com mais de 30 bancos homologados: Bradesco, Itaú, Santander, Caixa, BB, Sicoob e mais.

Método	Descrição
Config	Configura o banco, a carteira e as credenciais da API de cobrança
EnviarBoleto	Registra o boleto na API do banco e devolve linha digitável e PDF
ConsultarTitulo	Consulta um título específico pelo identificador
ConsultarTitulos	Lista títulos por período, situação ou pagador
BoletoGerarPDF	Gera o PDF do boleto a partir do arquivo INI, sem registrar no banco
GerarRemessa	Gera o arquivo de remessa bancária (CNAB 240/400)
LerRetorno	Processa o arquivo de retorno bancário e devolve os dados em INI

Configuração

Config

Configura o banco, a carteira e as credenciais da API de cobrança

▾

Parâmetro	Tipo	Dir	Descrição
p_TipoCobranca	int	IN	Código do banco/carteira no ACBrBoleto
p_NumeroBanco	int	IN	Número do banco (ex.: 237 = Bradesco, 341 = Itaú)
p_DigitoBanco	string	IN	Dígito verificador do número do banco
p_CIP	string	IN	Código de identificação de pagamento (quando exigido)
p_NumeroCorrespondente	int	IN	Número do banco correspondente, quando houver
p_OrientacaoBanco	string	IN	Instruções padrão impressas no boleto
p_IndicadorPix	bool	IN	true = gera o boleto com QR Code Pix híbrido
p_TipoChavePix	int	IN	Tipo da chave Pix (0 = Nenhuma, 1 = E-mail, 2 = CPF, 3 = CNPJ, 4 = Celular, 5 = Aleatória)
p_ChavePix	string	IN	Chave Pix usada no boleto híbrido
p_ClientId	string	IN	Client ID da aplicação na API do banco
p_ClientSecret	string	IN	Client Secret da aplicação na API do banco
p_KeyUser	string	IN	Chave de usuário exigida por alguns bancos
p_ArqKey	Byte[]	IN	Chave privada (.key) do certificado de comunicação
p_ArqCer	Byte[]	IN	Certificado público (.cer/.crt) de comunicação
p_Scopes	string	IN	Escopos OAuth autorizados na API do banco
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

Cobrança via API (registro on-line)

EnviarBoleto

Registra o boleto na API do banco e devolve linha digitável e PDF

▾

Parâmetro	Tipo	Dir	Descrição
p_OperacaoCobranca	int	IN	Operação a executar (0 = Inclusão, 1 = Alteração, 2 = Baixa/Cancelamento)
p_ArquivoIni	Byte[]	IN	Conteúdo INI do boleto no padrão ACBrBoleto
p_CodRetorno	string	OUT	Código de retorno devolvido pelo banco
p_CodBarras	string	OUT	Código de barras do boleto
p_LinhaDigitavel	string	OUT	Linha digitável do boleto
p_NossoNumero	string	OUT	Nosso Número atribuído ao título
p_NossoNumeroCorrespondente	string	OUT	Nosso Número no banco correspondente, quando houver
p_URL	string	OUT	URL do boleto hospedado pelo banco
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_Retorno	Byte[]	OUT	Retorno bruto da API do banco
p_PDF	Byte[]	OUT	PDF do boleto

Retorno:bool — true quando o título foi registrado no banco

ConsultarTitulo

Consulta um título específico pelo identificador

▾

Parâmetro	Tipo	Dir	Descrição
p_Identificador	string	IN	Identificador do título (Nosso Número ou id da API, conforme o banco)
p_IndSituacao	int	IN	Filtra pela situação do título
p_DataTitulo	string	IN	Data base da consulta (formato AAAA-MM-DD)
p_CodRetorno	string	OUT	Código de retorno devolvido pelo banco
p_CodBarras	string	OUT	Código de barras do boleto
p_LinhaDigitavel	string	OUT	Linha digitável do boleto
p_NossoNumero	string	OUT	Nosso Número atribuído ao título
p_URL	string	OUT	URL do boleto hospedado pelo banco
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConsultarTitulos

Lista títulos por período, situação ou pagador

▾

Parâmetro	Tipo	Dir	Descrição
p_SituacaoBoleto	int	IN	Situação dos títulos a listar
p_BoletoVencido	int	IN	1 = apenas vencidos, 0 = todos
p_DataInicioMov	string	IN	Data inicial de movimento
p_DataFinalMov	string	IN	Data final de movimento
p_DataInicioVecto	string	IN	Data inicial de vencimento
p_DataFinalVencto	string	IN	Data final de vencimento
p_DataInicioReg	string	IN	Data inicial de registro
p_DataFinalReg	string	IN	Data final de registro
p_CNPJCPFPagador	string	IN	CNPJ/CPF do pagador, para filtrar o resultado
p_NumProtocolo	string	IN	Número do protocolo, para filtrar o resultado
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_Retorno	Byte[]	OUT	Retorno bruto da API do banco

Retorno:bool — true quando a operação foi concluída com sucesso

Impressão e arquivos CNAB

BoletoGerarPDF

Gera o PDF do boleto a partir do arquivo INI, sem registrar no banco

▾

Parâmetro	Tipo	Dir	Descrição
p_ArquivoIni	Byte[]	IN	Conteúdo INI do boleto no padrão ACBrBoleto
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_PDF	Byte[]	OUT	PDF do boleto

Retorno:bool — true quando o PDF foi gerado

GerarRemessa

Gera o arquivo de remessa bancária (CNAB 240/400)

▾

Parâmetro	Tipo	Dir	Descrição
p_ArquivoIni	Byte[]	IN	Conteúdo INI do boleto no padrão ACBrBoleto
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_ArqRemessa	Byte[]	OUT	Arquivo de remessa gerado (CNAB)

Retorno:bool — true quando o arquivo de remessa foi gerado

LerRetorno

Processa o arquivo de retorno bancário e devolve os dados em INI

▾

Parâmetro	Tipo	Dir	Descrição
p_ArquivoRetorno	Byte[]	IN	Conteúdo do arquivo de retorno bancário (CNAB)
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_ArqIniRetorno	Byte[]	OUT	Dados do retorno convertidos para INI

Retorno:bool — true quando o arquivo de retorno foi processado

P Pix

SOAP /ws/pix.asmx

Cobranças Pix imediatas (Cob) e com vencimento (CobV). PSPs homologados: AppLess, QQPag, Bradesco, Itaú, BB, Santander, Sicredi, Sicoob, C6Bank.

Método	Descrição
Config	Configuração geral do Pix: chave, PSP e dados do recebedor
ConfigPSPAilos	Credenciais do PSP Ailos (certificados key/cer/root)
ConfigPSPAppLess	Credenciais do PSP AppLess
ConfigPSPBB	Credenciais do PSP Banco do Brasil
ConfigPSPBradesco	Credenciais do PSP Bradesco (certificado PFX)
ConfigPSPC6Bank	Credenciais do PSP C6 Bank
ConfigPSPCielo	Credenciais do PSP Cielo
ConfigPSPGerenciaNet	Credenciais do PSP Gerencianet (Efí)
ConfigPSPInter	Credenciais do PSP Banco Inter
ConfigPSPItau	Credenciais do PSP Itaú (certificados key/cer)
ConfigPSPMercadoPago	Credenciais do PSP Mercado Pago
ConfigPSPPagSeguro	Credenciais do PSP PagSeguro
ConfigPSPPixPDV	Credenciais do PSP PixPDV
ConfigPSPQQPag	Credenciais do PSP QQPag
ConfigPSPSantander	Credenciais do PSP Santander (certificado PFX)
ConfigPSPShipay	Credenciais do PSP Shipay
ConfigPSPSicoob	Credenciais do PSP Sicoob
ConfigPSPSicredi	Credenciais do PSP Sicredi
CriarCobrancaImediata	Cria uma cobrança imediata (Cob) e devolve o QR Code
ConsultarCobrancaImediata	Consulta uma cobrança imediata pelo TxId
RevisarCobrancaImediata	Altera uma cobrança imediata já criada, gerando nova revisão
CancelarCobrancaImediata	Cancela (remove) uma cobrança imediata
ConsultarCobrancasCob	Lista cobranças imediatas de um período
CriarCobranca	Cria uma cobrança com vencimento (CobV), com juros, multa e desconto
ConsultarCobranca	Consulta uma cobrança com vencimento pelo TxId
RevisarCobranca	Altera uma cobrança com vencimento já criada, gerando nova revisão
CancelarCobranca	Cancela (remove) uma cobrança com vencimento
ConsultarCobrancasCobV	Lista cobranças com vencimento de um período
ConsultarPix	Consulta um Pix recebido pelo EndToEndId
ConsultarPixRecebidos	Lista os Pix recebidos em um período
SolicitarDevolucaoPix	Solicita a devolução total ou parcial de um Pix recebido
ConsultarDevolucaoPix	Consulta a situação de uma devolução solicitada
GerarQRCodeEstatico	Gera um QR Code estático, reutilizável para vários pagamentos

Configuração

Config

Configuração geral do Pix: chave, PSP e dados do recebedor

▾

Parâmetro	Tipo	Dir	Descrição
p_TipoChave	int	IN	Tipo da chave Pix (0 = Nenhuma, 1 = E-mail, 2 = CPF, 3 = CNPJ, 4 = Celular, 5 = Aleatória)
p_PSP	int	IN	Código do PSP (ver tabela de PSPs)
p_CEPRecebedor	string	IN	CEP do recebedor
p_CidadeRecebedor	string	IN	Cidade do recebedor
p_NomeRecebedor	string	IN	Nome do recebedor exibido no QR Code
p_UFRecebedor	string	IN	UF do recebedor
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a configuração foi gravada

Credenciais por PSP

ConfigPSPAilos

Credenciais do PSP Ailos (certificados key/cer/root)

▾

Parâmetro	Tipo	Dir	Descrição
p_ChavePix	string	IN	Chave Pix do recebedor
p_ClientId	string	IN	Client ID da aplicação no PSP
p_ClientSecret	string	IN	Client Secret da aplicação no PSP
p_ArqKey	Byte[]	IN	Chave privada (.key)
p_ArqCer	Byte[]	IN	Certificado público (.cer/.crt)
p_ArqRoot	Byte[]	IN	Certificado raiz da cadeia
p_Scopes	string	IN	Escopos OAuth autorizados no PSP
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigPSPAppLess

Credenciais do PSP AppLess

▾

Parâmetro	Tipo	Dir	Descrição
p_ChavePIX	string	IN	Chave Pix do recebedor
p_ClientId	string	IN	Client ID da aplicação no PSP
p_ClientSecret	string	IN	Client Secret da aplicação no PSP
p_SecretKeyHMAC	string	IN	Secret Key HMAC fornecida pelo PSP
p_Scopes	string	IN	Escopos OAuth autorizados no PSP
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigPSPBB

Credenciais do PSP Banco do Brasil

▾

Parâmetro	Tipo	Dir	Descrição
p_ChavePix	string	IN	Chave Pix do recebedor
p_ClientId	string	IN	Client ID da aplicação no PSP
p_ClientSecret	string	IN	Client Secret da aplicação no PSP
p_DeveloperApplicationKey	string	IN	Developer Application Key (Banco do Brasil)
p_ArqKey	Byte[]	IN	Chave privada (.key)
p_ArqCer	Byte[]	IN	Certificado público (.cer/.crt)
p_ArqPFX	Byte[]	IN	Certificado no formato PFX/P12
p_PwdPFX	string	IN	Senha do certificado PFX
p_ApiVersao	int	IN	Versão da API do PSP
p_Scopes	string	IN	Escopos OAuth autorizados no PSP
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigPSPBradesco

Credenciais do PSP Bradesco (certificado PFX)

▾

Parâmetro	Tipo	Dir	Descrição
p_ChavePix	string	IN	Chave Pix do recebedor
p_ClientId	string	IN	Client ID da aplicação no PSP
p_ClientSecret	string	IN	Client Secret da aplicação no PSP
p_ArqPFX	Byte[]	IN	Certificado no formato PFX/P12
p_SenhaPFX	string	IN	Senha do certificado PFX
p_Scopes	string	IN	Escopos OAuth autorizados no PSP
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigPSPC6Bank

Credenciais do PSP C6 Bank

▾

Parâmetro	Tipo	Dir	Descrição
p_ChavePix	string	IN	Chave Pix do recebedor
p_ClientId	string	IN	Client ID da aplicação no PSP
p_ClientSecret	string	IN	Client Secret da aplicação no PSP
p_ArqKey	Byte[]	IN	Chave privada (.key)
p_ArqCer	Byte[]	IN	Certificado público (.cer/.crt)
p_Scopes	string	IN	Escopos OAuth autorizados no PSP
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigPSPCielo

Credenciais do PSP Cielo

▾

Parâmetro	Tipo	Dir	Descrição
p_ChavePix	string	IN	Chave Pix do recebedor
p_ClientId	string	IN	Client ID da aplicação no PSP
p_ClientSecret	string	IN	Client Secret da aplicação no PSP
p_Scopes	string	IN	Escopos OAuth autorizados no PSP
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigPSPGerenciaNet

Credenciais do PSP Gerencianet (Efí)

▾

Parâmetro	Tipo	Dir	Descrição
p_ChavePix	string	IN	Chave Pix do recebedor
p_ClientId	string	IN	Client ID da aplicação no PSP
p_ClientSecret	string	IN	Client Secret da aplicação no PSP
p_ArqPFX	Byte[]	IN	Certificado no formato PFX/P12
p_Scopes	string	IN	Escopos OAuth autorizados no PSP
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigPSPInter

Credenciais do PSP Banco Inter

▾

Parâmetro	Tipo	Dir	Descrição
p_ChavePix	string	IN	Chave Pix do recebedor
p_ClientId	string	IN	Client ID da aplicação no PSP
p_ClientSecret	string	IN	Client Secret da aplicação no PSP
p_ArqKey	Byte[]	IN	Chave privada (.key)
p_ArqCer	Byte[]	IN	Certificado público (.cer/.crt)
p_Scopes	string	IN	Escopos OAuth autorizados no PSP
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigPSPItau

Credenciais do PSP Itaú (certificados key/cer)

▾

Parâmetro	Tipo	Dir	Descrição
p_ChavePix	string	IN	Chave Pix do recebedor
p_ClientId	string	IN	Client ID da aplicação no PSP
p_ClientSecret	string	IN	Client Secret da aplicação no PSP
p_ArqKey	Byte[]	IN	Chave privada (.key)
p_ArqCer	Byte[]	IN	Certificado público (.cer/.crt)
p_Scopes	string	IN	Escopos OAuth autorizados no PSP
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigPSPMercadoPago

Credenciais do PSP Mercado Pago

▾

Parâmetro	Tipo	Dir	Descrição
p_ChavePIX	string	IN	Chave Pix do recebedor
p_AccessToken	string	IN	Access Token fornecido pelo PSP
p_Scopes	string	IN	Escopos OAuth autorizados no PSP
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigPSPPagSeguro

Credenciais do PSP PagSeguro

▾

Parâmetro	Tipo	Dir	Descrição
p_ChavePix	string	IN	Chave Pix do recebedor
p_ClientId	string	IN	Client ID da aplicação no PSP
p_ClientSecret	string	IN	Client Secret da aplicação no PSP
p_ArqKey	Byte[]	IN	Chave privada (.key)
p_ArqCer	Byte[]	IN	Certificado público (.cer/.crt)
p_Scopes	string	IN	Escopos OAuth autorizados no PSP
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigPSPPixPDV

Credenciais do PSP PixPDV

▾

Parâmetro	Tipo	Dir	Descrição
p_TokenPSP	string	IN	Token de acesso fornecido pelo PSP
p_SecretKey	string	IN	Secret Key fornecida pelo PSP
p_Scopes	string	IN	Escopos OAuth autorizados no PSP
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigPSPQQPag

Credenciais do PSP QQPag

▾

Parâmetro	Tipo	Dir	Descrição
p_ChavePIX	string	IN	Chave Pix do recebedor
p_ClientId	string	IN	Client ID da aplicação no PSP
p_ClientSecret	string	IN	Client Secret da aplicação no PSP
p_Scopes	string	IN	Escopos OAuth autorizados no PSP
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigPSPSantander

Credenciais do PSP Santander (certificado PFX)

▾

Parâmetro	Tipo	Dir	Descrição
p_ChavePix	string	IN	Chave Pix do recebedor
p_ConsumerKey	string	IN	Consumer Key fornecida pelo PSP
p_ConsumerSecret	string	IN	Consumer Secret fornecido pelo PSP
p_ArqPFX	Byte[]	IN	Certificado no formato PFX/P12
p_SenhaPFX	string	IN	Senha do certificado PFX
p_Scopes	string	IN	Escopos OAuth autorizados no PSP
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigPSPShipay

Credenciais do PSP Shipay

▾

Parâmetro	Tipo	Dir	Descrição
p_ClientId	string	IN	Client ID da aplicação no PSP
p_SecretKey	string	IN	Secret Key fornecida pelo PSP
p_AccessKey	string	IN	Access Key fornecida pelo PSP
p_Scopes	string	IN	Escopos OAuth autorizados no PSP
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigPSPSicoob

Credenciais do PSP Sicoob

▾

Parâmetro	Tipo	Dir	Descrição
p_ChavePix	string	IN	Chave Pix do recebedor
p_ClientId	string	IN	Client ID da aplicação no PSP
p_TokenSandbox	string	IN	Token do ambiente de testes do PSP
p_ArqKey	Byte[]	IN	Chave privada (.key)
p_ArqCer	Byte[]	IN	Certificado público (.cer/.crt)
p_Scopes	string	IN	Escopos OAuth autorizados no PSP
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigPSPSicredi

Credenciais do PSP Sicredi

▾

Parâmetro	Tipo	Dir	Descrição
p_ChavePix	string	IN	Chave Pix do recebedor
p_ClientId	string	IN	Client ID da aplicação no PSP
p_ClientSecret	string	IN	Client Secret da aplicação no PSP
p_ArqKey	Byte[]	IN	Chave privada (.key)
p_ArqCer	Byte[]	IN	Certificado público (.cer/.crt)
p_Scopes	string	IN	Escopos OAuth autorizados no PSP
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

Cobrança imediata (Cob)

CriarCobrancaImediata

Cria uma cobrança imediata (Cob) e devolve o QR Code

▾

Parâmetro	Tipo	Dir	Descrição
p_PSP	int	IN	Código do PSP (ver tabela de PSPs)
p_ChavePix	string	IN	Chave Pix do recebedor
p_TxId	string	IN	Identificador da transação, definido pelo integrador (26 a 35 caracteres)
p_SolicitacaoPagador	string	IN	Texto exibido ao pagador no aplicativo do banco
p_ValorOriginal	decimal	IN	Valor da cobrança
p_CPFCNPJDevedor	string	IN	CPF/CNPJ do devedor
p_DevedorNome	string	IN	Nome ou razão social do devedor
p_Observacoes	string	IN	Observações internas da cobrança
p_Referencia	string	IN	Referência interna do integrador
p_Expiracao	int	IN	Tempo de expiração da cobrança, em segundos
p_ModalidadeAlteracao	bool	IN	true = permite que o pagador altere o valor
p_Revisada	bool	IN	true = registra a cobrança como revisão
p_CodStatus	int	OUT	Situação da cobrança (0 = Nenhum, 1 = Ativa, 2 = Concluída, 3 = Removida pelo usuário, 4 = Removida pelo PSP)
p_TxIdRet	string	OUT	TxId efetivamente gravado pelo PSP
p_Revisao	int	OUT	Número da revisão da cobrança
p_PixCopiaeCola	string	OUT	Código Pix copia e cola (BR Code)
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_QrCode	Byte[]	OUT	Imagem do QR Code em PNG
p_TxtRetorno	Byte[]	OUT	Retorno bruto do PSP em JSON

Retorno:bool — true quando a cobrança foi criada no PSP

ConsultarCobrancaImediata

Consulta uma cobrança imediata pelo TxId

▾

Parâmetro	Tipo	Dir	Descrição
p_PSP	int	IN	Código do PSP (ver tabela de PSPs)
p_TxId	string	IN	Identificador da transação, definido pelo integrador (26 a 35 caracteres)
p_Revisao	int	IN	Revisão a consultar (0 = revisão atual)
p_CodStatus	int	OUT	Situação da cobrança (0 = Nenhum, 1 = Ativa, 2 = Concluída, 3 = Removida pelo usuário, 4 = Removida pelo PSP)
p_PixCopiaeCola	string	OUT	Código Pix copia e cola (BR Code)
p_EndToEndId	string	OUT	EndToEndId do pagamento, quando a cobrança já foi paga
p_ValorPIX	decimal	OUT	Valor efetivamente pago
p_DhPix	string	OUT	Data/hora em que o Pix foi pago
p_InfoPagador	string	OUT	Mensagem informada pelo pagador no momento do pagamento
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_QrCode	Byte[]	OUT	Imagem do QR Code em PNG
p_TxtRetorno	Byte[]	OUT	Retorno bruto do PSP em JSON

Retorno:bool — true quando a cobrança foi localizada

RevisarCobrancaImediata

Altera uma cobrança imediata já criada, gerando nova revisão

▾

Parâmetro	Tipo	Dir	Descrição
p_PSP	int	IN	Código do PSP (ver tabela de PSPs)
p_ChavePix	string	IN	Chave Pix do recebedor
p_TxId	string	IN	Identificador da transação, definido pelo integrador (26 a 35 caracteres)
p_SolicitacaoPagador	string	IN	Texto exibido ao pagador no aplicativo do banco
p_ValorOriginal	decimal	IN	Valor da cobrança
p_CPFCNPJDevedor	string	IN	CPF/CNPJ do devedor
p_DevedorNome	string	IN	Nome ou razão social do devedor
p_Observacoes	string	IN	Observações internas da cobrança
p_Referencia	string	IN	Referência interna do integrador
p_Expiracao	int	IN	Tempo de expiração da cobrança, em segundos
p_ModalidadeAlteracao	bool	IN	true = permite que o pagador altere o valor
p_CodStatusIn	int	IN	Nova situação a aplicar na revisão
p_CodStatus	int	OUT	Situação da cobrança (0 = Nenhum, 1 = Ativa, 2 = Concluída, 3 = Removida pelo usuário, 4 = Removida pelo PSP)
p_TxIdRet	string	OUT	TxId efetivamente gravado pelo PSP
p_Revisao	int	OUT	Número da revisão da cobrança
p_PixCopiaeCola	string	OUT	Código Pix copia e cola (BR Code)
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_QrCode	Byte[]	OUT	Imagem do QR Code em PNG
p_TxtRetorno	Byte[]	OUT	Retorno bruto do PSP em JSON

Retorno:bool — true quando a operação foi concluída com sucesso

CancelarCobrancaImediata

Cancela (remove) uma cobrança imediata

▾

Parâmetro	Tipo	Dir	Descrição
p_PSP	int	IN	Código do PSP (ver tabela de PSPs)
p_TxId	string	IN	Identificador da transação, definido pelo integrador (26 a 35 caracteres)
p_CodStatus	int	OUT	Situação da cobrança (0 = Nenhum, 1 = Ativa, 2 = Concluída, 3 = Removida pelo usuário, 4 = Removida pelo PSP)
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_TxtRetorno	Byte[]	OUT	Retorno bruto do PSP em JSON

Retorno:bool — true quando a operação foi concluída com sucesso

ConsultarCobrancasCob

Lista cobranças imediatas de um período

▾

Parâmetro	Tipo	Dir	Descrição
p_PSP	int	IN	Código do PSP (ver tabela de PSPs)
p_DataInicio	DateTime	IN	Data inicial do período
p_DataFim	DateTime	IN	Data final do período
p_CPFCNPJ	string	IN	CPF/CNPJ para filtrar o resultado (opcional)
p_Location	bool	IN	true = retorna também a location de cada cobrança
p_Status	int	IN	Filtra por situação da cobrança
p_PaginaAtual	int	IN	Página a retornar, iniciando em 0
p_ItensPorPagina	int	IN	Quantidade de itens por página
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_TxtRetorno	Byte[]	OUT	Retorno bruto do PSP em JSON

Retorno:bool — true quando a operação foi concluída com sucesso

Cobrança com vencimento (CobV)

CriarCobranca

Cria uma cobrança com vencimento (CobV), com juros, multa e desconto

▾

Parâmetro	Tipo	Dir	Descrição
p_PSP	int	IN	Código do PSP (ver tabela de PSPs)
p_ChavePix	string	IN	Chave Pix do recebedor
p_TxId	string	IN	Identificador da transação, definido pelo integrador (26 a 35 caracteres)
p_SolicitacaoPagador	string	IN	Texto exibido ao pagador no aplicativo do banco
p_ValorOriginal	decimal	IN	Valor da cobrança
p_DataVencimento	string	IN	Data de vencimento no formato AAAA-MM-DD
p_ValidadeAposVencto	int	IN	Dias em que a cobrança segue pagável após o vencimento
p_ModalidadeMulta	int	IN	1 = Valor fixo, 2 = Percentual
p_VlrOuPctMulta	decimal	IN	Valor ou percentual da multa, conforme a modalidade
p_ModalidadeJuros	int	IN	1 = Valor por dia, 2 = Percentual ao dia, 3 = Percentual ao mês, 4 = Percentual ao ano
p_VlrOuPctJuros	decimal	IN	Valor ou percentual dos juros, conforme a modalidade
p_ModalidadeAbatimento	int	IN	1 = Valor fixo, 2 = Percentual
p_VlrOuPctAbatimento	decimal	IN	Valor ou percentual do abatimento, conforme a modalidade
p_ModalidadeDesconto	int	IN	1 = Valor fixo até a data, 2 = Percentual até a data
p_VlrOuPctDesconto	decimal	IN	Valor ou percentual do desconto, conforme a modalidade
p_CPFCNPJDevedor	string	IN	CPF/CNPJ do devedor
p_DevedorNome	string	IN	Nome ou razão social do devedor
p_Observacoes	string	IN	Observações internas da cobrança
p_Referencia	string	IN	Referência interna do integrador
p_Revisada	bool	IN	true = registra a cobrança como revisão
p_CodStatus	int	OUT	Situação da cobrança (0 = Nenhum, 1 = Ativa, 2 = Concluída, 3 = Removida pelo usuário, 4 = Removida pelo PSP)
p_TxIdRet	string	OUT	TxId efetivamente gravado pelo PSP
p_Revisao	int	OUT	Número da revisão da cobrança
p_PixCopiaeCola	string	OUT	Código Pix copia e cola (BR Code)
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_QrCode	Byte[]	OUT	Imagem do QR Code em PNG
p_TxtRetorno	Byte[]	OUT	Retorno bruto do PSP em JSON

Retorno:bool — true quando a cobrança foi criada no PSP

ConsultarCobranca

Consulta uma cobrança com vencimento pelo TxId

▾

Parâmetro	Tipo	Dir	Descrição
p_PSP	int	IN	Código do PSP (ver tabela de PSPs)
p_TxId	string	IN	Identificador da transação, definido pelo integrador (26 a 35 caracteres)
p_Revisao	int	IN	Revisão a consultar (0 = revisão atual)
p_CodStatus	int	OUT	Situação da cobrança (0 = Nenhum, 1 = Ativa, 2 = Concluída, 3 = Removida pelo usuário, 4 = Removida pelo PSP)
p_PixCopiaeCola	string	OUT	Código Pix copia e cola (BR Code)
p_EndToEndId	string	OUT	EndToEndId do pagamento, quando a cobrança já foi paga
p_ValorPIX	decimal	OUT	Valor efetivamente pago
p_DhPix	string	OUT	Data/hora em que o Pix foi pago
p_InfoPagador	string	OUT	Mensagem informada pelo pagador no momento do pagamento
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_QrCode	Byte[]	OUT	Imagem do QR Code em PNG
p_TxtRetorno	Byte[]	OUT	Retorno bruto do PSP em JSON

Retorno:bool — true quando a cobrança foi localizada

RevisarCobranca

Altera uma cobrança com vencimento já criada, gerando nova revisão

▾

Parâmetro	Tipo	Dir	Descrição
p_PSP	int	IN	Código do PSP (ver tabela de PSPs)
p_ChavePix	string	IN	Chave Pix do recebedor
p_TxId	string	IN	Identificador da transação, definido pelo integrador (26 a 35 caracteres)
p_SolicitacaoPagador	string	IN	Texto exibido ao pagador no aplicativo do banco
p_ValorOriginal	decimal	IN	Valor da cobrança
p_DataVencimento	string	IN	Data de vencimento no formato AAAA-MM-DD
p_ValidadeAposVencto	int	IN	Dias em que a cobrança segue pagável após o vencimento
p_ModalidadeMulta	int	IN	1 = Valor fixo, 2 = Percentual
p_VlrOuPctMulta	decimal	IN	Valor ou percentual da multa, conforme a modalidade
p_ModalidadeJuros	int	IN	1 = Valor por dia, 2 = Percentual ao dia, 3 = Percentual ao mês, 4 = Percentual ao ano
p_VlrOuPctJuros	decimal	IN	Valor ou percentual dos juros, conforme a modalidade
p_ModalidadeAbatimento	int	IN	1 = Valor fixo, 2 = Percentual
p_VlrOuPctAbatimento	decimal	IN	Valor ou percentual do abatimento, conforme a modalidade
p_ModalidadeDesconto	int	IN	1 = Valor fixo até a data, 2 = Percentual até a data
p_VlrOuPctDesconto	decimal	IN	Valor ou percentual do desconto, conforme a modalidade
p_CPFCNPJDevedor	string	IN	CPF/CNPJ do devedor
p_DevedorNome	string	IN	Nome ou razão social do devedor
p_Observacoes	string	IN	Observações internas da cobrança
p_Referencia	string	IN	Referência interna do integrador
p_CodStatusIn	int	IN	Nova situação a aplicar na revisão
p_CodStatus	int	OUT	Situação da cobrança (0 = Nenhum, 1 = Ativa, 2 = Concluída, 3 = Removida pelo usuário, 4 = Removida pelo PSP)
p_TxIdRet	string	OUT	TxId efetivamente gravado pelo PSP
p_Revisao	int	OUT	Número da revisão da cobrança
p_PixCopiaeCola	string	OUT	Código Pix copia e cola (BR Code)
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_QrCode	Byte[]	OUT	Imagem do QR Code em PNG
p_TxtRetorno	Byte[]	OUT	Retorno bruto do PSP em JSON

Retorno:bool — true quando a operação foi concluída com sucesso

CancelarCobranca

Cancela (remove) uma cobrança com vencimento

▾

Parâmetro	Tipo	Dir	Descrição
p_PSP	int	IN	Código do PSP (ver tabela de PSPs)
p_TxId	string	IN	Identificador da transação, definido pelo integrador (26 a 35 caracteres)
p_CodStatus	int	OUT	Situação da cobrança (0 = Nenhum, 1 = Ativa, 2 = Concluída, 3 = Removida pelo usuário, 4 = Removida pelo PSP)
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_TxtRetorno	Byte[]	OUT	Retorno bruto do PSP em JSON

Retorno:bool — true quando a operação foi concluída com sucesso

ConsultarCobrancasCobV

Lista cobranças com vencimento de um período

▾

Parâmetro	Tipo	Dir	Descrição
p_PSP	int	IN	Código do PSP (ver tabela de PSPs)
p_DataInicio	DateTime	IN	Data inicial do período
p_DataFim	DateTime	IN	Data final do período
p_CPFCNPJ	string	IN	CPF/CNPJ para filtrar o resultado (opcional)
p_Location	bool	IN	true = retorna também a location de cada cobrança
p_Status	int	IN	Filtra por situação da cobrança
p_PaginaAtual	int	IN	Página a retornar, iniciando em 0
p_ItensPorPagina	int	IN	Quantidade de itens por página
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_TxtRetorno	Byte[]	OUT	Retorno bruto do PSP em JSON

Retorno:bool — true quando a operação foi concluída com sucesso

Pix recebidos e devoluções

ConsultarPix

Consulta um Pix recebido pelo EndToEndId

▾

Parâmetro	Tipo	Dir	Descrição
p_PSP	int	IN	Código do PSP (ver tabela de PSPs)
p_E2EId	string	IN	EndToEndId do Pix recebido
p_StatusPix	int	OUT	Situação do Pix
p_Valor	decimal	OUT	Valor devolvido
p_TxIdRet	string	OUT	TxId efetivamente gravado pelo PSP
p_TxtRetorno	Byte[]	OUT	Retorno bruto do PSP em JSON
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConsultarPixRecebidos

Lista os Pix recebidos em um período

▾

Parâmetro	Tipo	Dir	Descrição
p_PSP	int	IN	Código do PSP (ver tabela de PSPs)
p_DataInicio	DateTime	IN	Data inicial do período
p_DataFim	DateTime	IN	Data final do período
p_TxId	string	IN	Identificador da transação, definido pelo integrador (26 a 35 caracteres)
p_CPFCNPJ	string	IN	CPF/CNPJ para filtrar o resultado (opcional)
p_PaginaAtual	int	IN	Página a retornar, iniciando em 0
p_ItensPorPagina	int	IN	Quantidade de itens por página
p_TxtRetorno	Byte[]	OUT	Retorno bruto do PSP em JSON
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

SolicitarDevolucaoPix

Solicita a devolução total ou parcial de um Pix recebido

▾

Parâmetro	Tipo	Dir	Descrição
p_PSP	int	IN	Código do PSP (ver tabela de PSPs)
p_E2EId	string	IN	EndToEndId do Pix recebido
p_IdDevolucao	string	IN	Identificador da devolução, definido pelo integrador
p_Valor	decimal	IN	Valor a devolver
p_Natureza	string	IN	Natureza da devolução (conforme o Banco Central)
p_Descricao	string	IN	Descrição da devolução
p_StatusDev	int	OUT	Situação da devolução
p_RtrId	string	OUT	Identificador da devolução atribuído pelo Banco Central
p_TxtRetorno	Byte[]	OUT	Retorno bruto do PSP em JSON
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a devolução foi aceita pelo PSP

ConsultarDevolucaoPix

Consulta a situação de uma devolução solicitada

▾

Parâmetro	Tipo	Dir	Descrição
p_PSP	int	IN	Código do PSP (ver tabela de PSPs)
p_E2EId	string	IN	EndToEndId do Pix recebido
p_IdDevolucao	string	IN	Identificador da devolução, definido pelo integrador
p_StatusDev	int	OUT	Situação da devolução
p_RtrId	string	OUT	Identificador da devolução atribuído pelo Banco Central
p_Valor	decimal	OUT	Valor devolvido
p_TxtRetorno	Byte[]	OUT	Retorno bruto do PSP em JSON
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

QR Code estático

GerarQRCodeEstatico

Gera um QR Code estático, reutilizável para vários pagamentos

▾

Parâmetro	Tipo	Dir	Descrição
p_PSP	int	IN	Código do PSP (ver tabela de PSPs)
p_Valor	decimal	IN	Valor a devolver
p_InfoAdicional	string	IN	Informação adicional exibida no QR Code
p_TxId	string	IN	Identificador da transação, definido pelo integrador (26 a 35 caracteres)
p_PixCopiaeCola	string	OUT	Código Pix copia e cola (BR Code)
p_QrCode	Byte[]	OUT	Imagem do QR Code em PNG
p_TxtRetorno	Byte[]	OUT	Retorno bruto do PSP em JSON
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando o QR Code foi gerado

G GNRe

SOAP /ws/gnre.asmx

Guia Nacional de Recolhimento de Tributos Estaduais.

Método	Descrição
CertificadoUpload	Envia o certificado digital A1 usado na assinatura da GNRe
Config	Configura a UF e a empresa emitente
ConfigSW	Registra os dados da Software House integradora
GNReEnviar	Transmite a GNRe para a SEFAZ e devolve XML e PDF da guia
GNRePDF	Gera o PDF de uma GNRe já transmitida

Configuração

CertificadoUpload

Envia o certificado digital A1 usado na assinatura da GNRe

▾

Parâmetro	Tipo	Dir	Descrição
p_DocBin	Byte[]	IN	Conteúdo do certificado A1 (.pfx) em bytes
p_UF	string	IN	UF de recolhimento do tributo
p_ArquivoCertificado	string	IN	Nome do arquivo do certificado
p_SenhaCertificado	string	IN	Senha do certificado A1
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

Config

Configura a UF e a empresa emitente

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF de recolhimento do tributo
p_NomeEmpresa	string	IN	Razão social da empresa emitente
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConfigSW

Registra os dados da Software House integradora

▾

Parâmetro	Tipo	Dir	Descrição
p_SWCNPJ	string	IN	CNPJ da Software House
p_SWRazaoSocial	string	IN	Razão social da Software House
p_SWNomeFantasia	string	IN	Nome fantasia da Software House
p_SWSite	string	IN	Site da Software House
p_SWEmail	string	IN	E-mail de contato da Software House
p_SWFone	string	IN	Telefone de contato da Software House
p_SWResponsavel	string	IN	Nome do responsável técnico
p_SWSistema	string	IN	Nome do sistema integrador
p_SWVersao	string	IN	Versão do sistema integrador
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

Transmissão e impressão

GNReEnviar

Transmite a GNRe para a SEFAZ e devolve XML e PDF da guia

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF de recolhimento do tributo
p_TXTGNRe	Byte[]	IN	Conteúdo TXT/INI da GNRe no padrão ACBr
p_Email	string	IN	E-mail para envio da guia (opcional)
p_CodStatus	int	OUT	Código de status devolvido pela SEFAZ
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_NRec	string	OUT	Número do recibo da transmissão
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_XMLRet	Byte[]	OUT	XML de retorno da SEFAZ
p_PDFGNRe	Byte[]	OUT	PDF da guia GNRe

Retorno:bool — true quando a guia foi transmitida com sucesso

GNRePDF

Gera o PDF de uma GNRe já transmitida

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF de recolhimento do tributo
p_NotaFiscal	long	IN	Número da nota fiscal vinculada à guia
p_XMLGNRe	Byte[]	IN	XML da GNRe já transmitida
p_Regerar	bool	IN	true = regera o PDF mesmo que já exista
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro
p_PDFGNRe	Byte[]	OUT	PDF da guia GNRe

Retorno:bool — true quando o PDF foi gerado

M MDF-e

SOAP /ws/mdfe.asmx

Manifesto Eletrônico de Documentos Fiscais (modelo 58), que agrupa as NF-e e CT-e transportadas num mesmo veículo.

Parâmetros obrigatórios em toda chamada

p_CNPJSoftwareHouse	string	CNPJ da Software House cadastrada na API NeXT
p_CNPJCliente	string	CNPJ do cliente emitente
p_Token	string	Token de autenticação fornecido na contratação
p_Ambiente	int	`1` = Produção, `2` = Homologação, `3` = Simulação

Envio do documento

Os dados do manifesto são enviados num arquivo INI no padrão ACBr. Além do envio, o módulo cobre o encerramento da viagem (evento obrigatório), o cancelamento, a inclusão de condutor e de DF-e, e a geração do DAMDFE em PDF.

O detalhamento método a método, com parâmetros e retornos, está sendo publicado nesta página. Enquanto isso, a página do módulo traz os exemplos em VB6 e C#, e você pode falar com a gente para receber a relação completa dos métodos.

C CT-e

SOAP /ws/cte.asmx

Conhecimento de Transporte Eletrônico (modelo 57), documento fiscal da prestação do serviço de transporte de cargas. O documento auxiliar impresso é o DACTE. Os 4 parâmetros de autenticação valem para todos os métodos abaixo e não estão repetidos nas tabelas.

Método	Descrição
EnviarCTe	Transmite o CT-e para a SEFAZ, em lote ou de forma síncrona
ConsultaRecibo	Consulta o resultado do processamento de um lote pelo recibo
Consultar	Consulta a situação do CT-e pela chave, com ou sem os eventos
CTeXML	Devolve o XML autorizado do conhecimento
CTePDF	Gera o PDF do DACTE
EnviarEvento	Envia eventos do CT-e (carta de correção, EPEC e demais)
Cancelar	Cancela um CT-e autorizado, com justificativa
Inutilizar	Inutiliza uma faixa de numeração não utilizada
DistribuicaoDFePorChave	Baixa documentos de terceiros pela chave de acesso
DistribuicaoDFePorUltNSU	Baixa documentos novos a partir do último NSU lido
StatusServico	Consulta o status do serviço na SEFAZ
Disponibilidade	Verifica se a API está respondendo e se o token é válido

Emissão

EnviarCTe

Transmite o CT-e para a SEFAZ, em lote ou de forma síncrona

▾

Parâmetro	Tipo	Dir	Descrição
p_NumLote	long	IN	Número do lote de envio
p_TXT	Byte[]	IN	Conteúdo do CT-e em TXT/INI no padrão ACBr
p_Sincrono	bool	IN	`true` aguarda a autorização na mesma chamada; `false` devolve o recibo para consultar depois
p_Protocolo	string	OUT	Protocolo de autorização
p_CodStatus	int	OUT	Código de status devolvido pela SEFAZ
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_ChCTe	string	OUT	Chave de acesso do CT-e
p_XMLRetorno	Byte[]	OUT	XML de retorno da SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

ConsultaRecibo

Consulta o resultado do processamento de um lote pelo recibo

▾

Parâmetro	Tipo	Dir	Descrição
p_NRec	string	IN	Número do recibo devolvido no envio assíncrono
p_CodStatus	int	OUT	Código de status devolvido pela SEFAZ
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_XMLRetorno	Byte[]	OUT	XML de retorno da SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

Consulta e documentos

Consultar

Consulta a situação do CT-e pela chave, com ou sem os eventos

▾

Parâmetro	Tipo	Dir	Descrição
p_ChCTe	string	IN	Chave de acesso do CT-e
p_ExtrairEventos	bool	IN	`true` traz também os eventos vinculados ao documento
p_CodStatus	int	OUT	Código de status devolvido pela SEFAZ
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_Protocolo	string	OUT	Protocolo de autorização
p_XMLRetorno	Byte[]	OUT	XML de retorno da SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

CTeXML

Devolve o XML autorizado do conhecimento

▾

Parâmetro	Tipo	Dir	Descrição
p_ChCTe	string	IN	Chave de acesso do CT-e
p_XML	Byte[]	OUT	XML autorizado do conhecimento
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

CTePDF

Gera o PDF do DACTE

▾

Parâmetro	Tipo	Dir	Descrição
p_ChCTe	string	IN	Chave de acesso do CT-e
p_PDF	Byte[]	OUT	PDF do DACTE, pronto para impressão
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

Eventos

EnviarEvento

Envia eventos do CT-e (carta de correção, EPEC e demais)

▾

Parâmetro	Tipo	Dir	Descrição
p_NumLote	long	IN	Número do lote de envio
p_TXTEvento	Byte[]	IN	Conteúdo do evento em TXT/INI no padrão ACBr
p_CodStatus	int	OUT	Código de status devolvido pela SEFAZ
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_Protocolo	string	OUT	Protocolo de registro do evento
p_XMLRetorno	Byte[]	OUT	XML de retorno da SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

Cancelar

Cancela um CT-e autorizado, com justificativa

▾

Parâmetro	Tipo	Dir	Descrição
p_ChCTe	string	IN	Chave de acesso do CT-e a cancelar
p_Justificativa	string	IN	Motivo do cancelamento (mínimo de 15 caracteres)
p_CNPJEmitente	string	IN	CNPJ do emitente do conhecimento
p_NumLote	long	IN	Número do lote de envio
p_CodStatus	int	OUT	Código de status devolvido pela SEFAZ
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_Protocolo	string	OUT	Protocolo do cancelamento
p_XMLRetorno	Byte[]	OUT	XML de retorno da SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

Inutilizar

Inutiliza uma faixa de numeração não utilizada

▾

Parâmetro	Tipo	Dir	Descrição
p_CNPJEmitente	string	IN	CNPJ do emitente
p_Justificativa	string	IN	Motivo da inutilização (mínimo de 15 caracteres)
p_Ano	int	IN	Ano da numeração
p_Modelo	int	IN	Modelo do documento (`57` para CT-e)
p_Serie	int	IN	Série do documento
p_NumeroInicial	long	IN	Primeiro número da faixa
p_NumeroFinal	long	IN	Último número da faixa
p_CodStatus	int	OUT	Código de status devolvido pela SEFAZ
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_Protocolo	string	OUT	Protocolo da inutilização
p_XMLRetorno	Byte[]	OUT	XML de retorno da SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

Distribuição de DF-e

DistribuicaoDFePorChave

Baixa documentos de terceiros pela chave de acesso

▾

Parâmetro	Tipo	Dir	Descrição
p_cUFAutor	int	IN	Código IBGE da UF do autor da consulta
p_CNPJCPF	string	IN	CNPJ ou CPF do interessado
p_ChCTe	string	IN	Chave de acesso do documento
p_CodStatus	int	OUT	Código de status devolvido pela SEFAZ
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_XMLRetorno	Byte[]	OUT	XML de retorno da SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

DistribuicaoDFePorUltNSU

Baixa documentos novos a partir do último NSU lido

▾

Parâmetro	Tipo	Dir	Descrição
p_cUFAutor	int	IN	Código IBGE da UF do autor da consulta
p_CNPJCPF	string	IN	CNPJ ou CPF do interessado
p_UltNSU	string	IN	Último NSU lido; a SEFAZ devolve os documentos posteriores a ele
p_CodStatus	int	OUT	Código de status devolvido pela SEFAZ
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_XMLRetorno	Byte[]	OUT	XML de retorno da SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

Serviço

StatusServico

Consulta o status do serviço na SEFAZ

▾

Parâmetro	Tipo	Dir	Descrição
p_CodStatus	int	OUT	Código de status devolvido pela SEFAZ
p_DhRecbto	string	OUT	Data e hora do recebimento pela SEFAZ
p_XMotivo	string	OUT	Descrição do status devolvido pela SEFAZ
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a operação foi concluída com sucesso

Disponibilidade

Verifica se a API está respondendo e se o token é válido

▾

Parâmetro	Tipo	Dir	Descrição
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a API responde e o token é válido

D DC-e

SOAP /ws/dce.asmx

Declaração de Conteúdo eletrônica, usada no transporte de bens quando o remetente não é contribuinte do ICMS.

Parâmetros obrigatórios em toda chamada

p_CNPJSoftwareHouse	string	CNPJ da Software House cadastrada na API NeXT
p_CNPJCliente	string	CNPJ do cliente emitente
p_Token	string	Token de autenticação fornecido na contratação
p_Ambiente	int	`1` = Produção, `2` = Homologação, `3` = Simulação

Envio do documento

Os dados da declaração são enviados num arquivo INI no padrão ACBr, com remetente, destinatário e a relação de bens. O módulo cobre envio, consulta, cancelamento e a geração do documento auxiliar em PDF.

C NFCom

SOAP /ws/nfcom.asmx

Nota Fiscal Fatura de Serviço de Comunicação Eletrônica (modelo 62), que substitui os modelos 21 e 22.

Parâmetros obrigatórios em toda chamada

p_CNPJSoftwareHouse	string	CNPJ da Software House cadastrada na API NeXT
p_CNPJCliente	string	CNPJ do cliente emitente
p_Token	string	Token de autenticação fornecido na contratação
p_Ambiente	int	`1` = Produção, `2` = Homologação, `3` = Simulação

Envio do documento

A fatura é enviada num arquivo INI no padrão ACBr. O uso típico é o faturamento mensal de toda a base de assinantes, uma NFCom por assinante, dentro do laço de geração de faturas do seu sistema.

A NFAg

SOAP /ws/nfag.asmx

Nota Fiscal da Água e Saneamento Eletrônica, emitida por concessionárias e serviços autônomos de água.

Parâmetros obrigatórios em toda chamada

p_CNPJSoftwareHouse	string	CNPJ da Software House cadastrada na API NeXT
p_CNPJCliente	string	CNPJ do cliente emitente
p_Token	string	Token de autenticação fornecido na contratação
p_Ambiente	int	`1` = Produção, `2` = Homologação, `3` = Simulação

Envio do documento

A fatura é enviada num arquivo INI no padrão ACBr. O uso típico é o fechamento do ciclo de leitura, com a emissão de toda a base de consumidores de uma vez.

G NFGás

SOAP /ws/nfgas.asmx

Nota Fiscal Fatura de Fornecimento de Gás Canalizado, emitida por distribuidoras de gás.

Parâmetros obrigatórios em toda chamada

p_CNPJSoftwareHouse	string	CNPJ da Software House cadastrada na API NeXT
p_CNPJCliente	string	CNPJ do cliente emitente
p_Token	string	Token de autenticação fornecido na contratação
p_Ambiente	int	`1` = Produção, `2` = Homologação, `3` = Simulação

Envio do documento

A fatura é enviada num arquivo INI no padrão ACBr. O uso típico é o fechamento do ciclo de medição, com a emissão de toda a base de consumidores de uma vez.

F Financeiro

SOAP /ws/financeiro.asmx

Integração bancária do módulo financeiro: extrato para conciliação, débito automático e PagFor.

Parâmetros obrigatórios em toda chamada

p_CNPJSoftwareHouse	string	CNPJ da Software House cadastrada na API NeXT
p_CNPJCliente	string	CNPJ do cliente emitente
p_Token	string	Token de autenticação fornecido na contratação
p_Ambiente	int	`1` = Produção, `2` = Homologação, `3` = Simulação

Envio do documento

São três serviços no mesmo endpoint: extrato (consulta dos lançamentos da conta por período, para conciliar o contas a receber), débito automático (envio dos débitos autorizados e leitura do retorno) e PagFor (lote de pagamento a fornecedores). A API monta e interpreta os arquivos do banco, sem você tratar layout CNAB.

U Utilitários

SOAP /ws/nfeutil.asmx

Consultas cadastrais e tabelas fiscais para automatizar seu ERP.

Método	Descrição
CEP	Consulta o endereço a partir do CEP
CEPLog	Busca reversa: encontra o CEP a partir do logradouro
CNPJ	Consulta os dados cadastrais de um CNPJ na Receita Federal
GTINConsulta	Consulta o cadastro centralizado de GTIN/EAN da SEFAZ
NCMConsulta	Consulta a descrição de um código NCM
NCMLista	Devolve a tabela completa de NCM em arquivo
NCMLista2	Devolve a tabela completa de NCM como texto
CEST	Consulta a descrição de um código CEST
CESTLista	Devolve a tabela completa de CEST em arquivo
CESTLista2	Devolve a tabela completa de CEST como texto
CFOP	Consulta a descrição de um código CFOP
CFOPLista	Devolve a tabela completa de CFOP em arquivo
CFOPLista2	Devolve a tabela completa de CFOP como texto
IBPT	Baixa a tabela IBPT de uma UF (carga tributária aproximada)
IBPTVersao	Informa a versão vigente da tabela IBPT
MoedaCotacaoRetornar	Consulta a cotação de uma moeda em uma data
Email	Envia e-mail pelo servidor SMTP informado, com até 5 anexos
PDFHTML	Converte um documento HTML em PDF
PDFEnviarImagem	Envia uma imagem para ser referenciada na conversão HTML para PDF

Endereço e cadastro

CEP

Consulta o endereço a partir do CEP

▾

Parâmetro	Tipo	Dir	Descrição
p_CEP	string	IN	CEP a consultar (somente números)
p_UF	string	OUT	UF do endereço encontrado
p_TipoLogradouro	string	OUT	Tipo do logradouro encontrado
p_Logradouro	string	OUT	Logradouro encontrado
p_Bairro	string	OUT	Bairro encontrado
p_Municipio	string	OUT	Município encontrado
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a consulta retornou dados

CEPLog

Busca reversa: encontra o CEP a partir do logradouro

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF onde pesquisar
p_TipoLogradouro	string	IN	Tipo do logradouro a pesquisar
p_Logradouro	string	IN	Nome (ou parte) do logradouro a pesquisar
p_Bairro	string	IN	Bairro a pesquisar
p_Municipio	string	IN	Município a pesquisar
p_CEP	string	OUT	CEP encontrado
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a consulta retornou dados

CNPJ

Consulta os dados cadastrais de um CNPJ na Receita Federal

▾

Parâmetro	Tipo	Dir	Descrição
p_CNPJConsulta	string	IN	CNPJ a consultar (somente números)
p_RazaoSocial	string	OUT	Razão social
p_NomeFantasia	string	OUT	Nome fantasia
p_DataAbertura	string	OUT	Data de abertura da empresa
p_CNAE1	string	OUT	CNAE principal
p_CNAE2	string	OUT	CNAEs secundários
p_NaturezaJuridica	string	OUT	Natureza jurídica
p_EmpresaTipo	string	OUT	Tipo da empresa (Matriz ou Filial)
p_Endereco	string	OUT	Logradouro do endereço cadastral
p_Numero	string	OUT	Número do endereço
p_Complemento	string	OUT	Complemento do endereço
p_Bairro	string	OUT	Bairro encontrado
p_CEP	string	OUT	CEP encontrado
p_Municipio	string	OUT	Município encontrado
p_UF	string	OUT	UF do endereço encontrado
p_IE	string	OUT	Inscrição estadual
p_Situacao	string	OUT	Situação cadastral na Receita Federal
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a consulta retornou dados

Produto e tributação

GTINConsulta

Consulta o cadastro centralizado de GTIN/EAN da SEFAZ

▾

Parâmetro	Tipo	Dir	Descrição
p_EAN	string	IN	Código GTIN/EAN a consultar
p_CodStatus	int	OUT	Código de status devolvido pela SEFAZ
p_DhResp	string	OUT	Data/hora da resposta
p_XProd	string	OUT	Descrição do produto cadastrada no GTIN
p_CEST	string	OUT	CEST vinculado ao GTIN
p_NCM	string	OUT	NCM vinculado ao GTIN
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a consulta retornou dados

NCMConsulta

Consulta a descrição de um código NCM

▾

Parâmetro	Tipo	Dir	Descrição
p_NCM	string	IN	Código NCM a consultar
p_NCMOut	string	OUT	Código NCM normalizado
p_NCMDescricao	string	OUT	Descrição do NCM
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a consulta retornou dados

NCMLista

Devolve a tabela completa de NCM em arquivo

▾

Parâmetro	Tipo	Dir	Descrição
p_NCMLista	Byte[]	OUT	Tabela NCM completa
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a consulta retornou dados

NCMLista2

Devolve a tabela completa de NCM como texto

▾

Parâmetro	Tipo	Dir	Descrição
p_NCMLista	string	OUT	Tabela NCM completa
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a consulta retornou dados

CEST

Consulta a descrição de um código CEST

▾

Parâmetro	Tipo	Dir	Descrição
p_CEST	string	IN	Código CEST a consultar
p_CESTDescricao	string	OUT	Descrição do CEST
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a consulta retornou dados

CESTLista

Devolve a tabela completa de CEST em arquivo

▾

Parâmetro	Tipo	Dir	Descrição
p_CESTTabela	Byte[]	OUT	Tabela CEST completa
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a consulta retornou dados

CESTLista2

Devolve a tabela completa de CEST como texto

▾

Parâmetro	Tipo	Dir	Descrição
p_CESTTabela	string	OUT	Tabela CEST completa
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a consulta retornou dados

CFOP

Consulta a descrição de um código CFOP

▾

Parâmetro	Tipo	Dir	Descrição
p_CFOP	string	IN	Código CFOP
p_CFOPDescricao	string	OUT	Descrição do CFOP
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a consulta retornou dados

CFOPLista

Devolve a tabela completa de CFOP em arquivo

▾

Parâmetro	Tipo	Dir	Descrição
p_CFOPTabela	Byte[]	OUT	Tabela CFOP completa
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a consulta retornou dados

CFOPLista2

Devolve a tabela completa de CFOP como texto

▾

Parâmetro	Tipo	Dir	Descrição
p_CFOPTabela	string	OUT	Tabela CFOP completa
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a consulta retornou dados

IBPT

Baixa a tabela IBPT de uma UF (carga tributária aproximada)

▾

Parâmetro	Tipo	Dir	Descrição
p_UF	string	IN	UF onde pesquisar
p_Versao	string	IN	Versão da tabela IBPT desejada (vazio = mais recente)
p_IBPTTabela	Byte[]	OUT	Tabela IBPT da UF informada
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a consulta retornou dados

IBPTVersao

Informa a versão vigente da tabela IBPT

▾

Parâmetro	Tipo	Dir	Descrição
p_Versao	string	OUT	Versão vigente da tabela IBPT
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a consulta retornou dados

Câmbio

MoedaCotacaoRetornar

Consulta a cotação de uma moeda em uma data

▾

Parâmetro	Tipo	Dir	Descrição
p_MoedaSimbolo	string	IN	Símbolo da moeda (ex.: USD, EUR)
p_DiaCotacao	int	IN	Dia da cotação
p_MesCotacao	int	IN	Mês da cotação
p_AnoCotacao	int	IN	Ano da cotação
p_ValorCotacaoCompra	decimal	OUT	Cotação de compra
p_ValorCotacaoVenda	decimal	OUT	Cotação de venda
p_DataHoraCotacao	string	OUT	Data/hora da cotação
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a consulta retornou dados

E-mail e PDF

Email

Envia e-mail pelo servidor SMTP informado, com até 5 anexos

▾

Parâmetro	Tipo	Dir	Descrição
p_Host	string	IN	Servidor SMTP
p_User	string	IN	Usuário de autenticação SMTP
p_Password	string	IN	Senha de autenticação SMTP
p_Port	int	IN	Porta do servidor SMTP
p_NomeRemetente	string	IN	Nome exibido como remetente
p_EmailRemetente	string	IN	E-mail do remetente
p_EmailDestinatario	string	IN	E-mail do destinatário
p_CC	string	IN	Destinatários em cópia
p_CCo	string	IN	Destinatários em cópia oculta
p_ReplyTo	string	IN	Endereço de resposta
p_Titulo	string	IN	Assunto da mensagem
p_Msg	string	IN	Corpo da mensagem
p_MsgArq	Byte[]	IN	Corpo da mensagem lido de um arquivo
p_Prioridade	int	IN	Prioridade do e-mail
p_Notificacao	bool	IN	true = solicita confirmação de leitura
p_Html	bool	IN	true = envia o corpo da mensagem em HTML
p_SemRodape	bool	IN	true = omite o rodapé padrão
p_SSL	bool	IN	true = usa conexão segura (SSL/TLS)
p_Anexo1	Byte[]	IN	Primeiro anexo
p_Anexo2	Byte[]	IN	Segundo anexo
p_Anexo3	Byte[]	IN	Terceiro anexo
p_Anexo4	Byte[]	IN	Quarto anexo
p_Anexo5	Byte[]	IN	Quinto anexo
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando o e-mail foi aceito pelo servidor SMTP

PDFHTML

Converte um documento HTML em PDF

▾

Parâmetro	Tipo	Dir	Descrição
p_HTML	Byte[]	IN	Conteúdo HTML a converter em PDF
p_PDF	Byte[]	OUT	PDF gerado
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando o PDF foi gerado

PDFEnviarImagem

Envia uma imagem para ser referenciada na conversão HTML para PDF

▾

Parâmetro	Tipo	Dir	Descrição
p_NomeImagem	string	IN	Nome com que a imagem será referenciada no HTML
p_Imagem	Byte[]	IN	Conteúdo da imagem em bytes
p_MsgRetorno	string	OUT	Mensagem de retorno ou descrição do erro

Retorno:bool — true quando a imagem foi armazenada

L Layout dos arquivos de envio

NF-e, NFS-e, Boleto e GNRe são enviados como um arquivo INI no padrão do ACBrLib. O conteúdo do INI vai no parâmetro de arquivo do método correspondente. Os modelos completos, com todas as seções e campos, estão na documentação oficial do ACBr — os links abaixo abrem em nova aba.

Regras comuns a todos os INIs

Seções entre colchetes e um campo por linha (Campo=Valor). Codificação Windows-1252. Datas no formato dd/MM/yyyy e valores decimais com vírgula (1234,56) — exceto a GNRe, que usa ponto. Campos sem valor podem ser omitidos. Seções que se repetem usam sufixo numérico sequencial a partir de 1 — [Produto001], [Titulo1] — e a numeração precisa casar entre as seções do mesmo item.

Modelos oficiais por documento

Documento	Parâmetro	Modelos na documentação do ACBr
NF-e / NFC-e	p_TXTNFe	Preenchimento do arquivo .INI Índice de todos os modelos Modelo NFe.INI Modelo NFe.INI — Reforma Tributária Modelo 1 — NFCe.INI Modelo 1 — NFCe.INI — Reforma Tributária Modelo 2 — NFCe.INI Modelo 2 — NFCe.INI — Reforma Tributária
NFS-e	p_TXT	Modelo NFSe.INI — Padrão Nacional Modelo NFSe.INI — Padrão Nacional — Reforma Tributária
Boleto	p_ArquivoIni	Informações gerais Modelo Cedente.INI Modelo Cedente_Titulos.INI
GNRe	p_TXTGNRe	Modelo Gerar Guia INI

Métodos que recebem o INI

Método	Parâmetro
EnviarNFeTXT	INI da NF-e ou NFC-e como `string`
EnviarNFeTXTObj	INI da NF-e ou NFC-e como `byte[]`
EnviarNFeTXTObj2	INI da NF-e ou NFC-e como `byte[]`, com lote `Int64`
EnviarNFSe	INI da DPS que origina a NFS-e
CancelarNFSe	INI com os dados do cancelamento
EnviarBoleto	INI com cedente, conta, banco e títulos
BoletoGerarPDF	Mesmo INI do envio, só para gerar o PDF
GerarRemessa	Mesmo INI do envio, para gerar o arquivo de remessa CNAB
GNReEnviar	INI da guia de recolhimento

I Formas de integração

Além de consumir o SOAP diretamente, a API NeXT disponibiliza duas bibliotecas e dois executáveis. Todos expõem os mesmos 126 métodos documentados acima, com os mesmos parâmetros — muda apenas a forma de chamar.

Camada	Indicada para	Requisito
SOAP direto	Qualquer linguagem com suporte a WebService	Nenhum
DLL .NET	C#, VB.NET, aplicações .NET Framework 4.8	.NET Framework 4.8
DLL VB6	Visual Basic 6, Delphi, Clipper e outros via COM	SOAP Toolkit 3.0
Executável .NET	Qualquer linguagem, via linha de comando	.NET Framework 4.8
Executável VB6	Linha de comando em Windows sem .NET	SOAP Toolkit 3.0

Qual escolher

Em Windows antigos, onde instalar o .NET Framework não é viável, use a DLL VB6 ou o executável VB6 — ambos dependem apenas do SOAP Toolkit 3.0, que é leve e roda desde o Windows 2000. Os dois executáveis aceitam exatamente os mesmos argumentos e produzem o mesmo arquivo INI de retorno, então trocar um pelo outro não exige alterar a integração.

Pré-requisitos

Componente	Necessário para	Onde obter
.NET Framework 4.8	DLL .NET e ApiNeXTCli.Net.exe	Download no site da Microsoft
SOAP Toolkit 3.0	DLL VB6 e ApiNeXTCli.Vb6.exe	Acompanha o instalador da DLL VB6

O .NET Framework 4.8 já vem instalado no Windows 10 (a partir da versão 1903), no Windows 11 e no Windows Server 2019/2022 — nesses sistemas não é preciso instalar nada. Em versões anteriores, use o link acima.

O Microsoft SOAP Toolkit 3.0 teve o suporte encerrado pela Microsoft e não está mais disponível no site dela. Por isso ele acompanha o instalador da DLL VB6, que já o registra na máquina — não é necessário procurá-lo à parte.

N DLL .NET

ASSEMBLY ApiNeXT.Net.dll

Biblioteca para .NET Framework 4.8. Cada módulo é uma classe, e cada método devolve bool com a mensagem em p_MsgRetorno.

Classes disponíveis

Classe	Módulo	Métodos
clsNFe	NF-e / NFC-e / MD-e	42
clsPix	Pix	33
clsNFSe	NFS-e	20
clsNFeUtil	Utilitários	19
clsBoleto	Boletos	7
clsGNRe	GNRe	5

Instalação

Adicione a referência a ApiNeXT.Net.dll no seu projeto e importe o namespace DLL_ApiNeXT. Nenhum registro em COM ou GAC é necessário.

Tipos

No WebService	Na DLL	Observação
string	string
int / long	int / Int64
decimal	decimal
dateTime	DateTime
base64Binary	Byte[]	XML, PDF, QR Code e arquivos de entrada

Parâmetros Byte[] de saída chegam vazios (um único byte 0) quando a operação não produziu conteúdo — teste Length > 1 antes de gravar.

Exemplo — criar cobrança Pix e gravar o QR Code

using DLL_ApiNeXT;

clsPix _Pix = new clsPix();

bool _ok = _Pix.CriarCobrancaImediata(
    "11222333000181",            // CNPJ Software House
    "99888777000100",            // CNPJ Cliente
    _token,                      // Token
    2,                           // Ambiente: 2 = Homologação
    (int)clsNeXT.PSP.pspBradesco,
    _chavePix, _txId, "Pedido 1234", 150.00m,
    _cpfCnpjDevedor, _nomeDevedor, "", "",
    3600,                        // expiração em segundos
    false, false,
    out int _codStatus, out string _txIdRet, out int _revisao,
    out string _copiaeCola, out string _msg,
    out byte[] _qrCode, out byte[] _txtRetorno);

if (_ok)
{
    Console.WriteLine("TxId gerado : " + _txIdRet);
    Console.WriteLine("Copia e Cola: " + _copiaeCola);

    if (_qrCode.Length > 1)
        File.WriteAllBytes(@"C:\pix\qrcode.png", _qrCode);
}
else
{
    Console.WriteLine("Erro: " + _msg);
}

Endpoint utilizado

O endereço de cada serviço é fixo, em https://apinext.com.br/ws/, e atende produção, homologação e simulação — o que seleciona o ambiente é o parâmetro p_Ambiente de cada chamada.

V DLL VB6

ACTIVEX ApiNeXT.Vb6.dll

Biblioteca ActiveX para Visual Basic 6 e outras linguagens com suporte a COM. Mesmas 6 classes e 126 métodos da versão .NET.

Pré-requisito

Exige o Microsoft SOAP Toolkit 3.0 registrado na máquina. Ele acompanha o instalador da DLL VB6, que já o registra — a Microsoft descontinuou o componente e não o distribui mais.

Se por algum motivo ele não estiver presente, toda chamada devolve false com a mensagem "Microsoft SOAP Toolkit 3.0 não instalado nesta máquina." (erro ActiveX 429).

Instalação

Execute o instalador da DLL VB6 — ele registra a ApiNeXT.Vb6.dll e o SOAP Toolkit 3.0. Depois, adicione a referência ao seu projeto em Project > References, escolhendo ApiNeXT na lista.

Para registrar manualmente, use regsvr32 ApiNeXT.Vb6.dll. Durante o desenvolvimento também é possível abrir o grupo ApiNeXTDemo.Vb6.vbg, que carrega a DLL e o projeto de demonstração juntos.

Equivalência de tipos

No WebService	No VB6	Observação
string	String
int / long	Long	32 bits — suficiente para lotes e numeração de notas
decimal	Currency	Use `CCur()` ao passar valores calculados
dateTime	Date
base64Binary	Byte()	Sempre `ByRef`: arrays não podem ser passados por valor

Funções auxiliares

O módulo modApiNeXT traz os conversores entre arquivo e Byte(), além dos enums (ApiNeXT_PSP, ApiNeXT_PixStatus, ApiNeXT_PixTipoChave, ApiNeXT_Ambiente).

Função	Uso
ArquivoParaBytes	Lê um arquivo do disco para os parâmetros de entrada (TXT, INI, certificado)
BytesParaArquivo	Grava em disco o retorno binário (XML, PDF, QR Code). Devolve False quando não há conteúdo
BytesParaTexto	Converte para String o retorno textual (INI ou JSON)

Exemplo — criar cobrança Pix e gravar o QR Code

Dim objPix          As New clsPix
Dim blnOk           As Boolean
Dim lngCodStatus    As Long
Dim strTxIdRet      As String
Dim lngRevisao      As Long
Dim strCopiaeCola   As String
Dim strMsg          As String
Dim bytQrCode()     As Byte
Dim bytTxtRetorno() As Byte

blnOk = objPix.CriarCobrancaImediata("11222333000181", "99888777000100", strToken, 2, _
                                     pspBradesco, strChavePix, strTxId, "Pedido 1234", CCur(150), _
                                     strCPFCNPJ, strNomeDevedor, "", "", 3600, False, False, _
                                     lngCodStatus, strTxIdRet, lngRevisao, strCopiaeCola, strMsg, _
                                     bytQrCode, bytTxtRetorno)

If blnOk Then
    Debug.Print "TxId gerado : " & strTxIdRet
    Debug.Print "Copia e Cola: " & strCopiaeCola
    Call BytesParaArquivo(bytQrCode, "C:\pix\qrcode.png")
Else
    Call MsgBox(strMsg, vbExclamation)
End If

Set objPix = Nothing

Endpoint utilizado

O endereço de cada serviço é fixo e fica nas constantes do módulo modApiNeXT (cURLNFE, cURLNFSE, cURLPIX, cURLBOLETO, cURLGNRE, cURLNFEUTIL). O mesmo endereço atende produção, homologação e simulação — o que seleciona o ambiente é o parâmetro p_lngAmbiente de cada chamada.

E Executável (linha de comando)

CLI ApiNeXTCli.Net.exe | ApiNeXTCli.Vb6.exe

Permite chamar qualquer um dos 126 métodos sem referenciar biblioteca alguma — útil para linguagens sem suporte a COM ou .NET. O resultado é gravado num arquivo INI.

Duas versões, mesma interface

Executável	Requisito	Quando usar
ApiNeXTCli.Net.exe	.NET Framework 4.8	Padrão em Windows atuais
ApiNeXTCli.Vb6.exe	SOAP Toolkit 3.0	Windows antigos, sem .NET instalado

Os dois aceitam os mesmos argumentos, as mesmas abreviações e gravam o INI no mesmo formato. Os exemplos abaixo valem para ambos — basta trocar o nome do executável.

Sintaxe

ApiNeXTCli.Net.exe /funcao:<modulo> /metodo:<metodo> [/p_Parametro:valor ...]
                [/path:<pasta>] [/retorno:<arquivo.ini>]

Argumento	Descrição
/funcao	Módulo: `nfe`, `nfse`, `pix`, `boleto`, `gnre` ou `nfeutil`
/metodo	Nome do método, exatamente como na documentação acima
/p_Xxx	Qualquer parâmetro do método, pelo nome. Parâmetros `Byte[]` recebem o caminho de um arquivo
/path	Pasta onde gravar os retornos binários (XML, PDF, QR Code)
/retorno	Arquivo INI de resultado. Sem ele, a saída vai para o console

Descobrindo métodos e parâmetros

O próprio executável lista o que está disponível, sem precisar consultar esta página:

ApiNeXTCli.Net.exe                              > ajuda geral e lista de funções
ApiNeXTCli.Net.exe /funcao:pix /metodo:?        > lista os 33 métodos de Pix
ApiNeXTCli.Net.exe /funcao:pix /metodo:CriarCobrancaImediata?
                                             > lista entradas e saídas do método

Arquivo de retorno

O INI traz uma seção com o nome do método e uma linha por parâmetro de saída (sem o prefixo p_). Retornos binários são gravados em /path e o INI informa o caminho.

[StatusServico]
Sucesso=True
CodStatus=107
DhRecbto=2026-08-07T14:22:31-03:00
XMotivo=Servico em Operacao
Retorno=

Chave	Conteúdo
Sucesso	`True` ou `False` — o retorno booleano do método
Retorno	A mensagem de `p_MsgRetorno`
Path<Nome>	Caminho do arquivo gravado para cada saída binária
PathXML / PathPDF	Chaves adicionais, para compatibilidade com integrações antigas

Código de saída

Código	Significado
0	Operação concluída com sucesso
10	A operação retornou falha — consulte `Retorno` no INI
-1	Ajuda exibida: função ou método ausente ou inválido

Exemplos

REM Status do serviço da SEFAZ-SP
ApiNeXTCli.Net.exe /funcao:nfe /metodo:StatusServico ^
    /cnpjsw:11222333000181 /cnpj:99888777000100 /token:SEU_TOKEN /amb:2 ^
    /retorno:C:\api\ret.ini

REM Transmitir NF-e a partir de um TXT e receber XML e PDF
ApiNeXTCli.Net.exe /funcao:nfe /metodo:EnviarNFeTXTObj ^
    /cnpjsw:11222333000181 /cnpj:99888777000100 /token:SEU_TOKEN /amb:2 ^
    /uf:SP /lote:1 /pathtxt:C:\api\nfe.txt /tpdanfe:1 ^
    /path:C:\api\saida /retorno:C:\api\ret.ini

REM Criar cobrança Pix
ApiNeXTCli.Net.exe /funcao:pix /metodo:CriarCobrancaImediata ^
    /cnpjsw:11222333000181 /cnpj:99888777000100 /token:SEU_TOKEN /amb:2 ^
    /psp:0 /txid:PEDIDO0001 /vlr:150,00 /expira:3600 ^
    /path:C:\api\saida /retorno:C:\api\ret.ini

Abreviações aceitas

Além de /p_NomeDoParametro, o executável aceita abreviações para os parâmetros mais usados. Elas são resolvidas conforme o método chamado — /lote, por exemplo, alimenta p_IdLote na NF-e e p_NumLote na NFS-e.

Abreviação	Parâmetro	Abreviação	Parâmetro
/cnpjsw	p_CNPJSoftwareHouse	/txid	p_TxId
/cnpj	p_CNPJCliente	/psp	p_PSP
/token	p_Token	/chpix	p_ChavePix
/amb	p_Ambiente	/vlr	p_ValorOriginal
/uf	p_UF	/expira	p_Expiracao
/chnfe	p_ChNFe	/e2eid	p_E2EId
/lote	p_IdLote / p_NumLote	/iddevolucao	p_IdDevolucao
/serie	p_Serie	/dtini	p_DataInicio
/nf	p_NumeroNF / p_NumNFSe	/dtfim	p_DataFim
/nprot	p_NProt / p_Protocolo	/nsu	p_NSU
/just	p_XJust	/sit	p_Situacao
/pathtxt	p_TXTNFe / p_ArquivoIni	/pathxml	p_XMLNFe
/pathpfx	p_ArquivoCertificado	/pfxpwd	p_SenhaCertificado
/email	p_Email	/tpdanfe	p_DANFeTipo

São 58 abreviações no total. Se preferir, use sempre o nome completo do parâmetro — ele tem prioridade sobre a abreviação.

APINeXT — Documentação

A Autenticação

Parâmetros obrigatórios em toda chamada

E Endpoints

N NF-e / NFC-e

Configuração

Disponibilidade

CertificadoUpload

Config

ConfigEmail

ConfigParams

ConfigModeloDANFe

ConfigSoftwareHouse

NFeLogotipoEnviar

NFeLogotipoExcluir

Emissão e envio

ChaveAcessoGerar

EnviarNFeTXT

EnviarNFeTXTObj

EnviarNFeTXTObj2

EnviarNFeXML

EnviarNFeXMLObj

Eventos

Cancelamento

CartaCorrecao

CartaCorrecaoObj

Inutilizacao

Consultas

StatusServico

ConsultaSituacao

ConsultaRecibo

ConsultaCadastro

Impressão, XML e e-mail

NFePDF

NFePDFEvento

NFePDFInutilizacao

NFeXML

NFeEmailEnvio

Tabelas fiscais

GTINConsulta

NCMConsulta

NCMLista

NCMLista2

CESTLista

CESTLista2

IBPT

IBPTVersao

M Manifestação do Destinatário (MD-e)

Eventos de manifestação

CienciaOperacao

ConfirmacaoOperacao

DesconhecimentoOperacao

OperacaoNaoRealizada

ManifestacaoDestinatario

Distribuição de documentos (DFe)

ConsultaNFeRecebida

S NFS-e

Configuração

CertificadoUpload

Config

ConfigParams

ConfigParamsWS

NFSeLogotipoEnviar

NFSeLogotipoExcluir

InformacoesProvedor

Emissão e cancelamento

EnviarNFSe

CancelarNFSe

Consultas

ConsultaNFSe

ConsultaNFSeRPS

ConsultaRPSLote

ConsultaSituacao

ConsultarEvento

Serviços tomados

ConsultaServicoTomado

ConsultaServicoTomadoADN

ConsultaServicoTomadoADNEventos

Impressão e XML

NFSePDF