Mastersafdfev 3

FORMAT: 1A
HOST: http://localhost:8080/webservice/api/
# MASTERSAF DFE - Manual API
Esta documentação detalha os endpoints disponíveis para integração webservice do

Mastersaf DFE.
## Validação usuários webservice
É feita uma validação de usuários webservice (qualquer usuário utilizado na

requisição webservice, independente se é administrador, integrador ou não), para
que a cada 5 tentativas de login sem sucesso no intervalo de tempo de 30 segundos,
seja bloqueado o usuário por 30 minutos.
## Listagem e paginação
Os endpoints da API que retornam uma listagem são paginados (getListagem e getLog).
Para navegar entre as páginas há 2 parâmetros:
- **maxResults**: quantidade de objetos por página. O maxResults deve ser um valor
numérico entre 1 e 100, caso seja omitido será utilizado o valor padrão: 10.
- **offset**: posição do objeto a partir do qual a página deve ser carregada. O
objeto inicial possui a posição 0.
Estes dois parâmetros (acima) serão mostrados no response da consulta também.
No response existem 2 atributos que podem ser utilizados para controle de

paginação:
- **count**: quantia total de itens para os filtros informados
- **hasMore**: indica se há mais uma página a ser buscada para os filtros
informados.
Por *exemplo*, utilizando maxResults 10 e offset 0 será retornada a primeira página

com 10 objetos. Utilizando maxResults 10 e offset 10 trará a segunda página,
maxResults 10 e offset 20 a terceira página, e assim por diante.
## Listagem de Erros
- 203: Usuário e senha sem permissão de acessar o método/dados da empresa.

- 400: Erros de validação/parser/argumentos ilegais descritos no Response Body.
- 403: Forbidden: Usuário e senha não foram informados corretamente.
- 404: Não encontrado.
- 412: JSON nao informado ou invalido ou nenhuma ação (campo action) encontrada.
- 415: Unsupported Media Type - Métodos-type não foi informado corretamente.
- 500: Erro interno.
Mais informações sobre os códigos de retorno podem ser encontradas em:

"http://en.wikipedia.org/wiki/List_of_http_status_codes"
## Suporte Técnico
[link-zendesk]: https://atendimentotr.zendesk.com/
Se mesmo após ler a documentação restarem dúvidas ou encontrar algum problema,
abra um chamado na Central de Ajuda diretamente através deste link: [Onesource

Mastersaf - Suporte Geral][link-zendesk] ou entre em contato com nossa equipe de
Suporte Técnico pelo Telefone:
Central Telefônica: (11) 4700-9050
Selecionar:
Opção 4 – Suporte a produtos
Opção 2 - ONESOURCE MASTERSAF
Opção 2 – Documentos Fiscais Eletrônicos (DFE)
Nosso horário de atendimento é de segunda a sexta-feira das 9h às 18h.
## accessToken [/login]
### Gerar Login (accessToken) [POST]
Endpoint de login para utilizar a chave secreta do usuário e retornar um token JWT.
Após a autenticação ser feita, você receberá um token. Utilize o token de acesso
recebido para as chamadas subsequentes inserindo-o no header da requisição.
"Bearer". Esse token tem um tempo de expiração (response body) e deverá ser gerado
um novo após a expiração.
### Exemplos URL (Requisição)

http://localhost:8080/webservice/api/login (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/login (ambiente de homologação do SaaS)
### Autenticação
Não é preciso utilizar autenticação para fazer requisições a esta API.
### Tratamento de dados

Todos os dados enviados e recebidos pela API estão/deverão ser em formato JSON
(application/json).
+ Request (application/json)
+ Attributes (request)
+ nomeUsuario (required) - Login do usuário de integração
+ chave (required) - Chave gerada e copiada do cadastro do usuário de
integração
+ Body
{
"nomeUsuario": "integrador",
"chave":
"tGA3AWFXdOTxy8bQ5x+RhbgYhU56y2G3gUpPGomf46JEqvcuIwtgJKvkOqC13tb9lrHnv4tNsl07yI+5Yp
hj+w=="
}
+ Response 200 (application/json)
+ Attributes (response)
+ accessToken - Token de acesso

+ tokenType - Tipo do token
+ expiresIn (number) - Mostra o tempo que falta para expiração do token, em
minutos. A expiração ocorre diariamente. A regra de tempo do token considera sempre
o final do dia (hora 24:00), ou seja, o campo "expiresIn" sempre retorna a
quantidade em minutos restantes para expiração do token no momento da solicitação,
por exemplo se for solicitado o token às 23:59, o campo "expiresIn" seria retornado
com o valor de 1 (minuto para expiração).
+ Headers
+ Body
{
"accessToken":
"eyJhbGciOiJSUzUxMiJ9.eyJleHAiOjE2MTc3NjQzODYsImp0aSI6InF3bGsxSzdUMXBMQ0hWMkNYak11a
3ciLCJpYXQiOjE2MTc3NDgzNjYsIm5iZiI6MTYxNzc0ODI0NiwiaXNzIjoiREYtZV93ZWJzZXJ2aWNlIiwi
c3ViIjoiZWxhaW5lbWFjaGFkbyJ9.T3JelpR6pI-BNIHs3-cH403PywBwNrp-
hcNU5aHFS05Br7TyOF24zUWnHa09T7bQiA3SUWXnyq4jaAhyQ1dAplOAU6m0LW0mv-
dc_nvtZFdV24AVveaLCkUu1ejMWDcxOte-Y1br_l9urlSbuZ13iLLW76kaiWMwG1b6yU1lvGu5bgHN-
pb1n_d71_ckN5GSybgrVJ2TSOKBEM4Fqnqx9fXCJUJg5V3hhL1WXAdIUUb-
zUZy9Yka6RW31OuZCeaIkPHwXfT_2VXeQRnbTeGSRh8NKa1vedb7oKC3mDGNby2wNR7Xf9R2tN6djQ3feFV
wB7VmB5ck53oqYOGdvIEOqQ",
"tokenType": "Bearer",
"expiresIn": 267
}
# Group NFE
Resumindo o processo, primeiramente, é enviado um pacote de dados; depois é feita

uma consulta recebendo uma lista de ids e, então por fim, marcam-se no sistema os
ids consultados para que numa próxima consulta
eles não sejam retornados novamente.
Para todos os requests é preciso usar basic authentication (utilizando o usuário e
a senha fornecidos) ou token. Com isso, basta realizar POST para enviar os pacotes
e GET para consultar o resultado do processamento. O corpo do POST (request body)
deve ser um json contendo uma tag “action” e uma tag “txt_conteudo”.O txt_conteudo
é formado por um objeto json, cujo atributo “xml” deve ser preenchido com o xml
padrão SEFAZ.
## POST [/nfe]
### Enviar Pacote [POST]
Método para envio de NF-es para serem autorizadas pela Sefaz correspondente.
### Exemplos URL

http://localhost:8080/webservice/api/nfe (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/nfe (ambiente de homologação do SaaS)
### Permissões
Permissões conforme cadastro de usuários. O usuário informado na requisição deve

possuir ao menos uma destas permissões:
+ NF-e Integrador (ROLE_NFE_INTEGRADOR)
+ Administrar o sistema (ROLE_SUPER_ADMIN)

Todos os dados recebidos pela API estão/deverão ser em formato JSON
(application/json).
### Autenticação
+ access_token: seu_token
OU
+ basic_auth: username e password
### Retorno Erro
Response Body: {"result":"<descrição do erro>"}
Http status: 203, 400, 412, 500.
*Consultar título LISTAGEM DE ERROS para maiores informações sobre os erros.
+ Headers
access_token: seu_token
basic_auth: username e password
+ Attributes (emissaoNfeRequest)
+ Body
Exemplo formato TXT:

{"action": "EnviarPacote","referencia":
"arquivo_integrador_20160802113423.txt","ids": null,"txt_conteudo": {"xml": "--
nota_ini--;--versao_Layout_DFe_ini--;1.20;--versao_Layout_DFe_fim--;--
inf_NFe_ini--;4.00;;--inf_NFe_fim--;--
param_gerais_ini--;impressora_hp1;123456;1;Marcos Pessoa;busca1 uso interno;--
param_gerais_fim--;--ide_ini--;43;00001004;Venda de mercadoria adquirida ou
recebida;55;404;102;2017-10-26T06:30:00-02:00;2017-10-26T06:30:00-
02:00;1;1;4309209;0;1;;2;1;1;0;1;0;Msafdfe;--x_contingencia_ini--;;;--
x_contingencia_fim--;--nfReferenciada_ini--;--ref_NFe_ini--;;;;;;;--
ref_NFe_fim--;--ref_NFP_ini--;;;;;;;;;--ref_NFP_fim--;;--ref_ECF_ini--;;;;--
ref_ECF_fim--;--nfReferenciada_fim--;--ide_fim--;--emit_ini--;00910509000171;;TSL -
DFE RS;TSL - DFE RS;--ender_Emit_ini--;Rua das Araucárias;345;Próx.
Liga;Centro;4309209;Goiandira;RS;78945612;1058;Brasil;47999899796;--
ender_Emit_fim--;0018000282;;--x_emitente_ini--;123456;6123457;--
x_emitente_fim--;3;--emit_fim--;--avulsa_ini--;;;;;;;;;;;;--avulsa_fim--;--
dest_ini--;35402759007198;;;Bimbo GO;--ender_Dest_ini--;Rua Avenida;423;Próx.
centro;Sto Antonio;5208707;São Paulo;GO;14526878;1058;Brasil;11978545588;--
ender_Dest_fim--;1;105294225;;;destinatario@teste.com;--dest_fim--;--
retirada_ini--;00910509000171;;Negro Arroyo Lane;308;Complemento
Teste;Centro;4309209;GRAVATAI;RS;--retirada_fim--;--
entrega_ini--;00910509000171;;Negro Arroyo Lane;308;Complemento
Teste;Centro;4309209;GRAVATAI;RS;--entrega_fim--;--aut_XML_ini--;00910509000171;;--
aut_XML_fim--;--item_nota_ini--;--det_ini--;001;--prod_ini--;CTCAPD;;PRODUTO TESTE
1;31021090;--nve_ini--;AA0001;--nve_fim--;--nve_ini--;AA0002;--nve_fim--;--
sequencia_XML_ini--;1111567;N;00910509000171;--
sequencia_XML_fim--;;123;5405;KG;10.000;25.00;250.00;;KG;1.000;250.00;0;0;0.00;;1;-
-di_ini--;;;;;;;;;;;;--adi_ini--;;;;;;--adi_fim--;--di_fim--;--det_Export_ini--;;--
export_Ind_ini--;;;;--export_Ind_fim--;--det_Export_fim--;;;;--
rastro_ini--;AA0001LT;25;2016-12-01;2018-12-01;--rastro_fim--;--prod_fim--;--
impostos_ini--;0.00;--ICMS_ini--;--icms_00_ini--;;;;;;;--icms_00_fim--;--
icms_10_ini--;;;;;;;;;;;;;--icms_10_fim--;--icms_20_ini--;;;;;;;;--
x_icms20_deson_ini--;;;--x_icms20_deson_fim--;--icms_20_fim--;--
icms_30_ini--;;;;;;;;;--x_icms30_deson_ini--;;;--x_icms30_deson_fim--;--
icms_30_fim--;--icms_40_ini--;0;41;--x_icms40_deson_ini--;;;--
x_icms40_deson_fim--;--icms_40_fim--;--icms_51_ini--;;;;;;;;;;;--icms_51_fim--;--
icms_60_ini--;;;--x_icms60_retido_ini--;;;;--x_icms60_retido_fim--;--
icms_60_fim--;--icms_70_ini--;;;;;;;;;;;;;;--x_icms70_deson_ini--;;;--
x_icms70_deson_fim--;--icms_70_fim--;--icms_90_ini--;;;--x_icms90_icms_ini--;; ;; ;
; --x_icms90_icms_fim--;--x_icms90_icmsst_ini--;;;;;;;--x_icms90_icmsst_fim--;--
icms_part_ini--;;;;;;;;;;;;;;;;--icms_part_fim--;--icms_st_ini--;;;;;;;--
icms_st_fim--;--icms_sn101_ini--;;;;;--icms_sn101_fim--;--icms_sn102_ini--;;;--
icms_sn102_fim--;--icms_sn201_ini--;;;;;;;;;;;--icms_sn201_fim--;--
icms_sn202_ini--;;;;;;;;;--icms_sn202_fim--;--icms_sn500_ini--;;;--
x_sn500_retido_ini--;;;;--x_sn500_retido_fim--;--icms_sn500_fim--;--
icms_sn900_ini--;;;--x_sn900_icms_ini--;;;;;;--x_sn900_icms_fim--;--
x_sn900_icmsst_ini--;;;;;;;--x_sn900_icmsst_fim--;--x_sn900_credito_ini--;;;--
x_sn900_credito_fim--;--icms_sn900_fim--;--ICMS_fim--;--
IPI_ini--;777;01234567896325;888;9584;999;--ipi_trib_ini--;99;--
x_ipi_aliq_ini--;0.00;0;--x_ipi_aliq_fim--;--x_ipi_unid_ini--;;;--
x_ipi_unid_fim--;0.00;--ipi_trib_fim--;--ipi_nt_ini--;;--ipi_nt_fim--;--
IPI_fim--;--II_ini--;;;;;--II_fim--;--PIS_ini--;--pis_aliq_ini--;;;;;--
pis_aliq_fim--;--pis_qtde_ini--;;;;;--pis_qtde_fim--;--pis_nt_ini--;08;--
pis_nt_fim--;--pis_outr_ini--;;--x_pis_percent_ini--;;;--x_pis_percent_fim--;--
x_pis_valor_ini--;;;;--x_pis_valor_fim--;--pis_outr_fim--;--PIS_fim--;--
PISST_ini--;--pis_st_ini--;--x_pisst_percent_ini--;;;--x_pisst_percent_fim--;--
x_pisst_valor_ini--;;;;--x_pisst_valor_fim--;--pis_st_fim--;--PISST_fim--;--
COFINS_ini--;--cofins_aliq_ini--;;;;;--cofins_aliq_fim--;--cofins_qtde_ini--;;;;;--
cofins_qtde_fim--;--cofins_nt_ini--;08;--cofins_nt_fim--;--cofins_outr_ini--;;--
x_cofinsoutr_percent_ini--;;;--x_cofinsoutr_percent_fim--;--
x_cofinsoutr_valor_ini--;;;;--x_cofinsoutr_valor_fim--;--cofins_outr_fim--;--
COFINS_fim--;--COFINSST_ini--;--cofins_st_ini--;--x_cofinsst_percent_ini--;;;--
x_cofinsst_percent_fim--;--x_cofinsst_valor_ini--;;;;--x_cofinsst_valor_fim--;--
cofins_st_fim--;--COFINSST_fim--;--ISSQN_ini--;;;;;;;;;;;;;;;;;--ISSQN_fim--;--
impostos_fim--;--imposto_devol_ini--;;--ipi_devol_ini--;;--ipi_devol_fim--;--
imposto_devol_fim--;--inf_adicionais_ini--;;--inf_adicionais_fim--;--det_fim--;--
item_nota_fim--;--total_ini--;--
icms_Tot_ini--;0.00;0.00;0.00;0.00;0.00;0.00;0.00;0.00;0.00;0.00;0.00;250.00;0.00;0
.00;0.00;0.00;0.00;0.00;0.00;0.00;0.00;250.00;0.00;--icms_Tot_fim--;--
issqn_Tot_ini--;0.00;0.00;0.00;0.00;0.00;;0.00;0.00;0.00;0.00;0.00;;--
issqn_Tot_fim--;--ret_Trib_ini--;0.00;0.00;0.00;0.00;0.00;0.00;0.00;--
ret_Trib_fim--;--total_fim--;--inf_transporte_ini--;--transp_ini--;9;--
transp_fim--;--transporta_ini--;00910509000171; ;Mastersaf;0018000282;Negro Arroyo
Lane;GRAVATAI;RS;--transporta_fim--;--
ret_Transp_ini--;50.00;40.00;10;10.00;5353;4309209;--ret_Transp_fim--;--
x_transp_diversos_ini--;--veic_Transp_ini--;MMM1932;RS;RN12318TC;--
veic_Transp_fim--;--reboque_ini--;ALO2866;SP;1231212;--reboque_fim--;--
x_transp_diversos_fim--;;;--volume_ini--;120;Agonias;Wksaok;12312;2300;2500;--
lacre_ini--;222663;--lacre_fim--;--volume_fim--;--inf_transporte_fim--;--
cobr_ini--;--fat_ini--;1231245;1000.00;1000.00;1000.00;--fat_fim--;--
duplicata_ini--;;;;--duplicata_fim--;--cobr_fim--;--pag_ini--;--
detPag_ini--;01;250.00;--detPag_fim--;0.00;--pag_fim--;--inf_Adic_ini--;Informações
Adicionais de Interesse do Fisco;Informações Complementares de interesse do
Contribuinte;--uso_livre_c_ini--;campo 1 uso livre;Conteúdo do Campo 1 para uso
livre;--uso_livre_c_fim--;--uso_livre_f_ini--;242342;texto de uso livre NFe;--
uso_livre_f_fim--;--proc_referenciado_ini--;20;9;--proc_referenciado_fim--;--
inf_Adic_fim--;--exporta_ini--;;;;--exporta_fim--;--compra_ini--;;;;--
compra_fim--;--cana_ini--;2016;01/2016;--cana_forn_diario_ini--;17;1000;--
cana_forn_diario_fim--;500;600;1100;--cana_deducao_ini--;1760.00;1500.00;--
cana_deducao_fim--;1500.00;1600.00;1700.00;--cana_fim--;--nota_fim--;--
arquivo_fim--;","mastersaf": {"versaoLayoutDfe": "0.00","parametros":
[{"ordemEmbarque": "123456","nrItens": "1","usuarioEmitente": "Walter
White"}]}},"id_integrador": "U0172283-TPL-A"}
Exemplo formato XML:

{"action":"EnviarPacote","referencia":"msafRS_3-
108937911.txt","ids":null,"txt_conteudo":{"xml":<NFe
xmlns=\"http://www.portalfiscal.inf.br/nfe\"> <infNFe
versao=\"4.00\"><ide><cUF>43</cUF><cNF>00001004</cNF><natOp>Venda de mercadoria
adquirida ou
recebida</natOp><mod>55</mod><serie>4</serie><nNF>40051</nNF><dhEmi>2017-07-
13T06:30:00-02:00</dhEmi><dhSaiEnt>2017-07-13T06:30:00-02:00</dhSaiEnt><tpNF>1</
tpNF><idDest>1</idDest><cMunFG>4309209</cMunFG><tpImp>0</tpImp><tpEmis>1</
tpEmis><cDV>1</cDV><tpAmb>2</tpAmb><finNFe>1</finNFe><indFinal>1</
indFinal><indPres>1</indPres><indIntermed>0</indIntermed><procEmi>0</
procEmi><verProc>Msafdfe</verProc></ide><emit><CNPJ>00910509000171</CNPJ><xNome>TSL
- DFE RS</xNome><xFant>TSL - DFE RS</xFant><enderEmit><xLgr>Rua das
Araucárias</xLgr><nro>345</nro><xCpl>Próx.
Liga</xCpl><xBairro>Centro</xBairro><cMun>4309209</cMun><xMun>Goiandira</
xMun><UF>RS</UF><CEP>78945612</CEP><cPais>1058</cPais><xPais>Brasil</
xPais><fone>47999899796</fone></enderEmit><IE>0018000282</IE><IM>123456</
IM><CNAE>6123457</CNAE><CRT>3</CRT></emit><dest><CNPJ>35402759007198</
CNPJ><xNome>Bimbo GO</xNome><enderDest><xLgr>Rua
Avenida</xLgr><nro>423</nro><xCpl>Próx. centro</xCpl><xBairro>Sto
Antonio</xBairro><cMun>5208707</cMun><xMun>São
Paulo</xMun><UF>GO</UF><CEP>14526878</CEP><cPais>1058</cPais><xPais>Brasil</
xPais><fone>11978545588</fone></enderDest><indIEDest>1</indIEDest><IE>105294225</
IE><email>destinatario@teste.com</email></dest><retirada><CNPJ>00910509000171</
CNPJ><xLgr>Negro Arroyo Lane</xLgr><nro>308</nro><xCpl>Complemento
Teste</xCpl><xBairro>Centro</xBairro><cMun>4309209</cMun><xMun>GRAVATAI</
xMun><UF>RS</UF></retirada><entrega><CNPJ>00910509000171</CNPJ><xLgr>Negro Arroyo
Lane</xLgr><nro>308</nro><xCpl>Complemento
xMun><UF>RS</UF></entrega><autXML><CNPJ>00910509000171</CNPJ></autXML><det
nItem=\"1\"><prod><cProd>CTCAPD</cProd><cEAN/><xProd>PRODUTO TESTE
1</xProd><NCM>31021090</NCM><NVE>AA0001</NVE><NVE>AA0002</NVE><CEST>1111567</
CEST><indEscala>N</indEscala><CNPJFab>00910509000171</CNPJFab><EXTIPI>123</
EXTIPI><CFOP>5405</CFOP><uCom>KG</uCom><qCom>10.000</qCom><vUnCom>25.00</
vUnCom><vProd>250.00</vProd><cEANTrib/><uTrib>KG</uTrib><qTrib>1.000</
qTrib><vUnTrib>250.00</vUnTrib><indTot>1</indTot><rastro><nLote>AA0001LT</
nLote><qLote>25</qLote><dFab>2016-12-01</dFab><dVal>2018-12-01</dVal></rastro></
prod><imposto><vTotTrib>0.00</vTotTrib><ICMS><ICMS40><orig>0</orig><CST>41</CST></
ICMS40></ICMS><IPI><clEnq>777</clEnq><CNPJProd>01234567896325</
CNPJProd><cSelo>888</cSelo><qSelo>9584</qSelo><cEnq>999</cEnq><IPITrib><CST>99</
CST><vBC>0.00</vBC><pIPI>0</pIPI><vIPI>0.00</vIPI></IPITrib></
IPI><PIS><PISNT><CST>08</CST></PISNT></PIS><COFINS><COFINSNT><CST>08</CST></
COFINSNT></COFINS></imposto></det><total><ICMSTot><vBC>0.00</vBC><vICMS>0.00</
vICMS><vICMSDeson>0.00</vICMSDeson><vFCPUFDest>0.00</
vFCPUFDest><vICMSUFDest>0.00</vICMSUFDest><vICMSUFRemet>0.00</
vICMSUFRemet><vFCP>0.00</vFCP><vBCST>0.00</vBCST><vST>0.00</vST><vFCPST>0.00</
vFCPST><vFCPSTRet>0.00</vFCPSTRet><vProd>250.00</vProd><vFrete>0.00</
vFrete><vSeg>0.00</vSeg><vDesc>0.00</vDesc><vII>0.00</vII><vIPI>0.00</
vIPI><vIPIDevol>0.00</vIPIDevol><vPIS>0.00</vPIS><vCOFINS>0.00</
vCOFINS><vOutro>0.00</vOutro><vNF>250.00</vNF><vTotTrib>0.00</vTotTrib></
ICMSTot></total><transp><modFrete>9</modFrete><transporta><CNPJ>00910509000171</
CNPJ><xNome>Mastersaf</xNome><IE>0018000282</IE><xEnder>Negro Arroyo
Lane</xEnder><xMun>GRAVATAI</xMun><UF>RS</UF></transporta><retTransp><vServ>50.00</
vServ><vBCRet>40.00</vBCRet><pICMSRet>10</pICMSRet><vICMSRet>10.00</
vICMSRet><CFOP>5353</CFOP><cMunFG>4309209</cMunFG></
retTransp><veicTransp><placa>MMM1932</placa><UF>RS</UF><RNTC>RN12318TC</RNTC></
veicTransp><reboque><placa>ALO2866</placa><UF>SP</UF><RNTC>1231212</RNTC></
reboque><vol><qVol>120</qVol><esp>Agonias</esp><marca>Wksaok</marca><nVol>12312</
nVol><pesoL>2300</pesoL><pesoB>2500</pesoB><lacres><nLacre>222663</nLacre></
lacres></vol></transp><cobr><fat><nFat>1231245</nFat><vOrig>1000.00</
vOrig><vDesc>1000.00</vDesc><vLiq>1000.00</vLiq></fat></
cobr><pag><detPag><tPag>01</tPag><vPag>250.00</vPag></detPag><vTroco>0.00</
vTroco></pag><infAdic><infAdFisco>Informações Adicionais de Interesse do
Fisco</infAdFisco><infCpl>Informações Complementares de interesse do
Contribuinte</infCpl><obsCont xCampo=\"campo 1 uso livre\"><xTexto>Conteúdo do
Campo 1 para uso livre</xTexto></obsCont><obsFisco xCampo=\"242342\"><xTexto>texto
de uso livre
NFe</xTexto></obsFisco><procRef><nProc>20</nProc><indProc>9</indProc></procRef></
infAdic><cana><safra>2016</safra><ref>01/2016</ref><forDia
dia=\"17\"><qtde>1000</qtde></forDia><qTotMes>500</qTotMes><qTotAnt>600</
qTotAnt><qTotGer>1100</qTotGer><deduc><xDed>1500.00</xDed><vDed>1760.00</vDed></
deduc><vFor>1500.00</vFor><vTotDed>1600.00</vTotDed><vLiqFor>1700.00</vLiqFor></
cana></infNFe></NFe>","mastersaf":{"parametros":
[{"ordemEmbarque":"123456","nrItens":"1","usuarioEmitente":"Walter
White"}]}},"id_integrador":"U0163451-TPL-A"}
Exemplo grupo mastersaf com resptec:

"mastersaf":{"resptec":
{"respTecCnpj":"23622719000160","respTecContato":"Teste","respTecEmail":"responsave
l.tecnico@teste.com","respTecFone":"4730473148","respTecIdCsrt":"01","respTecCsrt":
"ljKblriAsJArzTsbPmrV6gi25SU="}}
Exemplo grupo mastersaf com contingencias:

"mastersaf":{"contingencias":
[{"cnpjEmissor":"35402759000188","serie":"335","numeroNota":"32336","dataEntrada":"
2020-07-31T08:33:56-03:00","dataSaida":"2020-07-31T08:35:01-03:00","motivo":"SEFAZ
FORA DO AR. Contingência EPEC","cEvento":"110140"}]}
Exemplo grupo mastersaf com parametros:

"mastersaf":{"parametros":[{"ordemEmbarque":"123456","dsImpressora":"HP
5440","nrItens":"1","campoUsoInterno":"testeCampo uso
Interno","usuarioEmitente":"Walter White", "enviaPrinter":"1",
"nomenclaturaArquivos":"nomeArquiNFe"}]}
Exemplo caso necessite de contingencia na origem preencher o atributo

“mastersaf”, exemplo:
Exemplo 1:
{"action":"EnviarPacote","referencia":"678_2020028.txt","txt_conteudo":
{"xml":"<NFe xmlns=\"http://www.portalfiscal.inf.br/nfe\"> <infNFe
adquirida ou
de uso livre
cana></infNFe></NFe>","mastersaf":{"contingencias":
[{"cnpjEmissor":"00910509000171","serie":"678","numeroNota":"2020028","dataEntrada"
:"2011-10-31T11:35:00","dataSaida":"2011-11-30T12:35:00","motivo":"Sem
internet."}]}}}
Exemplo 2:
{"action":"EnviarPacote","referencia":"DOCNUM_XXX","txt_conteudo":
{"xml":"<NFe xmlns=\"http://www.portalfiscal.inf.br/nfe\"> <infNFe
adquirida ou
de uso livre
cana></infNFe></NFe>","mastersaf":{"contingencias":
[{"cnpjEmissor":"35402759000188","serie":"335","numeroNota":"32336","dataEntrada":"
2016-05-31T08:33:56-03:00","dataSaida":"2016-05-31T08:35:01-03:00","motivo":"SEFAZ
FORA DO AR. Contingência
EPEC","cEvento":"110140","dsMotivoCont":"CONTINGENCIA"}]},"id_integrador":"NOME_INT
EGRADOR"}}
Exemplo caso necessite informar o Responsável Técnico deixando o DF-e calcular

o hash, exemplo:
Exemplo XML:
108937911.txt","ids":null,"txt_conteudo":{"xml":"<NFe
adquirida ou
recebida</natOp><indPag>1</indPag><mod>55</mod><serie>603</serie><nNF>8937911</
nNF><dhEmi>2014-10-30T01:30:00-03:00</dhEmi><dhSaiEnt>2014-10-30T01:30:00-03:00</
dhSaiEnt><tpNF>1</tpNF><idDest>1</idDest><cMunFG>4314902</cMunFG><tpImp>0</
tpImp><tpEmis>1</tpEmis><cDV>1</cDV><tpAmb>2</tpAmb><finNFe>1</
finNFe><indFinal>1</indFinal><indPres>1</indPres><indIntermed>0</
indIntermed><procEmi>0</procEmi><verProc>Mastersaf
DF-e</verProc><NFref><refNFe>43131100910509000171556660000211001000010044</
refNFe></NFref></ide><emit><CNPJ>00910509000171</CNPJ><xNome>TSL Tecnologia em
Sistemas de Legislacao SA - RS</xNome><xFant>Mastersaf
RS</xFant><enderEmit><xLgr>Av Dr Cardoso de Melo</xLgr><nro>1855</nro><xCpl>13
Andar</xCpl><xBairro>Centro</xBairro><cMun>4314902</cMun><xMun>Porto
Alegre</xMun><UF>RS</UF><CEP>78098530</CEP><cPais>1058</cPais><xPais>Brasil</
CNPJ><xNome>NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR
FISCAL</xNome><enderDest><xLgr>Negro Arroyo
Lane</xLgr><nro>308</nro><xCpl>Albuquerque</xCpl><xBairro>Centro</
xBairro><cMun>4314902</cMun><xMun>Porto
IE><IM>123456</IM></dest><retirada><CNPJ>35402759000185</CNPJ><xLgr>Negro Arroyo
Teste</xCpl><xBairro>Centro</xBairro><cMun>3550308</cMun><xMun>SAO
PAULO</xMun><UF>SP</UF></retirada><entrega><CNPJ>35402759000185</CNPJ><xLgr>Negro
Arroyo Lane</xLgr><nro>308</nro><xCpl>Complemento
PAULO</xMun><UF>SP</UF></entrega><autXML><CNPJ>35402759000185</CNPJ></autXML><det
nItem=\"1\"><prod><cProd>CTCAPD</cProd><cEAN/><xProd>KIT P/ MANUT MENSAL DE
DPAC</xProd><NCM>31260000</NCM><NVE>AA0001</NVE><NVE>AA0002</NVE><NVE>AA0005</
NVE><EXTIPI>123</EXTIPI><CFOP>5405</CFOP><uCom>PC</uCom><qCom>1.0000</
qCom><vUnCom>1000.00</vUnCom><vProd>1000.00</vProd><cEANTrib/><uTrib>PC</
uTrib><qTrib>1.0000</qTrib><vUnTrib>1000.00</vUnTrib><indTot>1</
indTot><comb><cProdANP>210203001</cProdANP><pMixGN>0</pMixGN><CODIF>135165153</
CODIF><qTemp>25</qTemp><UFCons>SP</UFCons><CIDE><qBCProd>0.00</
qBCProd><vAliqProd>0</vAliqProd><vCIDE>0.00</vCIDE></CIDE></comb></
vICMS><vICMSDeson>0.00</vICMSDeson><vBCST>0.00</vBCST><vST>0.00</
vST><vProd>1000.00</vProd><vFrete>0.00</vFrete><vSeg>0.00</vSeg><vDesc>0.00</
vDesc><vII>0.00</vII><vIPI>0.00</vIPI><vPIS>0.00</vPIS><vCOFINS>0.00</
Lane</xEnder><xMun>SAO
PAULO</xMun><UF>SP</UF></transporta><retTransp><vServ>50.00</vServ><vBCRet>40.00</
vBCRet><pICMSRet>10</pICMSRet><vICMSRet>10.00</vICMSRet><CFOP>5353</
CFOP><cMunFG>3550308</cMunFG></retTransp><veicTransp><placa>MMM1932</
placa><UF>SP</UF><RNTC>RN12318TC</RNTC></veicTransp><reboque><placa>ALO2866</
placa><UF>SP</UF><RNTC>1231212</RNTC></reboque><vol><qVol>120</qVol><esp>Agonias</
esp><marca>Wksaok</marca><nVol>12312</nVol><pesoL>2300</pesoL><pesoB>2500</
pesoB><lacres><nLacre>222663</nLacre></lacres></vol></
transp><cobr><fat><nFat>1231245</nFat><vOrig>1000.00</vOrig><vDesc>1000.00</
vDesc><vLiq>1000.00</vLiq></fat><dup><nDup>10</nDup><dVenc>2013-11-27</
dVenc><vDup>30.00</vDup></dup></cobr><infAdic><infAdFisco>Informações Adicionais de
Interesse do Fisco</infAdFisco><infCpl>Informações Complementares de interesse do
Contribuinte</infCpl><obsCont xCampo=\"campo 1\"><xTexto>Conteúdo do Campo
1</xTexto></obsCont><obsCont xCampo=\"campo 2\"><xTexto>Conteúdo do
Campo</xTexto></obsCont><obsFisco xCampo=\"campo 123\"><xTexto>123 Conteúdo do
Campo</xTexto></obsFisco><obsFisco xCampo=\"campo 234\"><xTexto>234 Conteúdo do
Campo</xTexto></obsFisco><procRef><nProc>20</nProc><indProc>9</indProc></
procRef><procRef><nProc>20</nProc><indProc>9</indProc></procRef></
infAdic><compra><xNEmp>333</xNEmp><xPed>444</xPed><xCont>555</xCont></
compra><cana><safra>2013</safra><ref>11/2013</ref><forDia
cana><infRespTec><CNPJ>23622719000160</CNPJ><xContato>Responsável Técnico
Exemplo</xContato><email>responsavel.tecnico@teste.com</email><fone>4730473148</
fone><idCSRT>01</idCSRT><CSRT>1098765432</CSRT></infRespTec></infNFe></
NFe>","mastersaf":{"parametros":
Exemplo TXT:
{"action": "EnviarPacote","referencia":
"arquivo_integrador_20160802113423.txt","ids": null,"txt_conteudo": {"xml": "--
nota_ini--;--versao_Layout_DFe_ini--;1.20;--versao_Layout_DFe_fim--;--
inf_NFe_ini--;4.00;;--inf_NFe_fim--;--
param_gerais_ini--;impressora_hp1;123456;1;Marcos Pessoa;busca1 uso interno;--
param_gerais_fim--;--ide_ini--;43;00001004;Venda de mercadoria adquirida ou
recebida;55;404;102;2017-10-26T06:30:00-02:00;2017-10-26T06:30:00-
02:00;1;1;4309209;0;1;;2;1;1;0;1;0;Msafdfe;--x_contingencia_ini--;;;--
x_contingencia_fim--;--nfReferenciada_ini--;--ref_NFe_ini--;;;;;;;--
ref_NFe_fim--;--ref_NFP_ini--;;;;;;;;;--ref_NFP_fim--;;--ref_ECF_ini--;;;;--
ref_ECF_fim--;--nfReferenciada_fim--;--ide_fim--;--emit_ini--;00910509000171;;TSL -
DFE RS;TSL - DFE RS;--ender_Emit_ini--;Rua das Araucárias;345;Próx.
Liga;Centro;4309209;Goiandira;RS;78945612;1058;Brasil;47999899796;--
ender_Emit_fim--;0018000282;;--x_emitente_ini--;123456;6123457;--
x_emitente_fim--;3;--emit_fim--;--avulsa_ini--;;;;;;;;;;;;--avulsa_fim--;--
dest_ini--;35402759007198;;;Bimbo GO;--ender_Dest_ini--;Rua Avenida;423;Próx.
centro;Sto Antonio;5208707;São Paulo;GO;14526878;1058;Brasil;11978545588;--
ender_Dest_fim--;1;105294225;;;destinatario@teste.com;--dest_fim--;--
retirada_ini--;00910509000171;;Negro Arroyo Lane;308;Complemento
Teste;Centro;4309209;GRAVATAI;RS;--retirada_fim--;--
entrega_ini--;00910509000171;;Negro Arroyo Lane;308;Complemento
Teste;Centro;4309209;GRAVATAI;RS;--entrega_fim--;--aut_XML_ini--;00910509000171;;--
aut_XML_fim--;--item_nota_ini--;--det_ini--;001;--prod_ini--;CTCAPD;;PRODUTO TESTE
1;31021090;--nve_ini--;AA0001;--nve_fim--;--nve_ini--;AA0002;--nve_fim--;--
sequencia_XML_ini--;1111567;N;00910509000171;--
sequencia_XML_fim--;;123;5405;KG;10.000;25.00;250.00;;KG;1.000;250.00;0;0;0.00;;1;-
-di_ini--;;;;;;;;;;;;--adi_ini--;;;;;;--adi_fim--;--di_fim--;--det_Export_ini--;;--
export_Ind_ini--;;;;--export_Ind_fim--;--det_Export_fim--;;;;--
rastro_ini--;AA0001LT;25;2016-12-01;2018-12-01;--rastro_fim--;--prod_fim--;--
impostos_ini--;0.00;--ICMS_ini--;--icms_00_ini--;;;;;;;--icms_00_fim--;--
icms_10_ini--;;;;;;;;;;;;;--icms_10_fim--;--icms_20_ini--;;;;;;;;--
icms_30_ini--;;;;;;;;;--x_icms30_deson_ini--;;;--x_icms30_deson_fim--;--
icms_30_fim--;--icms_40_ini--;0;41;--x_icms40_deson_ini--;;;--
x_icms40_deson_fim--;--icms_40_fim--;--icms_51_ini--;;;;;;;;;;;--icms_51_fim--;--
icms_60_ini--;;;--x_icms60_retido_ini--;;;;--x_icms60_retido_fim--;--
icms_60_fim--;--icms_70_ini--;;;;;;;;;;;;;;--x_icms70_deson_ini--;;;--
x_icms70_deson_fim--;--icms_70_fim--;--icms_90_ini--;;;--x_icms90_icms_ini--;; ;; ;
; --x_icms90_icms_fim--;--x_icms90_icmsst_ini--;;;;;;;--x_icms90_icmsst_fim--;--
icms_part_ini--;;;;;;;;;;;;;;;;--icms_part_fim--;--icms_st_ini--;;;;;;;--
icms_st_fim--;--icms_sn101_ini--;;;;;--icms_sn101_fim--;--icms_sn102_ini--;;;--
icms_sn102_fim--;--icms_sn201_ini--;;;;;;;;;;;--icms_sn201_fim--;--
icms_sn202_ini--;;;;;;;;;--icms_sn202_fim--;--icms_sn500_ini--;;;--
x_sn500_retido_ini--;;;;--x_sn500_retido_fim--;--icms_sn500_fim--;--
icms_sn900_ini--;;;--x_sn900_icms_ini--;;;;;;--x_sn900_icms_fim--;--
x_sn900_icmsst_ini--;;;;;;;--x_sn900_icmsst_fim--;--x_sn900_credito_ini--;;;--
x_sn900_credito_fim--;--icms_sn900_fim--;--ICMS_fim--;--
IPI_ini--;777;01234567896325;888;9584;999;--ipi_trib_ini--;99;--
x_ipi_aliq_ini--;0.00;0;--x_ipi_aliq_fim--;--x_ipi_unid_ini--;;;--
x_ipi_unid_fim--;0.00;--ipi_trib_fim--;--ipi_nt_ini--;;--ipi_nt_fim--;--
IPI_fim--;--II_ini--;;;;;--II_fim--;--PIS_ini--;--pis_aliq_ini--;;;;;--
pis_aliq_fim--;--pis_qtde_ini--;;;;;--pis_qtde_fim--;--pis_nt_ini--;08;--
pis_nt_fim--;--pis_outr_ini--;;--x_pis_percent_ini--;;;--x_pis_percent_fim--;--
x_pis_valor_ini--;;;;--x_pis_valor_fim--;--pis_outr_fim--;--PIS_fim--;--
PISST_ini--;--pis_st_ini--;--x_pisst_percent_ini--;;;--x_pisst_percent_fim--;--
x_pisst_valor_ini--;;;;--x_pisst_valor_fim--;--pis_st_fim--;--PISST_fim--;--
COFINS_ini--;--cofins_aliq_ini--;;;;;--cofins_aliq_fim--;--cofins_qtde_ini--;;;;;--
cofins_qtde_fim--;--cofins_nt_ini--;08;--cofins_nt_fim--;--cofins_outr_ini--;;--
x_cofinsoutr_percent_ini--;;;--x_cofinsoutr_percent_fim--;--
x_cofinsoutr_valor_ini--;;;;--x_cofinsoutr_valor_fim--;--cofins_outr_fim--;--
COFINS_fim--;--COFINSST_ini--;--cofins_st_ini--;--x_cofinsst_percent_ini--;;;--
x_cofinsst_percent_fim--;--x_cofinsst_valor_ini--;;;;--x_cofinsst_valor_fim--;--
cofins_st_fim--;--COFINSST_fim--;--ISSQN_ini--;;;;;;;;;;;;;;;;;--ISSQN_fim--;--
impostos_fim--;--imposto_devol_ini--;;--ipi_devol_ini--;;--ipi_devol_fim--;--
imposto_devol_fim--;--inf_adicionais_ini--;;--inf_adicionais_fim--;--det_fim--;--
item_nota_fim--;--total_ini--;--
icms_Tot_ini--;0.00;0.00;0.00;0.00;0.00;0.00;0.00;0.00;0.00;0.00;0.00;250.00;0.00;0
.00;0.00;0.00;0.00;0.00;0.00;0.00;0.00;250.00;0.00;--icms_Tot_fim--;--
issqn_Tot_ini--;0.00;0.00;0.00;0.00;0.00;;0.00;0.00;0.00;0.00;0.00;;--
issqn_Tot_fim--;--ret_Trib_ini--;0.00;0.00;0.00;0.00;0.00;0.00;0.00;--
ret_Trib_fim--;--total_fim--;--inf_transporte_ini--;--transp_ini--;9;--
transp_fim--;--transporta_ini--;00910509000171; ;Mastersaf;0018000282;Negro Arroyo
Lane;GRAVATAI;RS;--transporta_fim--;--
ret_Transp_ini--;50.00;40.00;10;10.00;5353;4309209;--ret_Transp_fim--;--
x_transp_diversos_ini--;--veic_Transp_ini--;MMM1932;RS;RN12318TC;--
veic_Transp_fim--;--reboque_ini--;ALO2866;SP;1231212;--reboque_fim--;--
x_transp_diversos_fim--;;;--volume_ini--;120;Agonias;Wksaok;12312;2300;2500;--
lacre_ini--;222663;--lacre_fim--;--volume_fim--;--inf_transporte_fim--;--
cobr_ini--;--fat_ini--;1231245;1000.00;1000.00;1000.00;--fat_fim--;--
duplicata_ini--;;;;--duplicata_fim--;--cobr_fim--;--pag_ini--;--
detPag_ini--;01;250.00;--detPag_fim--;0.00;--pag_fim--;--inf_Adic_ini--;Informações
Adicionais de Interesse do Fisco;Informações Complementares de interesse do
Contribuinte;--uso_livre_c_ini--;campo 1 uso livre;Conteúdo do Campo 1 para uso
livre;--uso_livre_c_fim--;--uso_livre_f_ini--;242342;texto de uso livre NFe;--
uso_livre_f_fim--;--proc_referenciado_ini--;20;9;--proc_referenciado_fim--;--
inf_Adic_fim--;--exporta_ini--;;;;--exporta_fim--;--compra_ini--;;;;--
compra_fim--;--cana_ini--;2016;01/2016;--cana_forn_diario_ini--;17;1000;--
cana_forn_diario_fim--;500;600;1100;--cana_deducao_ini--;1760.00;1500.00;--
cana_deducao_fim--;1500.00;1600.00;1700.00;--cana_fim--;--
infRespTec_ini--;23622719000160;Responsável Técnico
Exemplo;responsavel.tecnico@teste.com;4730473148;--seq_XML_ini--;01;1098765432;--
seq_XML_fim--;--infRespTec_fim--;--nota_fim--;--arquivo_fim--;","mastersaf":
{"versaoLayoutDfe": "4.03","parametros": [{"ordemEmbarque": "123456","nrItens":
"1","usuarioEmitente": "Walter White"}]}},"id_integrador": "U0172283-TPL-A"}
Exemplo caso necessite informar o Responsável Técnico com o hash já calculado,

exemplo:
108937911.txt","ids":null,"txt_conteudo":{"xml":"<NFe
adquirida ou
recebida</natOp><indPag>1</indPag><mod>55</mod><serie>603</serie><nNF>8937911</
nNF><dhEmi>2014-10-30T01:30:00-03:00</dhEmi><dhSaiEnt>2014-10-30T01:30:00-03:00</
dhSaiEnt><tpNF>1</tpNF><idDest>1</idDest><cMunFG>4314902</cMunFG><tpImp>0</
tpImp><tpEmis>1</tpEmis><cDV>1</cDV><tpAmb>2</tpAmb><finNFe>1</
finNFe><indFinal>1</indFinal><indPres>1</indPres><indIntermed>0</
indIntermed><procEmi>0</procEmi><verProc>Mastersaf
DF-e</verProc><NFref><refNFe>43131100910509000171556660000211001000010044</
refNFe></NFref></ide><emit><CNPJ>00910509000171</CNPJ><xNome>TSL Tecnologia em
Sistemas de Legislacao SA - RS</xNome><xFant>Mastersaf
RS</xFant><enderEmit><xLgr>Av Dr Cardoso de Melo</xLgr><nro>1855</nro><xCpl>13
Andar</xCpl><xBairro>Centro</xBairro><cMun>4314902</cMun><xMun>Porto
FISCAL</xNome><enderDest><xLgr>Negro Arroyo
Lane</xLgr><nro>308</nro><xCpl>Albuquerque</xCpl><xBairro>Centro</
xBairro><cMun>4314902</cMun><xMun>Porto
IE><IM>123456</IM></dest><retirada><CNPJ>35402759000185</CNPJ><xLgr>Negro Arroyo
PAULO</xMun><UF>SP</UF></retirada><entrega><CNPJ>35402759000185</CNPJ><xLgr>Negro
Arroyo Lane</xLgr><nro>308</nro><xCpl>Complemento
PAULO</xMun><UF>SP</UF></entrega><autXML><CNPJ>35402759000185</CNPJ></autXML><det
nItem=\"1\"><prod><cProd>CTCAPD</cProd><cEAN/><xProd>KIT P/ MANUT MENSAL DE
DPAC</xProd><NCM>31260000</NCM><NVE>AA0001</NVE><NVE>AA0002</NVE><NVE>AA0005</
NVE><EXTIPI>123</EXTIPI><CFOP>5405</CFOP><uCom>PC</uCom><qCom>1.0000</
qCom><vUnCom>1000.00</vUnCom><vProd>1000.00</vProd><cEANTrib/><uTrib>PC</
uTrib><qTrib>1.0000</qTrib><vUnTrib>1000.00</vUnTrib><indTot>1</
indTot><comb><cProdANP>210203001</cProdANP><pMixGN>0</pMixGN><CODIF>135165153</
CODIF><qTemp>25</qTemp><UFCons>SP</UFCons><CIDE><qBCProd>0.00</
qBCProd><vAliqProd>0</vAliqProd><vCIDE>0.00</vCIDE></CIDE></comb></
vICMS><vICMSDeson>0.00</vICMSDeson><vBCST>0.00</vBCST><vST>0.00</
vST><vProd>1000.00</vProd><vFrete>0.00</vFrete><vSeg>0.00</vSeg><vDesc>0.00</
vDesc><vII>0.00</vII><vIPI>0.00</vIPI><vPIS>0.00</vPIS><vCOFINS>0.00</
transp><cobr><fat><nFat>1231245</nFat><vOrig>1000.00</vOrig><vDesc>1000.00</
vDesc><vLiq>1000.00</vLiq></fat><dup><nDup>10</nDup><dVenc>2013-11-27</
dVenc><vDup>30.00</vDup></dup></cobr><infAdic><infAdFisco>Informações Adicionais de
Interesse do Fisco</infAdFisco><infCpl>Informações Complementares de interesse do
Contribuinte</infCpl><obsCont xCampo=\"campo 1\"><xTexto>Conteúdo do Campo
1</xTexto></obsCont><obsCont xCampo=\"campo 2\"><xTexto>Conteúdo do
Campo</xTexto></obsCont><obsFisco xCampo=\"campo 123\"><xTexto>123 Conteúdo do
Campo</xTexto></obsFisco><obsFisco xCampo=\"campo 234\"><xTexto>234 Conteúdo do
Campo</xTexto></obsFisco><procRef><nProc>20</nProc><indProc>9</indProc></
procRef><procRef><nProc>20</nProc><indProc>9</indProc></procRef></
infAdic><compra><xNEmp>333</xNEmp><xPed>444</xPed><xCont>555</xCont></
compra><cana><safra>2013</safra><ref>11/2013</ref><forDia
cana><infRespTec><CNPJ>23622719000160</CNPJ><xContato>Responsável Técnico
Exemplo</xContato><email>responsavel.tecnico@teste.com</email><fone>4730473148</
fone><idCSRT>01</idCSRT><hashCSRT>ljKblriAsJArzTsbPmrV6gi25SU=</hashCSRT></
infRespTec></infNFe></NFe>","mastersaf":{"parametros":
+ Body
{
"result": "OK"
}
### Cancelar [POST]
Método para cancelar NF-es enviados ao webservice.

O corpo do POST (request body) deve ser um json contendo uma tag “action” e uma tag
“txt_conteudo”. O txt_conteudo é posicional separado por “;” (ponto-e-virgula).
### Exemplos URL

ou
### Permissões


(application/json).
### Autenticação
OU
### Retorno Erro
Http status: 203, 400, 412, 500.
+ Headers
+ Attributes
+ action (required) - Ação solicitada. Conteúdo: "Cancelar"

+ referencia - Nome do arquivo de integração
+ txt_conteudo (required) - Grupo de informações de cancelamento.
+ xml (required) - Conteúdo do Cancelamento de NF-e.
Formato TXT: Informar dados conforme layout padrão TXT de Cancelamento de
NF-e (layout/planilha está disponível no Web Help:
Mastersaf_Layout_DFe_V3_NFe_NFCe).
Formato XML: Informar dados conforme layout XML de Cancelamento de NF-e
(layout/planilha está disponível no Web Help > zip do manual de integração
webservice > Mastersaf-Layout_DF-e_V3-NF-e_XML).
+ id_integrador - Nome do integrador responsável pelo envio do documento.
+ Body

{"action":"Cancelar","referencia":"arquivo_integrador_20120223123535.txt","txt_cont
eudo":{"xml":"--nota_cancelada_ini--;\n1.00;\
n35161035402759000185551440005253841000010041;\n35402759000186;\n110111;\nTeste
cancelamneto via arquivo NFE;\n110337602119;\n--nota_cancelada_fim--;\n--
arquivo_fim--;"},"id_integrador":"U0163451-TPL-A"}
{"action":"Cancelar","referencia":"arquivo_integrador_20120223124109.txt","txt_cont
eudo":{"xml":"<root><notaCancelada><versao>4.00</
versao><chaveAcesso>43220700910509000171550170000007751123456805</
chaveAcesso><cnpj>00910509000171</cnpj><docStat>110111</
docStat><motivoCancelamento>TESTE CANCELAMENTO
XML</motivoCancelamento><inscricaoEstadual>0018000282</inscricaoEstadual></
notaCancelada></root>"},"id_integrador":"U0163451-TPL-A"}
+ Body
{
"result": "OK"
}
### Inutilizar [POST]
Método para inutilizar numerações de NF-es que ainda não foram utilizadas.
Obs.: Se no intervalo de inutilização for informado mais de 10 mil números, a

requisição será rejeitada pois o número ultrapassa o limite definido pela Sefaz
(10.000 números).
### Exemplos URL

ou
### Autenticação
OU
### Retorno Erro
Http status: 203, 400, 412, 500.
+ Headers
+ Attributes
+ action (required) - Ação solicitada. Conteúdo: “Inutilizar”
+ txt_conteudo (required) - Grupo de informação de Inutilização
+ xml (required) - Conteúdo da Inutilização de NF-e.
Formato TXT: Informar dados conforme layout padrão TXT de Inutilização de
NF-e (layout/planilha está disponível no Web Help:
Formato XML: Informar dados conforme layout XML de Inutilização de NF-e
(layout/planilha está disponível no Web Help > zip do manual de integração
+ Body
{"action":"Inutilizar","referencia":"arquivo_integrador_20120223124109.txt","txt_co
nteudo":{"xml":"--nota_inutilizada_ini--;\n4.00;\n00910509000171;\n2;\n2;\n1;\
n15000;\n17;\nInutilização de notas com erro de xml;\n22;\n0018000282;\n55;\n--
nota_inutilizada_fim--;\n--arquivo_fim--;"},"id_integrador":"U0163451-TPL-A"}
{"action":"Inutilizar","referencia":"arquivo_integrador_20120223124109.txt","txt_co
nteudo":{"xml":"<root><notaInutilizada><versao>4.00</versao><cnpj>00910509000171</
cnpj><docStat>2</docStat><tipoAmbiente>2</
tipoAmbiente><numeroDocumentoFiscalInicial>1</
numeroDocumentoFiscalInicial><numeroDocumentoFiscalFinal>15000</
numeroDocumentoFiscalFinal><serie>17</serie><motivoInutilizacao>TESTE DE
INUTILIZACAO XML</motivoInutilizacao><ano>22</ano><inscricaoEstadual>0018000282</
inscricaoEstadual><mod>55</mod></notaInutilizada></
root>"},"id_integrador":"U0163451-TPL-A"}
+ Body
{
"result": "OK"
}
+ Body
{
"result": [
{
"nProt": null,
"ano": "22",
"mod": "55",
"nNFFin": 15000,
"cnpjEmissor": "00910509000171",
"idProcessamento": null,
"cStat": 102,
"tipoInutilizacaoNota": "tipoInutilizacaoNota",
"tipoMensagemRetorno": 2,
"xDescricao": "Quantidade de numeração a inutilizar ultrapassa
o limite definido pela Sefaz (10.000 números)",
"cUF": null,
"serie": "17",
"dataHoraAut": "",
"status": 999,
"nNFIni": 1
}
],
"nfe": true
}
### EnviarCartaCorrecaoNfe [POST]
Método para emitir cartas de correção para NF-es já autorizadas.

“txt_conteudo”. O txt_conteudo é posicional separado por “;”(ponto-e-virgula).
### Exemplos URL

ou
### Permissões


(application/json).
### Autenticação
OU
### Retorno Erro
Http status: 203, 400, 412, 500.
+ Headers
+ Attributes
+ action (required) - Ação solicitada. Conteúdo: "EnviarCartaCorrecaoNfe"

+ txt_conteudo (required) - Grupo de informações de carta de correção.
+ xml (required) - Conteúdo da Carta de Correção de NF-e.
Formato TXT: Informar dados conforme layout padrão TXT de Carta de Correção
de NF-e (layout/planilha está disponível no Web Help:
Formato XML: Informar dados conforme layout XML de Carta de Correção de NF-
e (layout/planilha está disponível no Web Help > zip do manual de integração
+ Body
{"action":"EnviarCartaCorrecaoNfe","referencia":"arquivo_integrador_20120223160622.
txt","txt_conteudo":{"xml":"--carta_correcao_ini--;\n1.00;\
n43141000910509000171556030089379111000010048;\n00910509000171;\n0018000282;\
n110110;\n1;\n2011-11-10T16:35:00-02:00;\nlabel: Carta de Correcao para nota xpto;\
n--carta_correcao_fim--;\n--arquivo_fim--;"},"id_integrador":"U0163451-TPL-A"}
{"action":"EnviarCartaCorrecaoNfe","referencia":"0000033742","txt_conteudo":
{"xml":"<root><evento><infEvento><cnpj>00910509000171</
cnpj><chNfe>43220700910509000171550170000007751123456805</
chNfe><inscricaoEstadual>0018000282</inscricaoEstadual><dhEvento>2022-11-
01T16:35:00-02:00</dhEvento><tpEvento>110110</tpEvento><nSeqEvento>1</
nSeqEvento><verEvento>1.00</verEvento><detEvento><xCorrecao>TEXTO LIVRE PARA CARTA
DE
CORRECAO</xCorrecao></detEvento></infEvento></evento></root>"},"id_integrador":""}
+ Body
{
"result": "OK"
}
### MarcarConsultado [POST]
Método para indicar ao WebService que determinados documentos já foram consultados

e não precisam mais ser retornados na consulta (GET). Deve ser utilizado depois do
método de consulta onde são listados os documentos para geração de retorno.
“ids”.
### Exemplos URL

ou
### Permissões

(application/json).
### Autenticação
OU
### Retorno Erro
Http status: 203, 400, 412, 500.
+ Headers
+ Attributes
+ action (required) - Ação solicitada. Conteúdo: "MarcarConsultado"

+ ids (required) - Listagem de ids dos processamentos a serem marcados como
consultados.
+ Body
Exemplo:
{"action":"MarcarConsultado","ids":[6556],"id_integrador":"U0163451-TPL-A"}
+ Body
{
"result": "OK"
}
### MarcarImpresso [POST]
Método para indicar ao WebService que determinados documentos já foram impressos e

não precisam mais ser retornados na consulta (GET). Deve ser utilizado depois do
método de consulta onde são listados os documentos para que devem ser enviados para
o Printer imprimir (getImpressao).
“ids”.
### Exemplos URL

ou
### Permissões


(application/json).
### Autenticação
OU
### Retorno Erro
Http status: 203, 400, 412, 500.
+ Headers
+ Attributes
+ action (required) - Ação solicitada. Conteúdo: "MarcarImpresso"

+ ids (required) - Grupo de informações para marcar como impresso.
+ idProcessamento (required) - Atributo de ids. Id do processamento a ser
marcado.
+ idNota (required) - Atributo de ids. Id da nota a ser marcada.
+ Body
Exemplo:
{"action":"MarcarImpresso","ids":[{"idProcessamento":604,"idNota":29}]}
+ Body
{
"result": "OK"
}
### MarcarCartaCorrecaoImpresso [POST]
Método para indicar ao WebService que determinados Cartas de Correção já foram

impressos e não precisam mais ser retornados na consulta (GET). Deve ser utilizado
depois do método de consulta onde são listados os documentos para geração de
retorno.
“ids”.
### Exemplos URL

ou
### Permissões


(application/json).
### Autenticação
OU
### Retorno Erro
Http status: 203, 400, 412, 500.
+ Headers
+ Attributes
+ action (required) - Ação solicitada. Conteúdo:

"MarcarCartaCorrecaoImpresso”"
+ ids (required) - Grupo de informações para marcar como impresso.
+ idProcessamento (required) - Atributo de ids. Id do processamento a ser
marcado.
+ idNota (required) - Atributo de ids. Id da CCe a ser marcada.
+ Body
Exemplo:
{"action":"MarcarCartaCorrecaoImpresso","ids":
[{"idProcessamento":785179,"idNota":2777}]}
+ Body
{
"result": "OK"
}
### ReimpressaoDanfe [POST]
Método para solicitar reimpressão de NF-es.

“txt_conteudo”. O txt_conteudo é posicional separado por “;”(ponto-e-virgula).
### Exemplos URL

ou
### Permissões


(application/json).
### Autenticação
OU
### Retorno Erro
Http status: 203, 400, 412, 500.
+ Headers
+ Attributes
+ action (required) - Ação solicitada. Conteúdo: "ReimpressaoDanfe"

+ txt_conteudo (required) - Grupo de informações de reimpressão.
+ xml (required) - Conteúdo da solicitação de Reimpressão de NF-e. Layout
conforme exemplo abaixo, contendo CNPJ do emitente, número da NF-e, série e IE do
emitente.
+ Body
Exemplo:
{"action":"ReimpressaoDanfe","txt_conteudo":{"xml":"--
reimpressao_danfe_ini--;00910509000171;20;852;0018000282;--
reimpressao_danfe_ini_fim--;"}}
+ Body
{
"result": "OK"
}
### Consultar Cadastro [POST]
Método para envio de Consultas de Cadastros pela Sefaz correspondente.

O corpo do POST (request body) deve ser um json contendo todos os campos do layout
do método.
### Exemplos URL

ou
### Permissões


(application/json).
### Autenticação
OU
### Retorno Erro
Http status: 203, 400, 412, 500.
__Detalhamento do grupo XML:__

| campo | Descrição | Conteúdo | Tipo | Tamanho |
| :---: | :--- | :---: | :--- | :---: |
|--consulta_cadastro_ini--; | | | | |
| versao | Versão do Layout | 2.00 | Caractere | 4 |
| CNPJ | CNPJ da empresa | Identificação da empresa para o qual será retornado
a consulta | Caractere | 14 |
| IE | Inscrição Estadual da empresa | Identificação da empresa para o qual
será retornado a consulta | Caractere | 0-14 |
| UF_pesquisa | UF à qual se destina a consulta | | Caractere | 2 |
| IE_pesquisa | Inscrição Estadual a ser consultada | Somente um dos campos
(IE_pesquisa ou CNPJ_pesquisa ou CPF_pesquisa) deve ser preenchido. | Caractere |
0-14 |
| CNPJ_pesquisa | CNPJ a ser consultado | Somente um dos campos (IE_pesquisa ou
CNPJ_pesquisa ou CPF_pesquisa) deve ser preenchido. | Caractere | 14 |
| CPF_pesquisa | CPF a ser consultado | Somente um dos campos (IE_pesquisa ou
CNPJ_pesquisa ou CPF_pesquisa) deve ser preenchido. | Caractere | 11 |
|--consulta_cadastro_fim--; | | | | |
|--arquivo_fim--; | | | | |
+ Headers
+ Attributes
+ action (required) - Ação solicitada. Conteúdo: "ConsultarCadastro"

+ referencia - Nome do arquivo utilizado na integração.
+ txt_conteudo (required) - Grupo de informação da consulta.
+ xml (required) - Conteúdo da Consulta do Cadastro conforme layout padrão
do produto, tabela abaixo "Detalhamento do grupo XML".
+ Body
{
"action": "ConsultarCadastro",
"referencia": "referencia-consulta-cadastro.txt",
"txt_conteudo": {
"xml": "--consulta_cadastro_ini--;\n2.00;\n00910509000777;\
n0018000555;\n41;\n;\n00910509000777;\n;\n--consulta_cadastro_fim--;\n--
arquivo_fim--;\n"
}
}
+ Body
{
"result": "OK"
}
### Gerar Comprovante de Entrega [POST]
Método para enviar o evento de Comprovante de Entrega de uma NFe autorizada.
### Exemplos URL

ou
### Autenticação
OU
### Retorno Sucesso

Response Body: {“result”:”OK”}
Http status: 202 (Solicitação enviada com sucesso)
### Retorno Erro
Http status: 203, 400, 412, 500.
+ Headers
+ Attributes
+ action (required) - Ação solicitada. Conteúdo: “EnviarEntregaNfe”

+ txt_conteudo (required) - Grupo de informações do Comprovante de Entrega.
+ xml (required) - Conteúdo do Comprovante de Entrega de NF-e.
Formato TXT: Informar dados conforme layout padrão TXT de Comprovante de
Entrega de NF-e (layout/planilha está disponível no Web Help:
Mastersaf_Layout_DFe_V3_NFe_Comprovante_Entrega).
Formato XML: Informar dados conforme layout padrão XML de Comprovante de
Entrega de NF-e (layout/planilha está disponível no Web Help > zip do manual de
integração webservice > Mastersaf-Layout_DF-e_V3-NF-e_XML).
+ Body

{
"action":"EnviarEntregaNfe",
"referencia":"arquivo_integrador_20120223160622.txt",
"txt_conteudo":{
"xml":"--nfe_comprovante_entrega_ini--;--
mastersaf_ini--;4.00;marcos;--
mastersaf_fim--;35210900910509002034550180000152251000010049;00910509002034;1180938
46110;110130;1;2021-09-22T19:20:00-03:00;--inf_comprovante_entrega_ini--;2021-09-
22T19:00:00-03:00;9999999;Jucá
Recebedor;20.13;23.555;iVBORw0KGgoAAAANSUhEUgAAATUAAACjCAMAAADciXncAAAA/FBMVEX///
9mZmb8////fwBiYmL+gQBcXFxfX1/+/v/+//
1ZWVl6enqYmJjZ2dlpaWn4+Pjx8fH9ewCKiorh4eH9hAD8eACrq6tsbGyQkJD+iADJycnr6+u9vb39dQD8i
wCenp6zs7P9+/SFhYWmpqbMzMz99uv98eN+fn78kQD96tb94sf9y6OwsLB0dHT8xJP927380a/
8z5/8oEv9xZn9pVr7tnz938P+lz79xo39rmv8jiT7vYr8n079lTj84b7969v9r138q0/7pUD8wH79s3L7tG
b6zZf8q1H72a78mB/9nTH9tHz+jSX8qmz9uYX+0bL8nyn/iiL+m0/9u3EnU/5aAAAbO0lEQVR4nO1dC1/
aStMPEwJZvEaTYlSiURO5VC4KKCjSo7QV2+PztP3+3+WZmd2ERJHTvs/
lvI3MOb8KuWx2/5n7zi6atqQlLUmDv7sDvweJ2Ufw63X/
lXNLmpGZ+iM+uO4f884vKU0QfrjrgOKpmletujUlpNC4+zAGc4nbSxJ+1fPcB/
Wt5npVu6Y024PreVVfLIVUEuNgRuxlV6veBwUU3LvuD1DabIKMZ9cjNhRvnecEEJmMg/A9z7M/
KaAEhEF8Wcf2XC+gE0IzQQMBb5rthBZ0ei3EjT7DbdWbxHYzKY8Cma2lVJzWuu8Ebxs1M6zarvExdiv8GVg
p3Q++JoES2g/btb1QvGUxhYmNYmnUfv6GmoGWwZ68aQcYHl1SZu1nh1/nI2gTzO6jMN+yjE5s1/
WMeuqYqUHk6oL2XIMhr7nIa2862oKgaqBeS0NAWKnT9U/15+cmumtXw7doDqRiN8ki+p17tKGps3B/
9wlYTDsIaYcvBbpW0J3Qum8G3AZ+fksch/7GQyeM+AkgHYHCg832Ab9isOBN+Rq/
06xHVhQkfujRPTyEbwc3aBhIV3LAzDPqkyT0ae06ozZ1XZdRC4aWrTflaaGcE7gyDN3uvJlsSM1AG+BaD8l
jptaZ3kn33//sfZRItGzDJu8WmmgDXDtI3gC3Fh5zjfpb4bYegeba50mVTrG7+4k/
ojwqoYUxiqCJQdQAUbONcbIR6HIrRu9/1++/lya2jSO2R4LYJPLN/
KlrK+4zZ0KnGKmh4y2ej7Ls91sBn4ZHQs22B2/
FnDIGtjFJqjMTaveN14TN9LuWhbJqQsvFDw0CCnrUSKztsk/
+FGEz7FDKIUJATsjMj4i4bxYhoL2s9QMwRWgYeKdFeTcIbPrsvZlIHoKBYZ3L4BNqj9Pb1MDROQMC0BSiNW
kGCf4TWtOyETf9C32B8bludMP/ac//
ThIAwgcF1R36ZGl2EZ8+35NDBk3LsLwNgo1gJKd4ojNqXY35D2ZRRIYJhx6EPnGToIyQhOoPz6vOQKNPbcO
1e5QdQl1vWx30aaHeRh8Xb2kTrxnWhcasGP9LCUyRUfwE3I4My37yUzN44R+PdRF5/
Zw1m7ie+4h4BGwzUNvDwHEqXYFgi0sLXduvvswBcwOmf+3p+qgFWYWtbRlk9c79VMKRiFGDmpxdaekSK+ii
0UDND20HGcwhyyn83nA4CdCW/
tntSZUGXYstRDubVgElziD5ovFr0mamx3llux1WYu2PHfbIgoE3auNlrM30AdpQ5CdBN04c3bIsDgsaFnEk
/udnk9f6rJRw/Jfs3SJrpVGbeu45/
RVS+lDkwCeYtGviNesJzEgsWw6385UkGw0pk9PKImoCGhFqHBTAB9u+S9UkYDROk8jSUkBQ84F4C4FCL03X
rVCDfwy6DXJwB4yUbpGJuDRUqxd/08D+y9SyaID4PwegddvzjGQAj5ayhkLoU/
4WraVRcVGl1SbdNsC4+7VbQ7+jYlmVSyCFRzDpyF4m8ho1igrwIYu8hnhIpjAs1mstA1HrQCIAQLhMdHFb3
WvkMlu3rRsIHcTpmuQS/69XECm9gndfW/RJdygJ8g9Liqjrv/
ro35kEMptu6IbT5akSf4rxOCcVMVySYREdh75lOD3wSXNdwpNDd/
iEmQkXFkGldwECw8LPlQmJMNlQehUZtaE0DXCJLNTkRDaa1OZVKD99MqazET+hDLvoT1T0ygX0HITJ8KHWH
gM06ItuUZJjPLIqeo85UIjmN1u/rGcVNNNEZyLkagPB0waqjAPubU+KF/
2LvGZhZCCaf7ZR05EmG0Cz4jhtCInB9EqfOWyM/Om3L1o+2Y8woLKH7MEm2JeQ/GBSCJAcot+pMc9deR/
Q1cCQXUS+P7Quh198H6XU+IreroUxwjUdJ8ihrTuOY/fZxRMzZzlLFFx0v//Zj2ZY/
JRLKuR4A8O1+hwrCHHxFJii1SDnA69G1PQhIhO2UVI1ETBn1tg46HpIUgr1yU33Inj53N+ZoOaidBnOhL1U
ZCr3s0wBCTldx+RXDb0mwEch7lWsIQZSVhe4guip4qDpVFQb6UYTYe6ybdGtL8STE8fCaMGuZYrdWMbQxXK
eCKuO7trotGlsNWN9ZIqwUUdQbGfoXyIaQc+yPQjPEV/
oX+CZ+sUY2dLX0WYShq4u6RJjhuuK9HT1IDtOG44Kg0Xpq5EQ0TyJbQQcNdVm1UGC/
bIb9Dyu25VKF8Kh3YKeTQED8Vi7ousYebYraGQRKvgqQbNuUGQNRdZTdlATcKmCRaPS0hg1BJEyH/
6dPfWJ1/z7e1ZPAN8RtSeoUfaIuLBl2XWp528MW5+Q/0HtYFBGXgkFCE1kxYpqXh/
93WP9z5HQhhFqDpUP1TEEYnWk1WyMqojnrmy9jhcOvj3VMJQKMU5n0aUJ9hDEj8/
IogPLxqhCBOj4GpWmRq4uoobiLLSHGLVhhvSaDBw5HqLyIeh3LzGWwgEGVdcNyenoe1NUXw10bet+jdASwB
N8PDOPKGPA6ne/
TgRNU9mO3hNkUW+sitUNKLaokKyShN783UP9zxH6YBXGTDdsjpwgmo+C4IHLgwQE6GQgalKEUwTC//
g5UPUdhJYfBrJ4BoJxQE6gEF9lYKpXnlfC/caEA75xmBVkEoznDeJTjCPBgR+7xuSFiy80mVUjews+/
yskangmbFxgrAB9ah513E22AgQxIb/+WwvDKuQdH5LlkKzBTJSzSQteS1xA58pHZK/
cR5qtAYqhKLN7Qa1e+mgPvqFLZw38TPlrJvn1jbrPQdKj6/
WSPGGis48I+K7l1F5xHEww9DGYvu3pJIPh0LJ7xGIVi5MoVEpfb7RDyFrdKc1ccuFZnXKT6PRzJakEyfeqP
gqbZTv9V92thw7ZiEcDTa0J5+j+OagAuxZ7z04QZX2z461prOzb140aT/1eUuLVsMaUOHoc8YSJ/
3hH4eZFtQcLCuIJcr9N3OhzgccTwEg6NJU66cVx47qdpcpTED3HoSlN5AmQQQJxim/
LmjQ2BYLn+F4FDVkp5HkEMgRihMhTRlg6NBhw4GvpVhxUcpOsoIYD/
dNhx8MaomIb8exIpUYurusSz3FxjAmdXrBILbXsR0IWTagJfcOyzrGtPscJzgDAH3HKUne6GYGNQ0fprVV6
ckpYty5x8P7UMB7jQd5a+oK1FwKauhfQKxDk6YbtliD4GpRiO8fo4Loio1Kj0s6IbqOAXA5Jt30TmsgoNxy
6BxcqI0Zf6obVW4Ca8BukA8PpNOJI9nnJMlPw9U0lQCiuz8ZaIT8aEgrQGPWSX0tVbpvix0cEEertRZUaqr
ztwbBTM3ic2NW0sRU/ws7IXJU/
Y4TKmJP+cf0Us8WtbTeBq9ZebwMFs08hbPDHZz+puSAIyQnMIGpwaUWoGVRaO25TaS0BJmEKq16NChgeFih
ymtez6yCT5fhfu8FhgD9AqW9o4NvRi7FG2dBrAtoqw0/ZaiEGFcexGnQGai3OvQoq5/
CrxoISWwE9Q3+Iv5zr+pS8kK5jU/
YJtC+Ogq3yanHvb0aCYncGbRgAPDnSMUWh6zqW0SfFZmJMKf5pdxYNOOhd0x8K2kWo80IDMXa4AmKEzDZUn
sdlZuJ30x84lmU558hZQmXauhq0Lds1hhS5s3/
rL17dw1NXcjZL+C7eGWJ0JmuLbDSiwQ09ovJnRrSaJku4L75c10mmao7Mug4BrnSqOwsESaqcwlvgeTRHF1
SH+
+OOs3Gtx+kDXj22JK+xiak3v1zUMhWJmnIOGUcXSPawzjVoORhNjtBbHbvs7YqH21fCSKGNK4aFzCWmclkQ
yDQvdC1VJsmY88YD/9Nx/
XfJxECx36pJBW6wC48aamJZHs26twxPR8kK0Wt4LRBFDaaHeEuYzCUJ8Ce27j0wq9Va/
QAyo9QkiWsDY59RHR2sEdrQCocBENbI2RLB1JrQNfdXrwoYtCZ9/
kt7U8SNUnIXI3cTZXzkVBzjSWjZgQ2HNZD1QA7ptvbTdS2qyRCyWCaQeyrQxOfLDLiAa7sryzhktpxLYXgz
C7nqEbSapWL3DGWKTK1V0dlls1yQsyaBzwECTZ2AzBXxXIr4MHlZlAz1iuE0SSvSWj4Udr/
vswKTK5Tp9qGl0gMZmm3h6nYViFJY5PcwgO8GcuGn9a1PTHQxHfhC3NrGramiS5MXHGMo4RNqaEH9f3p1Xs
jsGdWA13+3u4MarSCqqaSKnqWZPZjNIqO90wQ6vRaynU9pI5sqOgQ8WAaV81GYSaqKWM+nDDklzuzak3uDF
9cN+54au9Wr5OJqtGLI5lW1bSeDs8jpigWa9WRpmgDc6LJOF3rouw1lGdrYM1ogNdx4DBeOYV2Czy7u/
eeQK7am9pSSJL5NlQ9dct9i1DIShRIJqo4xomQ1lVAxIV9wAbeD4XedCjbY/
4eOYUygP7wcw6TitC+QL78ThvHyeJTwOu3MAwEv6z6nwECX5fP6ohTd70Y4QMVr1gQBOFeo2TTZrhuWE5Jn
f42yG9IiM//z4xhGeCkFX9/
EsKL3AcJ28Hx9GWKOsBlNSoT0HBWoZWrPBcrUUnqtS5miJ5WfuEEpe7Kcby017Qd1jFWv5eeBhVZzZFXQla
hhyB/adjVhXJXHFt4Z7g9sEIP/
Ls2MWnq2appNLXgaDbttdjbGBKAuKzogGKPOClqUcWPtR3V7CGDQ7AgtfLrm1Xka+mOePeZ120lYEE1V5Ye
qrft19JSxClNT1SfzdjHQ0mnxRUeVIaN5sBzH+oec3tR9aF5+74NaMovhVq+OlvRO/
8h4ha3UsuWoZFAWP2eunNlU2+XIFcR+o3cRghhT5ggde5ZYJ4R2xXIm8ETV8ohU/
0sHL76q6FafN2Aj6EXVuIeoLMmUW/5Jt05w8VYWCcZd2xo2mCtAuzAc6ztp7x5ZB/Zj69ctoOkmw/
qChsKiic6RbesTvpvzkVP7Sn7xG23OLtGqtpFld2uQkbmpF1TnyjzEglz+Jvnzlh1o8KdE7UnWXIlvlkGof
depgEObOLZMl2tya6JbmgelckHbeOTNUmAgq7D6GQrcEwRCRQiU5xe+JSdHrsnrZQltyW024bpCUT6VV+qW
b/q98yatyRCQyme0DRedYeK/
yMP9lp0sboKomkit5DxHDGTy2kD3A8QlKrYKLSr7cvMl1ODie5cq6A0HhVaojesgrKWyIW3D8+wWie2NWh9
qZXJVrUmrauUAR5QSVysEuqTlr79/v/AhsDE6tUNO+1I2pD4GXrFNYLVs+yqhuEz/
0bDvWK2Nopr8TK6qpYWOPDzbuKSg8ltcE25y8gi0Jp1HkZXZbC4e0tTiKPjgedPUIiLRaknjeR7lBTLJa5r
gLXJo1XCTxld3LE4j0imqFBIwIaHVB3RuNBzwFDu0erd8QcewfyT0mqkKohG1jsWNGnaGlrWkqO3wzhQj3t
ADxoPReQfDzubossmavkFC63TADGnTDsqU8VL5FnNb/VZE24ul073ikjdZsLIye/
yCoD1ExTXwZUm3kKvzyBRY57S8AG4ci8uqeLMJmoyCc9d1P8jSelUsD7XPH8KkPwv+APXhsL2ozPK3JuSoM
cYDzCxyRa2QC3xsS0aorYsWiWrHor12yJPo2a6sY1C+B940dd0/1MJcjV032o5hLLLq4yYINF9uUS003mRC
uv+R3Anf020uARR+7/E+tXm1AM/
zHiWv0uqDbLq2cwmC3nA44A1zoGcxarTPoVApIGSe3qChtsISWmobZgEP1eqtNCHBwBtOMpbmWED+I+1a5/
JGVnXWYVaNlwyMo6SF3JInSQISk4EMru9iK/owWwszFlBDJ71FW6CjumpQXNWmaMFDS/
EqAnD7KZ2nhSfpxly8FSGdyD1MR7JePmi3aTsP4RmuzTsxq7lijVnOlHPtcGu70xQ8cCn3MB1k1eN4TvHOr
8mDoUFTTrSLH2hBPZDGgqtRGaxPrueldVjX4FYmb4XXajxePTVPLoJ491uou7orfVu4r37kXIYZPFbv0xLa
0gk0I1tTBYuoQ968moSLtkqkcjbbCynMf6SNrNmG1gxPVlAKuUWKFqVuyTzc065rzbcioDRL0mjUlGSBipB
M6PcuOJaEqeu5HmNVs+n3b57dzXtmkSGpNRrjNwOa0vRcx6H5bdp0QiU+ZMBAobp9Jfd9+vSIEpqWzHrjgV
dM8pK/NyOeimQIHkzRyb1/Nna4vW7FEfqzqWOWy+nb8W3nEaA59dz0r92YvO9T9CskzwEdGx7/
Askb47EUwR39FtzzX7sRyf3Tn0XlD/SDXt5jxkpJf41gQL8R9OzXbhbeUKPfCLLfjGs7lyD00LX9/Ne/
chlrOfhAvyo0Xnhx5gnC+0FHJhkxEkVPNha9RKoDxFX18Vaxl2h8vM9U5dCvk9waN9pJjGSvo/
hOQDCbCGBlJteFynUF2U9BLiK52kJhwCprEJ1pel48lzfxqp5bn2UnM7UW498k+tXVmNdC+tXVyPN/
sKteNXjbDPYKmVC7m15Fv5tUc+mHVtUpcfV499oGKUtKkLhz3bu3NC3w71DCbt4+pH4IYYnfz9FSJJe0pCU
taUlLWtKSlrSkJS1pSUta0pKWtKQlLWlJS1rSkpa0pCUtaUlLWtKSlvT/iH6mLC9DpXubq89oFw/u49/
t6Io1/HISX7/9fud05XRnfy8+coLn1561+D76sneIl+P1B/trG/
EVa8dbeGx1f3aEHniwqb6Yx6ur+6lOnhyvbh2tIB2tJh68sU9t09Gdg0Nqa20n0dMNbPLdK+PT9qgHRFs7x
7uyrYPVLW5t6/hk1i85XOz/cbL/
eLiUT1FhFQ8eFfKl3XhEpXzpOLr6tFTM53L5fLG0Gg1ypZgv5hNNrhby+ZLEfHMLL8/
n6fpC6SiCoExt4H+FwrsI6EJRPZlRyxULW0nQNvLUCjVDD95Rz9osF+JeF/
mB7xI9pYEVy6+M74S6lcvJA+v8IlVH6VihGL2zzSO+UD7h4CVqOSI+S61u5XOFGWqFXFENb7eQl5fhv8Wc4
sZT+vI+0SB+L/C5zfWiapW6qFB7X5KPon8LKxKBTflNcaxZzuV3Uqit8x30duhZ6/
J9HceN59Vrel+Me4r9KORyZy/
HV6DBl+lLsSgBLzNqBfUIvrS0qrrFj5CvrLia6NHe0RbROg2LPhztv44adQQ7vbV6hJjhe9mIUcvlYmbbyc
eorRbl5Qc7RyvrBYnaPoN6trVzShAUjxKo5U8XoXZE4rVF7yEvGfGM7jiIBG/
jFdRm48udRuPjcexEtx5GqK3zIe5Xiblth/pf3pH9T/
GaFjNMKdZkr6F2SuNkbbRJL1qhz6gVDuWAZY8kajTY4rGCc2OTOWSTzq6fkGHY28I2Cvsz1NSX+ajlJYNt0
INLe6qlpGJ4BbXZ+Arx+HYLEfIxEWor8uMeDZM+b9AY30X939vUXtAK9mWm0uejtoZsEh9+R01uxqjl1lXr
xF+qh3vFJA9KOiReiRQ6PibPXVWoqavnolaMbjpSfdvE3uTTjS9AbWWmABA1vO44fWsCNe43vST6W15o+Fc
W8FrUFwQqUk44knIEoUSteCifWMjFqBEWxZn1jcY8GxhdzGjQlaweWQoWo4bMxs/
676GmqccxemvaAnrJa/FwY16jozOP4CAaPw23HDHbap6/SGlYISOwn+Q2wjrxdlA18XMQteL+QVHd9/
Oo5dKD+AXU8otQy6nHsdHYfyYtSXqBWn7rQFHMHgjC7Mkka1KxnZKyK0pA90o4YEROorZbYutxPIOJldFMQ
eyo90CoHW5EhnYxajHS1PhaRNu/
itpOfOvmc9S2SbPQUWm51o9nLuJfoRbbdDLFCrXkk0lw8xFqpU0cV3mDWa2wHaOmHZfYVSic7kY+Vk51aIb
aboQaMXWO3MT51mDb3DDNjW18h7nCRoRaQVGp/Iuokbeobn0/
Qw2fYG7s0tPk81fZS1L9n6PhXqKWpHm8lkLNPCwQ16CiQvdhJ0ZNOzktsI9VyL83/
xI16gQZhPmeB3tNBXoNpUMtQi2i/
NmvohaTtP7KXyPPr5Cb2dvdswK7bIX84UvMfg6109d5bYPEq2weMAoJ1FBm35+xaywd2sWoUdfxUfNRiwFS
EUUataP/O2r7MWrxcHOzYW6/U/0/
naPfXqBW3N1QFNvQBRK6wUr6IMemOoUa9WiHHdqd+ajFek1jC0MKbD6voTTRaFdU04xa1Ec5ol/
Rawdm6lZGrVAqEUL5gzRAazuF2L7/
BWpzPI+j5FGG6XiGGptp+eaeo4YjOKNTm3L8hZlyPU3zmjQWW3NRy5+g4n5P3d+boTbH85jFoXht+XXU5tj
Qs218xFH+hQeMZ8tpK5Zo9S+9XOSE/GryDsncEjX2OaS3/hI1bS+v2o/
v4oHnZ56d9PfIIBROzuahxmChao1OzUGN2D++EXHIx77Ez/trZEBnmYuI6BWUtp8f/
SnUTgoJB4C+cGQToSaDVLpwDmrsE1P7x0l/m76wmxejxi5eef1Vz2O7kIs8yTmorZVys2Dk5Tv+OS+Xe/
hch20Ucy/
GpP0cahtsrCRsJ7MshkKNBBhdEG0uamtR9EgZkfyR7NRhIbIzM9TWpI5/1V8jV1hqK2LUZ6jxdauzJyb0yQ
sJXU3fOkONXvBzTLWTOH5M0c+gpry+nf3dwyNiLMWyEWonpaLMsMSo7a6svtvfPVk7eUfSKwd7UCALf7C/
i7YVP8mIYoZaJOivocZCfRiNLv/uJPJVmX9J7xVXdrf3Tgjd/EytpVHjBMduykFOeLm7sUjtR/0/
zs8yMr+MGnqtbPqlDxZJf4Satv/
u3WYKtcNCniwfG6aoeZMBz0t7mC9uR1hEqG0UF6LGmq8YPQYNa0mReoNFaQrZu04Y/
DRqG3l1FdP6M9TIRkmD8B77X6T+F3MpeGat5lOoFeejpu3nCyrBVyifJG5N6YGdYoRaKfb7inF+1DwoFCPP
ayWyh8VZXpMZupjO5aJ1jhXqSpQg3C7MvMooebyxEx3MF9aTw0x76O9KiVtlVrKkPGWNw8Jc6SR9WbH4wkL
QSMvl9ZkuOiifzZ65u15eP4y+bB6u5Iql4voRBrVKqR+Vy2nteYBt8Rj33u+craM/
X8idJWO5veMz5LV8eSdOEGyelddjy4pdKZdTfTRX8EikVdbWy2fSCVg7QrSIr/
LrZ6fx6dUzZKM8dzBBW6nxaftnOAoUg3yufCZfwXq5HPP3cfmsfJTuP0rRvJyRaZqvfUuf0jb29vZSPTKft
5e8YWMTL3+hR/Hgppm+JXX7yxbnnubG9zY30yaPGn/hyD9vk+9M3Pp8xKlHzElILmlJS1pSVu
hfvN6Fe3JldXgAAAAASUVORK5CYII=;2021-09-22T19:00:00-03:00;--
inf_comprovante_entrega_fim--;--nfe_comprovante_entrega_fim--;--arquivo_fim--;"} ,
"id_integrador":"U0163451-TPL-A"
}

{
"action":"EnviarEntregaNfe",
"txt_conteudo":{
"xml":"<comprovanteEntrega><versao>4.00</versao><evento><cnpj>00910509002034</
cnpj><ie>0018001360</ie><chNfe>43210900910509002034554350000000091000010040</
chNfe><dhEvento>2021-09-24T01:30:00-03:00</dhEvento><tpEvento>111500</
tpEvento><nSeqEvento>1</nSeqEvento><infCE><dhEntrega>2021-05-12T16:05:00-03:00</
dhEntrega><nDoc>2</nDoc><xNome>teste</
xNome><base64img>hrdNG+cFbtyRkNBLk6f5gwbUtKc=</base64img><dhHash>021-05-
12T16:05:00-03:00</dhHash></infCE></evento></comprovanteEntrega>"
},
}
+ Body
{
"result": "OK"
}
### Gerar Cancelamento do Comprovante de Entrega [POST]
Método para enviar o evento de Cancelamento do Comprovante de Entrega autorizado,

de NFe.
### Exemplos URL

ou
### Autenticação
OU
### Retorno Sucesso

### Retorno Erro
Http status: 203, 400, 412, 500.
+ Headers
+ Attributes
+ action (required) - Ação solicitada. Conteúdo: “CancelarEntregaNfe”

+ txt_conteudo (required) - Grupo de informações do Cancelamento do
Comprovante de Entrega.
+ xml (required) - Conteúdo do Cancelamento de Comprovante de Entrega de
NF-e.
Formato TXT: Informar dados conforme layout padrão TXT de Cancelamento do
Comprovante de Entrega de NF-e (layout/planilha está disponível no Web Help:
Mastersaf_Layout_DFe_V3_NFe_Comprovante_Entrega).
Formato XML: Informar dados conforme layout padrão XML de Cancelamento do
Comprovante de Entrega de NF-e (layout/planilha está disponível no Web Help > zip
do manual de integração webservice > Mastersaf-Layout_DF-e_V3-NF-e_XML).
+ Body

{
"action":"CancelarEntregaNfe",
"txt_conteudo":{
"xml":"--nfe_canc_comprovante_entrega_ini--;--
mastersaf_ini--;4.00;marcos;--
mastersaf_fim--;43210900910509002034554350000000071000010045;00910509002034;0018001
360;110131;1;2021-09-27T19:22:00-03:00;891210030952543;--
nfe_canc_comprovante_entrega_fim--;--arquivo_fim--;"
},
}

{
"action":"CancelarEntregaNfe",
"txt_conteudo":{
"xml":"<root><cancCE><versao>4.00</versao><evento><cnpj>00910509002034</
cnpj><ie>0018001360</ie><chNfe>43210900910509002034554350000000071000010045</
chNfe><dhEvento>2021-09-24T10:59:00-03:00</dhEvento><tpEvento>110131</
tpEvento><nSeqEvento>2</nSeqEvento><infCanCE><nProtCE>891210030899005</nProtCE></
infCanCE></evento></cancCE></root>"
},
}
+ Body
{
"result": "OK"
}
## GET [/nfe/get]
### Consultar Comprovante de Entrega e Cancelamento de Comprovante de Entrega

(getEventoEntrega) [GET /nfe/getEventoEntrega]
Método de consulta para retornar a listagem dos eventos de Comprovante de Entrega e

Cancelamento do
Comprovante de Entrega da NF-e, apresentados na aba “Comprovantes de Entrega” do
detalhamento da
NF-e.

http://localhost:8080/webservice/api/nfe/getEventoEntrega (*instalação in house*)
**ou**
https://ws.h.dfe.mastersaf.com.br/api/nfe/getEventoEntrega (*ambiente de
homologação do SaaS*)
### Autenticação
OU

(application/json).
+ Parameters
+ Headers
+ retorno - Grupo de informações para geração dos arquivos de retorno.
Dentro trás 0 ou N registros de documentos.
+ ids - Atributo de “retorno”. Listagem dos IDs dos processamentos que
constam como não consultados.
+ loteEventoEntrega - Atributo de “retorno”. Listagem dos retornos do(s)
evento(s) de Comprovante de Entrega e Cancelamento do Comprovante de Entrega que
foram processadas pelo DFE.
+ nProt - Atributo de “loteEventoEntrega”. Número do protocolo.
+ nSeqEvento - Atributo de “loteEventoEntrega”. Número sequencial do
evento.
+ nomeArquivoRetorno - Atributo de “loteEventoEntrega”. Nome do arquivo.
+ nNF - Atributo de “loteEventoEntrega”. Número da nota fiscal.
+ chave - Atributo de “loteEventoEntrega”. Chave da nota.
+ cStat - Atributo de “loteEventoEntrega”. Código do status retornado.
+ xDescricao - Atributo de “loteEventoEntrega”. Descrição da consulta de
acordo com o status final.
+ tipoComprovanteEntrega - Atributo de “loteEventoEntrega”. Tipo do evento
(tipoComprovanteEntrega outipoCancelamentoComprovanteEntrega)
+ serie - Atributo de “loteEventoEntrega”. Série da nota fiscal.
+ dhRegEvento - Atributo de “loteEventoEntrega”. Data e Hora do evento,
formato “AAAA-MM-DDTHH:MM:SS”.
+ CNPJ - Atributo de “loteEventoEntrega”. CNPJ do emissor.
+ IE - Atributo de “loteEventoEntrega”. IE do emissor.
+ tpEvento - Atributo de “loteEventoEntrega”. Código do tipo de evento
(110130 ou 110131).
+ Headers
+ Body
{
"retorno": {
"ids": [
20939,
20924
],
"loteEventoEntrega": [
{
"nProt": "",
"nSeqEvento": "2",
"nomeArquivoRetorno":
"43210900910509002034554350000000071000010045-ComprovanteEntrega-Canc02",
"nNF": "7",
"chave": "43210900910509002034554350000000071000010045",
"cStat": "573",
"xDescricao": "Rejeicao: Duplicidade de evento",
"tipoComprovanteEntrega": "tipoCancelamentoComprovanteEntrega",
"serie": "435",
"dhRegEvento": "2021-09-27T19:33:22-03:00",
"CNPJ": "00910509002034",
"IE": "0018001360",
"tpEvento": "110131"
},
{
"nProt": "891210030953014",
"nSeqEvento": "91",
"nomeArquivoRetorno":
"43210900910509002034554350000000071000010045-ComprovanteEntrega-Canc91",
"nNF": "7",
"chave": "43210900910509002034554350000000071000010045",
"cStat": "135",
"xDescricao": "Evento registrado e vinculado a NF-e",
"tipoComprovanteEntrega": "tipoCancelamentoComprovanteEntrega",
"serie": "435",
"dhRegEvento": "2021-09-27T19:33:23-03:00",
"CNPJ": "00910509002034",
"IE": "0018001360",
"tpEvento": "110131"
}
]
}
}
### Consultar Listagem NFE (getListagem) [GET /nfe/getListagem{?

cnpj,ie,periodoInicial,periodoFinal,offset,maxResults,infoAdicionais}]
Endpoint de Método de consulta para retornar uma listagem de NF-e, irá retornar
alguns dados principais de 1 ou N NF-e por consulta.
Este método retorna uma lista paginada com todos os documentos para os filtros
informados. Mais informações sobre a paginação podem ser consultadas no tópico
*LISTAGEM E PAGINAÇÃO* neste documento.

http://localhost:8080/webservice/api/nfe/getListagem?
cnpj=&ie=&periodoInicial=&periodoFinal=&offset=&maxResults=&infoAdicionais=
(*instalação in house*)
**ou**
https://ws.h.dfe.mastersaf.com.br/api/nfe/getListagem?
cnpj=&ie=&periodoInicial=&periodoFinal=&offset=&maxResults=&infoAdicionais=
(*ambiente de homologação do SaaS*)
### Autenticação
OU

(application/json).
+ Parameters
+ cnpj - Filtrar por cnpj
+ ie (optional) - Filtrar por inscrição estadual
+ periodoInicial (optional) - Filtrar por período inicial. O intervalo entre
periodo inicial e final deverá ser no máximo 31 dias. Se não informado será
considerado o dia corrente. Formato DD/MM/AAAA HH:MM.
+ periodoFinal (optional) - Filtrar por período final. O intervalo entre
+ offset (number, optional) - Elemento inicial da lista. Se não informado será
considerado o valor 0.
+ maxResults (number, optional) - Número de elementos da lista (min:1 max:100).
Se não informado será considerado o valor 10.
+ infoAdicionais (optional) - true ou false. Se não informado será considerado
como false. Indica se deseja utilizar o resultado resumido (false), com as
informações mais relevantes de cada documento (situacao, tipoEmissao, chaveAcesso,
dataAutorizacao, cnpjEmissor, valorTotal, serie, cpfCnpjDest, dataEmissao,
numeroNfe, status), ou informações adicionais (true) de cada documento, além das
informações do resumido (enderecoFornec, razaoSocialTrans,
placaVeiculoTransportador, tipoNfe, cpfCnpjTransportador, bairroFornec, ufTrans,
razaoSocialEmissor, protocolo, especie, marca, codigoAntt, ufPlaca, bairroDest,
razaoSocialDest, municipioFornec, enderecoDest, ufDestinatario, cepFornec,
numeracaoVolume, municipioTrans, tipoFrete, cfop, dataSaida, enderecoTrans,
descricaoSituacao, qtdaVolume, naturezaOperacao, pesoBruto, municipioDest, cepDest,
ufFornec, pesoLiquido, valorTransporte).
+ Headers
+ result - Atributo de resultado, dentro trás 0 ou N registros de

documentos.
+ message - "OK"
+ hasMore - Indica se há mais uma página a ser buscada para os filtros
informados. true ou false.
+ count - Quantia total de itens para os filtros informados
+ maxResults - Quantidade de objetos por páginainformada nos parâmetros.
+ offset - Posição do objeto a partir do qual a página deve ser carregada,
informada nos parâmetros.
+ Headers
+ Body
{
"result": [
{
"situacao": "Rejeitado",
"tipoEmissao": "1",
"chaveAcesso": "43210700910509000171557340000738671000010048",
"dataAutorizacao": "",
"cnpjEmissor": "00910509000171",
"valorTotal": "240,00",
"serie": "734",
"cpfCnpjDest": "35402759000185",
"dataEmissao": "23/07/2021 03:19:00",
"numeroNfe": "73867",
"status": "728"
},
{
"situacao": "Autorizado",
"tipoEmissao": "1",
"chaveAcesso": "43210700910509000171557340000738661000010040",
"dataAutorizacao": "07/07/2021 18:01:59",
"cnpjEmissor": "00910509000171",
"serie": "734",
"cpfCnpjDest": "35402759000185",
"dataEmissao": "07/07/2021 03:19:00",
"status": "100"
},
{
"tipoEmissao": "1",
"chaveAcesso": "43210700910509000171557340000738651000010043",
"cnpjEmissor": "00910509000171",
"serie": "734",
"cpfCnpjDest": "35402759000185",
"dataEmissao": "07/07/2021 03:19:00",
"status": "100"
},
{
"tipoEmissao": "1",
"chaveAcesso": "43210700910509000171557340000738641000010046",
"cnpjEmissor": "00910509000171",
"serie": "734",
"cpfCnpjDest": "35402759000185",
"dataEmissao": "07/07/2021 03:19:00",
"status": "100"
}
],
"offset": 4,
"maxResults": 4,
"count": 20,
"hasMore": true,
"message": "OK"
}
### Consultar Log NFE (getLog) [GET /nfe/getLog{?

cnpj,ie,serie,numero,offset,maxResults}]
Endpoint de Método de consulta para retornar os logs da NF-e, irá retornar todos os
logs de uma única NF-e a cada consulta, por isso o cliente deverá enviar como
parâmetro a identificação da NF-e.
Este método retorna uma lista paginada com os logs para os filtros informados. Mais
informações sobre a paginação podem ser consultadas no tópico LISTAGEM E PAGINAÇÃO
neste documento.

http://localhost:8080/webservice/api/nfe/getLog?
cnpj=&ie=&serie=&numero=&offset=&maxResults= (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/nfe/getLog?
cnpj=&ie=&serie=&numero=&offset=&maxResults= (ambiente de homologação do SaaS)
### Autenticação
OU

(application/json).
+ Parameters
+ serie - Filtrar por série do documento.
+ numero - Filtrar por número do documento.
+ Headers
+ result - Atributo de resultado, dentro trás 0 ou N registros de logs.

+ message - "OK"
+ maxResults - Quantidade de objetos por página, informada nos parâmetros.
+ Headers
+ Body
{
"result":
[
{"dataHora":"03/08/2021
10:44:34","status":10,"historico":"Criado NFE - Processamento inicia-se às
03/08/2021 10h44 -(elainemachado@TR-CFX65Y2)","stackTrace":null},
{"dataHora":"03/08/2021 10:44:37","status":10,"historico":"Remontando e Assinando
novo xml da NF-e.","stackTrace":null},{"dataHora":"03/08/2021
10:44:37","status":10,"historico":"De acordo com a norma técnica NT2011.004, a
razão social do destinatário foi mudada para \"NF-E EMITIDA EM AMBIENTE DE
HOMOLOGACAO - SEM VALOR FISCAL\".","stackTrace":null},{"dataHora":"03/08/2021
10:44:38","status":20,"historico":"Retorno do xml do lote.","stackTrace":null},
{"dataHora":"03/08/2021 10:44:38","status":30,"historico":"Lote Recebido com
sucesso :431022029371486","stackTrace":null},{"dataHora":"03/08/2021
10:44:47","status":30,"historico":"Realizando consulta da situação do
lote","stackTrace":null},{"dataHora":"03/08/2021
10:44:48","status":30,"historico":"Retorno do xml de consulta do
lote.","stackTrace":null},{"dataHora":"03/08/2021
10:44:48","status":30,"historico":"Chave de Acesso =
43210800910509002034550180000000131000010049","stackTrace":null},
{"dataHora":"03/08/2021 10:44:48","status":100,"historico":"Autorizado o uso da
NFE","stackTrace":null},{"dataHora":"03/08/2021
10:45:04","status":100,"historico":"Marcado como consultado -(elainemachado@TR-
CFX65Y2)","stackTrace":null}
],
"message":"OK",
"hasMore": true,
"count": 50,
"maxResults": 10,
"offset": 0
}
### Consultar Evento Prorrogação (getEventoProrrog) [GET /nfe/getEventoProrrog{?

maxResults}]
Endpoint de Método de consulta dos eventos de prorrogação não consultados.

http://localhost:8080/webservice/api/nfe/getEventoProrrog?maxResults= (instalação
in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/nfe/getEventoProrrog?maxResults= (ambiente de
homologação do SaaS)
### Autenticação
OU
### Permissões


(application/json).
+ Parameters
+ maxResults (number, optional) - Número de elementos da lista. Se não
informado será considerado o valor 50.
+ Headers
### Consultar Impressão Carta de Correção NF-e (getImpressaoCCe) [GET

/nfe/getImpressaoCCe]
Endpoint para obter apenas os retornos dos documentos de Carta de Correção de NF-e,
que devem ser enviados para o Printer imprimir. Após o retorno, o sistema marca os
documentos como “adicionados na fila de impressão” e não são mais retornados pelo
método.
Anteriormente esse método tinha o nome de getImpressaoCcNfe (ainda válido até a
versão 3.104.0), à partir da versão 3.104.0, somente o nome getImpressaoCCe será
reconhecido.

http://localhost:8080/webservice/api/nfe/getImpressaoCCe (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/nfe/getImpressaoCCe (ambiente de homologação
do SaaS)
### Autenticação
OU
### Permissões


(application/json).
+ Parameters
+ Headers
+ impressaoCCe - Lista de eventos de carta de correção para impressão. Trás

0 ou N registros de documentos.
+ idProcessamento - Atributo de "impressaoCCe". Id do processamento.
+ params - Atributo de "impressaoCCe". Parâmetros de impressão.
+ Headers
+ Body
{
"impressaoCCe": [
{
"idProcessamento": 23140,
"params": {
"id": 19462,
"conteudoXml": "<NFe
xmlns=\"http://www.portalfiscal.inf.br/nfe\"><infNFe
Id=\"NFe43211000910509002034554350000000781000010047\"
adquirida ou recebida
&<></natOp><mod>55</mod><serie>435</serie><nNF>78</nNF><dhEmi>2021-10-
indFinal><indPres>1</indPres><procEmi>0</procEmi><verProc>3.96.0</verProc></
ide><emit><CNPJ>00910509002034</CNPJ><xNome>NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO
- SEM VALOR FISCAL</xNome><xFant>NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM
VALOR FISCAL</xFant><enderEmit><xLgr>Rua das
FISCAL</xNome><enderDest><xLgr>Rua Avenida</xLgr><nro>423</nro><xCpl>Próx.
centro</xCpl><xBairro>Sto Antonio</xBairro><cMun>3550308</cMun><xMun>São
Paulo</xMun><UF>SP</UF><CEP>14526878</CEP><cPais>1058</cPais><xPais>Brasil</
xPais><fone>11978545588</fone></enderDest><indIEDest>1</
indIEDest><IE>118093846110</IE><email>automacao@automacao.com.br</email></
dest><retirada><CNPJ>00910509000171</CNPJ><xLgr>Negro Arroyo
nItem=\"1\"><prod><cProd>CTCAPD</cProd><cEAN>9782700520057</cEAN><xProd>PRODUTO
TESTE 1 &<></xProd><NCM>31021090</NCM><NVE>AA0001</NVE><NVE>AA0002</
NVE><CEST>1111567</CEST><indEscala>N</indEscala><CNPJFab>00910509000171</
CNPJFab><cBenef>RS051501</cBenef><EXTIPI>123</EXTIPI><CFOP>5405</CFOP><uCom>KG</
uCom><qCom>10.000</qCom><vUnCom>25.00</vUnCom><vProd>250.00</
vProd><cEANTrib>9782700520057</cEANTrib><uTrib>KG</uTrib><qTrib>1.000</
qTrib><vUnTrib>250.00</vUnTrib><vDesc>10.00</vDesc><indTot>1</
indTot><rastro><nLote>AA0001LT</nLote><qLote>25</qLote><dFab>2016-12-01</
dFab><dVal>2018-12-01</dVal></rastro><med><cProdANVISA>1234567890123</
cProdANVISA><vPMC>100.00</vPMC></med></prod><imposto><vTotTrib>0.00</
vTotTrib><ICMS><ICMS40><orig>0</orig><CST>41</CST><vICMSDeson>20.00</
vICMSDeson><motDesICMS>1</motDesICMS></ICMS40></
ICMS><IPI><CNPJProd>01234567896325</CNPJProd><cSelo>888</cSelo><qSelo>9584</
qSelo><cEnq>999</cEnq><IPITrib><CST>99</CST><vBC>0.00</vBC><pIPI>0</
pIPI><vIPI>0.00</vIPI></IPITrib></IPI><PIS><PISNT><CST>08</CST></PISNT></
PIS><COFINS><COFINSNT><CST>08</CST></COFINSNT></COFINS></imposto><infAdProd><!
[CDATA[ <id item=\"2N153E525AB\" ped=\" 386302\"/><div uM=\"
PC\"/> ]]></infAdProd></det><total><ICMSTot><vBC>0.00</vBC><vICMS>0.00</
transp><pag><detPag><tPag>18</tPag><vPag>10.00</vPag></detPag><detPag><tPag>18</
tPag><vPag>10.00</vPag></detPag><detPag><tPag>18</tPag><vPag>10.00</vPag></
detPag><detPag><tPag>18</tPag><vPag>10.00</vPag></detPag><detPag><tPag>18</
tPag><vPag>100.00</vPag></detPag><detPag><tPag>18</tPag><vPag>100.00</vPag></
detPag></pag><infAdic><infAdFisco>Informações Adicionais de Interesse do
Fisco</infAdFisco><infCpl><fornec:00017621 Brose do Brasil Ltda > 0000001937
Fiat Automoveis Ltda021 25052018 IPI - Suspenso cfe. Art 136-Inc III Dec7212
Resolução do Senado Federal nº 13/12, Número da FCI 038A01CA-D396-4212-81D4-
4B88C4AB66DC Resolução do Senado Federal nº 13/12, Número da FCI CD524971-A6C8-
4AF4-83D1-635D9DA9D162 Resolução do Senado Federal nº 13/12, Número da FCI
22A57466-C5B9-411D-AEC0-BF8D5F0DB945 Resolução do Senado Federal nº 13/12, Número
da FCI A2D96FF6-AAB2-4A06-8F92-94AA64B36A79 Resolução do Senado Federal nº 13/12,
Número da FCI F73AFF59-A101-4BD1-825A-492F921DDB48 Resolução do Senado Federal nº
13/12, Número da FCI 36E34ED4-263E-4CB3-A1B7-60457537AA2F Resolução do Senado
Federal nº 13/12, Número da FCI 7788D195-BAD8-4CA7-9AB9-34EA8035BEB0 Resolução do
Senado Federal nº 13/12, Número da FCI B033E8D9-42EF-423D-9E06-135ABD49BF25
Resolução do Senado Federal nº 13/12, Número da FCI EC8BDA77-D413-44FD-BEBB-
8F13A44328DD Resolução do Senado Federal nº 13/12, Número da FCI FA3DB178-ACCC-
4A40-842B-45A5DFD91FC2 Resolução do Senado Federal nº 13/12, Número da FCI
377132CA-B9C3-4015-A96A-AEAB62E138F6 Resolução do Senado Federal nº 13/12, Número
da FCI B2354C80-0678-43C5-95A5-8ECA624243F8 Resolução do Senado Federal nº 13/12,
Número da FCI B5CC45CB-3A65-4F89-A822-30DF57AE05A4 Resolução do Senado Federal nº
13/12, Número da FCI A6A9CD34-24D4-41F3-8E6A-A30504D47142 Resolução do Senado
Federal nº 13/12, Número da FCI 8D19FFB1-9B85-49D5-9532-0C4E15A8519F Resolução do
Senado Federal nº 13/12, Número da FCI 8E35688B-CD1C-4655-880B-5F70C567D20D
Resolução do Senado Federal nº 13/12, Número da FCI FF283BCD-BBB8-4F0C-B217-
5784333BAF7C bordero 138781</infCpl><obsCont xCampo=\"campo 1 uso
livre\"><xTexto>Conteúdo do Campo 1 para uso livre</xTexto></obsCont><obsFisco
xCampo=\"242342\"><xTexto>texto de uso livre
cana><infRespTec><CNPJ>00910509000171</CNPJ><xContato>Teste</
xContato><email>teste@teste.com</email><fone>11997731642</fone></infRespTec></
infNFe><Signature
xmlns=\"http://www.w3.org/2000/09/xmldsig#\"><SignedInfo><CanonicalizationMethod
Algorithm=\"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"/><SignatureMethod
Algorithm=\"http://www.w3.org/2000/09/xmldsig#rsa-sha1\"/><Reference
URI=\"#NFe43211000910509002034554350000000781000010047\"><Transforms><Transform
Algorithm=\"http://www.w3.org/2000/09/xmldsig#enveloped-signature\"/><Transform
Algorithm=\"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"/></Transforms><Digest
Method
Algorithm=\"http://www.w3.org/2000/09/xmldsig#sha1\"/><DigestValue>sNi6P9IxCIZwmCvh
HQx1IIjlfgk=</DigestValue></Reference></SignedInfo><SignatureValue>ORVCTTx4HmB/
vNDwLGZ/
rJyikDBVbblKikRi4TVb2bGAefOuCrD9NxUjOas9CxU4J+wrQlK+6baUbPUbkXXtVU6t8516tUyOVXoTdB9
HrhFvVh5MChnxfYpyoGKV3jv6l402IWvG80N2Gl5JULO4LDE9Q/1DB79VP8pLRw70kHmL2FYemQp/
vAKBFqEl+BEVZakA3RFx6Xl1oMoQ8ey6XZzxA7JilsPVj44enWJAMXDg0u2k7UXmBS54JtQ65VB3RnvypIW
ENbPEa2B3lh8jPByyn3u2B4QaT0yVwyW3PItE+9paJPQ+aXsORL9aczp9aVb1H7KZoaBiWRNGqVy2QQ==</
SignatureValue><KeyInfo><X509Data><X509Certificate>MIIIKDCCBhCgAwIBAgIQEv7EB8+qTPef
9zTOM9U/
fjANBgkqhkiG9w0BAQsFADB4MQswCQYDVQQGEwJCUjETMBEGA1UEChMKSUNQLUJyYXNpbDE2MDQGA1UECxM
tU2VjcmV0YXJpYSBkYSBSZWNlaXRhIEZlZGVyYWwgZG8gQnJhc2lsIC0gUkZCMRwwGgYDVQQDExNBQyBDZX
J0aXNpZ24gUkZCIEc1MB4XDTIxMDQyNzIwNDUyOFoXDTIyMDQyNzIwNDUyOFowggEWMQswCQYDVQQGEwJCU
jETMBEGA1UECgwKSUNQLUJyYXNpbDELMAkGA1UECAwCU0MxFjAUBgNVBAcMDUZsb3JpYW5vcG9saXMxGTAX
BgNVBAsMEFZpZGVvQ29uZmVyZW5jaWExFzAVBgNVBAsMDjA4OTM2MDU0MDAwMTc1MTYwNAYDVQQLDC1TZWN
yZXRhcmlhIGRhIFJlY2VpdGEgRmVkZXJhbCBkbyBCcmFzaWwgLSBSRkIxFjAUBgNVBAsMDVJGQiBlLUNOUE
ogQTExSTBHBgNVBAMMQFRIT01TT04gUkVVVEVSUyBCUkFTSUwgQ09OVEVVRE8gRSBURUNOT0xPR0lBIExUR
EE6MDA5MTA1MDkwMDEyMjQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDKnQdaUqBCrTjAgPki
Wu6LVRy8npH3egR/
zIIxH0Zgmtx6KRXLMWgZp4ZeR7Lzg7cs3U8WGY5pHLYEzAoWaudY5zgYzgNDDw5k1BL1SqHLPJnGKNDFNBO
U/9hX2PDwLtZMAANLwXzaYfPKpiicOCDMoPj4RALSEM1Wc/
1QtZ5X7+62+4yTXdHEd8EsaNfHV9ifa5F02R7V+l4bfT+CFPKLqyt0IpI1mmyaxCxPHsTp5J2Desi+lzOXt
Cwvt0rbY74FtIaBTbZfwB8xaqQ6HB8OZk6AYFLAWLtM2xWwvKGgygGE4EUP+hkjppuqK1e7ddVujZZJEo0l
lUYesJfUeX5JAgMBAAGjggMMMIIDCDCBuwYDVR0RBIGzMIGwoDgGBWBMAQMEoC8ELTExMDcxOTc1MjM0MjI
wMzY4MzAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMKAaBgVgTAEDAqARBA9TQU5USUFHTyBBWUVSWkGgGQ
YFYEwBAwOgEAQOMDA5MTA1MDkwMDEyMjSgFwYFYEwBAwegDgQMMDAwMDAwMDAwMDAwgSRjb21wbGlhbmNlL
mJyYXNpbEB0aG9tc29ucmV1dGVycy5jb20wCQYDVR0TBAIwADAfBgNVHSMEGDAWgBRTfX+dvtFh0CC62p/
jiacTc1jNQjB/
BgNVHSAEeDB2MHQGBmBMAQIBDDBqMGgGCCsGAQUFBwIBFlxodHRwOi8vaWNwLWJyYXNpbC5jZXJ0aXNpZ24
uY29tLmJyL3JlcG9zaXRvcmlvL2RwYy9BQ19DZXJ0aXNpZ25fUkZCL0RQQ19BQ19DZXJ0aXNpZ25fUkZCLn
BkZjCBvAYDVR0fBIG0MIGxMFegVaBThlFodHRwOi8vaWNwLWJyYXNpbC5jZXJ0aXNpZ24uY29tLmJyL3Jlc
G9zaXRvcmlvL2xjci9BQ0NlcnRpc2lnblJGQkc1L0xhdGVzdENSTC5jcmwwVqBUoFKGUGh0dHA6Ly9pY3At
YnJhc2lsLm91dHJhbGNyLmNvbS5ici9yZXBvc2l0b3Jpby9sY
3IvQUNDZXJ0aXNpZ25SRkJHNS9MYXRlc3RDUkwuY3JsMA4GA1UdDwEB/
wQEAwIF4DAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwgawGCCsGAQUFBwEBBIGfMIGcMF8GCCsG
AQUFBzAChlNodHRwOi8vaWNwLWJyYXNpbC5jZXJ0aXNpZ24uY29tLmJyL3JlcG9zaXRvcmlvL2NlcnRpZml
jYWRvcy9BQ19DZXJ0aXNpZ25fUkZCX0c1LnA3YzA5BggrBgEFBQcwAYYtaHR0cDovL29jc3AtYWMtY2VydG
lzaWduLXJmYi5jZXJ0aXNpZ24uY29tLmJyMA0GCSqGSIb3DQEBCwUAA4ICAQBZWQ0ps8Pb0xTU3O+M3twKP
2q5SK0YQD36OIqaWubiiT2R+joqBId3jvyoux1+Vp3VjVcf4F51xy5w1i18w0cs884slP1iWOlkPkqVBOtt
+ZDRhJdYnyrSFduAwI6JPjh2ItmWA65xaHSdshkHCVGYpMYzYyoL22hrHyAwDrRa2i0VmW+zqBJmGxFT1AJ
EW0PiSxOhiGjEbRVIqCQkcnYOq4FSFplEwgthLQHLuG9zEvqxSb4v9r10N4fp31rXbpIXg9b8cKD+jfN8Sk
Q5uCrIr6pl/pQm/
ZGri3vSkJqst2EHchY6m+ONCB8X18gakBiiUIECOPp1hq1KtrGGQN2sCWcPFghpSl32b7/rO1P1i2KmC/
BjP59rQSd8BdjC6yZXSrkMfnx+
+6WCvPAw2IW8rzW2ROKoObfk5sQOaxwgrf2OE1slcTFAY3CXuxpzP2Pm72XF/
owYJNKreyp+zvxJKSbhXBAHVTB7oWmbTdYZulSSAlclKV1R81iXuZqk/
s61Tox9UleMNxkc+AmIN05Ao2LM3nyNHCWQmyQ6NY8ptLajpZZV5M9HD6kWhbwLms9mMvVpXuIFmfNEEHAU
LqW1aVmq62Kldksb31COwoY6eNusXHRbktcrOxo0aCCXAmROL625LuOnz6L8Ler/
BdjKrsLMQflmp4BveQCHxb97Zg==</X509Certificate></X509Data></KeyInfo></Signature></
NFe>",
"versaoXml": null,
"dataEmissao": null,
"nroCopias": 1,
"impressoraAlvo": null,
"formatoImpressao": 12,
"isContingencia": false,
"nroProtocolo": "143210001245275",
"emailEmpresa": "teste@teste.com",
"emailEmitente": "",
"dataRecebimentoDpec": null,
"nroRecebimentoDpec": null,
"casasDecimaisValorUnit": 4,
"diretorioModeloDoctoFiscalCustomizado": null,
"statusDocto": 0,
"xmlEnvioCC": "<?xml version=\"1.0\" encoding=\"UTF-8\"
standalone=\"yes\"?><procEventoNFe versao=\"1.00\"
xmlns=\"http://www.portalfiscal.inf.br/nfe\"><evento
xmlns=\"http://www.portalfiscal.inf.br/nfe\" versao=\"1.00\"><infEvento
Id=\"ID1101104321100091050900203455435000000078100001004701\"><cOrgao>43</
cOrgao><tpAmb>2</tpAmb><CNPJ>00910509002034</
CNPJ><chNFe>43211000910509002034554350000000781000010047</chNFe><dhEvento>2021-12-
nSeqEvento><verEvento>1.00</verEvento><detEvento versao=\"1.00\"><descEvento>Carta
de Correcao</descEvento><xCorrecao>Informações complementares: /teste - um dois /
tres</xCorrecao><xCondUso>A Carta de Correcao e disciplinada pelo paragrafo 1o-A do
art. 7o do Convenio S/N, de 15 de dezembro de 1970 e pode ser utilizada para
regularizacao de erro ocorrido na emissao de documento fiscal, desde que o erro nao
esteja relacionado com: I - as variaveis que determinam o valor do imposto tais
como: base de calculo, aliquota, diferenca de preco, quantidade, valor da operacao
ou da prestacao; II - a correcao de dados cadastrais que implique mudanca do
remetente ou do destinatario; III - a data de emissao ou de
saida.</xCondUso></detEvento></infEvento><Signature
URI=\"#ID1101104321100091050900203455435000000078100001004701\"><Transforms><Transf
orm Algorithm=\"http://www.w3.org/2000/09/xmldsig#enveloped-signature\"/><Transform
Method
Algorithm=\"http://www.w3.org/2000/09/xmldsig#sha1\"/><DigestValue>uSUcfimdB1DUIhVz
rPWFAYfCghE=</DigestValue></Reference></SignedInfo><SignatureValue>DGVsuurE/
73gEchSf4DrH3u4YC1iiAT63aDxsgINuazaH4PAt2ci6KvOIONTZehgDccL/
CRfqhjeM+LJgV28KW1NmkpaQaMTe4Fz0tyENRKNdscHphUdSTl7q7YzBUEJ2l+DQv9OixCM5jeNWYqynyJL
yXL1QTLA5J0FRlBe7HhxAwR5KNK5dLys2m6BRu0hx7sAhGRRbY8hAMpwT3FrlGJGpGy9LAG7Og56j05CRrs
Lofz7fmih+uMdqPZ7jl5K76IWchgT+mjzXIOs0Q7n8WrLEWrv0aeeCaWFHRhPt0EPZttNGjE3veAzsm0jKO
cMCQhgXXjac+eHekJBqsUmXA==</
9zTOM9U/
Wu6LVRy8npH3egR/
jiacTc1jNQjB/
YnJhc2lsLm91dHJhbGNyLmNvbS5ici9yZXBvc2l0b3Jpby9sY3IvQUNDZXJ0aXNpZ25SRkJHNS9MYXRlc3R
DUkwuY3JsMA4GA1UdDwEB/
Q5uCrIr6pl/pQm/
evento><retEvento xmlns=\"http://www.portalfiscal.inf.br/nfe\"
versao=\"1.00\"><infEvento><tpAmb>2</tpAmb><verAplic>RS201905151543</
verAplic><cOrgao>43</cOrgao><cStat>135</cStat><xMotivo>Evento registrado e
vinculado a NF-e</xMotivo><chNFe>43211000910509002034554350000000781000010047</
chNFe><tpEvento>110110</tpEvento><nSeqEvento>1</
nSeqEvento><CNPJDest>00910509002034</
CNPJDest><emailDest>automacao@automacao.com.br</emailDest><dhRegEvento>2021-12-
21T11:41:22-03:00</dhRegEvento><nProt>143210001245275</nProt></infEvento></
retEvento></procEventoNFe>",
"xmlRetornoCC": "<retEvento
xmlns=\"http://www.portalfiscal.inf.br/nfe\"
versao=\"1.00\"><infEvento><tpAmb>2</tpAmb><verAplic>RS201905151543</
vinculado a NF-e</xMotivo><chNFe>43211000910509002034554350000000781000010047</
chNFe><tpEvento>110110</tpEvento><nSeqEvento>1</
nSeqEvento><CNPJDest>00910509002034</
CNPJDest><emailDest>automacao@automacao.com.br</emailDest><dhRegEvento>2021-12-
21T11:41:22-03:00</dhRegEvento><nProt>143210001245275</nProt></infEvento></
retEvento>",
"xmlCancelamento": null,
"casasDecimaisQuantidade": null,
"valorAproximadoTributos": "",
"mensagemContingencia": null,
"cnpjEmissor": "00910509002034",
"inscricaoEmissor": "0018001360",
"urlConsultaNota": null,
"urlConsultaDanfe": null,
"viaNotaEmissao": null,
"contingenciaEpec": false,
"falsaImpressao": false,
"sequenciaImpressao": 0,
"valorTributosDanfe": null,
"exibirDadosConsumidorDanfe": true,
"exibirChaveReferenciadaDanfe": true,
"exibirValoresIcmsInterestadual": true,
"exibirValorTributavelProduto": 1,
"enviaPrinter": 0,
"nomenclaturaArquivos": null,
"exibirQuadrosTotaisICMSFCP": null,
"informacoesFatura": null,
"exibirInformacoesEntrega": 0,
"exibirInformacoesRetirada": 0,
"layoutImpressao": 0,
"isNotaRecebimento": false,
"ordemEmbarque": "123456",
"nroItens": "1",
"usuarioEmitente": "Walter White",
"exibirDadosCDATA": false,
"urlConsultaMDFe": null,
"urlConsultaCTe": null,
"codMsgSefazContribuinte": null,
"msgSefazContribuinte": null,
"documentoCustomizado": null
}
}
]
}
# Group NFCE
## GET [/ncfe/get]
### Consultar Listagem NFCE (getListagem) [GET /nfce/getListagem{?

cnpj,ie,periodoInicial,periodoFinal,offset,maxResults}]
Endpoint de Método de consulta para retornar uma listagem de NFC-e, irá retornar
alguns dados principais de 1 ou N NFC-e por consulta.
LISTAGEM E PAGINAÇÃO neste documento.

http://localhost:8080/webservice/api/nfce/getListagem?
cnpj=&ie=&periodoInicial=&periodoFinal=&offset=&maxResults= (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/nfce/getListagem?
cnpj=&ie=&periodoInicial=&periodoFinal=&offset=&maxResults= (ambiente de
### Autenticação
OU

(application/json).
+ Parameters
+ Headers


documentos.
+ message - "OK"
+ Headers
+ Body
{
"result":[
{"enderecoFornec":"Rua das Araucárias,
345","razaoSocialTrans":"Transportadora","placaVeiculoTransportador":"","numeroNfce
":"51","situacao":"Autorizado","tipoNfe":"1","cpfCnpjTransportador":"","bairroForne
c":"Centro","ufTrans":"RS","dataEmissao":"26/02/2021
11:35:43","razaoSocialEmissor":"NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR
FISCAL","protocolo":"143210000095216","especie":"Agonias","marca":"Wksaok","codigoA
ntt":"","ufPlaca":"","bairroDest":"Sto Antonio","dataAutorizacao":"26/02/2021
11:35:51","razaoSocialDest":"NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR
FISCAL","valorTotal":"250,00","municipioFornec":"Goiandira","enderecoDest":"Rua
Avenida,
423","ufDestinatario":"SP","cepFornec":"78945612","numeracaoVolume":"12312","cnpjEm
issor":"00910509002034","municipioTrans":"Rio
Grange","tipoFrete":"9","cpfCnpjDest":"35402759000185","cfop":"5405","dataSaida":""
,"enderecoTrans":"Rua Sem Fim","descricaoSituacao":"Autorizado o uso da NF-
e","chaveAcesso":"43210200910509002034651680000000511000010042","qtdaVolume":"120",
"naturezaOperacao":"Venda de mercadoria adquirida ou
recebida","serie":"168","pesoBruto":"2.500,0000","municipioDest":"São
Paulo","cepDest":"14526878","ufFornec":"RS","pesoLiquido":"2.300,0000","valorTransp
orte":"0"}
],
"message":"OK",
"hasMore": false,
"count": 4,
"maxResults": 10,
"offset": 0
}
### Consultar Log NFCE (getLog) [GET /nfce/getLog{?

Endpoint de Método de consulta para retornar os logs da NFC-e, irá retornar todos
os logs de uma única NFC-e a cada consulta, por isso o cliente deverá enviar como
parâmetro a identificação da NFC-e.
neste documento.
http://localhost:8080/webservice/api/nfce/getLog?
ou
https://ws.h.dfe.mastersaf.com.br/api/nfce/getLog?
### Autenticação
OU

(application/json).
+ Parameters
+ Headers

+ message - "OK"
+ Headers
+ Body
{
"result":[{
"dataHora":"22/03/2018 15:18:23",
"status":10,
"historico":"Criado NFC-e - Processamento inicia-se às 22/03/2018
15h18 -(integrador@U0172999-TPL-B)",
"stackTrace":null
},
{
"dataHora":"22/03/2018 15:18:23",
"status":20,
"historico":"Criado lote para envio",
"stackTrace":null
},
{
"dataHora":"22/03/2018 15:18:27",
"status":20,
"historico":"Retorno do xml do lote.",
"stackTrace":null
},
{
"dataHora":"22/03/2018 15:18:27",
"status":30,
"historico":"Lote Recebido com sucesso :431995022491403",
"stackTrace":null
},
{
"dataHora":"22/03/2018 15:18:33",
"status":30,
"historico":"Realizando consulta da situação do lote",
"stackTrace":null
},
{
"dataHora":"22/03/2018 15:18:36",
"status":30,
"historico":"Retorno do xml de consulta do lote.",
"stackTrace":null
},
{
"dataHora":"22/03/2018 15:18:36",
"status":30,
"historico":"Chave de Acesso =
43180300999509000334657410000477271000010099",
"stackTrace":null
},
{
"dataHora":"22/03/2018 15:18:36",
"status":100,
"historico":"Autorizado o uso da NFC-e",
"stackTrace":null
},
{
"dataHora":"22/03/2018 15:18:53",
"status":100,
"historico":"Marcado como consultado -(integrador@U0172999-TPL-
B)",
"stackTrace":null
}],
"message":"OK",
"hasMore": false,
"count": 9,
"maxResults": 10,
"offset": 0
}
# Group CTE
## GET [/cte/get]
## Consultar Listagem CTE (getListagem) [GET /cte/getListagem{?

Endpoint de Método de consulta para retornar uma listagem de CT-e, irá retornar
alguns dados principais de 1 ou N CT-e por consulta.

http://localhost:8080/webservice/api/cte/getListagem?
ou
https://ws.h.dfe.mastersaf.com.br/api/cte/getListagem?
### Autenticação
OU

(application/json).
+ Parameters
+ Headers

documentos.
+ message - "OK"
+ Headers
+ Body
{
"result":[
{"situacao":"Rejeitado","emitenteDescricao":"CT-E EMITIDO EM
AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL","dataEmissao":"19/07/2021
05:57:35","protocolo":null,"cnpjEmitente":"00910509002034","descricaoRetorno":"Reje
ição: IE do destinatario invalida","razaoSocialDest":"CT-E EMITIDO EM AMBIENTE DE
HOMOLOGACAO - SEM VALOR FISCAL","razaoSocialRecebedor":"CT-E EMITIDO EM AMBIENTE DE
HOMOLOGACAO - SEM VALOR FISCAL","cpfCnpjExpedidor":"13495487000172","modal":"01 -
Rodoviário","cpfCnpjRecebedor":"01943665000100","tipoServico":"0 -
Normal","valorTotalMercadoria":"218,18","valorTotalPrestacao":"17,45","cpfCnpjDest"
:"00910509002034","cfop":"5353","razaoSocialRemetente":"CT-E EMITIDO EM AMBIENTE DE
HOMOLOGACAO - SEM VALOR
FISCAL","ufOrigem":"RS","numeroCte":"9","cpfCnpjRemetente":"76096718000438","razaoS
ocialExpedidor":"CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR
FISCAL","chaveAcesso":"43210700910509002034570060000000091391776625","naturezaOpera
cao":"Prestação serv. tranRS. estab.
comercial","ufDest":"RS","serie":"6","emailEnviadoPara":"","tomadorServico":"3 -
Destinatário"},{"situacao":"Autorizado","emitenteDescricao":"CT-E EMITIDO EM
05:57:35","protocolo":"143210000392300","cnpjEmitente":"00910509002034","descricaoR
etorno":"Autorizado o uso do CT-e","razaoSocialDest":"CT-E EMITIDO EM AMBIENTE DE
FISCAL","ufOrigem":"RS","numeroCte":"12","cpfCnpjRemetente":"76096718000438","razao
SocialExpedidor":"CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR
comercial","ufDest":"RS","serie":"6","emailEnviadoPara":"teste@teste.com","tomadorS
ervico":"3 - Destinatário"},{"situacao":"Rejeitado","emitenteDescricao":"CT-E
EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL","dataEmissao":"19/07/2021
Destinatário"},{"situacao":"Rejeitado","emitenteDescricao":"CT-E EMITIDO EM
Destinatário"},{"situacao":"Erro no XML","emitenteDescricao":"CT-E EMITIDO EM
05:57:35","protocolo":null,"cnpjEmitente":"00910509002034","descricaoRetorno":"Marc
ado como consultado -(elainemachado@TR-CFX65Y2)","razaoSocialDest":"CT-E EMITIDO
EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL","razaoSocialRecebedor":"CT-E EMITIDO
EM AMBIENTE DE HOMOLOGACAO - SEM VALOR
FISCAL","cpfCnpjExpedidor":"13495487000172","modal":"01 -
Destinatário"},{"situacao":"Autorizado","emitenteDescricao":"CT-E EMITIDO EM
FISCAL","ufOrigem":"MG","numeroCte":"14","cpfCnpjRemetente":"76096718000438","razao
comercial","ufDest":"MG","serie":"6","emailEnviadoPara":"elaine.machado@tr.com","to
madorServico":"3 - Destinatário"},{"situacao":"Autorizado","emitenteDescricao":"CT-
E
EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL","dataEmissao":"19/07/2021
FISCAL","ufOrigem":"MG","numeroCte":"16","cpfCnpjRemetente":"76096718000438","razao
comercial","ufDest":"MG","serie":"6","emailEnviadoPara":"","tomadorServico":"3 -
Destinatário"}
],
"message":"OK",
"hasMore": false,
"count": 10,
"maxResults": 10,
"offset": 0
}
### Consultar Log CTE (getLog) [GET /cte/getLog{?

Endpoint de Método de consulta para retornar os logs do CT-e, irá retornar todos os
logs de um único CT-e a cada consulta, por isso o cliente deverá enviar como
parâmetro a identificação do CT-e.
neste documento.

http://localhost:8080/webservice/api/cte/getLog?
ou
https://ws.h.dfe.mastersaf.com.br/api/cte/getLog?
### Autenticação
OU

(application/json).
+ Parameters
+ Headers

+ message - "OK"
+ Headers
+ Body
{
"result": [
{
"dataHora": "21/09/2017 15:33:55",
"status": 10,
"historico": "Criado CT-e - Processamento inicia-se às
21/09/2017 15h33 -(administrator@U6036514-TPD-A)",
"stackTrace": null
},
{
"dataHora": "21/09/2017 15:33:55",
"status": 10,
"historico": "Chave de acesso:
4300910509000171577524410075441391776621",
"stackTrace": null
},
{
"dataHora": "21/09/2017 15:34:05",
"status": 20,
"historico": "Criado lote para envio",
"stackTrace": null
},
{
"dataHora": "21/09/2017 15:34:07",
"status": 20,
"historico": "Retorno do xml do lote.",
"stackTrace": null
},
{
"dataHora": "21/09/2017 15:34:07",
"status": 30,
"historico": "Em Processamento",
"stackTrace": null
},
{
"dataHora": "21/09/2017 15:34:14",
"status": 30,
"historico": "Envio do xml de consulta do lote.",
"stackTrace": null
},
{
"dataHora": "21/09/2017 15:34:15",
"status": 30,
"historico": "Retorno do xml de consulta do lote.",
"stackTrace": null
},
{
"dataHora": "21/09/2017 15:34:15",
"status": 200,
"historico": "CT-e Rejeitado 415 - Rejeição: CNPJ do remetente
invalido;",
"stackTrace": null
},
{
"dataHora": "22/09/2017 10:01:37",
"status": 10,
"historico": "Criado CT-e - Processamento inicia-se às
22/09/2017 10h01 -(administrator@U6036514-TPD-A)",
"stackTrace": null
},
{
"dataHora": "22/09/2017 10:01:37",
"status": 10,
"historico": "Chave de acesso:
4300910509000171577524410075441391776621",
"stackTrace": null
}
],
"message":"OK",
"hasMore": true,
"count": 19,
"maxResults": 10,
"offset": 0
}
### Consultar Impressão Carta de Correção CT-e (getImpressaoCCe) [GET

/cte/getImpressaoCCe]
Endpoint para obter apenas os retornos dos documentos de Carta de Correção de CT-e,
método.
Anteriormente esse método tinha o nome de getImpressaoCcCte (ainda válido até a
reconhecido.

http://localhost:8080/webservice/api/cte/getImpressaoCCe (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/cte/getImpressaoCCe (ambiente de homologação
do SaaS)
### Autenticação
OU
### Permissões

+ CT-e Integrador (ROLE_CTE_INTEGRADOR)

(application/json).
+ Parameters
+ Headers
+ Headers
+ Body
{
"impressaoCCe": [
{
"params": {
"id": 36,
"conteudoXml": "<?xml version=\"1.0\" encoding=\"UTF-
8\" standalone=\"yes\"?><cteProc xmlns=\"http://www.portalfiscal.inf.br/cte\"
versao=\"3.00\"><CTe xmlns=\"http://www.portalfiscal.inf.br/cte\"><infCte
Id=\"CTe43210900910509002034570060000000301391776626\"
versao=\"3.00\"><ide><cUF>43</cUF><cCT>39177662</cCT><CFOP>5353</CFOP><natOp>Presta
ção serv. tranRS. estab.
comercial</natOp><mod>57</mod><serie>6</serie><nCT>30</nCT><dhEmi>2021-09-
28T07:50:00-03:00</dhEmi><tpImp>1</tpImp><tpEmis>1</tpEmis><cDV>6</cDV><tpAmb>2</
tpAmb><tpCTe>0</tpCTe><procEmi>0</procEmi><verProc>3.95.1</
verProc><cMunEnv>4309209</cMunEnv><xMunEnv>Jundiai</xMunEnv><UFEnv>RS</
UFEnv><modal>02</modal><tpServ>0</tpServ><cMunIni>4309209</
cMunIni><xMunIni>Jundiai</xMunIni><UFIni>RS</UFIni><cMunFim>4309209</
cMunFim><xMunFim>Bertioga</xMunFim><UFFim>RS</UFFim><retira>1</
retira><indIEToma>1</indIEToma><toma3><toma>3</toma></toma3></
ide><compl><xCaracAd>ENTREGA</xCaracAd><xCaracSer>ENTREGA
EXPRESSA</xCaracSer><xEmi>Juca</xEmi><fluxo><pass><xPass>2233112</xPass></pass></
fluxo><Entrega><semData><tpPer>0</tpPer></semData><semHora><tpHor>0</tpHor></
semHora></Entrega><origCalc>Chapeco</origCalc><destCalc>Jundiai</
destCalc><xObs>Obersavacoes gerais do CT-e</xObs><ObsCont
xCampo=\"30\"><xTexto>Conteudo do Campo</xTexto></ObsCont><ObsFisco
xCampo=\"30\"><xTexto>Conteudo do
Campo</xTexto></ObsFisco></compl><emit><CNPJ>00910509002034</CNPJ><IE>0018001360</
IE><xNome>CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR
FISCAL</xNome><xFant>Transcataratas ETRod Lt-Filial</xFant><enderEmit><xLgr>AV
ANDRE COSTA</xLgr><nro>2002</nro><xBairro>ENGORDADOURO</xBairro><cMun>4309209</
cMun><xMun>Porto
Alegre</xMun><CEP>13214730</CEP><UF>RS</UF><fone>01121521110</fone></enderEmit></
emit><rem><CNPJ>76096718000438</CNPJ><IE>ISENTO</IE><xNome>CT-E EMITIDO EM AMBIENTE
DE HOMOLOGACAO - SEM VALOR FISCAL</xNome><xFant>Transcataratas ETRod
Lt-Filial</xFant><fone>01121521110</fone><enderReme><xLgr>AV ANDRE
COSTA</xLgr><nro>2002</nro><xCpl>Anexo
1</xCpl><xBairro>ENGORDADOURO</xBairro><cMun>4314902</cMun><xMun>JUNDIAI</
xMun><CEP>13214730</CEP><UF>RS</UF><cPais>1058</cPais><xPais>Brasil</xPais></
enderReme><email>testeauto@testeauto.com</email></
rem><exped><CNPJ>13495487000172</CNPJ><IE>ISENTO</IE><xNome>CT-E EMITIDO EM
AMBIENTE DE HOMOLOGACAO - SEM VALOR
FISCAL</xNome><fone>1121521000</fone><enderExped><xLgr>AV. ANDRE
COSTA</xLgr><nro>2002</nro><xCpl>ENGORDADOURO</xCpl><xBairro>Centro</
xBairro><cMun>4314902</cMun><xMun>JUNDIAI</xMun><CEP>13214730</CEP><UF>RS</
UF><cPais>1058</cPais><xPais>Brasil</xPais></
enderExped><email>testeauto@testeauto.com</email></
exped><receb><CNPJ>01943665000100</CNPJ><IE>ISENTO</IE><xNome>CT-E EMITIDO EM
FISCAL</xNome><fone>1333173234</fone><enderReceb><xLgr>RUA DR OSVALDO
CRUZ</xLgr><nro>SN</nro><xCpl>JD
PAULISTA</xCpl><xBairro>Centro</xBairro><cMun>4315008</cMun><xMun>BERTIOGA</
enderReceb><email>testeauto@testeauto.com</email></
receb><dest><CNPJ>35402759000185</CNPJ><IE>110337602110</IE><xNome>CT-E EMITIDO EM
FISCAL</xNome><fone>1333173234</fone><enderDest><xLgr>RUA DR OSVALDO
CRUZ</xLgr><nro>SN</nro><xCpl>Av. 5</xCpl><xBairro>JD
PAULISTA</xBairro><cMun>3552502</cMun><xMun>SUAZANO</xMun><CEP>11250000</
CEP><UF>SP</UF><cPais>1058</cPais><xPais>Brasil</xPais></
enderDest><email>testeauto@testeauto.com</email></dest><vPrest><vTPrest>17.45</
vTPrest><vRec>17.45</vRec><Comp><xNome>FRETE
VALOR</xNome><vComp>17.45</vComp></Comp></vPrest><imp><ICMS><ICMS00><CST>00</
CST><vBC>17.45</vBC><pICMS>12.00</pICMS><vICMS>2.09</vICMS></ICMS00></
ICMS><vTotTrib>0.00</vTotTrib><infAdFisco>0.00</infAdFisco></
imp><infCTeNorm><infCarga><vCarga>218.18</vCarga><proPred>SERVICO DE TRANRSORTE
INTERMUNICIPAL</proPred><xOutCat>FRIOS</xOutCat><infQ><cUnid>03</cUnid><tpMed>UNIDA
DE</tpMed><qCarga>0.0000</qCarga></infQ><vCargaAverb>218.18</vCargaAverb></
infCarga><infDoc><infNFe><chave>35140413495487000172550010005396431442573157</
chave></infNFe></infDoc><infModal versaoModal=\"3.00\"><aereo
xmlns=\"http://www.portalfiscal.inf.br/cte\"><nMinu>123456789</nMinu><nOCA>65432165
498</nOCA><dPrevAereo>2016-11-02</dPrevAereo><natCarga><xDime>1234X1234X1234</
xDime><cInfManu>03</cInfManu><cInfManu>04</cInfManu></natCarga><tarifa><CL>M</
CL><cTar>1235</cTar><vTar>1234.90</vTar></tarifa></aereo></infModal></
infCTeNorm></infCte><infCTeSupl><qrCodCTe>https://dfe-portal.svrs.rs.gov.br/cte/
qrCode?chCTe=43210900910509002034570060000000301391776626&tpAmb=2</qrCodCTe></
infCTeSupl><Signature
URI=\"#CTe43210900910509002034570060000000301391776626\"><Transforms><Transform
Method
Algorithm=\"http://www.w3.org/2000/09/xmldsig#sha1\"/><DigestValue>6TxpfYiXIWQ+pl7/
sZl88dMj2zg=</DigestValue></Reference></SignedInfo><SignatureValue>q726U/
qjFuYYcQnzKZzFEIAxZZ/uWMgZOAZX1rM99q5NzcshYmiOKptAcpQ/+iBlDhYYhN85y1jYk5vB/
3f7H7A0t6hug1lTAVDgdfoE6DbIUhnUW0W9/
ihGznBMwhzSQK2JRf2V9VmjhDTN1G4FvCsztNT1ncjlFcqaKXscqjCGbcPQu87qiWyGA1UqagBf6VABlpi1
ZYf0ExVoaFOglAKLS4PNdEuO2SjpVuGbsl6EtlU8yJYokoryPqGnv/rzXZe0oxKPHyWaZuLb/
onv+GMy9jOcSFgeOouSVrTkNGzvP1JrdRu+TGjZsrUaHgIvMqezeUlO7L7E1sR+d+XkmQ==</
9zTOM9U/
Wu6LVRy8npH3egR/
jiacTc1jNQjB/
Q5uCrIr6pl/pQm/
CTe><protCTe xmlns:ns2=\"http://www.w3.org/2000/09/xmldsig#\"
versao=\"3.00\"><infProt><tpAmb>2</tpAmb><verAplic>RS20210820101440</
verAplic><chCTe>43210900910509002034570060000000301391776626</chCTe><dhRecbto>2021-
09-28T12:02:10-03:00</dhRecbto><nProt>143210000465840</
nProt><digVal>6TxpfYiXIWQ+pl7/sZl88dMj2zg=</digVal><cStat>100</
cStat><xMotivo>Autorizado o uso do CT-e</xMotivo></infProt></protCTe></cteProc>",
"versaoXml": "3.00",
"dataEmissao": 1640258820000,
"nroCopias": 1,
"nroProtocolo": "143210001339014",
"emailEmpresa": "elaine.machado@tr.com",
"statusDocto": 100,
standalone=\"yes\"?><procEventoCTe xmlns=\"http://www.portalfiscal.inf.br/cte\"
versao=\"3.00\"><eventoCTe xmlns=\"http://www.portalfiscal.inf.br/cte\"
versao=\"3.00\"><infEvento
Id=\"ID1101104321090091050900203457006000000030139177662601\"><cOrgao>43</
CNPJ><chCTe>43210900910509002034570060000000301391776626</chCTe><dhEvento>2021-12-
nSeqEvento><detEvento versaoEvento=\"3.00\"><evCCeCTe
xmlns=\"http://www.portalfiscal.inf.br/cte\"><descEvento>Carta de
Correcao</descEvento><infCorrecao><grupoAlterado>dest</grupoAlterado><campoAlterado
>fone</campoAlterado><valorAlterado>118436472211843</
valorAlterado><nroItemAlterado>1</nroItemAlterado></infCorrecao><xCondUso>A Carta
de Correcao e disciplinada pelo Art. 58-B do CONVENIO/SINIEF 06/89: Fica permitida
a utilizacao de carta de correcao, para regularizacao de erro ocorrido na emissao
de documentos fiscais relativos a prestacao de servico de transporte, desde que o
erro nao esteja relacionado com: I - as variaveis que determinam o valor do imposto
tais como: base de calculo, aliquota, diferenca de preco, quantidade, valor da
prestacao;II - a correcao de dados cadastrais que implique mudanca do emitente,
tomador, remetente ou do destinatario;III - a data de emissao ou de
saida.</xCondUso></evCCeCTe></detEvento></infEvento><Signature
Method
Algorithm=\"http://www.w3.org/2000/09/xmldsig#sha1\"/><DigestValue>V2Rv5CFsrgv2o6I5
ZnyLLv8xPo8=</DigestValue></Reference></
SignedInfo><SignatureValue>SSv2g5mr3Yx4ra7K/8tQPoIL8RLmPeJ606tWwl3iCcguhBbxjIj3/
JZSrLZoy13x0nSgy5LWUrggk7vW9p725uGPrCFh7p20boJ4Tj7WwyG9FgPitl3SpBJ7A6QWuKpCKe89Top4
RZVCWCjfeZPwtVj97bnh9xW3B5QvP9f0Bdu30A4zoxhAZT495F3if4fDGpZSLOeEwGhwVEss8h/
1CoXuQY72q9jz6o6m6xraohp+mB/
PqPPlTBaSraRr2m6XghbNI8oj0FbaU1hmUKEt7vl4RqnTqtH609a6G2ho5J5mTLM0rdQR1L4CDGqYVnIGan
8SaI9kvri1FiUTZZcN6A==</
9zTOM9U/
Wu6LVRy8npH3egR/
jiacTc1jNQjB/
Q5uCrIr6pl/pQm/
eventoCTe><retEventoCTe xmlns=\"http://www.portalfiscal.inf.br/cte\"
Id=\"ID143210001339014\"><tpAmb>2</tpAmb><verAplic>RS20210422091228</
vinculado a CT-e</xMotivo><chCTe>43210900910509002034570060000000301391776626</
chCTe><tpEvento>110110</tpEvento><xEvento>Carta Correção
Registrada</xEvento><nSeqEvento>1</nSeqEvento><dhRegEvento>2021-12-23T13:31:37-
03:00</dhRegEvento><nProt>143210001339014</nProt></infEvento></retEventoCTe></
procEventoCTe>",
"xmlRetornoCC": "<retEventoCTe
xmlns=\"http://www.portalfiscal.inf.br/cte\" versao=\"3.00\"><infEvento
03:00</dhRegEvento><nProt>143210001339014</nProt></infEvento></retEventoCTe>",
"valorAproximadoTributos": null,
"cnpjEmissor": null,
"inscricaoEmissor": null,
"exibirDadosConsumidorDanfe": true,
"exibirValoresIcmsInterestadual": false,
"enviaPrinter": 0,
"ordemEmbarque": null,
"nroItens": null,
"usuarioEmitente": "elaine machado",
}
}
]
}
### Obter XML de Inutilização (getXmlInutilizacao) [GET /cte/getXmlInutilizacao{?
cnpjEmissor,numeroCte,serieCte}]
Endpoint de Método para obter o XML de inutilização do respectivo CT-e.

http://localhost:8080/webservice/api/cte/getXmlInutilizacao?
cnpjEmissor=00910509000171&numeroCte=1&serieCte=603
ou
https://ws.h.dfe.mastersaf.com.br/api/cte/getXmlInutilizacao?
cnpjEmissor=00910509000171&numeroCte=1&serieCte=603 (ambiente de homologação do
SaaS)
### Autenticação
OU
### Permissões


(application/json).
+ Parameters
+ cnpjEmissor - Filtrar pelo cnpj do emissor
+ numeroCte - Filtrar pelo número do CT-e
+ serieCte - Filtrar pela série do CT-e
+ Headers
+ xml - O resultado é o xml de inutilização solicitado, sem nenhum

atributo.
+ Headers
+ Body
{
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><procInutCTe
xmlns="http://www.portalfiscal.inf.br/cte" versao="3.00"><inutCTe
xmlns="http://www.portalfiscal.inf.br/cte" versao="3.00"><infInut
Id="ID430091050900203457452001007544001007544"><tpAmb>2</tpAmb><xServ>INUTILIZAR</
xServ><cUF>43</cUF><ano>21</ano><CNPJ>00910509002034</CNPJ><mod>57</
mod><serie>452</serie><nCTIni>1007544</nCTIni><nCTFin>1007544</nCTFin><xJust>Nota
foi rejeitada</xJust></infInut><Signature
xmlns="http://www.w3.org/2000/09/xmldsig#"><SignedInfo><CanonicalizationMethod
Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/><SignatureMethod
Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/><Reference
URI="#ID430091050900203457452001007544001007544"><Transforms><Transform
Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/><Transform
Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/></Transforms><DigestMe
thod
Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/><DigestValue>BZW3Ty92v3QjrnjELB
SOyCuFOxc=</DigestValue></Reference></
SignedInfo><SignatureValue>h7sBLBGJg4dRDUqkuX/Lsurv94HeWDi2ex3NWOf+dvmjY/
7xvVhieoYtApnA8xm1vT+j/EK6hoUPapRO1Ys1rxJbne9ECH63504GtyAVvi+iOk7MdFSWYZKUf/YR4/
ytG5YBkM/fO2bMPg+/awv5VKzJxiinTfEit/
V+ItZ5eGZvQPw4U1WEKvsj3iDCWvsgXRmrFtRe5K1e6aEpy6ZNLlLbOKO0FH/
qx+E4Lv9a+pAfMMIEzPDMC/
ITBJWbFhlQwaKWNdL0SAQP+0AG6IblxVaySOYTFOgKNEQKS5Y6ztU0PrfCkMOMYRF+bgSMIPhHPz8lANtDJ
7U56WhCJfSwGA==</
SignatureValue><KeyInfo><X509Data><X509Certificate>MIIH4jCCBcqgAwIBAgIQVdaP8hHn2jF8
Eh7gmWpbzDANBgkqhkiG9w0BAQsFADB0MQswCQYDVQQGEwJCUjETMBEGA1UEChMKSUNQLUJyYXNpbDEtMCs
GA1UECxMkQ2VydGlzaWduIENlcnRpZmljYWRvcmEgRGlnaXRhbCBTLkEuMSEwHwYDVQQDExhBQyBDZXJ0aX
NpZ24gTXVsdGlwbGEgRzcwHhcNMjAwNTEyMTYzNDU5WhcNMjEwNTEyMTYzNDU5WjCBtDELMAkGA1UEBhMCQ
lIxEzARBgNVBAoMCklDUC1CcmFzaWwxHjAcBgNVBAsMFUFDIENlcnRpc2lnbiBNdWx0aXBsYTEXMBUGA1UE
CwwOMDg5MzYwNTQwMDAxNzUxGzAZBgNVBAsMEkFzc2luYXR1cmEgVGlwbyBBMTE6MDgGA1UEAwwxVEhPTVN
PTiBSRVVURVJTIEJSQVNJTCBDT05URVVETyBFIFRFQ05PTE9HSUEgTFREQTCCASIwDQYJKoZIhvcNAQEBBQ
ADggEPADCCAQoCggEBAM0i06wJ88hpXxSPM3ggfL78oazxzP4kDUkNMW3cYntUMcOrHJ70LYpuspGXNyUgL
jv/G0hXCXb9QOaIP1NlAw3zPUteXp7pPPXxoFNQ8/oFv2mTN8MKab1V/
SU9frj72toBneSRjN9Li3Fe20yuHaPKfdLWElp7Gm5N3HQ+ZoGl/JYFbvJvQUYdi+aEuPUXigmd/
o8SmDIJPr64K3yIZ9fuOf6eGxDVCF4wzF7kGtryf0+4IpMGgdGw955M3N5U78dSdkJzXXO9MZ3kvYaOSfia
jrjyHBNpjFSuwbPN/Rtlb70p0HrfYHv1hTj8qVKE1wibFPuNMBZnfx7TmkLal/
0CAwEAAaOCAy0wggMpMIG7BgNVHREEgbMwgbCgOAYFYEwBAwSgLwQtMTEwNzE5NzUyMzQyMjAzNjgzMDAwM
DAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwoBoGBWBMAQMCoBEED1NBTlRJQUdPIEFZRVJaQaAZBgVgTAEDA6AQ
BA4wMDkxMDUwOTAwMDE3MaAXBgVgTAEDB6AOBAwwMDAwMDAwMDAwMDCBJGNvbXBsaWFuY2UuYnJhc2lsQHR
ob21zb25yZXV0ZXJzLmNvbTAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFF1yDL8z0rvjhqboTAZxflVcB6DWMI
GLBgNVHSAEgYMwgYAwfgYGYEwBAgELMHQwcgYIKwYBBQUHAgEWZmh0dHA6Ly9pY3AtYnJhc2lsLmNlcnRpc
2lnbi5jb20uYnIvcmVwb3NpdG9yaW8vZHBjL0FDX0NlcnRpc2lnbl9NdWx0aXBsYS9EUENfQUNfQ2VydGlT
aWduX011bHRpcGxhLnBkZjCBxgYDVR0fBIG+MIG7MFygWqBYhlZodHRwOi8vaWNwLWJyYXNpbC5jZXJ0aXN
pZ24uY29tLmJyL3JlcG9zaXRvcmlvL2xjci9BQ0NlcnRpc2lnbk11bHRpcGxhRzcvTGF0ZXN0Q1JMLmNybD
BboFmgV4ZVaHR0cDovL2ljcC1icmFzaWwub3V0cmFsY3IuY29tLmJyL3JlcG9zaXRvcmlvL2xjci9BQ0Nlc
nRpc2lnbk11bHRpcGxhRzcvTGF0ZXN0Q1JMLmNybDAOBgNVHQ8BAf8EBAMCBeAwHQYDVR0lBBYwFAYIKwYB
BQUHAwIGCCsGAQUFBwMEMIG2BggrBgEFBQcBAQSBqTCBpjBkBggrBgEFBQcwAoZYaHR0cDovL2ljcC1icmF
zaWwuY2VydGlzaWduLmNvbS5ici9yZXBvc2l0b3Jpby9jZXJ0aWZpY2Fkb3MvQUNfQ2VydGlzaWduX011bH
RpcGxhX0c3LnA3YzA+BggrBgEFBQcwAYYyaHR0cDovL29jc3AtYWMtY2VydGlzaWduLW11bHRpcGxhLmNlc
nRpc2lnbi5jb20uYnIwDQYJKoZIhvcNAQELBQADggIBACa4MY9buGUeP06Oa4t2cFeiJ/
OtUokUUzPqieA3MCBPEmYwExj8yQRsX5kKk645x1U+HMF5yKRsPZ3+q7RvbwWKjsuEWdYeuVLhbRAHXKeDy
SF8nwLB1kxmA5OfPqJLHNnG4nKs/
ShCiUxFqauGfwkZth6AvphqKaixcCa+1IvSvqmh4FhFwGFISpF5UVHjuMc/
hsNrfcVbvh6d4KC7XCqPxtIH8ZoWNH51SSDXFxwo+ce6LPWXJwtM2ezWmH58zyykM2y5S3hdP0HpvrcuNs6
hplWOy6zHmO7H8Bb9fUdxTSn7ZEgw90WMA+lhX7qoBKc9rr0p6HIJydwiRiGn/7Ceueul0ow/
QMil0IMI63cVY5cHHiKdwVM+wFz1rKn2wTe9QnOwvtdo/
JhXwjpfrlSVjRbDPKKMT4bKUSdM12BgAqMfY3WSzHDA4J5mXPHuuS03TPpQER0m7oAT7us8M3QCkCKMdyu3
BQqqqw4JCj6Q9uLBnwRE2C344Md2X4gRzyfdlqv+TJlH2Bl2EBgTlRPpDEpPXf1CHDR4Wf5975ikJRqQnHA
Ni2eBwDUkWlERHFYMmlkAZFLL6eops2sqMJQdfEfGqQLxC6DHgZh1AD9GRwI9wbrX6u7ZjDAAP77ISORfvS
Y0mm2Ml2ls2XdMUW+4EBbSH65hcRu7JQCV/OJF</X509Certificate></X509Data></KeyInfo></
Signature></inutCTe><retInutCTe xmlns="http://www.portalfiscal.inf.br/cte"
versao="3.00"><infInut
Id="Id143210000186750"><tpAmb>2</tpAmb><verAplic>RS20191021102431</
verAplic><cStat>102</cStat><xMotivo>Inutilizacao de numero
homologado</xMotivo><cUF>43</cUF><ano>21</ano><CNPJ>00910509002034</CNPJ><mod>57</
mod><serie>452</serie><nCTIni>1007544</nCTIni><nCTFin>1007544</
nCTFin><dhRecbto>2021-03-25T08:02:09-03:00</dhRecbto><nProt>143210000186750</
nProt></infInut></retInutCTe></procInutCTe>
}
## Consultar Status com parâmetros (getStatus) [GET /cte/getStatus{?

cnpjEmissor,numeroCte,serie,incluiXmlProc}]
Endpoint de Método para obter o Status de uma CT-e apartir de um conjunto de

filtros. Deve ser utilizado para obter
informações de um único documento não importando o estágio de processamento. É
diferente da “Consulta retorno” que
retorna os dados somente de documentos que tiveram seu processamento finalizado.
Esse método possui a mesma estrutura de resposta que os métodos “Consulta Padrão” e
“Consulta Retorno” (GET), para mantermos um layout único de resposta de documentos
em nosso webservice.
Os atributos relacionados ao id de processamento do documento (“ids”,
“idProcessamento” ou “idProcessamentoLote”) estarão sempre vazios.

http://localhost:8080/webservice/api/cte/getStatus?
cnpjEmissor=00910509002034&numeroCte=1054&serie=601&incluiXmlProc=false (instalação
in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/cte/getStatus?
cnpjEmissor=00910509002034&numeroCte=1054&serie=601&incluiXmlProc=false (ambiente
de homologação do SaaS)
### Autenticação
OU
### Permissões


(application/json).
+ Parameters
+ cnpjEmissor (required) - Filtrar por cnpj do emissor do CT-e
+ numeroCte (required) - Filtrar por número do CT-e
+ serie (required) - Filtrar por série do CT-e
+ incluiXmlProc (optional) - Parâmetro opcional true ou false, indica se no
response da requisição deve ser mostrado o campo xmlProcessado ou não. Se false,
campo não é mostrado. Se true, o campo é mostrado e seu respectivo xml processado,
para documentos autorizados ou cancelados. Se não informado esse parâmetro ou
estiver vazio, será considerado como default false.
+ Headers
+ retorno - Atributo de "retorno", dentro trás 0 ou N registros de

documentos, grupo de informações para geração dos arquivos de retorno.
+ ctes - Atributo de "retorno", listagem dos retornos das CT-es. Caso
localizado será retornado o documento consultado.
+ nota - Atributo de "ctes", dentro trás os dados do documento.
+ chaveAcessoModificada - Atributo de "nota". Informa se o documento teve
a chave de acesso alterada durante rotina de emissão. Retorna 0 para false ou 1
para true.
+ dataEntradaContingencia - Atributo de "nota". Informa a data de entrada
em contingência, se houver.
+ cnpj - Atributo de "nota". Informa o cnpj do emitente.
+ dataEmissao - Atributo de "nota". Informa a data de emissão.
+ codBarraAdic - Atributo de "nota". Informa o código de barras adicional,
se houver.
+ descricaoStatus - Atributo de "nota". Informa a descrição do status do
documento.
+ xmlProcessado - Atributo de "nota". Informa o xml processado, tanto de
aprovação, quanto de cancelamento, quando o parâmetro incluiXmlProc for true na
requisição.
+ numeroProtocolo - Atributo de "nota". Informa o número de protocolo.
+ dataAutorizacao - Atributo de "nota". Informa a data de autorização, se
houver.
+ serie - Atributo de "nota". Informa a série do CT-e.
+ chaveCte - Atributo de "nota". Informa a chave do CT-e.
+ numeroConhecimento - Atributo de "nota". Informa o número do CT-e.
+ servico - Atributo de "nota". Informa o tipo de serviço solicitado. 1:
Emissão. 2: Cancelamento. 3: Inutilização. 4: Cancelamento por Evento. 6: Carta de
Correção.
+ tipoAmbiente - Atributo de "nota". Informa o tipo de ambiente. 1:
Produção. 2: Homologação.
+ status - Atributo de "nota". Informa o código do status da resposta da
sefaz.
+ motivoContingencia - Atributo de "nota". Informa o motivo de
contingência, se houver.
+ referencia - Atributo de "ctes". Nome do arquivo utilizado na integração.
+ ids - Atributo de "retorno". Listagem dos IDs dos processamentos.
(*somente para inutilizações)
+ loteInutilizado - Atributo de "retorno". Listagem dos retorno de
Inutilizações. Será preenchido se o documento consultado estiver inutilizado
+ Headers
+ Body
Exemplo aprovação e carta de correção:
{
"retorno": {
"ctes": [
{
"nota": {
"chaveAcessoModificada": "0",
"dataEntradaContingencia": "",
"cnpj": "00910509002034",
"dataEmissao": "2022-07-14T08:31:56-03:00",
"codBarraAdic": "",
"descricaoStatus": "Evento registrado e vinculado a CT-
e",
"xmlProcessado": "<?xml version=\"1.0\" encoding=\"UTF-
8\" standalone=\"yes\"?><cteProc xmlns=\"http://www.portalfiscal.inf.br/cte\"
versao=\"3.00\"><CTe xmlns=\"http://www.portalfiscal.inf.br/cte\"><infCte
Id=\"CTe43210900910509002034575030000009561391776625\"
Ã§Ã£o serv. tranRS. estab.
tpAmb><tpCTe>0</tpCTe><procEmi>0</procEmi><verProc>3.00</
verProc><cMunEnv>4314902</cMunEnv><xMunEnv>JundiaÃ</xMunEnv><UFEnv>RS</
UFEnv><modal>01</modal><tpServ>0</tpServ><cMunIni>4314902</
cMunIni><xMunIni>JundiaÃ</xMunIni><UFIni>RS</UFIni><cMunFim>4315008</
cMunFim><xMunFim>Bertioga</xMunFim><UFFim>RS</UFFim><retira>1</
retira><xDetRetira>ro Norte Retirada na rua Dr. Aventureiro Norte Retirada na rua
Dr. Aventureiro Norte Retirada na rua Dr. Aventureiro Norte Retirada na rua Dr.
Aventureiro
Leste</xDetRetira><indIEToma>1</indIEToma><toma3><toma>3</toma></toma3></
ide><compl><xCaracAd>ENTREGA</xCaracAd><xCaracSer>ENTREGA
EXPRESSA</xCaracSer><xEmi>Juca</xEmi><fluxo><xOrig>Dados Orig.
Carga</xOrig><pass><xPass>2233112</xPass></pass><pass><xPass>3333112</xPass></
pass><xDest>1223235543</xDest><xRota>455878</xRota></
fluxo><Entrega><noPeriodo><tpPer>4</tpPer><dIni>2016-12-20</dIni><dFim>2016-12-
20</dFim></noPeriodo><noInter><tpHor>4</tpHor><hIni>12:00:00</
hIni><hFim>12:30:00</hFim></noInter></Entrega><origCalc>ChapecÃ³</
origCalc><destCalc>JundiaÃ</destCalc><xObs>Obersavacoes gerais do
CT-e</xObs><ObsCont xCampo=\"30\"><xTexto>ConteÃºdo do
Campo</xTexto></ObsCont><ObsFisco xCampo=\"30\"><xTexto>ConteÃºdo do
Campo</xTexto></ObsFisco></compl><emit><CNPJ>00910509002034</CNPJ><IE>0018001360</
IE><IEST>00000000000000</IEST><xNome>CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM
VALOR FISCAL</xNome><xFant>Transcataratas ETRod
Lt-Filial</xFant><enderEmit><xLgr>AV ANDRE
COSTA</xLgr><nro>2002</nro><xBairro>ENGORDADOURO</xBairro><cMun>4314902</
cMun><xMun>SAO
PAULO</xMun><CEP>13214730</CEP><UF>RS</UF><fone>01121521110</fone></enderEmit></
emit><rem><CNPJ>76096718000438</CNPJ><IE>ISENTO</IE><xNome>CT-E EMITIDO EM AMBIENTE
DE HOMOLOGACAO - SEM VALOR FISCAL</xNome><xFant>Transcataratas ETRod
Lt-Filial</xFant><fone>01121521110</fone><enderReme><xLgr>AV ANDRE
1</xCpl><xBairro>ENGORDADOURO</xBairro><cMun>4314902</cMun><xMun>JUNDIAI</
enderReme><email>testeremet@gmail.com</email></rem><exped><CNPJ>13495487000172</
CNPJ><IE>ISENTO</IE><xNome>CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR
FISCAL</xNome><fone>1121521000</fone><enderExped><xLgr>AV. ANDRÃ‰
COSTA</xLgr><nro>2002</nro><xCpl>ENGORDADOURO</xCpl><xBairro>Centro</
xBairro><cMun>4314902</cMun><xMun>JUNDIAÃ</xMun><CEP>13214730</CEP><UF>RS</
UF><cPais>1058</cPais><xPais>Brasil</xPais></
enderExped><email>marcos.pessoa@thomsonreuters.com</email></
exped><receb><CNPJ>01943665000100</CNPJ><IE>ISENTO</IE><xNome>CT-E EMITIDO EM
FISCAL</xNome><fone>1333173234</fone><enderReceb><xLgr>RUA DR OSVALDO
CRUZ</xLgr><nro>SN</nro><xCpl>JD
PAULISTA</xCpl><xBairro>Centro</xBairro><cMun>4315008</cMun><xMun>BERTIOGA</
enderReceb><email>marcos.pessoa@thomsonreuters.com</email></
receb><dest><CNPJ>35402759000185</CNPJ><IE>110337602110</IE><xNome>CT-E EMITIDO EM
FISCAL</xNome><fone>1333173234</fone><enderDest><xLgr>RUA DR OSVALDO
CRUZ</xLgr><nro>SN</nro><xCpl>Av. 5</xCpl><xBairro>JD
CEP><UF>SP</UF><cPais>1058</cPais><xPais>Brasil</xPais></enderDest></
dest><vPrest><vTPrest>17.45</vTPrest><vRec>17.45</vRec><Comp><xNome>FRETE
VALOR1</xNome><vComp>17.44</vComp></Comp><Comp><xNome>FRETE
VALOR4</xNome><vComp>17.41</vComp></Comp></vPrest><imp><ICMS><ICMS00><CST>00</
ICMS><vTotTrib>0.00</vTotTrib><infAdFisco>0.00</infAdFisco></
imp><infCTeNorm><infCarga><vCarga>218.18</vCarga><proPred>SERVICO DE TRANRSORTE
INTERMUNICIPAL</proPred><xOutCat>FRIOS</xOutCat><infQ><cUnid>03</cUnid><tpMed>UNIDA
DE</tpMed><qCarga>0.0000</qCarga></infQ><infQ><cUnid>03</cUnid><tpMed>UNIDADE</
tpMed><qCarga>1.0000</qCarga></infQ><infQ><cUnid>03</cUnid><tpMed>UNIDADE</
tpMed><qCarga>2.0000</qCarga></infQ><infQ><cUnid>03</cUnid><tpMed>UNIDADE</
tpMed><qCarga>3.0000</qCarga></infQ><vCargaAverb>218.18</vCargaAverb></
infCarga><infDoc><infNFe><chave>43200500910509000171554200000040521000010047</
chave></infNFe></infDoc><infModal versaoModal=\"3.00\"><rodo
xmlns=\"http://www.portalfiscal.inf.br/cte\"><RNTRC>04036199</RNTRC><occ><serie>233
</serie><nOcc>12233</nOcc><dEmi>2016-11-01</dEmi><emiOcc><CNPJ>35402759000185</
CNPJ><cInt>123123</cInt><IE>110337602110</IE><UF>RS</UF><fone>47899886699</fone></
emiOcc></occ></rodo></infModal><infGlobalizado><xObs>Descritivo da informaÃ§Ãµes do
CT-e Globalizado,
Marcos.</xObs></infGlobalizado></infCTeNorm><autXML><CNPJ>53867676000143</CNPJ></
autXML><autXML><CPF>52084773350</CPF></autXML><autXML><CPF>76311161214</CPF></
autXML><autXML><CNPJ>47352163000105</CNPJ></autXML></
infCte><infCTeSupl><qrCodCTe>https://dfe-portal.svrs.rs.gov.br/cte/qrCode?
chCTe=43210900910509002034575030000009561391776625&tpAmb=2</qrCodCTe></
Method
Algorithm=\"http://www.w3.org/2000/09/xmldsig#sha1\"/><DigestValue>8ve0EEh2FpqKC+Gl
YVwcsjeHie4=</DigestValue></Reference></SignedInfo><SignatureValue>Noara1OZdoND/
hSf/jLIfUTbxnSoKYM2VXj86KdOwmP48JxtuxNegZOFoVjTQfWVGrNxAeJGYlI7j8gtAZrC/
gFZvbPBOwBm3GrZGNw4nyPkKVvxT+hbYAkbbsqH2xtcXwclzBL6vc7sT+E8R75PtRoGwLq/f5SW2DHE/
MhZlrKQZCOkWvTxvWN0sBx1OQM7nck20r9jp9zr2N9CuNAhku8JnH+lQIFAqm5MON3jwWdmxiGuS//
Xaxj5aFfXXlMn0l+TE08MOY7ldaWkaLUFDrfpC2VoLNZoLTKCwhFj9Z2e4VZv8pj+k08OeVnihxfeyZ4Xq/
TxtM883on0JT6r4A==</
9zTOM9U/
Wu6LVRy8npH3egR/
jiacTc1jNQjB/
Q5uCrIr6pl/pQm/
CTe><protCTe xmlns:ns2=\"http://www.w3.org/2000/09/xmldsig#\"
versao=\"3.00\"><infProt><tpAmb>2</tpAmb><verAplic>RS20210820101440</
verAplic><chCTe>43210900910509002034575030000009561391776625</chCTe><dhRecbto>2021-
09-24T16:38:48-03:00</dhRecbto><nProt>143210000465073</
nProt><digVal>8ve0EEh2FpqKC+GlYVwcsjeHie4=</digVal><cStat>100</
cStat><xMotivo>Autorizado
o uso do CT-e</xMotivo></infProt></protCTe></cteProc>",
"numeroProtocolo": "143210000465073",
"dataAutorizacao": "2021-09-24T16:38:48-03:00",
"serie": "503",
"chaveCte":
"43210900910509002034575030000009561391776625",
"numeroConhecimento": 956,
"servico": 1,
"tipoAmbiente": 2,
"status": 100,
"motivoContingencia": ""
},
"referencia": "arquivo_integrador_20210924163549.txt"
},
{
"nota": {
"nSeqEvento": 1,
"cnpj": "00910509002034",
"descricaoStatus": "Evento registrado e vinculado a CT-
e",
"serie": "503",
"chaveCte":
"43210900910509002034575030000009561391776625",
"dhRegEvento": "2021-12-23T13:30:08-03:00",
"servico": 6,
"tipoAmbiente": 2,
"tpEvento": 110110,
"status": 135,
},
}
],
"ids": [],
"loteInutilizado": []
}
}
exemplo cancelamento:
{
"retorno": {
"ctes": [
{
"nota": {
"nSeqEvento": 1,
"chaveAcessoModificada": "0",
"cnpj": "00910509002034",
"codBarraAdic": "",
"descricaoStatus": "Cancelamento de CT-e homologado",
"xmlProcessado": "<?xml version=\"1.0\" encoding=\"UTF-8\"
Id=\"ID1101114322080091050900203457603000001011139177662101\"><cOrgao>43</
nSeqEvento><detEvento versaoEvento=\"3.00\"><evCancCTe
xmlns=\"http://www.portalfiscal.inf.br/cte\"><descEvento>Cancelamento</
descEvento><nProt>143220000566903</nProt><xJust>cancelamento com erro
sefaz</xJust></evCancCTe></detEvento></infEvento><Signature
Method
Algorithm=\"http://www.w3.org/2000/09/xmldsig#sha1\"/><DigestValue>0JXemQoE3tJeM7mN
nFL2lzIDcN4=</DigestValue></Reference></
SignedInfo><SignatureValue>hvE6E7m4WTwvqh0FpX5+aPgXlXm89c+tylzak9fjuOEN36f7gJjYEYYy
Q5e1y+VYGLKTwR2qvOH4enZnUwS7S7pSZtvsvoGOwE/
0c0A+h3s2vTBUUnSLx03SxuJXSqv2S9pCF1Ds0RvLl9E0duB4MnEhys9EW3SL5OJuwzSq3460y9yN4vsaww
TRngPRHf/Id5Fe5ctarpH3aWsMsaX/
219kA4fdVYdbRlZVcsM0rtH3n55AiwXuBa10vXKq2g+Quywwo3LSDCrKwMrJ5hvBDeTY56Yvy2uA7KQwGhb
lOtl1v2JlkUcgYsm6aGs6qDVwbyq9Qq7/vlw4bb3Zd7xwzg==</
SignatureValue><KeyInfo><X509Data><X509Certificate>MIIILjCCBhagAwIBAgIQB1gZAF0j7Mgu
80rC8EdSzzANBgkqhkiG9w0BAQsFADB4MQswCQYDVQQGEwJCUjETMBEGA1UEChMKSUNQLUJyYXNpbDE2MDQ
GA1UECxMtU2VjcmV0YXJpYSBkYSBSZWNlaXRhIEZlZGVyYWwgZG8gQnJhc2lsIC0gUkZCMRwwGgYDVQQDEx
NBQyBDZXJ0aXNpZ24gUkZCIEc1MB4XDTIyMDQyNTIwNTIxNFoXDTIzMDQyNTIwNTIxNFowggERMQswCQYDV
QQGEwJCUjETMBEGA1UECgwKSUNQLUJyYXNpbDELMAkGA1UECAwCU0MxETAPBgNVBAcMCENyaWNpdW1hMRkw
FwYDVQQLDBBWaWRlb0NvbmZlcmVuY2lhMRcwFQYDVQQLDA4wODkzNjA1NDAwMDE3NTE2MDQGA1UECwwtU2V
jcmV0YXJpYSBkYSBSZWNlaXRhIEZlZGVyYWwgZG8gQnJhc2lsIC0gUkZCMRYwFAYDVQQLDA1SRkIgZS1DTl
BKIEExMUkwRwYDVQQDDEBUSE9NU09OIFJFVVRFUlMgQlJBU0lMIENPTlRFVURPIEUgVEVDTk9MT0dJQSBMV
ERBOjAwOTEwNTA5MDAxMzA1MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAozTrBlYmPHiHlwhC
6gn7KV4RtM32N/
WdXVf5oPGLCHcHPHL7I86dYWYygIl8fUmY21fbuXFPQ5yYy3EbKvxFBPEygGM+nQkiusCpLsugnMvf3eUn6
BMeAppcZwOoBDYR5JoLn0rFoIEKVO8aHAEUu39Y10VTAefT0j+qxFhrRUWXeYPyxRpqu1qjz8b0tlpXxUTH
ZD9AEdUBZimVcJZU1D9zLrtbYQAbXSm6UDdCZlaKtdQzP35/
HjCBHxDD3Pw4Ujp4o+11t7gTe5GUZXwd+K32VUAd7fcZgvtdLfarTaMwd0+yZdar5Z0hhh4DPSfpO2xoUao
QzEAEn6XZ/
MO3DQIDAQABo4IDFzCCAxMwgcYGA1UdEQSBvjCBu6A9BgVgTAEDBKA0BDIxMjA0MTk2NzUyMjgyNjE5NjY4
MDAwMDAwMDAwMDAwMDAwMDA1MDk4MzIyODNTU1BTUKAgBgVgTAEDAqAXBBVSSUNBUkRPIFRPTU1BU0kgRkl
MSE+gGQYFYEwBAwOgEAQOMDA5MTA1MDkwMDEzMDWgFwYFYEwBAwegDgQMMDAwMDAwMDAwMDAwgSRDT01QTE
lBTkNFLkJSQVNJTEBUSE9NU09OUkVVVEVSUy5DT00wCQYDVR0TBAIwADAfBgNVHSMEGDAWgBRTfX+dvtFh0
CC62p/jiacTc1jNQjB/
lzaWduLXJmYi5jZXJ0aXNpZ24uY29tLmJyMA0GCSqGSIb3DQEBCwUAA4ICAQCnNYlzCUG0H0lw8pONZL8R8
R+FZwBbt7IFUwZpdPwEgeguX4EqHXCZ+2iXz0SwAOQsKX6UWQtKqi49P8dEqh7YNzuV7zU+2IEXpdPWDzQM
TDcBpJ0YJhxLIjDinZpcsKVafedu35LA9GoyJCWZe+hNIjR6f4GNfY0pIoRmFal+XD9lJ2Q7QNW1JqR1Wl7
WidSyrJNk7oMvu2jC6EA/
UoWfAx1PdnhiFNFz0rL93CS7j+SWVzbhesbZ2JeaMVfM8GHlHKlcAAuJN1QAbi1CCzJRraT+DDaD6jDJYhb
Am2Rjzi2a71rVR3RgYeGGzVx8bbzLBHGP6UnrrJLKZ4k8gNnjuM5Qvp/y84Xjz/
yCI1hHo7o6Ywt5cn5bfda6kb3TmtK0+fzDBN2F2tJ2sFFIC61dcdhjECwquW7gUEfKWnW9r6P2ZHHWBa89b
pqO4IyJiHFfNDeA+XC0KiEzPno5AtHhSuAdAu/
hM7OBJlDMGMw3Xsf71BeqnpdKvFZPuLdJ5Mk7CCeP59lIWWnxhi1QAz/iqUCjW05pZ27Zud/
DWuyP1n+7jbx6z1JMb7TVeNVnAXmh0uvjyMrvQqrWo8jkyqk5ti6pBepairPAK1ypp5AF9LiAJ+ui9Aoi5X
nHyqn148GNKA2hmOuC66Yn02Rqbig5tNFBB5L0nlF78fHM/ZwDxw==</X509Certificate></
X509Data></KeyInfo></Signature></eventoCTe><retEventoCTe
chCTe><tpEvento>110111</tpEvento><xEvento>Cancelamento</xEvento><nSeqEvento>1</
nSeqEvento><dhRegEvento>2022-08-11T14:02:19-03:00</
dhRegEvento><nProt>143220000566907</nProt></infEvento></retEventoCTe></
procEventoCTe>",
"serie": "603",
"chaveCte": "43220800910509002034576030000010111391776621",
"dhRegEvento": "2022-08-11T14:02:19-03:00",
"servico": 4,
"tipoAmbiente": 2,
"tpEvento": 110111,
"status": 101,
},
}
],
"ids": [],
"loteInutilizado": []
}
}
# Group NFSE
### OBSERVAÇÕES GERAIS
Os passos resumindo este processo são:
1. É enviado um pacote de dados;

2. Através de uma consulta receberemos uma lista de ids e, então por fim;
3. Marcam-se no sistema os ids consultados para que numa próxima pesquisa eles não
sejam retornados novamente;
4. Com isso basta realizar POST para enviar os pacotes e GET para consultar o
resultado do processamento.
## POST [/nfse]
Método utilizado para enviar RPSs ao WebService.
### Exemplos URL

http://localhost:8080/webservice/api/dfe (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/dfe (ambiente de homologação do SaaS)
### Permissões
- NFS-e Integrador (ROLE_INTEGRADOR)
- Administrar o sistema (ROLE_SUPER_ADMIN)

(application/json).
### Autenticação
OU
### Envio
“txt_conteudo”. O separador de campos do conteúdo é o pipe ( | ). Para quebra de
linha usa-se \n.
Para enviar vários RPSs você deve concatenar as strings antes de colocar em
txt_conteúdo (txt conteúdo terá vários “__rps__|versao=1(...)”), mas só pode
existir um “__arquivo_fim__|”. No caso de cancelamento o procedimento é o mesmo
(vários __cancelamento__ e apenas um __arquivo_fim__|).
### Retorno Erro

Response Body: {“result”:”<descrição do erro>“}
Http status: 400, 412, 500.
+ Headers
+ Attributes
+ action (required) - Ação solicitada. Conteúdo: “EnviarPacote”

+ txt_conteudo (required) - Conteúdo do RPS. Informar dados do RPS conforme
layout padrão do produto.
+ body

{
"action":"EnviarPacote",
"txt_conteudo":{
"__rps__|\nversao=1|\ntipoAmbienteSistema=2|codCidade=3304557|\
nnaturezadaOperacao=1|\nnumeroRps=1|\nserieRps=R11|\ntipoRps=1|\
ndataEmissaoRps=2010-11-21T22:32:52|\nsituacaoRps=1|\nregimeEspecialTributacao=1|\
noptanteSimplesNacional=2|\nincentivadorCultural=2|\nvalorPis=0|\nvalorCofins=0|\
nvalorInss=0|\nvalorIr=0|\nvalorCsll=0|\nvalorLiquidoNfse=950.00|\
ntipoRecolhimento=2|\nmunicipioPrestacao=3304557|\nvalorServicos=1000.00|\
nitemListaServico=0403|\nbaseCalculo=1000.00|\naliquotaServicos=0.02|\
nvalorIss=50.00|\noutrasRetencoes=0|\nvalorIssRetido=0|\
ncodigoTributacaoMunicipio=040302|\nvalorDescontoIncondicionado=0|\
nvalorDescontoCondicionado=0|\ninscricaoPrestador=01997092|\
ncnpjPrestador=00910509000252|\ncpfCnpjTomador=10841608709|\
nrazaoSocialTomador=Marcus Barcelos|\nnumeroEnderecoTomador=1000|\
ncomplementoEnderecoTomador=Centro|\nbairroTomador=Centro|\ncidadeTomador=3304557|\
ncepTomador=20040010|\nemailTomador=email_tomador.com|\
ntelefoneTomador=1144444444|\nenderecoTomador=Av Presidente Vargas|\
nindicacaoCpfCnpj=1|\nufTomador=RJ|\ncnpjIntermediarioServico=|\n__item__|\
ndiscriminacaoServico=Servico de
programacao|\n__deducao__|\nvalorDeduzir=0|\n__arquivo_fim__|\n"
}
}
{
"result": "OK"
}
### Cancelar [POST]
Método para cancelar RPSs enviados ao webservice.
### Exemplos URL

http://localhost:8080/webservice/api/dfe (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/dfe (ambiente de homologação do SaaS)
### Permissões
- NFS-e Integrador (ROLE_INTEGRADOR)
- Administrar o sistema (ROLE_SUPER_ADMIN)

(application/json).
### Autenticação
OU
### Envio
“txt_conteudo”. O separador de campos do conteúdo é o pipe ( | ).
Exemplo de Request Body conforme arquivo de exemplo: nfse_request_post_cancelar.tx
### Retorno Erro

Response Body: {“result”:”<descrição do erro>“}
Http status: 400, 412, 500.
+ Headers
+ Attributes
+ action (required) - Ação solicitada. Conteúdo: “Cancelar”

+ txt_conteudo (required) - Conteúdo do RPS. Informar dados do RPS conforme
layout padrão do produto.
+ body

{
"action":"Cancelar",
"txt_conteudo":{
"__cancelamento__|versao=1|tipoAmbienteSistema=2|codCidade=3304557|
cnpjPrestador=00910509000252|inscricaoPrestador=01997092|numeroNfe=200455|
codigoVerificacao=FBQN-NXFU|motivoCancelamento=TESTE DE CANCELAMENTO|
codigoCancelamento=5555|__arquivo_fim__|"
}
}
{
"result": "OK"
}
## GET [/dfe/get]
### Consultar Status RPS/NFS-e (getStatus) [GET /dfe/getStatus{?

cnpjPrestador,inscricaoPrestador,numeroRps,serieRps}]
Endpoint de Método de consulta para obter o status de um RPS/NFS-e a partir de um

conjunto de filtros. Deve ser utilizado para obter informações de um único
documento não importando o estágio de processamento.
Todos os parâmetros são obrigatórios.

#### Instalação In House
http://localhost:8080/webservice/api/dfe/getStatus?
cnpjPrestador=&inscricaoPrestador=&numeroRps=&serieRps=
#### Ambiente de Homologação do SaaS

https://ws.h.dfe.mastersaf.com.br/api/dfe/getStatus?
cnpjPrestador=&inscricaoPrestador=&numeroRps=&serieRps=
### Autenticação
OU

(application/json).
### Permissões

+ NFS-e Integrador (ROLE_INTEGRADOR)
### Retorno Sucesso
Response Body:
{"retorno": [{"nfse": {},"referencia":
"arquivo_integrador_20200116183231.txt"}]}
Http status: 200
### Retorno Erro

Http status: 203, 404, 500.
*Consultar tópico LISTAGEM DE ERROS para maiores informações sobre os erros.
+ Parameters
+ cnpjPrestador (required) - Filtrar por cnpj do Prestador
+ inscricaoPrestador (required) - Filtrar por inscrição municipal do Prestador
+ numeroRps (required) - Filtrar por número do RPS.
+ serieRps (required) - Filtrar por série do RPS.
+ Headers

+ nfse - Atributo de "retorno", dentro trás o registro do RPS/NFS-e
filtrado.
+ docNum (number) - Atributo de "nfse", mostra o Número para identificar o
documento na origem. Preenchido conforme enviado na integração do documento.
+ tipoAmbienteSistema (number) - Atributo de "nfse", mostra o tipo de
ambiente utilizado, sendo “1” para ambiente de Produção ou “2” para ambiente de
Homologação.
+ valorIss (number) - Atributo de "nfse", mostra o valor do ISS informado
no RPS.
+ aliquotaServicos - Atributo de "nfse", mostra a alíquota de serviço
informada no RPS.
+ dataCancelamento - Atributo de "nfse", mostra a Data e Hora de
Cancelamento da Nota Fiscal.
+ descricaoStatus - Atributo de "nfse", mostra a descrição do status da
última transação.
+ baseCalcRetorno (number) - Atributo de "nfse", mostra o Valor da base de
cálculo do ISS que foi calculado e retornado pela prefeitura, para os casos em que
esse conceito se aplicar.
+ numeroRps (number) - Atributo de "nfse", mostra o Número do RPS.
+ inscricaoPrestador - Atributo de "nfse", mostra a Inscrição Municipal do
Prestador que emitiu a NFSe.
+ codigoVerificacao - Atributo de "nfse", mostra o Código de Verificação,
gerado para identificação da NFS-e.
+ vlLiquidoRetorno (number) - Atributo de "nfse", mostra o Valor do
faturamento líquido da NFS-e que foi calculado e retornado pela prefeitura, para os
casos em que esse conceito se aplicar.
+ valorDeduzir - Atributo de "nfse", mostra o Valor das deduções para
Redução da Base de Cálculo.
+ numeroNfe (number) - Atributo de "nfse", mostra o Número da NFS-e.
+ dataEmissaoRps - Atributo de "nfse", mostra Data e Hora de Emissão do
RPS.
+ urlConsulta - Atributo de "nfse", Link da Nota Fiscal No site da
prefeitura.
+ idProcessamentoRps (number) - Atributo de "nfse", mostra o ID interno do
DFE para controle do processamento do RPS.
+ serieRps - Atributo de "nfse", mostra a série do RPS.
+ numeroLote (number) - Atributo de "nfse", mostra o Número do Lote.
+ dataAprovacao - Atributo de "nfse", mostra Data e Hora de Aprovação da
Nota fiscal.
+ siafiPrestador - Atributo de "nfse", mostra o Código SIAFI da cidade da
declaração, informado no rps.
+ cnpjPrestador - Atributo de "nfse", mostra o Número do CNPJ do Prestador
do Serviço.
+ valorServicos - Atributo de "nfse", mostra o Valor dos serviços em R$.
+ codigoCancelamento - Atributo de "nfse", mostra o Código de Verificação,
gerado para identificação da NFS-e cancelada.
+ codCidade - Atributo de "nfse", mostra o Município do Prestador - Código
do IBGE.
+ vlIssRetRetorno (number) - Atributo de "nfse", mostra o Valor do ISS
Retido que foi calculado e retornado pela prefeitura, para os casos em que esse
conceito se aplicar.
+ situacaoRps - Atributo de "nfse", mostra a Situação do RPS. Pode retornar
valores conforme retorno de cada prefeitura.
+ vlIssRetorno (number) - Atributo de "nfse", mostra o Valor do ISS que foi
calculado e retornado pela prefeitura, para os casos em que esse conceito se
aplicar.
+ tipoRetorno - Atributo de "nfse", corresponde ao fluxo da transação: 1.
Emissão, 2. Cancelamento.
+ numeroProtocolo - Atributo de "nfse", mostra o Número do Protocolo
disponibilizado pela Prefeitura.
+ tipoRps - Atributo de "nfse", mostra o Tipo de RPS, que é Ppreenchido
conforme enviado na integração do documento.
+ status (number) - Atributo de "nfse", mostra o Código do Status da última
transação,
APROVADO(100, "Autorizado", Tipo.SUCESSO)
CANCELADO(101, "Cancelado", Tipo.SUCESSO)
REJEITADO(200, "Rejeitado", Tipo.FALHA)
DUPLICIDADE(204, "Duplicidade", Tipo.SUCESSO)
ERRO_XML(201,"Erro no XML", Tipo.FALHA)
ERRO_GERAL(999,"Erro geral", Tipo.FALHA)
+ message - "OK"
+ Headers
+ Body
{
"retorno": [
{
"nfse": {
"docNum": null,
"tipoAmbienteSistema": 2,
"valorIss": 20.00,
"aliquotaServicos": "0.0200",
"dataCancelamento": "2020-01-16T17:37:54",
"descricaoStatus": "Cancelado o uso da NFS-e",
"baseCalcRetorno": 79998.00,
"numeroRps": 7634,
"inscricaoPrestador": "01997092",
"codigoVerificacao": "VSF3-WIRZ",
"vlLiquidoRetorno": 79991.00,
"valorDeduzir": "0.00",
"numeroNfe": 3957135,
"dataEmissaoRps": "2020-01-16T00:00:00",
"urlConsulta":
"https://homologacao.notacarioca.rio.gov.br/contribuinte/notaprint.aspx?
ccm=01997092&nf=3957135&verificacao=VSF3WIRZ",
"idProcessamentoRps": 8,
"serieRps": "345",
"numeroLote": 1234567803,
"dataAprovacao": "2020-01-16T17:32:45",
"siafiPrestador": "6001",
"cnpjPrestador": "00910509000252",
"valorServicos": "80000.00",
"codigoCancelamento": "1",
"codCidade": "3304557",
"vlIssRetRetorno": null,
"situacaoRps": "2",
"vlIssRetorno": 1599.96,
"tipoRetorno": "2",
"numeroProtocolo":
"00000000000000000000000000000000000000000002365890",
"tipoRps": "1",
"status": 101
},
}
]
}
### Consulta Padrão (get) [GET /dfe/{?cnpj,serie, maxResults}]
Endpoint de Método para obter os retornos dos documentos enviados e a lista de

documentos não consultados.

http://localhost:8080/webservice/api/dfe/
serie=TR5,171,A02&cnpj=57036351000213,78917809000179?maxResults=100

https://ws.h.dfe.mastersaf.com.br/api/dfe/
serie=TR5,171,A02&cnpj=57036351000213,78917809000179?maxResults=100
### Autenticação
OU

(application/json).
### Permissões

+ NFS-e Integrador (ROLE_INTEGRADOR)
### Retorno Sucesso
Response Body: {"retorno":{"ids":[],"rpss":[]}}

Http status: 200
### Retorno Erro
Http status: 203, 404, 500.

+ Parameters
+ cnpj - Filtrar por cnpj do Prestador
+ serie - Filtrar por série do RPS.
+ maxResults - Número de elementos da lista. Se não informado será considerado
o valor 50.
+ Headers

+ ids - Atributo de "retorno", dentro trás
+ rpss - Atributo de "retorno", dentro trás o registro do RPS/NFS-e
filtrado.
+ docNum (number) - Atributo de "rpss", mostra o Número para identificar o
+ idProcessamentoLote (number) - Atributo de "rpss", mostra o ID interno do
DFE para controle do processamento do lote.
+ tipoAmbienteSistema (number) - Atributo de "rpss", mostra o tipo de
Homologação.
+ valorIss (number) - Atributo de "rpss", mostra o valor do ISS informado
no RPS.
+ aliquotaServicos - Atributo de "rpss", mostra a alíquota de serviço
informada no RPS.
+ descricaoStatus - Atributo de "rpss", mostra a descrição do status da
+ baseCalcRetorno (number) - Atributo de "rpss", mostra o Valor da base de
cálculo do ISS que foi calculado e retornado pela prefeitura, para os casos em que
esse conceito se aplicar.
+ numeroRps (number) - Atributo de "rpss", mostra o Número do RPS.
+ inscricaoPrestador - Atributo de "rpss", mostra a Inscrição Municipal do
+ codigoVerificacao - Atributo de "rpss", mostra o Código de Verificação,
+ vlLiquidoRetorno (number) - Atributo de "rpss", mostra o Valor do
faturamento líquido da NFS-e que foi calculado e retornado pela prefeitura, para os
casos em que esse conceito se aplicar.
+ valorDeduzir - Atributo de "rpss", mostra o Valor das deduções para
Redução da Base de Cálculo.
+ numeroNfe (number) - Atributo de "rpss", mostra o Número da NFS-e.
+ dataEmissaoRps - Atributo de "rpss", mostra Data e Hora de Emissão do
RPS.
+ urlConsulta - Atributo de "rpss", Link da Nota Fiscal No site da
prefeitura.
+ idProcessamentoRPS (number) - Atributo de "rpss", mostra o ID interno do
DFE para controle do processamento do RPS.
+ serieRps - Atributo de "rpss", mostra a série do RPS.
+ numeroLote (number) - Atributo de "rpss", mostra o Número do Lote.
+ dataAprovacao - Atributo de "rpss", mostra Data e Hora de Aprovação da
Nota fiscal.
+ siafiPrestador - Atributo de "rpss", mostra o Código SIAFI da cidade da
+ cnpjPrestador - Atributo de "rpss", mostra o Número do CNPJ do Prestador
do Serviço.
+ valorServicos - Atributo de "rpss", mostra o Valor dos serviços em R$.
+ codCidade - Atributo de "rpss", mostra o Município do Prestador - Código
do IBGE.
+ vlIssRetRetorno (number) - Atributo de "rpss", mostra o Valor do ISS
Retido que foi calculado e retornado pela prefeitura, para os casos em que esse
conceito se aplicar.
+ situacaoRps - Atributo de "rpss", mostra a Situação do RPS. Pode retornar
+ vlIssRetorno (number) - Atributo de "rpss", mostra o Valor do ISS que foi
calculado e retornado pela prefeitura, para os casos em que esse conceito se
aplicar.
+ tipoRetorno - Atributo de "rpss", corresponde ao fluxo da transação: 1.
Emissão, 2. Cancelamento.
+ numeroProtocolo - Atributo de "rpss", mostra o Número do Protocolo
+ tipoRps - Atributo de "rpss", mostra o Tipo de RPS, que é Ppreenchido
+ status (number) - Atributo de "rpss", mostra o Código do Status da última
transação,
+ Headers
+ Body
{
"retorno": {
"ids": [
28769,
28770,
28771
],
"rpss": [
{
"nota": {
"docNum": null,
"idProcessamentoLote": null,
"valorIss": 1600.00,
"aliquotaServicos": 0.0200,
"descricaoStatus": "Autorizado o uso da NFS-e",
"baseCalcRetorno": 80000.00,
"numeroRps": 501930390,
"codigoVerificacao": "A2AS-ALXP",
"vlLiquidoRetorno": 79993.00,
"numeroNfe": 3962132,
"urlConsulta":
"https://homologacao.notacarioca.rio.gov.br/contribuinte/notaprint.aspx?
ccm=01997092&nf=3962132&verificacao=A2ASALXP",
"serieRps": "309",
"dataAprovacao": "2020-08-22T20:15:52",
"siafiPrestador": "6001",
"cnpjPrestador": "00910509000252",
"codCidade": "3304557",
"situacaoRps": "1",
"vlIssRetorno": 1600.00,
"tipoRetorno": "1",
"numeroProtocolo":
"00000000000000000000000000000000000000000002403573",
"tipoRps": "1",
"status": 100
},
"referencia": "NFSE_Prosegur2.txt"
},
{
"nota": {
"docNum": null,
"valorIss": 0.02,
"descricaoStatus": "Parar Processamento solicitado pelo
usuário: teste3",
"baseCalcRetorno": null,
"numeroRps": 31,
"codigoVerificacao": null,
"vlLiquidoRetorno": null,
"numeroNfe": null,
"urlConsulta": null,
"serieRps": "376",
"numeroLote": 1,
"siafiPrestador": null,
"cnpjPrestador": "00910509000171",
"codCidade": "3139003",
"situacaoRps": "1",
"vlIssRetorno": null,
"tipoRetorno": "1",
"numeroProtocolo": null,
"tipoRps": "1",
"status": 999
},
"referencia": null
},
{
"nota": {
"docNum": null,
"valorIss": 50.00,
"descricaoStatus": "Parar Processamento solicitado pelo
usuário: elaine machado",
"baseCalcRetorno": null,
"numeroRps": 757493,
"codigoVerificacao": null,
"vlLiquidoRetorno": null,
"numeroNfe": null,
"urlConsulta": null,
"serieRps": "321",
"cnpjPrestador": "00910509000252",
"codCidade": "3126109",
"situacaoRps": "1",
"vlIssRetorno": null,
"tipoRetorno": "1",
"tipoRps": "1",
"status": 999
},
"referencia": null
}
]
}
}
# Group CTE OS
## GET [/cteos/get]
### Consultar Listagem CTE OS (getListagem) [GET /cteos/getListagem{?

Endpoint de Método de consulta para retornar uma listagem de CT-e OS, irá retornar
alguns dados principais de 1 ou N CT-e OS por consulta.

http://localhost:8080/webservice/api/cteos/getListagem?
ou
https://ws.h.dfe.mastersaf.com.br/api/cteos/getListagem?
### Autenticação
OU

(application/json).
+ Parameters
+ Headers

documentos.
+ message - "OK"
+ Headers
+ Body
{
"result":[
{"situacao":"Rejeitado","valorTotalPrestacao":"10.000,00","cpfCnpjDest":"3540275900
0185","inicioPrest":"Porto Alegre - RS","dataEmissao":"07/04/2021
07:50:00","cnpjEmit":"00910509002034","protocolo":null,"locEnvio":"Porto Alegre -
RS","numeroCte":"18","descricaoRetorno":"Marcado como consultado -(admin1@TR-
74YFP13)","chaveAcesso":"43210400910509002034674390000000181391776620","naturezaOpe
racao":"Prestacao serv. tranRS. estab. comercial","razaoSocialDest":"CT-E EMITIDO
EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL","serie":"439","razaoSocialEmit":"CT-
E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL","fimPrest":"Curitiba -
PR","emailEnviadoPara":""},
PR","emailEnviadoPara":""},{"situacao":"Erro no
XML","valorTotalPrestacao":"10.000,00","cpfCnpjDest":"35402759000185","inicioPrest"
:"Porto Alegre - RS","dataEmissao":"07/04/2021
PR","emailEnviadoPara":""}
],
"message":"OK",
"hasMore": false,
"count": 7,
"maxResults": 10,
"offset": 0
}
### Consultar Log CTE OS (getLog) [GET /cteos/getLog{?

Endpoint de Método de consulta para retornar os logs do CT-e OS, irá retornar todos
os logs de um único CT-e OS a cada consulta, por isso o cliente deverá enviar como
parâmetro a identificação do CT-e OS.
neste documento.

http://localhost:8080/webservice/api/cteos/getLog?
ou
https://ws.h.dfe.mastersaf.com.br/api/cteos/getLog?
### Autenticação
OU

(application/json).
+ Parameters
+ Headers

+ message - "OK"
+ Headers
+ Body
{
"result":
[{"dataHora": "03/10/2017 20:24:26","status": 10, "historico": "Criado
CT-e OS - Processamento inicia-se às 03/10/2017 17h24 -(webservice@U0152094-TPL-
A)","stackTrace": null},
{"dataHora": "03/10/2017 20:24:26","status": 10,"historico": "Chave de
acesso: 43171000910509000171675550000000011391776625","stackTrace": null},
{"dataHora": "03/10/2017 20:28:14","status": 20,"historico": "Criado
lote para envio","stackTrace": null}],
"message":"OK",
"hasMore": false,
"count": 3,
"maxResults": 10,
"offset": 0
}
### Consultar Impressão Carta de Correção CT-e OS (getImpressaoCCe) [GET

/cteos/getImpressaoCCe]
Endpoint para obter apenas os retornos dos documentos de Carta de Correção de CT-e,
método.
Anteriormente esse método tinha o nome de getImpressaoCCeCTeOS (ainda válido até a
reconhecido.

http://localhost:8080/webservice/api/cteos/getImpressaoCCe (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/cteos/getImpressaoCCe (ambiente de
### Autenticação
OU
### Permissões


(application/json).
+ Parameters
+ Headers


+ Headers
+ Body
{
"impressaoCCe": [
{
"params": {
"id": 337,
"conteudoXml": "<CTeOS
xmlns=\"http://www.portalfiscal.inf.br/cte\" versao=\"3.00\"><infCte
Id=\"CTe43210400910509002034674390000000251391776624\"
cao serv. tranRS. estab.
tpAmb><tpCTe>0</tpCTe><procEmi>0</procEmi><verProc>3.89.1</
verProc><cMunEnv>4314902</cMunEnv><xMunEnv>Porto
Alegre</xMunEnv><UFEnv>RS</UFEnv><modal>01</modal><tpServ>8</tpServ><indIEToma>1</
indIEToma><cMunIni>4314902</cMunIni><xMunIni>Porto
Alegre</xMunIni><UFIni>RS</UFIni><cMunFim>4106902</cMunFim><xMunFim>Curitiba</
xMunFim><UFFim>PR</UFFim><infPercurso><UFPer>SC</UFPer></infPercurso></
ide><compl><xCaracAd>ENTREGA</xCaracAd><xCaracSer>EMERGENCIAL</
xCaracSer><xEmi>Juca</xEmi><xObs>Observacoes Complementares</xObs><ObsCont
xCampo=\"1\"><xTexto>observacoes contribuinte 1</xTexto></ObsCont><ObsFisco
xCampo=\"1\"><xTexto>observacoes fisco
1</xTexto></ObsFisco></compl><emit><CNPJ>00910509002034</CNPJ><IE>0018001360</
IE><xNome>CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR
FISCAL</xNome><xFant>Transportes Juca Ltda</xFant><enderEmit><xLgr>AV ANDRE
1</xCpl><xBairro>CENTRO</xBairro><cMun>4314902</cMun><xMun>Porto
Alegre</xMun><CEP>98700000</CEP><UF>RS</UF><fone>05121521110</fone></enderEmit></
emit><toma><CNPJ>35402759000185</CNPJ><IE>110337602110</IE><xNome>BIMBO
SP</xNome><xFant>BIMBO SP</xFant><fone>011123456789</fone><enderToma><xLgr>RUA DR
OSVALDO CRUZ</xLgr><nro>SN</nro><xCpl>Av. 5</xCpl><xBairro>JD
CEP><UF>SP</UF><cPais>1058</cPais><xPais>Brasil</xPais></
enderToma><email>automacao@dathomsonreuters.com</email></
toma><vPrest><vTPrest>10000.00</vTPrest><vRec>10000.00</vRec><Comp><xNome>SEC/
CAT</xNome><vComp>10000.00</vComp></Comp></vPrest><imp><ICMS><ICMS00><CST>00</
ICMS><vTotTrib>1200.00</vTotTrib><infAdFisco>Informacoes adicionais de interesse ao
fisco</infAdFisco><infTribFed><vPIS>0.00</vPIS><vCOFINS>0.00</vCOFINS><vIR>0.00</
vIR><vINSS>250.00</vINSS><vCSLL>0.00</vCSLL></infTribFed></
imp><infCTeNorm><infServico><xDescServ>prestacao servico
transporte</xDescServ></infServico><infDocRef><nDoc>1234</nDoc><serie>1</
serie><dEmi>2021-04-05</dEmi><vDoc>1</vDoc></infDocRef><seg><respSeg>4</
respSeg><xSeg>Seguradora Teste</xSeg><nApol>123ABCD</nApol></seg><infModal
versaoModal=\"3.00\"><rodoOS
xmlns=\"http://www.portalfiscal.inf.br/cte\"><TAF>123456789123</TAF><veic><placa>AB
C1234</placa></veic></rodoOS></infModal></infCTeNorm></
infCte><infCTeSupl><qrCodCTe>https://dfe-portal.svrs.rs.gov.br/cte/qrCode?
chCTe=43210400910509002034674390000000251391776624&tpAmb=2</qrCodCTe></
Method
Algorithm=\"http://www.w3.org/2000/09/xmldsig#sha1\"/><DigestValue>ty4e1JsyXpf2dc6p
soypOSpwizA=</DigestValue></Reference></
SignedInfo><SignatureValue>W8bo9evpABp69bmLxRqOR2A3SBBvqtDAwTK5v7xrGM2FlKJvxUDwKcSg
awzqxqhjmQ7vTeNBBg30I/
wnWtdWkPCgJhysUUaNR2DahZTp2MXPdOzbUVxY3VsdMPRNQDH24HiZwKjjgLlQHQ0pbZccM8kwxPLFqVONe
Z4b73QhtoiIJsTG+UxLM+zyslGnNKRUlg9Cdg5lZSxsc2R2gM4jYfnGqrWpQPT9vrT3aRCjrBp1/
UWGGeAprEDqpBq5fz0ZL6lG4LIFOjtYsa7AkVdUPsPLXHcPYl+J5z1oyTbOyFP9+hgjPCh9mfCe+GJrZIvM
U4xInGwov7IUxgUILygUPQ==</
Signature></CTeOS>",
"dataEmissao": 1650625020000,
"nroCopias": 1,
"nroProtocolo": "143220000088973",
"emailEmpresa": "elaine.machado@tr.com",
"statusDocto": 100,
Id=\"ID1101104321040091050900203467439000000025139177662401\"><cOrgao>43</
nSeqEvento><detEvento versaoEvento=\"3.00\"><evCCeCTe
xmlns=\"http://www.portalfiscal.inf.br/cte\"><descEvento>Carta de
Correcao</descEvento><infCorrecao><grupoAlterado>toma</grupoAlterado><campoAlterado
>fone</campoAlterado><valorAlterado>011123457777</
valorAlterado><nroItemAlterado>1</nroItemAlterado></infCorrecao><xCondUso>A Carta
de Correcao e disciplinada pelo Art. 58-B do CONVENIO/SINIEF 06/89: Fica permitida
a utilizacao de carta de correcao, para regularizacao de erro ocorrido na emissao
de documentos fiscais relativos a prestacao de servico de transporte, desde que o
erro nao esteja relacionado com: I - as variaveis que determinam o valor do imposto
tais como: base de calculo, aliquota, diferenca de preco, quantidade, valor da
prestacao;II - a correcao de dados cadastrais que implique mudanca do emitente,
tomador, remetente ou do destinatario;III - a data de emissao ou de
saida.</xCondUso></evCCeCTe></detEvento></infEvento><Signature
Method
Algorithm=\"http://www.w3.org/2000/09/xmldsig#sha1\"/><DigestValue>wsZSLQt5EOQaTb28
y+A/iNV+AXU=</DigestValue></Reference></
SignedInfo><SignatureValue>cBeUTZelozdkyX4r9iuwK58FkfJ2eSPpLZSpf8HVeymCzdEx1OSWOgyH
ScSmldoH2uttYGjbaaQRUnKWLQwefkLjNsgQHEqO/aB9d/
V2ZKVA0wp4wBKSe8q6w3q4Ap2jBaYxC13XrF8tCj2mRiL0KLfnXShzIiEhUzTwK8mLJ5GBkGkTlAHPb0H/
a9KHcvpUhvRLXoQJ+HTsMn6rzMz0kR3EGpyLUOK4+CWNgaN+V6CHxk4cIf2V41K6KOKVdHmhvY9Qn3rCSxm
8HMHm7J9kPxCOB2T+Pyu/0WbrKi0erQT46HTiZNHkjQfjXmWVvx4VeqwRIGfWbeo4bnKpEZt/qQ==</
9zTOM9U/
Wu6LVRy8npH3egR/
jiacTc1jNQjB/
Q5uCrIr6pl/pQm/
eventoCTe><retEventoCTe xmlns=\"http://www.portalfiscal.inf.br/cte\"
03:00</dhRegEvento><nProt>143220000088973</nProt></infEvento></retEventoCTe></
procEventoCTe>",
"xmlRetornoCC": "<retEventoCTe
03:00</dhRegEvento><nProt>143220000088973</nProt></infEvento></retEventoCTe>",
"cnpjEmissor": null,
"inscricaoEmissor": null,
"exibirDadosConsumidorDanfe": false,
"enviaPrinter": 0,
"ordemEmbarque": null,
"nroItens": null,
"usuarioEmitente": null,
}
}
]
}
# Group MDFE
Resumindo o processo, primeiramente é enviado um pacote de dados; depois é feita

uma consulta recebendo uma lista de ids e, então por fim, marcam-se no sistema os
ids consultados para que numa próxima consulta eles não sejam retornados novamente,
também são retornados os MDF-es para impressão via printer.
Para todos os requests é preciso usar basic authentication utilizando o usuário e a
senha fornecidos. Com isso basta realizar POST para enviar os pacotes e GET para
consultar o resultado do processamento. O corpo do POST (request body) deve ser um
json contendo uma tag “action” e uma tag “txt_conteudo”. O separador de campos do
conteúdo é o pipe ( | ). Para quebra de linha usa-se \n.
Para enviar vários MDF-es você deve concatenar as strings antes de colocar em
txt_conteúdo.Txt conteúdo terá vários “{“config”: “ .. “, “xml” : “...”} separando-
os por vírgula. No caso de cancelamento e encerramento o procedimento é o mesmo.
## POST [/mdfe]
Método para envio de MDF-es para serem autorizadas pela Sefaz correspondente.

http://localhost:8080/webservice/api/mdfe (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/mdfe (ambiente de homologação do SaaS)
### Autenticação
OU
### Retorno Sucesso

### Retorno Erro
Http status: 400, 412, 500.
+ Headers
+ Attributes
+ action (required) - Ação solicitada. Conteúdo: “EnviarPacote”

+ txt_conteudo (required) - Grupo de informações do MDF-e.
+ xml (required) - Conteúdo do MDF-e
Formato TXT: Informar dados conforme layout padrão TXT de MDF-e
(layout/planilha está disponível no Web Help:
Mastersaf_Layout_DFe_V3_MDFe_3_00_V3_04).
Formato XML: Conteúdo do XML de MDF-e. Informar dados conforme layout
padrão da Receita Federal.
+ config - Configurações.
+ Body

{
"action":"EnviarPacote",
"referencia":"arquivo_integrador_20161201162859.txt","ids":null,
"txt_conteudo":
[{"config":"{\"impressora\":\"\",\"ordemImpressao\":\"numero\",\"usuarioEmitente\":
\"Willian\",\"versao\":\"3.00\"}",
"xml":"<MDFe xmlns=\"http://www.portalfiscal.inf.br/mdfe\"><infMDFe
Id=\"MDFe99999999999999999999999999999999999999999999\"
versao=\"3.00\"><ide><cUF>43</cUF><tpAmb>2</tpAmb><tpEmit>1</tpEmit><tpTransp>1</
tpTransp><mod>58</mod><serie>123</serie><nMDF>1000</nMDF><cMDF>12345678</
cMDF><cDV>8</cDV><modal>1</modal><dhEmi>2016-12-01T03:00:00-02:00</
dhEmi><tpEmis>1</tpEmis><procEmi>0</procEmi><verProc>Mastersaf
DF-e</verProc><UFIni>RS</UFIni><UFFim>RS</UFFim><infMunCarrega><cMunCarrega>4314902
</cMunCarrega><xMunCarrega>Porto
Alegre</xMunCarrega></infMunCarrega></ide><emit><CNPJ>00111222000199</
CNPJ><IE>123456789</IE><xNome>Empresa Teste MDFe</xNome><xFant>Empresa Teste
MDFe</xFant><enderEmit><xLgr>RDV BR 222</xLgr><nro>KM 10</nro><xCpl>DISTRITO
INDUSTRIAL</xCpl><xBairro>MODELO</xBairro><cMun>4314902</cMun><xMun>PORTO
ALEGRE</xMun><CEP>13214730</CEP><UF>RS</UF><fone>5100001111</fone><email>empresa@em
ail.com</email></enderEmit></emit><infModal versaoModal=\"3.00\"><rodo
xmlns=\"http://www.portalfiscal.inf.br/mdfe\"><infANTT><RNTRC>12345678</
RNTRC><infCIOT><CIOT>123456789012</CIOT><CPF>00011122233</CPF></
infCIOT><valePed><disp><CNPJForn>00111222000199</CNPJForn><CPFPg>00011122233</
CPFPg><nCompra>123</nCompra><vValePed>100.00</vValePed></disp></
valePed><infContratante><CNPJ>00111222000199</CNPJ></infContratante></
infANTT><veicTracao><cInt>1</cInt><placa>AEI1322</placa><RENAVAM>W123G51234A</
RENAVAM><tara>123456</tara><capKG>123456</capKG><capM3>123</
capM3><prop><CNPJ>00111222000199</CNPJ><RNTRC>12345678</RNTRC><xNome>Marco
Oliveira</xNome><IE>123456789</IE><UF>RS</UF><tpProp>0</tpProp></prop><condutor><xN
ome>Juca
Oliveira</xNome><CPF>00011122233</CPF></condutor><tpRod>04</tpRod><tpCar>02</
tpCar><UF>RS</UF></veicTracao><veicReboque><cInt>2</cInt><placa>IEI1021</
placa><RENAVAM>WE8E123812A</RENAVAM><tara>789012</tara><capKG>789012</
capKG><capM3>456</capM3><prop><CNPJ>00111222000199</CNPJ><RNTRC>90123456</
RNTRC><xNome>Leonel
Silva</xNome><IE>123456789</IE><UF>RS</UF><tpProp>2</tpProp></prop><tpCar>02</
tpCar><UF>RS</UF></veicReboque><codAgPorto>11122233</
codAgPorto><lacRodo><nLacre>112233</nLacre></lacRodo></rodo></
infModal><infDoc><infMunDescarga><cMunDescarga>4314902</
cMunDescarga><xMunDescarga>Porto
Alegre</xMunDescarga><infCTe><chCTe>99999999999999999999999999999999999999999999</
chCTe><indReentrega>1</indReentrega><infUnidTransp><tpUnidTransp>1</
tpUnidTransp><idUnidTransp>LMM1532</idUnidTransp><lacUnidTransp><nLacre>1283091</
nLacre></lacUnidTransp><infUnidCarga><tpUnidCarga>4</
tpUnidCarga><idUnidCarga>16512</idUnidCarga><lacUnidCarga><nLacre>315135</
nLacre></lacUnidCarga><qtdRat>312.00</qtdRat></infUnidCarga><qtdRat>165.00</
qtdRat></infUnidTransp><peri><nONU>1234</nONU><xNomeAE>Nome
embarque</xNomeAE><xClaRisco>classe</xClaRisco><grEmb>grupo</grEmb><qTotProd>123.00
</qTotProd><qVolTipo>123.00</qVolTipo></peri></infCTe></infMunDescarga></
infDoc><seg><infResp><respSeg>1</respSeg><CNPJ>00111222000199</CNPJ></
infResp><infSeg><xSeg>Segurado
xyz</xSeg><CNPJ>00111222000199</CNPJ></infSeg><nApol>123456</nApol><nAver>12ABCD</
nAver><nAver>34EFGH</nAver></seg><tot><qCTe>1</qCTe><vCarga>1234.78</
vCarga><cUnid>01</cUnid><qCarga>11312</qCarga></tot><lacres><nLacre>60019</
nLacre></lacres><autXML><CNPJ>00111222000199</CNPJ></
autXML><infAdic><infAdFisco>informacoes adicionais
fisco</infAdFisco><infCpl>Informacoes
complementares</infCpl></infAdic></infMDFe></MDFe>\r\n"}],
"id_integrador":"11253-TPL-A"
}
+ Body
{
"result": "OK"
}
### Cancelar [POST]
Método para cancelar MDF-es enviados ao webservice.

ou
### Autenticação
OU
### Permissões

+ MDF-e Integrador (ROLE_MDFE_INTEGRADOR);
### Retorno Sucesso

### Retorno Erro
Http status: 400, 412, 500.
+ Headers
+ Attributes
+ action (required) - Ação solicitada. Conteúdo: “Cancelar”

+ txt_conteudo (required) - Grupo de informações de cancelamento.
+ xml (required) - Conteúdo do cancelamento do MDF-e
Formato TXT: Informar dados conforme layout padrão TXT de cancelamento de
MDF-e (layout/planilha está disponível no Web Help:
Formato XML: Conteúdo do XML de MDF-e. Informar dados conforme layout
padrão da Receita Federal.
+ Body

{
"action":"Cancelar",
"txt_conteudo":
[{"config":"{\"usuarioEmitente\":\"joao\",\"versao\":\"3.00\"}","xml":"<eventoMDFe
versao=\"3.00\" xmlns=\"http://www.portalfiscal.inf.br/mdfe\"><infEvento
Id=\"ID1101119999999999999999999999999999999999999999999901\"><cOrgao></
cOrgao><tpAmb>2</tpAmb><CNPJ>00111222000199</CNPJ><IE>123456789</
IE><chMDFe>99999999999999999999999999999999999999999999</chMDFe><dhEvento>2016-11-
nSeqEvento><detEvento versaoEvento=\"3.00\"><evCancMDFe
xmlns=\"http://www.portalfiscal.inf.br/mdfe\"><descEvento>Cancelamento</
descEvento><nProt>999990000099999</nProt><xJust>Justificativa de
Cancelamento</xJust></evCancMDFe></detEvento></infEvento></eventoMDFe>"}],
}
+ Body
{
"result": "OK"
}
### Encerrar [POST]
Método para encerrar MDF-es.

ou
### Autenticação
OU
### Permissões

### Retorno Sucesso

### Retorno Erro
Http status: 400, 412, 500.
+ Headers
+ Attributes
+ action (required) - Ação solicitada. Conteúdo: “Encerrar”
+ txt_conteudo (required) - Grupo de informações de encerramento.
+ config - Atributo de txt_conteudo. Configurações.
+ xml (required) - Atributo de txt_conteudo. Conteúdo do Encerramento de
MDF-e.
Formato TXT: Informar dados conforme layout padrão TXT de encerramento de
MDF-e (layout/planilha está disponível no Web Help:
Formato XML: Informar dados conforme layout padrão da Receita Federal mais
a tag <IE> para ser utilizada em processos internos.
+ Body

{
"action":"Encerrar",
"txt_conteudo":
[{"config":"{\"usuarioEmitente\":\"joao\",\"versao\":\"3.00\"}","xml":"<eventoMDFe
versao=\"3.00\" xmlns=\"http://www.portalfiscal.inf.br/mdfe\"><infEvento
Id=\"ID1101129999999999999999999999999999999999999999999901\"><cOrgao></
nSeqEvento><detEvento versaoEvento=\"3.00\"><evEncMDFe
xmlns=\"http://www.portalfiscal.inf.br/mdfe\"><descEvento>Encerramento</
descEvento><nProt>999990000099999</nProt><dtEnc>2016-11-02</dtEnc><cUF>43</
cUF><cMun>4314902</cMun></evEncMDFe></detEvento></infEvento></eventoMDFe>"}],
}
+ Body
{
"result": "OK"
}
### Marcar Consultado [POST]
Método para indicar ao WebService que determinados documentos já foram consultados

e não precisam mais ser retornados na consulta (GET). Deve ser utilizado depois do
método de consulta onde são listados os documentos para geração de retorno.

ou
### Autenticação
OU
### Permissões

### Retorno Sucesso

### Retorno Erro
Http status: 412, 500.
+ Headers
+ Attributes
+ action (required) - Ação solicitada. Conteúdo: “MarcarConsultado”

+ Ids (required) - Listagem de ids dos processamentos a serem marcados como
consultados.
+ Body
{
"action":"MarcarConsultado",
"ids":[8214]
}
+ Body
{
"result": "OK"
}
### Marcar Impresso [POST]
Método para indicar ao WebService que determinados documentos já foram impressos e

não precisam mais ser retornados na consulta (GET). Deve ser utilizado depois do
método de consulta onde são listados os documentos para que devem ser enviados para
o Printer imprimir (getImpressao).

ou
### Autenticação
OU
### Permissões

### Retorno Sucesso

### Retorno Erro
Http status: 400, 412, 500.
+ Headers
+ Attributes
+ action (required) - Ação solicitada. Conteúdo: “MarcarImpresso”

+ Ids (required) - Grupo de informações para marcar como impresso.
+ idProcessamento (required) - Id do processamento a ser marcado.
+ idNota (required) - Id da nota a ser marcada.
+ Body
{
"action":"MarcarImpresso",
"ids":[{"idProcessamento":8214,
"idNota":7197}]
}
+ Body
{
"result": "OK"
}
### Inclusão de Condutor [POST]
Método para incluir condutores no MDF-e.

ou
### Autenticação
OU
### Permissões

### Retorno Sucesso

### Retorno Erro
Http status: 400, 412, 500.
+ Headers
+ Attributes
+ action (required) - Ação solicitada. Conteúdo:

“EnviarMdfeInclusaoCondutor”
+ txt_conteudo (required) - Grupo de informações para inclusão de condutor.
+ config - Atributo de txt_conteudo. Configurações.
+ xml (required) - Atributo de txt_conteudo. Conteúdo da Inclusão de
Condutor de MDF-e.
Formato TXT: Informar dados conforme layout padrão TXT de Inclusão de
Condutor (layout/planilha está disponível no Web Help:
Formato XML: Informar dados conforme layout padrão da Receita Federal mais
a tag <IE> para ser utilizada em processos internos.
+ Body

{
"action": "EnviarMdfeInclusaoCondutor",
"referencia": "arquivo_integrador_2017110301.txt","ids": null,
"txt_conteudo": [{"config":
"{\"usuarioEmitente\":\"mastersaf\",\"versao\":\"3.00\"}","xml": "<eventoMDFe
xmlns=\"http://www.portalfiscal.inf.br/mdfe\" versao=\"3.00\"><infEvento
Id=\"ID43171100910509000171585550000055561123456784\"><cOrgao>43</
nSeqEvento><detEvento versaoEvento=\"3.00\"><evIncCondutorMDFe
xmlns=\"http://www.portalfiscal.inf.br/mdfe\"><descEvento>Inclusao
Condutor</descEvento><condutor><xNome>Alfredo
Borges</xNome><CPF>14064547535</CPF></condutor></evIncCondutorMDFe></detEvento></
infEvento></eventoMDFe>"}],
"id_integrador": "U0172283-TPL-A"
}
+ Body
{
"result": "OK"
}
### Pagamento da Operação de Transporte [POST]
Método para evento de Pagamento da Operação de Transporte.

ou
### Autenticação
OU
### Permissões

### Retorno Sucesso

### Retorno Erro
Http status: 400, 412, 500.
+ Headers
+ Attributes
+ action (required) - Ação solicitada. Conteúdo: “EnviarMdfePagtoOperacao”

+ txt_conteudo (required) - Grupo de informações de evento pagamento
operação.
+ xml (required) - Conteúdo do evento Pagto da Operação de MDF-e.
Formato TXT: Informar dados conforme layout padrão TXT do evento de Pagto
da Operação de MDF-e (layout/planilha está disponível no Web Help:
Formato XML: Informar dados conforme layout padrão XML do evento de Pagto
da Operação de MDF-e.
+ Body

{
"action": "EnviarMdfePagtoOperacao",
"referencia": "arquivo_integrador_2017110301.txt","ids": null,
"txt_conteudo": [{"config":
"{\"usuarioEmitente\":\"mastersaf\",\"versao\":\"3.00\"}","xml": "<eventoMDFe
xmlns=\"http://www.portalfiscal.inf.br/mdfe\" versao=\"3.00\"><infEvento
Id=\"ID1101164320043540275900581058501505670258112345678501\"><cOrgao>43</
CNPJ><chMDFe>43200435402759005810585015056702671123456784</chMDFe><dhEvento>2020-
04-03T08:18:44-03:00</dhEvento><tpEvento>110116</tpEvento><nSeqEvento>01</
nSeqEvento><detEvento versaoEvento=\"3.00\"><evPagtoOperMDFe
xmlns=\"http://www.portalfiscal.inf.br/mdfe\"><descEvento>Pagamento Operacao MDF-
e</descEvento><nProt>943200000013272</nProt><infViagens><qtdViagens>12345</
qtdViagens><nroViagem>12345</nroViagem></infViagens><infPag><xNome>automacao</
xNome><CPF>63368512226</CPF><Comp><tpComp>01</tpComp><vComp>1000000000000.00</
vComp><xComp>01 - Vale
Pedágio</xComp></Comp><vContrato>1000000000000.00</vContrato><indPag>1</
indPag><infPrazo><nParcela>100</nParcela><dVenc>2020-05-01</
dVenc><vParcela>1000000000000.00</vParcela></
infPrazo><infBanc><CNPJIPEF>97348730000110</CNPJIPEF></infBanc></infPag></
evPagtoOperMDFe></detEvento></infEvento></eventoMDFe>"}],
"id_integrador": "U0172283-TPL-A"
}
+ Body
{
"result": "OK"
}
## GET [/MDFE/get]
### Consulta Padrão [GET]
Método para obter os retornos dos documentos enviados, lista de documentos não
consultados, dados de lotes inutilizados e os documentos que devem ser enviados
para o Printer imprimir.

ou
### Autenticação
OU
### Permissões


(application/json).
Nenhum dado além do cabeçalho deverá ser informado.
+ Headers
+ impressao - Lista documentos para impressão.
+ id - Atributo de “impressao”. Id do processamento.
+ nota - Atributo de “impressao”. Parâmetros da nota a ser impressa.
+ mdfes - Atributo de “retorno”. Listagem dos retornos das MDF-es que foram
processadas pelo software.
+ Body
{
"impressao":[],
"retorno":
{
"mdfes":[
{
"nota":
{
"retEmissao":
{
"nProt":"943160000099999",
"dataAutorizacao":"2016-11-02T10:09:42-02:00"},
"statusSefaz":100,
"tpAmb":2,
"dhEmi":"2016-11-01T03:15:25-02:00",
"descricaoStatus":"Autorizado o uso do MDF-e",
"chMDFe":"99999999999999999999999999999999999999999999",
"nMDFe":8850,
"serie":"751",
"CNPJ":"00999999000999",
"descricaoStatusSefaz":"Evento registrado e
vinculado ao MDF-e",
"servico":1,
"versao":"3.00",
"status":100},
"referencia":"arquivo_integrador_20161202100809.txt"
},
{
"nota":
{
"retEmissao":
{
"nProt":"943160000099999",
"statusSefaz":135,
"tpAmb":2,
"dhEmi":"2016-11-01T03:15:25-02:00",
"descricaoStatus":"Encerramento de MDF-e
homologado: número: 8851, série: 751.",
"chMDFe":"99999999999999999999999999999999999999999999",
"nMDFe":8851,
"serie":"751",
"CNPJ":"00999999000999",
"descricaoStatusSefaz":"Encerramento de MDF-e
homologado",
"servico":3,
"versao":"3.00",
"status":132,
"retEncerramento":
{
"nProt":"943160000099999",
"dhRegEvento":"2016-11-02T10:12:50-02:00"}
},
},
{
"nota":
{
"retEmissao":
{
"nProt":"943160000099999",
"dataAutorizacao":"2016-11-02T10:09:49-02:00"
},
"retCancelamento":{"nProt":"943160000099999",
"dhRegEvento":"2016-11-02T10:12:50-02:00",
"xJust":"ttttttttttttttttttttttttt"
},
"statusSefaz":135,
"tpAmb":2,
"dhEmi":"2016-12-01T03:15:25-02:00",
"descricaoStatus":"Cancelamento de MDF-e homologado:
número: 8852, série: 751. Motivo de cancelamento: ttttttttttttttttttttttttt. ",
"chMDFe":"99999999999999999999999999999999999999999999",
"nMDFe":8852,
"serie":"751",
"CNPJ":"00999999000999",
"descricaoStatusSefaz":"Cancelamento de MDF-e
homologado",
"servico":2,
"versao":"3.00",
"status":101},
},
{
"nota":
{
"retIncCondutor":
{
"nProt":"943160000099999",
"nSeqEvento":1,
"dhRegEvento":"2016-12-02T10:12:29-02:00"
},
"retEmissao":
{
"nProt":"943160000099999",
},
"statusSefaz":135,
"tpAmb":2,
"dhEmi":"2016-12-01T03:15:25-02:00",
"chMDFe":"99999999999999999999999999999999999999999999",
"nMDFe":8850,
"serie":"751",
"CNPJ":"00999999000999",
"descricaoStatusSefaz":"Evento registrado e vinculado
ao MDF-e",
"servico":4,
"versao":"3.00",
"status":135
},
},
{
"nota":
{
"retEmissao":
{
"nProt":"943160000099999",
},
"statusSefaz":135,
"tpAmb":2,
"dhEmi":"2016-12-01T03:15:25-02:00",
"descricaoStatus":"Encerramento de MDF-e homologado:
número: 8851, série: 751.",
"chMDFe":"99999999999999999999999999999999999999999999",
"nMDFe":8851,
"serie":"751",
"CNPJ":"00999999000999",
"descricaoStatusSefaz":"Encerramento de MDF-e homologado",
"servico":3,
"versao":"3.00",
"status":132,
"retEncerramento":{"nProt":"943160000099999",
"dhRegEvento":"2016-12-02T10:12:50-02:00"
}
},
},
{
"nota":
{
"retEmissao":
{
"nProt":"943160000099999",
"retCancelamento":
{
"nProt":"943160000099999",
"dhRegEvento":"2016-12-02T10:12:50-02:00",
},
"statusSefaz":135,
"tpAmb":2,
"dhEmi":"2016-12-01T03:15:25-02:00",
"descricaoStatus":"Cancelamento de MDF-e homologado: número:
8852, série: 751. Motivo de cancelamento: ttttttttttttttttttttttttt. ",
"chMDFe":"99999999999999999999999999999999999999999999",
"nMDFe":8852,
"serie":"751",
"CNPJ":"00999999000999",
"descricaoStatusSefaz":"Cancelamento de MDF-e homologado",
"servico":2,
"versao":"3.00",
"status":101
},
}],
'"ids":[28728,28730,28729,28734,28736,28735]}
### Get Xml [GET]
Método para obter o XML de envio da respectiva chave de MDF-e.

http://localhost:8080/webservice/api/mdfe/
43220900910509000171583380000000141123456789/getXml (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/mdfe/
43220900910509000171583380000000141123456789/getXml (ambiente de homologação do
SaaS)
### Autenticação
OU
### Permissões


(application/json).
+ Headers
+ Body
{
<MDFe xmlns="http://www.portalfiscal.inf.br/mdfe"><infMDFe
Id="MDFe43120900910509000171582580000002031123456784"
versao="1.00"><ide><cUF>43</cUF><tpAmb>2</tpAmb><tpEmit>1</tpEmit><mod>58</
mod><serie>258</serie><nMDF>203</nMDF><cMDF>12345678</cMDF><cDV>4</cDV><modal>1</
modal><dhEmi>2012-09-21T09:00:00</dhEmi><tpEmis>1</tpEmis><procEmi>0</
procEmi><verProc>Mastersaf DF-e
v3</verProc><UFIni>RS</UFIni><UFFim>RS</UFFim><infMunCarrega><cMunCarrega>4314902</
cMunCarrega><xMunCarrega>Porto
Alegre</xMunCarrega></infMunCarrega><infPercurso><UFPer>RS</UFPer></infPercurso></
ide><emit><CNPJ>00910509000171</CNPJ><IE>0018000282</IE><xNome>Mastersaf RS - NF-
e</xNome><xFant>Mastersaf RS - NF-e</xFant><enderEmit><xLgr>RDV BR
101</xLgr><nro>KM 10</nro><xCpl>DISTRITO
INDUSTRIAL</xCpl><xBairro>EMAUS</xBairro><cMun>4314902</cMun><xMun>PORTO
ALEGRE</xMun><CEP>13214730</CEP><UF>RS</UF><fone>1184364721</fone><email>gustavo.ju
ngthon@thomsonreuters.com</email></enderEmit></emit><infModal
versaoModal="1.00"><rodo
xmlns="http://www.portalfiscal.inf.br/mdfe"><RNTRC>12345678</RNTRC><CIOT>1234567890
12</CIOT><veicPrincipal><cInt>1</cInt><placa>AAA1111</placa><tara>123456</
tara><capKG>123456</capKG><capM3>123</capM3><prop><RNTRC>12345678</RNTRC></
prop><condutor><xNome>Rodrigo</xNome><CPF>31075846521</CPF></condutor></
veicPrincipal><veicReboque><cInt>2</cInt><placa>IML1234</placa><tara>789012</
tara><capKG>789012</capKG><capM3>456</capM3><prop><RNTRC>90123456</RNTRC></prop></
veicReboque><valePed><disp><CNPJForn>73750523000129</
CNPJForn><CNPJPg>00910509000171</CNPJPg><nCompra>12345</nCompra></disp></
valePed></rodo></infModal><infDoc><infMunDescarga><cMunDescarga>4314902</
cMunDescarga><xMunDescarga>JUNDIAI</
xMunDescarga><infCTe><chCTe>24120210970887001338571990078910111234567895</
chCTe><SegCodBarra/></
infCTe><infCTe><chCTe>43120900910509000171570210000000021123456782</
chCTe><SegCodBarra/></infCTe><infCT><nCT>1234</nCT><serie>3</serie><subser>1</
subser><dEmi>2012-09-01</dEmi><vCarga>1254.30</vCarga></infCT><infCT><nCT>567</
nCT><serie>6</serie><subser>3</subser><dEmi>2012-09-02</dEmi><vCarga>6890.15</
vCarga></infCT></infMunDescarga></infDoc><tot><qCTe>2</qCTe><qCT>2</
qCT><vCarga>123456.78</vCarga><cUnid>01</cUnid><qCarga>1</qCarga></
tot><lacres><nLacre>123</nLacre></lacres><infAdic><infCpl>Informacoes
complementares que o emitente desejar enviar</infCpl></infAdic></infMDFe><Signature
URI="#MDFe43120900910509000171582580000002031123456784"><Transforms><Transform
Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/><Transform
thod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/><DigestValue>yqUCvWqyT/8/
WP7A3x/5nowz/+8=</DigestValue></Reference></SignedInfo><SignatureValue>d2/
G6El0eTZnJr+rx8CmvKtnL+ph6nZscan+out8wiko+q5ostFqDTR/
HO05EExGCJEoDAxDEh5VFup+hlhTFaaj+bNEedUjEFMJ9M7vaKq5Mo0/
ZLxieb0DNLehmXxsViLY2zlvvnBBIPJEaRzyvtmcX6TgoDY2UKhzdAZtrM30DEsgE8Gx0dpEJs0FMnLTuPf
veQKiblraEOb8MvR7Y4BG/
tc15H1x5Qs6JNgY+EbJMiMEd0WvL0BPf5syXCz96f+D2frzJGRhoQc5HzJtF8uHViQoHaWS+mfvYQDlT+/
sL2p/5pG/dt+fECTmS4wjmR31hqEaPax220Jm6z4WMA==</
SignatureValue><KeyInfo><X509Data><X509Certificate>MIIIXjCCBkagAwIBAgIQCFuUdi2MJs9D
Mk9biaGwaDANBgkqhkiG9w0BAQsFADB0MQswCQYDVQQGEwJCUjETMBEGA1UEChMKSUNQLUJyYXNpbDEtMCs
NpZ24gTXVsdGlwbGEgRzUwHhcNMTIwNzA5MDAwMDAwWhcNMTMwNzA4MjM1OTU5WjCB4jELMAkGA1UEBhMCQ
lIxEzARBgNVBAoUCklDUC1CcmFzaWwxITAfBgNVBAsUGEF1dGVudGljYWRvIHBvciBBUiBBSEVBRDEbMBkG
A1UECxQSQXNzaW5hdHVyYSBUaXBvIEExMRUwEwYDVQQLFAxJRCAtIDMzODI2MzgxNTAzBgNVBAMTLFRTTCB
URUNOT0xPR0lBIEVNIFNJU1RFTUFTIERFIExFR0lTTEFDQU8gUyBBMTAwLgYJKoZIhvcNAQkBFiFvcmRpbG
V5LnNhbnRvc0B0aG9tc29ucmV1dGVycy5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCWF
kY2bSL6EhN9b25wEfE68sl5w1K0VIIvThikY10QoCSANke1dgzzig7UY0ky+hT95cAkpciquPgXgBEt8r7B
NW0N3U5ACFYW80h7rey8ZuarAdGyLCdHsDZMqFGU+foLCZDBPMuF//UzQh4KGD0l/CNS5D47zPY/qN/
0yuy4hdvU6kazl6r7XyNex9HD2j7e8dVYM9gWta3/
Iv3Cv5n0lfIlQeBpX+0ztvJwRgS4J8B359jMpvKVwAkGJT2c2o1cxmfpMX8iVqsx21LNHS44B5T8SVF4vTE
gP8/7NHQkNA1v7xCpRNsFS2UMiiaNOjO32/
MQjcz5x3RcI7cxIRtDAgMBAAGjggN7MIIDdzCBwQYDVR0RBIG5MIG2oD0GBWBMAQMEoDQEMjA2MDIxOTc5M
jYyMTA5MjU4NjMwMDAwMDAwMDAwMDAwMDAwMDMwNzYyNjMxM1NTUFNQoB4GBWBMAQMCoBUEE09SRElMRVkg
TElNQSBTQU5UT1OgGQYFYEwBAwOgEAQOMDA5MTA1MDkwMDAxNzGgFwYFYEwBAwegDgQMMDAwMDAwMDAwMDA
wgSFvcmRpbGV5LnNhbnRvc0B0aG9tc29ucmV1dGVycy5jb20wCQYDVR0TBAIwADAfBgNVHSMEGDAWgBSdUM
+9/yTKr7Ez6xfiQnqOaSqOUzAOBgNVHQ8BAf8EBAMCBeAwgYkGA1UdIASBgTB/
MH0GBmBMAQIBCzBzMHEGCCsGAQUFBwIBFmVodHRwOi8vaWNwLWJyYXNpbC5jZXJ0aXNpZ24uY29tLmJyL3J
lcG9zaXRvcmlvL2RwYy9BQ19DZXJ0aXNpZ25fTXVsdGlwbGEvRFBDX0FDX0NlcnRpU2lnbk11bHRpcGxhLn
BkZjCCASUGA1UdHwSCARwwggEYMFygWqBYhlZodHRwOi8vaWNwLWJyYXNpbC5jZXJ0aXNpZ24uY29tLmJyL
3JlcG9zaXRvcmlvL2xjci9BQ0NlcnRpc2lnbk11bHRpcGxhRzUvTGF0ZXN0Q1JMLmNybDBboFmgV4ZVaHR0
cDovL2ljcC1icmFzaWwub3V0cmFsY3IuY29tLmJyL3JlcG9zaXRvcmlvL2xjci9BQ0NlcnRpc2lnbk11bHR
pcGxhRzUvTGF0ZXN0Q1JMLmNybDBboFmgV4ZVaHR0cDovL3JlcG9zaXRvcmlvLmljcGJyYXNpbC5nb3YuYn
IvbGNyL0NlcnRpc2lnbi9BQ0NlcnRpc2lnbk11bHRpcGxhRzUvTGF0ZXN0Q1JMLmNybDAdBgNVHSUEFjAUB
ggrBgEFBQcDAgYIKwYBBQUHAwQwgaAGCCsGAQUFBwEBBIGTMIGQMGQGCCsGAQUFBzAChlhodHRwOi8vaWNw
LWJyYXNpbC5jZXJ0aXNpZ24uY29tLmJyL3JlcG9zaXRvcmlvL2NlcnRpZmljYWRvcy9BQ19DZXJ0aXNpZ25
fTXVsdGlwbGFfRzUucDdjMCgGCCsGAQUFBzABhhxodHRwOi8vb2NzcC5jZXJ0aXNpZ24uY29tLmJyMA0GCS
qGSIb3DQEBCwUAA4ICAQAP2H+pBotJcDFjZAafmulklvliEUQOIy3hXQ0I4srUi0Fb6GFrRFbHvFdB2E0QV
1As+JpjOL9xfBSv8QLsB/HCvKh3H1tY0R6JE161ZsHQYPNE9KJFM/GLoXt5QqLHcz43lnjvY3/
m0WJtT6OVaqh5NtqGYs413U5vr4RVNDPBU3rvznhH869qzbhgZFH7KlodEc8tz0yj4bXEW85iV4ZpM5ENh9
JsEQxMI3PDfR4/N3I91Li1tXbzNqJ0h2udqWFlb9/
ZyXWUCtNFyUcXYePYG+bH1p8hXlnYeDGsGWu+mxCyYf8uNdY5OWKYYsU3qAfutYX17rKMOzm+UsaOyPB6HY
Pu+TlUCIuBXTxPbxa6X2mQUxKSbVtRNQWskvrmZ7O5+flANslkVb+sDfPdvBdC8vRun1SOF4huu8vgfE+/
Y55mWKxmlP8/FaQUz+i8th6fe19YDGHCIIDTUhYjC/BjimBlIEHVD4mtMGadP+Lx/
nvzGVSIshGbKEQgyjML6BvMEbbGXDg8LOiqBgxb39UFuc4GzLHnG9WqqqB2MBWnHDjCzjp5pnLGRWb/
2X4AUu1Eo3pvsDKc+oS+vm8cHV8uMCZJl5U2SQarSl6NGxgXxxq8fX4Zr/
v0sowjjgmAgie8+GKqL8nB80/9DZhUFd5dWG5cjBhTsHlIZf0rGimr2w==</X509Certificate></
X509Data></KeyInfo></Signature></MDFe>
}
### Consulta Retorno [GET]
Método para obter os retornos dos documentos enviados, lista de documentos não
consultados e dados de lotes inutilizados.
Exemplo URL com filtro

http://localhost:8085/webservice/api/mdfe/getRetorno/serie=700
ou
http://localhost:8085/webservice/api/mdfe/getRetorno/serie=700,701,703
http://localhost:8085/webservice/api/mdfe/getRetorno/serie=700&maxResults=100
ou
http://localhost:8085/webservice/api/mdfe/getRetorno/
serie=700,701,703&maxResults=100
Exemplo URL sem filtro

http://localhost:8080/webservice/api/mdfe/getRetorno (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/mdfe/getRetorno (ambiente de homologação do
SaaS)
### Autenticação
OU
### Permissões

(application/json).
+ Headers
+ mdfes - Atributo de “retorno”. Listagem dos retornos das MDF-es que foram
+ Body
{
"retorno":
{
"mdfes":
[
{
"nota":
{
"retEmissao":
{
"nProt":"943160000099999",
},
"statusSefaz":100,
"tpAmb":2,
"dhEmi":"2016-12-01T03:15:25-02:00",
"chMDFe":"99999999999999999999999999999999999999999999",
"nMDFe":8850,"serie":"751",
"CNPJ":"00999999000999",
ao MDF-e",
"servico":1,"versao":"3.00","status":100
},
},
{
"nota":
{
"retEmissao":
{
"nProt":"943160000099999",
},
"statusSefaz":135,
"tpAmb":2,
"dhEmi":"2016-12-01T03:15:25-02:00",
"chMDFe":"99999999999999999999999999999999999999999999",
"nMDFe":8851,
"serie":"751",
"CNPJ":"00999999000999",
homologado",
"servico":3,"versao":"3.00",
"status":132,"retEncerramento":
{
"nProt":"943160000099999",
"dhRegEvento":"2016-12-02T10:12:50-02:00"
}
},
},
{
"nota":
{
"retEmissao":
{
"nProt":"943160000099999",
},
"retCancelamento":
{
"nProt":"943160000099999",
"dhRegEvento":"2016-12-02T10:12:50-02:00",
},
"statusSefaz":135,
"tpAmb":2,
"dhEmi":"2016-12-01T03:15:25-02:00",
"chMDFe":"99999999999999999999999999999999999999999999",
"nMDFe":8852,
"serie":"751",
"CNPJ":"00999999000999",
homologado",
"servico":2,
"versao":"3.00",
"status":101
},
},
{
"nota":
{
"retIncCondutor":
{
"nProt":"943160000099999",
"nSeqEvento":1,
"dhRegEvento":"2016-12-02T10:12:29-02:00"
},
"retEmissao":
{
"nProt":"943160000099999",
},
"statusSefaz":135,
"tpAmb":2,
"dhEmi":"2016-12-01T03:15:25-02:00",
"chMDFe":"99999999999999999999999999999999999999999999",
"nMDFe":8850,
"serie":"751",
"CNPJ":"00999999000999",
ao MDF-e",
"servico":4,
"versao":"3.00",
"status":135
},
},
{
"nota":
{
"retEmissao":
{
"nProt":"943160000099999",
},
"statusSefaz":135,
"tpAmb":2,
"dhEmi":"2016-12-01T03:15:25-02:00",
"chMDFe":"99999999999999999999999999999999999999999999",
"nMDFe":8851,
"serie":"751",
"CNPJ":"00999999000999",
homologado",
"servico":3,
"versao":"3.00",
"status":132,
"retEncerramento":
{
"nProt":"943160000099999",
"dhRegEvento":"2016-12-02T10:12:50-02:00"
}
},
},
{
"nota":
{
"retEmissao":
{
"nProt":"943160000099999",
},
"retCancelamento":
{
"nProt":"943160000099999",
"dhRegEvento":"2016-12-02T10:12:50-02:00",
},
"statusSefaz":135,
"tpAmb":2,
"dhEmi":"2016-12-01T03:15:25-02:00",
"chMDFe":"99999999999999999999999999999999999999999999",
"nMDFe":8852,
"serie":"751",
"CNPJ":"00999999000999",
homologado",
"servico":2,
"versao":"3.00",
"status":101
},
}
],
"ids":[28728,28730,28729,28734,28736,28735]
}
}
### GetDamdfe [GET]
Método para obter o DAMDFE da respectiva chave de MDF-e.
43220900910509000171583380000000141123456789/getDamdfe (instalação in house)
ou
43220900910509000171583380000000141123456789/getDamdfe (ambiente de homologação do
SaaS)
### Autenticação
OU
### Permissões


(application/json).
+ Headers
+ Body
Response Body: retornará um array de bytes (byte[]). Esse retorno terá de ser
escrito em disco com extensão “.pdf”.
### GetXmlCancelamento [GET]
Método para obter o XML cancelado da respectiva chave de MDF-e.
43220900910509000171583380000000141123456789/getXmlCancelamento (instalação in
house)
ou
43220900910509000171583380000000141123456789/getXmlCancelamento (ambiente de
### Autenticação
OU
### Permissões


(application/json).
+ Headers
+ Body
{
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><procEventoMDFe
xmlns="http://www.portalfiscal.inf.br/mdfe" versao="3.00"><eventoMDFe
xmlns="http://www.portalfiscal.inf.br/mdfe" versao="3.00"><infEvento
Id="ID1101114320100091050900017158335000087887112345678701"><cOrgao>43</
nSeqEvento><detEvento versaoEvento="3.00"><evCancMDFe
xmlns="http://www.portalfiscal.inf.br/mdfe"><descEvento>Cancelamento</
descEvento><nProt>943200000041588</nProt><xJust>cancelando MDFE por falha de
emissao</xJust></evCancMDFe></detEvento></infEvento><Signature
URI="#ID1101114320100091050900017158335000087887112345678701"><Transforms><Transfor
m Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/><Transform
thod
Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/><DigestValue>vTZIlI3ophl4pFtvcn
7HFkWVblA=</DigestValue></Reference></
SignedInfo><SignatureValue>IyPD+y1t87qXCGV2m87NUbKBmk78/
gyGdx3VAvKKJpmbE8zMgW+dGb4/0o4bASxBwpgKJaW6rbm3G3x7vKuww+/
bifIJkXesSql6rC3RH9NGT9iixrcgTTA8KdqBbvHC+z4QRDSOxzaLEKuUyYYnWPCX8FEOgGjf+aHsYdvqge
m3jN3GWU0ybj3Vj3cdbRHxmWgvc7Vzy2igkhiwR7Kl2TRRiONcM7M27hvtChOJ0YsgevSyHZP5qPeDJdD9s
7J3Tq60eiJOdcp6Mz1+1XCS4ac1XTDm1k4gR8euAT0NOgs0B0p6a/
DJCRMVeeayIuatjZF8kQ6Sw5Kc8jl1FezcIw==</
Signature></eventoMDFe><retEventoMDFe xmlns="http://www.portalfiscal.inf.br/mdfe"
versao="3.00"><infEvento
Id="ID943200000041588"><tpAmb>2</tpAmb><verAplic>RS20191021102629</
vinculado ao MDF-e</xMotivo><chMDFe>43201000910509000188583350000878871123456787</
chMDFe><tpEvento>110111</tpEvento><xEvento>Cancelamento</xEvento><nSeqEvento>1</
dhRegEvento><nProt>943200000041588</nProt></infEvento></retEventoMDFe></
procEventoMDFe>
}
### GetXmlEncerramento [GET]
Método para obter o XML de encerramento da respectiva chave de MDF-e.
http://localhost:8080/webservice/api/mdfe/<chave mdfe>/getXmlEncerramento
(instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/mdfe/<chave mdfe>/getXmlEncerramento
(ambiente de homologação do SaaS)
### Autenticação
OU
### Permissões


(application/json).
+ Headers

+ Body
{
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><procEventoMDFe
xmlns="http://www.portalfiscal.inf.br/mdfe" versao="3.00"><eventoMDFe
xmlns="http://www.portalfiscal.inf.br/mdfe" versao="3.00"><infEvento
Id="ID1101124320100091050900017158335000087885112345678201"><cOrgao>43</
nSeqEvento><detEvento versaoEvento="3.00"><evEncMDFe
xmlns="http://www.portalfiscal.inf.br/mdfe"><descEvento>Encerramento</
descEvento><nProt>943200000041588</nProt><dtEnc>2020-10-26</dtEnc><cUF>27</
cUF><cMun>2700102</cMun></evEncMDFe></detEvento></infEvento><Signature
URI="#ID1101124320100091050900017158335000087885112345678201"><Transforms><Transfor
m Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/><Transform
thod
Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/><DigestValue>n3WTGeVTFqKkQQAjl+
CUn5V/a5w=</DigestValue></Reference></
SignedInfo><SignatureValue>bA2Qvb8wX+nSMdkrgd60CPzWzV/
DhmIL8M9HrtWDI3o1M6ZXmyMppyY/+1y8OLLgCFc/dU8AIVY/srzisIvLG0BTRCCnBygdGjQ/6kLfZa/
6fpeXsM4R67ZhRFLi+fMWBKKc+TClYlKxtQXP/4mlU52sq6/
gGTfvRsZRPPJXNcBywD3wnuKBRJXXkxEdGWUadetOcMlxFpdrt5ym78ns/
j4MnRXa4GTmqDkriAjF1HPEdsMuD32TzUiSndbWG8QnzULko0pa+r28oFL/
Hn5YL2S2vz8Byw3i5CTyMW1mce12sVCY7z49/CwniQioZExyQFOdj90uzyCv0ERpcU812w==</
Signature></eventoMDFe><retEventoMDFe xmlns="http://www.portalfiscal.inf.br/mdfe"
versao="3.00"><infEvento
Id="ID943200000043029"><tpAmb>2</tpAmb><verAplic>RS20191021102629</
vinculado ao MDF-e</xMotivo><chMDFe>43201022910509000188583350000878851123456782</
chMDFe><tpEvento>110112</tpEvento><xEvento>Encerramento</xEvento><nSeqEvento>1</
dhRegEvento><nProt>943200000043088</nProt></infEvento></retEventoMDFe></
procEventoMDFe>
}
### Consulta Impressão [GET]
Método para obter os retornos dos documentos que devem ser enviados para o Printer
imprimir.
Exemplo URL
http://localhost:8080/webservice/api/mdfe/getImpressao (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/mdfe/getImpressao (ambiente de homologação do
SaaS)
### Autenticação
OU
### Permissões


(application/json).
+ Headers
+ impressao - Lista documentos para impressão.
+ idProcessamento - Atributo de “impressao”. Id do processamento.
+ params - Atributo de “impressao”. Parâmetros da nota a ser impressa.
+ Body
{
"impressao": [
{
"params": {
"id": 25,
"conteudoXml": "<?xml version=\"1.0\" encoding=\"UTF-8\"
standalone=\"yes\"?><mdfeProc xmlns=\"http://www.portalfiscal.inf.br/mdfe\"
versao=\"3.00\"><MDFe xmlns=\"http://www.portalfiscal.inf.br/mdfe\"><infMDFe
Id=\"MDFe43220900910509000171583380000000141123456789\"
versao=\"3.00\"><ide><cUF>43</cUF><tpAmb>2</tpAmb><tpEmit>1</tpEmit><tpTransp>1</
tpTransp><mod>58</mod><serie>338</serie><nMDF>14</nMDF><cMDF>12345678</
cMDF><cDV>9</cDV><modal>2</modal><dhEmi>2022-09-21T07:01:21-03:00</
dhEmi><tpEmis>1</tpEmis><procEmi>0</procEmi><verProc>Mastersaf
DF-e</verProc><UFIni>RS</UFIni><UFFim>RS</UFFim><infMunCarrega><cMunCarrega>4314902
</cMunCarrega><xMunCarrega>Porto
Alegre</xMunCarrega></infMunCarrega><infPercurso><UFPer>RS</UFPer></
infPercurso><dhIniViagem>2021-12-16T10:00:00-03:00</dhIniViagem><indCanalVerde>1</
indCanalVerde></ide><emit><CNPJ>00910509000171</CNPJ><IE>0018000282</
IE><xNome>Mastersaf RS - NF-e</xNome><xFant>Mastersaf RS -
NF-e</xFant><enderEmit><xLgr>RDV BR 101</xLgr><nro>KM 10</nro><xCpl>DISTRITO
INDUSTRIAL</xCpl><xBairro>EMAUS</xBairro><cMun>4314902</cMun><xMun>PORTO
ALEGRE</xMun><CEP>13214730</CEP><UF>RS</UF><fone>1184364721</fone><email>testeauto@
testeauto.com</email></enderEmit></emit><infModal versaoModal=\"3.00\"><aereo
xmlns=\"http://www.portalfiscal.inf.br/mdfe\"><nac>1000</nac><matr>123456</
matr><nVoo>AB1234879</nVoo><cAerEmb>OACI</cAerEmb><cAerDes>OACI</
cAerDes><dVoo>2021-11-03</dVoo></aereo></
infModal><infDoc><infMunDescarga><cMunDescarga>4314902</
cMunDescarga><xMunDescarga>Porto
Alegre</xMunDescarga><infCTe><chCTe>43140500910509000171575550028081231123456783</
chCTe><indReentrega>1</indReentrega><infUnidTransp><tpUnidTransp>1</
tpUnidTransp><idUnidTransp>LMM1532</idUnidTransp><lacUnidTransp><nLacre>1283091</
nLacre></lacUnidTransp><infUnidCarga><tpUnidCarga>4</
tpUnidCarga><idUnidCarga>16512</idUnidCarga><lacUnidCarga><nLacre>315135</
nLacre></lacUnidCarga><qtdRat>312.00</qtdRat></infUnidCarga><qtdRat>165.00</
qtdRat></infUnidTransp><peri><nONU>1234</nONU><xNomeAE>Nome
embarque</xNomeAE><xClaRisco>classe</xClaRisco><grEmb>grupo</grEmb><qTotProd>123.00
</qTotProd><qVolTipo>123.00</qVolTipo></peri></infCTe></infMunDescarga></
infDoc><seg><infResp><respSeg>1</respSeg><CNPJ>00910509000171</CNPJ></
infResp><infSeg><xSeg>Segurado
xyz</xSeg><CNPJ>03364951000138</CNPJ></infSeg><nApol>123456</nApol><nAver>12ABCD</
nAver><nAver>34EFGH</nAver></seg><tot><qCTe>1</qCTe><vCarga>1234.78</
vCarga><cUnid>01</cUnid><qCarga>11312</qCarga></tot><lacres><nLacre>60019</
nLacre></lacres><autXML><CNPJ>00910509000171</CNPJ></
autXML><infAdic><infAdFisco>Teste Teste Teste Teste Teste Teste Teste
Teste</infAdFisco><infCpl>Teste Teste Teste Teste Teste Teste Teste
Teste</infCpl></infAdic><infRespTec><CNPJ>00910509000171</CNPJ><xContato>Douglas de
Souza
Pereira</xContato><email>douglas.pereira@thomsonreuters.com</email><fone>1199753269
6</fone></infRespTec></infMDFe><infMDFeSupl><qrCodMDFe>https://dfe-
portal.svrs.rs.gov.br/mdfe/qrCode?
chMDFe=43220900910509000171583380000000141123456789&tpAmb=2</qrCodMDFe></
infMDFeSupl><Signature
URI=\"#MDFe43220900910509000171583380000000141123456789\"><Transforms><Transform
Method
Algorithm=\"http://www.w3.org/2000/09/xmldsig#sha1\"/><DigestValue>89z0MmfN0ZJDCSLe
BU6JZdDVSfk=</DigestValue></Reference></
SignedInfo><SignatureValue>f2cT3hrI4p77Z0PYHf89JqD13E8ZdmAnjXBoph4S2IAzkgeIX1Mj5m9t
+vNViw+K7xpIApIuF4L373oA0yUeasYmvv95N2oXdRNudDDB/wp/
twAn5fThYGb1EAzEeceTwAaLrWsIschkJJjeiVafTJjtDWco2SR8Jv562CMuZEPclI15KSaTMOJRIZbQwLw
+JOvIWcz4ClouXyqbk3osoP0X2L/
Fp252brOKbD+4LlizlLwvKFFi18zEtHrR9OZaXJWWGxOkON6sLazUOhGd6guRmDWxsOq+FEUsbcpgKulY+U
3CBIC837nrKNKca6Fg+akszaX/qtI+DDLGGG0p/A==</
SignatureValue><KeyInfo><X509Data><X509Certificate>MIIILjCCBhagAwIBAgIQB1gZAF0j7Mgu
80rC8EdSzzANBgkqhkiG9w0BAQsFADB4MQswCQYDVQQGEwJCUjETMBEGA1UEChMKSUNQLUJyYXNpbDE2MDQ
GA1UECxMtU2VjcmV0YXJpYSBkYSBSZWNlaXRhIEZlZGVyYWwgZG8gQnJhc2lsIC0gUkZCMRwwGgYDVQQDEx
NBQyBDZXJ0aXNpZ24gUkZCIEc1MB4XDTIyMDQyNTIwNTIxNFoXDTIzMDQyNTIwNTIxNFowggERMQswCQYDV
QQGEwJCUjETMBEGA1UECgwKSUNQLUJyYXNpbDELMAkGA1UECAwCU0MxETAPBgNVBAcMCENyaWNpdW1hMRkw
FwYDVQQLDBBWaWRlb0NvbmZlcmVuY2lhMRcwFQYDVQQLDA4wODkzNjA1NDAwMDE3NTE2MDQGA1UECwwtU2V
jcmV0YXJpYSBkYSBSZWNlaXRhIEZlZGVyYWwgZG8gQnJhc2lsIC0gUkZCMRYwFAYDVQQLDA1SRkIgZS1DTl
BKIEExMUkwRwYDVQQDDEBUSE9NU09OIFJFVVRFUlMgQlJBU0lMIENPTlRFVURPIEUgVEVDTk9MT0dJQSBMV
ERBOjAwOTEwNTA5MDAxMzA1MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAozTrBlYmPHiHlwhC
6gn7KV4RtM32N/
WdXVf5oPGLCHcHPHL7I86dYWYygIl8fUmY21fbuXFPQ5yYy3EbKvxFBPEygGM+nQkiusCpLsugnMvf3eUn6
BMeAppcZwOoBDYR5JoLn0rFoIEKVO8aHAEUu39Y10VTAefT0j+qxFhrRUWXeYPyxRpqu1qjz8b0tlpXxUTH
ZD9AEdUBZimVcJZU1D9zLrtbYQAbXSm6UDdCZlaKtdQzP35/
HjCBHxDD3Pw4Ujp4o+11t7gTe5GUZXwd+K32VUAd7fcZgvtdLfarTaMwd0+yZdar5Z0hhh4DPSfpO2xoUao
QzEAEn6XZ/
MO3DQIDAQABo4IDFzCCAxMwgcYGA1UdEQSBvjCBu6A9BgVgTAEDBKA0BDIxMjA0MTk2NzUyMjgyNjE5NjY4
MDAwMDAwMDAwMDAwMDAwMDA1MDk4MzIyODNTU1BTUKAgBgVgTAEDAqAXBBVSSUNBUkRPIFRPTU1BU0kgRkl
MSE+gGQYFYEwBAwOgEAQOMDA5MTA1MDkwMDEzMDWgFwYFYEwBAwegDgQMMDAwMDAwMDAwMDAwgSRDT01QTE
lBTkNFLkJSQVNJTEBUSE9NU09OUkVVVEVSUy5DT00wCQYDVR0TBAIwADAfBgNVHSMEGDAWgBRTfX+dvtFh0
CC62p/jiacTc1jNQjB/
lzaWduLXJmYi5jZXJ0aXNpZ24uY29tLmJyMA0GCSqGSIb3DQEBCwUAA4ICAQCnNYlzCUG0H0lw8pONZL8R8
R+FZwBbt7IFUwZpdPwEgeguX4EqHXCZ+2iXz0SwAOQsKX6UWQtKqi49P8dEqh7YNzuV7zU+2IEXpdPWDzQM
TDcBpJ0YJhxLIjDinZpcsKVafedu35LA9GoyJCWZe+hNIjR6f4GNfY0pIoRmFal+XD9lJ2Q7QNW1JqR1Wl7
WidSyrJNk7oMvu2jC6EA/
UoWfAx1PdnhiFNFz0rL93CS7j+SWVzbhesbZ2JeaMVfM8GHlHKlcAAuJN1QAbi1CCzJRraT+DDaD6jDJYhb
Am2Rjzi2a71rVR3RgYeGGzVx8bbzLBHGP6UnrrJLKZ4k8gNnjuM5Qvp/y84Xjz/
yCI1hHo7o6Ywt5cn5bfda6kb3TmtK0+fzDBN2F2tJ2sFFIC61dcdhjECwquW7gUEfKWnW9r6P2ZHHWBa89b
pqO4IyJiHFfNDeA+XC0KiEzPno5AtHhSuAdAu/
hM7OBJlDMGMw3Xsf71BeqnpdKvFZPuLdJ5Mk7CCeP59lIWWnxhi1QAz/iqUCjW05pZ27Zud/
DWuyP1n+7jbx6z1JMb7TVeNVnAXmh0uvjyMrvQqrWo8jkyqk5ti6pBepairPAK1ypp5AF9LiAJ+ui9Aoi5X
nHyqn148GNKA2hmOuC66Yn02Rqbig5tNFBB5L0nlF78fHM/ZwDxw==</X509Certificate></
X509Data></KeyInfo></Signature></MDFe><protMDFe
xmlns=\"http://www.portalfiscal.inf.br/mdfe\" versao=\"3.00\"><infProt
Id=\"MDFe943220000059371\"><tpAmb>2</tpAmb><verAplic>RS20220905133447</
verAplic><chMDFe>43220900910509000171583380000000141123456789</
chMDFe><dhRecbto>2022-09-21T15:41:36-03:00</dhRecbto><nProt>943220000059371</
nProt><digVal>89z0MmfN0ZJDCSLeBU6JZdDVSfk=</digVal><cStat>100</
cStat><xMotivo>Autorizado o uso do
MDF-e</xMotivo></infProt></protMDFe></mdfeProc>",
"dataEmissao": 1663754481000,
"nroCopias": 1,
"nroProtocolo": "943220000059371",
"emailEmpresa": "email@email.com",
"emailEmitente": null,
"statusDocto": 100,
"xmlEnvioCC": null,
"xmlRetornoCC": null,
"mensagemContingencia": "DAMDFE em contingência, impresso
em decorrência de problemas técnicos.\n",
"cnpjEmissor": "00910509000171",
"inscricaoEmissor": "0018000282",
"exibirDadosConsumidorDanfe": false,
"enviaPrinter": 0,
"ordemEmbarque": "numero",
"nroItens": null,
"usuarioEmitente": "Willian",
"urlConsultaMDFe":
"https://dfe-portal.svrs.rs.gov.br/MDFE/Consulta",
}
}
]
}
# Group RECEPTOR CTE OS
## GET [/recebimentoCteos/get]
### Consultar Listagem Recebimento CTE OS (getListagem) [GET

/recebimentoCteos/getListagem{?
Endpoint de Método de consulta para retornar uma listagem de Recebimento CT-e OS,
irá retornar alguns dados principais de 1 ou N CT-e OS por consulta.

http://localhost:8080/webservice/api/recebimentoCteos/getListagem?
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoCteos/getListagem?
### Autenticação
OU

(application/json).
+ Parameters
+ Headers

documentos.
+ message - "OK"
+ Headers
+ Body
{
"result":[
PR","emailEnviadoPara":""},{"situacao":"Erro no
XML","valorTotalPrestacao":"10.000,00","cpfCnpjDest":"35402759000185","inicioPrest"
:"Porto Alegre - RS","dataEmissao":"07/04/2021
PR","emailEnviadoPara":""}
],
"message":"OK",
"hasMore": false,
"count": 7,
"maxResults": 10,
"offset": 0
}
### Consultar Log CTE OS Recebido (getLog) [GET /recebimentoCteos/getLog{?

Endpoint de Método de consulta para retornar os logs do CT-e OS recebido, irá

retornar todos os logs de um único CT-e OS a cada consulta, por isso o cliente
deverá enviar como parâmetro a identificação do CT-e OS.
neste documento.

http://localhost:8080/webservice/api/recebimentoCteos/getLog?
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoCteos/getLog?
### Autenticação
OU

(application/json).
+ Parameters
+ Headers

+ message - "OK"
+ Headers
+ Body
{
"result":
[{"dataHora": "03/10/2017 13:26:24","status": 10,"historico":
"Importação Manual de XML efetuada pelo usuário: renatorumor","stackTrace": null},
{"dataHora": "03/10/2017 13:26:24","status": 10,"historico": "Chave de
acesso: 43171000910509000171671710000002521391776622","stackTrace": null}],
"message":"OK",
"hasMore": false,
"count": 2,
"maxResults": 10,
"offset": 0
}
# Group RECEPTOR CTE
## POST [/recebimento]
### Semáforo CTE [POST /recebimento/semaforo]
Esta documentação detalha o endpoint que será criado para integração webservice do
Mastersaf DFE, funcionalidade Semáforo Receptor CT-e.
Observações:
1) Não terá opção de informar "Motivo da Liberação" conforme tem no portal. Essa
opção é exclusiva do portal.
2) Não terá opção de "Imprimir Consulta" conforme tem no portal. Essa opção é
exclusiva do portal.
3) As consultas do portal e via WS serão distintas, ou seja, só será retornado no
WS o que for solicitado via WS e vice-versa.
4) O tipo de ambiente (homologação ou produção) será o do ambiente/link que
utilizar no DF-e (a url passada na requisição), não teremos parâmetro pra isso na
requisição, como temos no portal.
5) O GET será por ID da consulta, e o POST será por chave e retornará o ID da
consulta. Somente será possível obter sucesso em POST, quando a última solicitação
já tiver sido processada (ou o job de exclusão já tiver removido a solicitação).
Então quando no POST for enviada uma chave que possui uma solicitação ainda em
processamento, iremos retornar erro 400 e o ID da solicitação ainda em aberto.
6) Solicitações de semáforo serão excluídas após 7 dias (parâmetro
dfe_config.QTDE_DIAS_EXCLUSAO_SOLICITACAO_SEMAFORO que determina a quantidade de
dias para exclusão dos registros de solicitação de semáforo via webservice (de
acordo com o campo data_requisicao da tabela dfe_consulta_semaforo_rcte),
independente se o processamento da consulta junto a Sefaz tenha sido realizada ou
não. Esse job de exclusão será executado todos os dias às 02:00 AM.
7) As regras são as mesmas do portal, com as exceções descritas nas observações
acima.
Método correspondente a tela Semáforo CT-e (do portal) onde realiza-se o

Recebimento do DACTE.
É realizada a consulta da situação atual do CT-e na SEFAZ e possibilita

visualização do status atual do recebimento do XML de emissão no MASTERSAF DFE.
Se sucesso na consulta, como é feito no portal, é registrado o recebimento do DACTE

"Documento Auxiliar Recebido".
É gravado também na tela de "Log Semáforo CT-e", no Portal, da mesma forma que
feito manualmente.
Solicitações de semáforo serão excluídas após 7 dias (parâmetro

acordo com o campo data_requisicao da tabela dfe_req_semaforo_cte), independente se
o processamento da consulta junto a Sefaz tenha sido realizada ou não. Esse job de
exclusão será executado todos os dias às 02:00 AM.
Após ter solicitado POST semáforo CT-e, deve-se solicitar o método getSemaforo para
obter o retorno do semáforo.

http://localhost:8080/webservice/api/recebimento/semaforo (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimento/semaforo (ambiente de homologação
do SaaS)
### Autenticação
OU
### Permissões

+ Receptores CT-e e NF-e Integrador (ROLE_RECEBIMENTO_INTEGRADOR);
+ Administrar o sistema (ROLE_SUPER_ADMIN);
Para que seja realizado o processamento da consulta semáforo, é necessário que seja
habilitada a função na Mensageria "Consulta Semáforo via Webservice".

Todos os dados enviados/recebidos pela API estão/deverão ser em formato JSON
(application/json).
### Retorno Sucesso

### Retorno Erro
Http status: 203, 400, 412, 500.
+ Headers
+ Attributes
+ referencia - Nome do arquivo/controle de integração.

+ cnpj (required) - CNPJ do CT-e. Será verificado no momento da solicitação
da consulta se o usuário possui permissão para o(s) CNPJ informado(s) no conteúdo
da consulta de Chave de Acesso.
+ ie - Inscrição Estadual do CT-e. Campo não é obrigatório, porém, caso
exista mais de uma empresa cadastrada no DFE com o mesmo CNPJ informado, quando não
informada IE no post irá ocorrer erro.
+ chave_acesso (required) - Chave de Acesso do CT-e. Pode solicitar apenas
1 chave de acesso na mesma solicitação.
+ Body
{
"referencia": "arquivo_integrador_20120223160622.txt",
"cnpj": "00910509000100",
"ie": "0018000123",
"chave_acesso": "43220600910509000171550170000007641123456808"
}
+ result - Trás a descrição do resultado como "OK".

+ uuid - "Será retornado um UUID (Universally Unique IDentifier - 128
bits), que deve ser utilizado posteriormente para consulta do processamento da
solicitação de semáforo. O UUID é também vinculado ao usuário autenticado que
efetuou a solicitação."
+ Body
{
"result": "OK",
"uuid": "039bca5e-6918-4187-ad5c-6fba4ddba40b"
}
+ Body
{
"result": "Existe solicitação em aberto para esse documento, é
necessário
aguardar a finalização do processamento antes de efetuar nova
solicitação.",
}
## GET [/recebimento/get]
### Consultar Semáforo CTE (getSemaforo) [GET /recebimento/getSemaforo{?uuid}]
Endpoint de Método de consulta do retorno de solicitação de semáforo CT-e (após ter

solicitado POST semáforo CT-e).
As Consultas solicitadas estarão disponíveis para retorno mesmo que a consulta não
tenha sido finalizada junto a Sefaz, pois dessa forma mostraremos status em
processamento.
Solicitações de semáforo serão excluídas após 7 dias (parâmetro

acordo com o campo data_requisicao da tabela dfe_req_semaforo_cte), independente se
o processamento da consulta junto a Sefaz tenha sido realizada ou não. Esse job de
exclusão será executado todos os dias às 02:00 AM.

http://localhost:8080/webservice/api/recebimento/getSemaforo?uuid= (instalação in
house)
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimento/getSemaforo?uuid= (ambiente de
### Autenticação
OU
### Permissões

+ Receptores CT-e e NF-e Integrador (ROLE_RECEBIMENTO_INTEGRADOR);
+ Administrar o sistema (ROLE_SUPER_ADMIN);
Para que seja realizado o processamento da consulta semáforo, é necessário que seja
habilitada a função na Mensageria "Consulta Semáforo via Webservice".
### Status de Processamento da Consulta

Processando, 10.
Processamento finalizado, 300.
Erro Geral, 999.

(application/json).
+ Parameters
+ uuid (requerid) - Filtrar pelo UUID que foi retornado na solicitação do
Semáforo (POST). Será mostrado na busca apenas o retorno da solicitação de semáforo
correspondente à esse UUID. O UUID é também vinculado ao usuário autenticado que
efetuou a solicitação.
+ Headers
+ versaoAplicativo - Visualização da versão do aplicativo que processou a

consulta na SEFAZ.
+ uf - Visualização da UF que atendeu à solicitação de consulta.
+ chave - Visualização da chave de acesso do CT-e consultado.
+ numero - Visualização do número do CT-e.
+ serie - Visualização da série do CT-e.
+ protocolo - Visualização do protocolo de autorização do CT-e.
+ data - Visualização da data e hora da emissão do CT-e na SEFAZ.
+ motivo - Visualização do status do recebimento do arquivo XML no
MASTERSAF DFE e o status do CT-e no arquivo XML.
+ statusProcessamento - Visualização da código do status de processamento
da consulta. Se 10, a consulta ainda está em processamento e deve ser executada
novamente até encontrar o status final, conforme tabela de status de processamento.
+ semaforoConsulta - Visualização do código do semáforo da consulta, o
mesmo que é mostrado no portal, na tela de "Semáforo NF-e". Sendo 1 para vermelho,
2 para amarelo e 3 para verde.
+ semaforoDanfe - Visualização do código do semáforo da situação do Danfe,
o mesmo que é mostrado no portal, na tela de "Listagem NF-e". Sendo 1 para
vermelho, 2 para amarelo e 3 para verde.
+ codigoSituacaoSefaz - Visualização do código do status atual da NF-e na
SEFAZ.
+ descricaoSituacaoSefaz - Visualização da descrição do status atual da NF-
e na SEFAZ.
+ filial - Visualização do CNPJ e Razão Social da empresa em que a consulta
foi realizada.
+ usuarioUltimaConsulta - Visualização do usuário que realizou a última
consulta à chave de acesso informada, username do login. Caso seja a primeira
consulta, será exibido em branco.
+ dataUltimaConsulta - Visualização da data da última consulta à chave de
acesso informada (com timezone destino da empresa). Caso seja a primeira consulta,
será exibido em branco.
+ referencia - Retorna valor conforme enviado na integração/requisição.
+ uuid - Será retornado o UUID (Universally Unique IDentifier - 128 bits),
correspondente à solicitação de semáforo. O UUID é também vinculado ao usuário
autenticado que efetuou a solicitação.
+ Headers
+ Body
{
"versaoAplicativo": "SP-CTe-2021-08-19-1",
"uf": "PE",
"chave":"26220307199061000179570010000511511000170952",
"numero": "000051151",
"serie": "001",
"protocolo": "526220000253200",
"data": "01-07-2022 17:25:01",
"motivo":"Arquivo XML encontrado no sistema e está AUTORIZADO.",
"codigoSemaforoConsulta": "1",
"codigoSemaforoDanfe":"1",
"codigoSituacaoSefaz": "100",
"descricaoSituacaoSefaz": "Autorizado o uso do CT-e",
"filial":"00910509002034 - Mastersaf RS",
"usuarioUltimaConsulta":"",
"dataUltimaConsulta":"",
"referencia":"",
}
+ Body
{
"result": "UUID não localizado."
}
### Consultar Listagem Recebimento CTE (getListagem) [GET

/recebimento/getListagem{?cnpj,ie,periodoInicial,periodoFinal,offset,maxResults}]
Endpoint de Método de consulta para retornar uma listagem de Recebimento CT-e, irá
retornar alguns dados principais de 1 ou N CT-e por consulta.

http://localhost:8080/webservice/api/recebimento/getListagem?
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimento/getListagem?
### Autenticação
OU

(application/json).
+ Parameters
+ Headers

documentos.
+ message - "OK"
+ Headers
+ Body
{
"result":[
{"situacao":"Autorizado","emitenteDescricao":"CT-E EMITIDO EM
11:14:00","protocolo":null,"cnpjEmitente":"00910509002034","descricaoRetorno":"CT-e
Aprovada na Sefaz. Chave de acesso -
43201000910509002034571670000001571391776627","razaoSocialDest":"CT-E EMITIDO EM
AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL","razaoSocialRecebedor":"CT-E EMITIDO EM
FISCAL","cpfCnpjExpedidor":"13495487000172","modal":"03 -
Aquaviário","cpfCnpjRecebedor":"01943665000100","tipoServico":"0 -
FISCAL","ufOrigem":"RS","numeroCte":"157","cpfCnpjRemetente":"76096718000438","raza
oSocialExpedidor":"CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR
FISCAL","chaveAcesso":"CTe43201000910509002034571670000001571391776627","naturezaOp
eracao":"Prestação serv. tranRS. estab.
Destinatário"}
],
"message":"OK",
"hasMore": false,
"count": 1,
"maxResults": 10,
"offset": 0
}
### Consultar Log CTE Recebido (getLog) [GET /recebimento/getLog{?

Endpoint de Método de consulta para retornar os logs do CT-e Recebido, irá retornar
todos os logs de um único CT-e a cada consulta, por isso o cliente deverá enviar
como parâmetro a identificação do CT-e.
neste documento.

http://localhost:8080/webservice/api/recebimento/getLog?
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimento/getLog?
### Autenticação
OU

(application/json).
+ Parameters
+ Headers

+ message - "OK"
+ Headers
+ Body
{
"result":
{"dataHora": "03/10/2017 13:26:24","status": 10,"historico": "Chave
de acesso: 43171000910509000171671710000002521391776622","stackTrace": null}],
"message":"OK",
"hasMore": false,
"count": 2,
"maxResults": 10,
"offset": 0
}
# Group RECEPTOR NFE
## GET [/recebimentoNfe/get]
### Consultar Listagem Recebimento NFE Transportador (getListagem) [GET

/recebimentoNfeTransp/getListagem{?
Endpoint de Método de consulta para retornar uma listagem de Recebimento de NF-e de

transportador, irá retornar alguns dados principais de 1 ou N NF-e por consulta.

http://localhost:8080/webservice/api/recebimentoNfeTransp/getListagem?
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfeTransp/getListagem?
### Autenticação
OU

(application/json).
+ Parameters
+ Headers

documentos.
+ message - "OK"
+ Headers
+ Body
{
"result":[
345","razaoSocialTrans":"Transportadora","placaVeiculoTransportador":"","numeroNfce
":"51","situacao":"Autorizado","tipoNfe":"1","cpfCnpjTransportador":"","bairroForne
c":"Centro","ufTrans":"RS","dataEmissao":"26/02/2021
ntt":"","ufPlaca":"","bairroDest":"Sto Antonio","dataAutorizacao":"26/02/2021
11:35:51","razaoSocialDest":"NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR
FISCAL","valorTotal":"250,00","municipioFornec":"Goiandira","enderecoDest":"Rua
Avenida,
423","ufDestinatario":"SP","cepFornec":"78945612","numeracaoVolume":"12312","cnpjEm
issor":"00910509002034","municipioTrans":"Rio
Grange","tipoFrete":"9","cpfCnpjDest":"35402759000185","cfop":"5405","dataSaida":""
,"enderecoTrans":"Rua Sem Fim","descricaoSituacao":"Autorizado o uso da NF-
recebida","serie":"168","pesoBruto":"2.500,0000","municipioDest":"São
Paulo","cepDest":"14526878","ufFornec":"RS","pesoLiquido":"2.300,0000","valorTransp
orte":"0"}
],
"message":"OK",
"hasMore": false,
"count": 1,
"maxResults": 10,
"offset": 0
}
### Consultar Listagem Recebimento NFE Destinatário (getListagem) [GET

/recebimentoNfe/getListagem{?
Endpoint de Método de consulta para retornar uma listagem de Recebimento de NF-e,

irá retornar alguns dados principais de 1 ou N NF-e por consulta.

http://localhost:8080/webservice/api/recebimentoNfe/getListagem?
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfe/getListagem?
### Autenticação
OU

(application/json).
+ Parameters
+ Headers
documentos.
+ message - "OK"
+ Headers
+ Body
{
"result":[
345","razaoSocialTrans":"Mastersaf","placaVeiculoTransportador":"MMM1932","situacao
":"Autorizado","tipoNfe":"1","cpfCnpjTransportador":"35402759000185","fatorAltura":
"1","bairroFornec":"Centro","ufTrans":"SP","dataEmissao":"16/02/2021
ntt":"RN12318TC","ufPlaca":"SP","bairroDest":"Sto
Antonio","dataAutorizacao":"16/02/2021 20:19:59","razaoSocialDest":"NF-E EMITIDA EM
FISCAL","valorTotal":"240,00","municipioFornec":"Goiandira","codEvento":"Ciência da
Operação","enderecoDest":"Rua Avenida,
423","ufDestinatario":"RS","numeroNfe":"694","cepFornec":"78945612","numeracaoVolum
e":"12312","cnpjEmissor":"00910509000171","municipioTrans":"SAO
PAULO","tipoFrete":"9","cpfCnpjDest":"00910509002034","dataHoraReg":"17/02/2021
20:11:51","cfop":"5405","dataSaida":"10/09/2021 16:53:39","enderecoTrans":"Negro
Arroyo Lane","descricaoSituacao":"Autorizado o uso da NF-
recebida","serie":"217","pesoBruto":"2.500,0000","municipioDest":"Porto
Alegre","cepDest":"14526878","ufFornec":"RS","pesoLiquido":"2.300,0000","valorTrans
porte":"50,00"}
],
"message":"OK",
"hasMore": false,
"count": 1,
"maxResults": 10,
"offset": 0
}
### Consultar Log NFE Recebida Destinatário (getLog) [GET /recebimentoNfe/getLog{?
Endpoint de Método de consulta para retornar os logs da NF-e Recebida como

Destinatário, irá retornar todos os logs de uma única NF-e a cada consulta, por
isso o cliente deverá enviar como parâmetro a identificação da NF-e.
neste documento.

http://localhost:8080/webservice/api/recebimentoNfe/getLog?
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfe/getLog?
### Autenticação
OU

(application/json).
+ Parameters
+ Headers

+ message - "OK"
+ Headers
+ Body
{
"result":
"message":"OK",
"hasMore": false,
"count": 2,
"maxResults": 10,
"offset": 0
}
### Consultar Log NFE Recebida Transportador (getLog) [GET

/recebimentoNfeTransp/getLog{?cnpj,ie,serie,numero,offset,maxResults}]
Endpoint de Método de consulta para retornar os logs da NF-e Recebida como

Transportador, irá retornar todos os logs de uma única NF-e a cada consulta, por
isso o cliente deverá enviar como parâmetro a identificação da NF-e.
neste documento.

http://localhost:8080/webservice/api/recebimentoNfeTransp/getLog?
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfeTransp/getLog?
### Autenticação
OU

(application/json).
+ Parameters
+ Headers

+ message - "OK"
+ Headers
+ Body
{
"result":
"message":"OK",
"hasMore": false,
"count": 2,
"maxResults": 10,
"offset": 0
}
# Group RECEPTOR NFSE
## GET [/receptor_nfs]
### Consulta Padrão (get) [GET /receptor_nfs]
Endpoint de Método para obter os retornos dos documentos recebidos e uma lista de
documentos não consultados.

http://localhost:8080/webservice/api/receptor_nfs

https://ws.h.dfe.mastersaf.com.br/api/receptor_nfs
### Autenticação
OU

(application/json).
### Permissões

### Retorno Sucesso
Response Body: {"retorno":{"ids":[],"nfss":[]}}

Http status: 200
### Retorno Erro
Http status: 203, 404, 500.

+ Headers

+ ids - Atributo de "retorno", listagem dos IDs dos processamentos que
+ nfss - Atributo de "retorno", listagem dos retornos das NFS-es que foram
+ nota - Atributo de "nfss", dentro trás o registro do RPS/NFS-e filtrado.
+ tipoAmbienteSistema (number) - Atributo de "nota", mostra o tipo de
Homologação.
+ valorIssRetido (number) - Atributo de "nota", mostra o valor do ISS
informado no RPS.
+ serieRpsSubstituido - Atributo de "nota", mostra a série do rps
substituido.
+ valorIss (number) - Atributo de "nota", mostra o valor do ISS informado
no RPS.
+ cepPrestador - Atributo de "nota", mostra o cep do prestador.
+ tipoLogradouroTomador - Atributo de "nota", mostra o tipo do logradouro
do tomador.
+ aliquotaServicos - Atributo de "nota", mostra a alíquota de serviço
informada no RPS.
+ itemListaServico - Atributo de "nota", mostra o item lista serviço.
+ inscricaoEstadualTomador - Atributo de "nota", mostra a IE do tomador.
+ descricaoStatus - Atributo de "nota", mostra a descrição do status da
+ dddTomador - Atributo de "nota", mostra o DDD do tomador.
+ razaoSocialIntermediarioServico - Atributo de "nota", mostra a razão
social do intermediário do serviço.
+ codigodaObra - Atributo de "nota", mostra o código da obra.
+ numeroRps (number) - Atributo de "nota", mostra o Número do RPS.
+ valorPis - Atributo de "nota", mostra o valor do PIS.
+ razaoSocialTomador - Atributo de "nota", mostra a razão social do
tomador.
+ codigoVerificacao - Atributo de "nota", mostra o Código de Verificação,
+ __deducao__ - Atributo de "nota", mostra o grupo dedução. Entre []
+ valorCsll - Atributo de "nota", mostra o valor do Csll.
+ telefonePrestador - Atributo de "nota", mostra o telefone do prestador.
+ valorDeduzir - Atributo de "nota", mostra o valor a deduzir.
+ dataEmissaoRps - Atributo de "nota", mostra Data e Hora de Emissão do
RPS.
+ urlConsulta - Atributo de "nota", Link da Nota Fiscal No site da
prefeitura.
+ complementoEnderecoTomador - Atributo de "nota", mostra o complemento do
endereço do tomador.
+ emailTomador - Atributo de "nota", mostra o email do tomador.
+ serieRps - Atributo de "nota", mostra a série do RPS.
+ numeroEnderecoTomador - Atributo de "nota", mostra o número do endereço
do tomador.
+ numeroLote (number) - Atributo de "nota", mostra o Número do Lote.
+ cnpjPrestador - Atributo de "nota", mostra o Número do CNPJ do Prestador
do Serviço.
+ inscricaoMunicipalTomador - Atributo de "nota", mostra a IM do tomador.
+ valorDescontoIncondicionado - Atributo de "nota", mostra o valor de
desconto incondicionado.
+ codigoServico - Atributo de "nota", mostra o código do serviço.
+ valorLiquidoNfse - Atributo de "nota", mostra o valor líquido de NFS-e.
+ enderecoPrestador - Atributo de "nota", mostra o endereço do prestador.
+ codigoCancelamento - Atributo de "nota", mostra o código de cancelamento.
+ __item__ - Atributo de "nota", mostra o grupo item. Entre []
+ valorTotal - Atributo de __item__
+ valorDeduzirItem - Atributo de __item__
+ unidadeMedida - Atributo de __item__
+ discriminacaoServico - Atributo de __item__
+ quantidade - Atributo de __item__
+ valorUnitario - Atributo de __item__
+ descricaoRps - Atributo de "nota", mostra a descrição do rps.
+ situacaoRps - Atributo de "nota", mostra a Situação do RPS. Pode retornar
+ dddPrestador - Atributo de "nota", mostra o ddd do prestador.
+ valorCredito - Atributo de "nota", mostra o valor crédito.
+ cidadeTomador - Atributo de "nota", mostra a cidade do tomador.
+ inscricaoMunicipalIntermediarioServico - Atributo de "nota", mostra a
inscrição municipal do intermediário do serviço.
+ nroProcessoNatureza - Atributo de "nota", mostra o número do processo
judicial ou administrativo de suspensão da exigibilidade.
+ numeroEnderecoPrestador - Atributo de "nota", mostra o número do endereço
do prestador.
+ cpfCnpjIntermediarioServico - Atributo de "nota", mostra o cpf/cnpj do
intermediário do serviço.
+ status (number) - Atributo de "nota", mostra o Código do Status da última
transação,
+ statusNfe - Atributo de "nota", mostra o status da nota.
+ docNum (number) - Atributo de "nota", mostra o Número para identificar o
+ razaoSocialPrestador - Atributo de "nota", mostra a razão social do
prestador.
+ cpfCnpjTomador - Atributo de "nota", mostra o cpf/cnpj do tomador.
+ dataEmissaoNfe - Atributo de "nota", mostra a data de emissão.
+ valorIr - Atributo de "nota", mostra o valor IR.
+ bairroTomador - Atributo de "nota", mostra o bairro do tomador.
+ inscricaoPrestador - Atributo de "nota", mostra a Inscrição Municipal do
+ numeroNfe (number) - Atributo de "nota", mostra o Número da NFS-e.
+ complementoEnderecoPrestador - Atributo de "nota", mostra o complemento
do endereço do prestador.
+ emailPrestador - Atributo de "nota", mostra o email do prestador.
+ art - Atributo de "nota", mostra a tag art (Obra).
+ siafiPrestador - Atributo de "nota", mostra o Código SIAFI da cidade da
+ outrasRetencoes - Atributo de "nota", mostra o valor de outras retenções.
+ ufTomador - Atributo de "nota", mostra a UF do tomador.
+ codigoTributacaoMunicipio - Atributo de "nota", mostra o código de
tributação do munícipio.
+ cepTomador - Atributo de "nota", mostra o cep do tomador.
+ valorServicos - Atributo de "nota", mostra o Valor dos serviços em R$.
+ telefoneTomador - Atributo de "nota", mostra o telefone do tomador.
+ ufPrestador - Atributo de "nota", mostra a UF do prestador.
+ tipoLogradouroPrestador - Atributo de "nota", mostra o tipo de logradouro
do prestador.
+ codCidade - Atributo de "nota", mostra o Município do Prestador - Código
do IBGE.
+ baseCalculo - Atributo de "nota", mostra o valor da base de cálculo.
+ numeroRpsSubstituido - Atributo de "nota", mostra o número rps
substituido.
+ logradouroTomador - Atributo de "nota", mostra o logradouro tomador.
+ numeroProtocolo - Atributo de "nota", mostra o Número do Protocolo
+ valorDescontoCondicionado - Atributo de "nota", mostra o valor de
desconto condicionado.
+ valorInss - Atributo de "nota", mostra o valor inss.
+ bairroPrestador - Atributo de "nota", mostra o bairro do prestador.
+ tipoRps - Atributo de "nota", mostra o Tipo de RPS, que é preenchido
+ codigoCnae - Atributo de "nota", mostra o código CNAE.
+ valorCofins - Atributo de "nota", mostra o valor de cofins.
+ valorTotalRecebido - Atributo de "nota", mostra o valor total recebido
(tag valorTotalRecebido).
+ Headers
+ Body
{
"retorno": {
"ids": [
28837
],
"nfss": [
{
"nota": {
"valorIssRetido": null,
"serieRpsSubstituido ": null,
"valorIss": 126,
"cepPrestador": "5423180",
"tipoLogradouroTomador": "AV",
"itemListaServico": null,
"inscricaoEstadualTomador": null,
"descricaoStatus": "Reprocessamento do Retorno
solicitado pelo usuário: teste",
"dddTomador": null,
"razaoSocialIntermediarioServico": null,
"codigodaObra": null,
"numeroRps": 3279,
"valorPis": null,
"razaoSocialTomador": "THOMSON REUTERS BRASIL CONTEUDO
E TECNOLOGIA LTDA",
"codigoVerificacao": "Q6RHREHU",
"__deducao__": [],
"valorCsll": null,
"telefonePrestador": null,
"valorDeduzir": 0.00,
"urlConsulta":
"https://nfe.prefeitura.sp.gov.br/contribuinte/notaprint.aspx?
ccm=56490550&nf=3276&cod=Q6RHREHU",
"complementoEnderecoTomador": "CJ 132 ANDAR 13 ",
"emailTomador": "contasapagar.br@thomsonreuters.com",
"serieRps": "NF",
"numeroEnderecoTomador": "1855",
"numeroLote": "852973370",
"cnpjPrestador": "09162524000153",
"inscricaoMunicipalTomador": "32489617",
"valorDescontoIncondicionado": null,
"codigoServico": "2800",
"valorLiquidoNfse": null,
"enderecoPrestador": "EUSEBIO MATOSO",
"codigoCancelamento": null,
"__item__": [
{
"valorTotal": null,
"valorDeduzirItem": null,
"unidadeMedida": null,
"discriminacaoServico": "Faturamento referente
a SUBSCRICAO AUTOMATION\n\nParcela 06 de 08.\n\nData de vencimento: 22/05/2022\n\
nValor Liquido: 4345,11\n\nProjeto Semantix: 2021-3613\n\nDados bancarios:\n\nBanco
BTG Pactual (208)\nAgencia: 0001\nConta: 00156772-9",
"quantidade": null,
"valorUnitario": null
}
],
"descricaoRps": null,
"situacaoRps": "1",
"dddPrestador": null,
"valorCredito": 0,
"cidadeTomador": "3550308",
"inscricaoMunicipalIntermediarioServico": null,
"nroProcessoNatureza": null,
"numeroEnderecoPrestador": "1375",
"cpfCnpjIntermediarioServico": null,
"status": 100,
"statusNfe": "N",
"docNum": null,
"razaoSocialPrestador": "SEMANTIX TECNOLOGIA EM SISTEMA
DE INFORMACAO S.A.",
"cpfCnpjTomador": "00910509000171",
"dataEmissaoNfe": "2022-04-22T11:06:22",
"valorIr": null,
"bairroTomador": "VILA OLIMPIA",
"numeroNfe": 3276,
"complementoEnderecoPrestador": "ANDAR 10
",
"emailPrestador": "financeiro@semantix.com.br",
"art": null,
"outrasRetencoes": null,
"ufTomador": "SP",
"codigoTributacaoMunicipio": null,
"cepTomador": "4548005",
"valorServicos": 4345.11,
"telefoneTomador": null,
"ufPrestador": "SP",
"tipoLogradouroPrestador": "AV",
"codCidade": "3550308",
"baseCalculo": null,
"numeroRpsSubstituido ": null,
"logradouroTomador": "DR CARDOSO DE MELO",
"valorDescontoCondicionado": null,
"valorInss": null,
"bairroPrestador": "PINHEIROS",
"tipoRps": "RPS",
"codigoCnae": null,
"valorCofins": null,
"valorTotalRecebido":4105.11
},
"referencia": null
}
]
}
}
# Data Structures
### emissaoNfeRequest (object)
- action: EnviarPacote (string, required) - Ação solicitada. Conteúdo:

“EnviarPacote”
- referencia: èxemplo: arquivo_integrador_20160802113423.txt` (string) - Nome do
arquivo de integração.
- id_integrador (string) - Nome do integrador responsável pelo envio do documento.
- txt_conteudo (txtConteudoEmissaoNfe) - Grupo de informação da NF-e.
#### txtConteudoEmissaoNfe (object)
- xml (xmlConteudoNfe, required) - Conteúdo do XML de Emissão da NF-e.

- mastersaf (mastersafNfe) - Informações para contingência, parâmetros para filtro
de impressão e outros parâmetros.
#### xmlConteudoNfe (object)
+ One Of
+ Formato TXT: Informar dados conforme layout padrão TXT de Emissão de NFe
[layout/planilha está disponível no Web Help: Mastersaf_Layout_DFe_V3_NFe_NFCe].
(required, string)
+ Formato XML: Informar dados conforme layout padrão da Receita Federal do XML
de Emissão de NFe [layout/planilha está disponível no Web Help > zip do manual de
integração webservice > `Mastersaf-Layout_DFe_V3-NF-e_XML`]. (required, string)
#### mastersafNfe (object)
- versaoLayoutDfe (string) - Atributo de mastersaf. Versão do layout DFE. Informar

o valor "4.04" ou “4.05”. Caso não seja informado, será considerada a versão
"4.00", ficando sujeito a rejeição pela SEFAZ.
- contingencias (contingenciasNfe) - Atributo de mastersaf. Grupo com informações
de contingencia. Caso emissão em contingência externa, caso contrário não informar.
- resptec (resptecNfe) - Atributo de mastersaf. Grupo com informações do
Responsável Técnico pelo sistema de emissão do Documento Fiscal eletrônico.
Preencher caso desejar informar um Responsável Técnico que não seja da Thomson
Reuters. Função disponível apenas para integração TXT. Se enviar informações de
responsável técnico tanto na tag do xml como neste grupo, serão consideradas as
informações do grupo "mastersaf". Se não enviar no grupo "mastersaf"("resptec") irá
gerar o conforme enviado no xml. Caso seja preenchido o grupo de informações de
Responsável Técnico na integração e no cadastro do Grupo de Empresa o parâmetro
“Informar Resp. Técnico nos Documentos” estiver como Sim, o grupo “infRespTec” é
gerado no XML com os dados informados na integração. (Função disponível apenas para
integração TXT);
- parametros (array[parametrosNfe]) - Atributo de mastersaf. Grupo de parâmetros de
controle de impressão e filtro.
- integracaoXml - Atributo de mastersaf. Parâmetro integração xml. Ao incluir o
parâmetro, mesmo que em branco (""), é assumido como TRUE, o correto é não enviar o
parâmetro caso não seja integração XML
- xmlLegado (boolean) - Atributo de mastersaf. Parâmetro integração de xml legado,
só informar se for TRUE. Ao incluir o parâmetro, mesmo que em branco (""), é
assumido como TRUE, o correto é não enviar o parâmetro caso não seja legado.
Arquivo deve conter tag <nfeProc> se existir o parâmetro.
#### parametrosNfe (object)

- ordemEmbarque - Atributo de parametros. Número da ordem de embarque.
- dsImpressora - Atributo de parametros. Nome da impressora que será utilizada para
imprimir está NF-e.
- nrItens - Atributo de parametros. Total de itens.
- campoUsoInterno - Atributo de parametros. Campo livre para uso interno. Os dados
informados neste campo não serão enviados à SEFAZ e não serão exibidos no DANFE.
Permitirá refinar os dados via busca Avançada no Portal.
- usuarioEmitente - Atributo de parametros. Nome do usuário que emitiu a nota no
ERP.
- enviaPrinter: `1` (enum[string]) - Atributo de parametros. Define se o documento
será enviado para o Printer.
+ Members
+ `1` - Imprime automaticamente e grava os arquivos XML e PDF nas pastas do
Printer;
+ `2` - Não imprime automaticamente e grava os arquivos PDF e XML nas pastas
do Printer. Ao utilizar esta opção, os campos "dsImpressora" e "ordemEmbarque"
serão ignorados;
+ `3` - Não imprime automaticamente e não grava arquivos XML e PDF nas pastas
do Printer. Ao utilizar esta opção, os campos "dsImpressora", "ordemEmbarque " e
"nomenclaturaArquivos” serão ignorados.
- nomenclaturaArquivos - Atributo de parametros. Nomenclatura específica para os
arquivos PDF e XML gravados pelo Printer. O valor neste campo será utilizado para
compor a nomenclatura dos arquivos PDF e XML. Caso não seja preenchido, os arquivos
serão gravados no formato padrão.
#### contingenciasNfe (object)

- cnpjEmissor: èxemplo: 04215122619` (string) - Atributo de contingencias. Cnpj do
emissor.
- serie: èxemplo: 335` (string) - Atributo de contingencias. Série da Nota.
- numeroNota: èxemplo: 10` (string) - Atributo de contingencias. Número da Nota.
- dataEntrada: èxemplo: 2020-07-31T08:33:56-03:00` (string) - Atributo de
contingencias. Início da entrada em contingência. Caso o campo tpEmis =
contingência, este campo se torna obrigatório.
- dataSaida: èxemplo: 2020-07-31T08:35:01-03:00` (string) - Atributo de
contingencias. Término da saída de contingência.
- motivo: èxemplo: SEFAZ FORA DO AR. Contingência EPEC` (string) - Atributo de
contingencias. Motivo de contingência. Caso o campo tpEmis = contingência, este
campo se torna obrigatório.
- cEvento: `110140` (string) - Atributo de contingencias. Código do evento de
emissão EPEC (110140). Informar o código 110140 somente para emissão EPEC. Para
outras contingências, deixar este campo vazio.
#### resptecNfe (object)

- respTecCnpj - Atributo de resptec. Informar o CNPJ da pessoa jurídica responsável
pelo sistema utilizado na emissão do documento fiscal eletrônico.
- respTecContato - Atributo de resptec. Informar o nome da pessoa a ser contatada
na empresa desenvolvedora do sistema utilizado na emissão do documento fiscal
eletrônico.
- respTecEmail - Atributo de resptec. Informar o e-mail da pessoa a ser contatada
na empresa desenvolvedora do sistema.
- respTecFone - Atributo de resptec. Informar o telefone da pessoa a ser contatada
na empresa desenvolvedora do sistema. Preencher com o Código DDD + número do
telefone.
- respTecIdCsrt - Atributo de resptec. Identificador do código de segurança do
responsável técnico.
- respTecCsrt - Atributo de resptec. Código de Segurança do Responsável Técnico.
## request
## response

Mastersafdfev 3

Enviado por

Dados do documento

Descrição original:

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Mastersafdfev 3

Enviado por

Direitos autorais:

Formatos disponíveis

FORMAT: 1A

# MASTERSAF DFE - Manual API

Esta documentação detalha os endpoints disponíveis para integração webservice do

## Validação usuários webservice

É feita uma validação de usuários webservice (qualquer usuário utilizado na

Estes dois parâmetros (acima) serão mostrados no response da consulta também.

No response existem 2 atributos que podem ser utilizados para controle de

Por *exemplo*, utilizando maxResults 10 e offset 0 será retornada a primeira página

- 203: Usuário e senha sem permissão de acessar o método/dados da empresa.

Mais informações sobre os códigos de retorno podem ser encontradas em:

Se mesmo após ler a documentação restarem dúvidas ou encontrar algum problema,

abra um chamado na Central de Ajuda diretamente através deste link: [Onesource

Opção 2 - ONESOURCE MASTERSAF

Opção 2 – Documentos Fiscais Eletrônicos (DFE)

Nosso horário de atendimento é de segunda a sexta-feira das 9h às 18h.

### Gerar Login (accessToken) [POST]

### Exemplos URL (Requisição)

### Tratamento de dados

+ Response 200 (application/json)

+ accessToken - Token de acesso

Resumindo o processo, primeiramente, é enviado um pacote de dados; depois é feita

### Enviar Pacote [POST]

### Exemplos URL

Permissões conforme cadastro de usuários. O usuário informado na requisição deve

### Tratamento de dados

### Retorno Erro

Response Body: {"result":"<descrição do erro>"}

Http status: 203, 400, 412, 500.

*Consultar título LISTAGEM DE ERROS para maiores informações sobre os erros.

Exemplo formato TXT:

Exemplo formato XML:

Exemplo grupo mastersaf com resptec:

Exemplo grupo mastersaf com contingencias:

Exemplo grupo mastersaf com parametros:

Exemplo caso necessite de contingencia na origem preencher o atributo

Exemplo caso necessite informar o Responsável Técnico deixando o DF-e calcular

Exemplo caso necessite informar o Responsável Técnico com o hash já calculado,

+ Response 202 (application/json)

Método para cancelar NF-es enviados ao webservice.

### Exemplos URL

Permissões conforme cadastro de usuários. O usuário informado na requisição deve

### Tratamento de dados

### Retorno Erro

Response Body: {"result":"<descrição do erro>"}

Http status: 203, 400, 412, 500.

*Consultar título LISTAGEM DE ERROS para maiores informações sobre os erros.

+ action (required) - Ação solicitada. Conteúdo: "Cancelar"

Exemplo formato TXT:

Exemplo formato XML:

+ Response 200 (application/json)

### Inutilizar [POST]

Obs.: Se no intervalo de inutilização for informado mais de 10 mil números, a

### Exemplos URL

### Retorno Erro

Response Body: {"result":"<descrição do erro>"}

Http status: 203, 400, 412, 500.

*Consultar título LISTAGEM DE ERROS para maiores informações sobre os erros.

Exemplo formato TXT:

Exemplo formato XML:

+ Response 202 (application/json)

+ Response 400 (application/json)

### EnviarCartaCorrecaoNfe [POST]

Por exemplo, utilizando maxResults 10 e offset 0 será retornada a primeira página

Detalhamento do grupo XML: