MASTERSAFDFE Integracao Web Service

MASTERSAF DFE
INTEGRAÇÃO COM WEBSERVICE – DFE V3
Versão do Documento: 1.70

Atualizado em: 21/12/2020
Sensitivity: Confidential
INTEGRAÇÃO COM WEBSERVICE - DFE V3 MASTERSAF DFE
SUMÁRIO
INTRODUÇÃO........................................................................................................................................................ 67
LISTAGEM E PAGINAÇÃO .................................................................................................................................... 69
1. MÓDULO NFSE (SERVIÇO) ................................................................................................................................... 70
1.1. OBSERVAÇÕES GERAIS ................................................................................................................................. 70

1.2. MÉTODO: POST ............................................................................................................................................. 70
1.2.1. EnviarPacote ............................................................................................................................................ 70
1.2.1.1. Introdução .......................................................................................................................................... 70
1.2.1.2. URL .................................................................................................................................................... 70
1.2.1.3. Exemplo URL ..................................................................................................................................... 70
1.2.1.4. Layout ................................................................................................................................................. 71
1.2.1.5.Permissões .......................................................................................................................................... 71
1.2.1.6. Cabeçalho........................................................................................................................................... 71
1.2.1.7. Envio ................................................................................................................................................... 71
1.2.1.8. Retorno Sucesso ................................................................................................................................ 71
1.2.1.9. Retorno Erro ....................................................................................................................................... 72
1.2.2. Cancelar ................................................................................................................................................... 72
1.2.2.1. Introdução .......................................................................................................................................... 72
1.2.2.2. URL .................................................................................................................................................... 72
1.2.2.3. Exemplo URL ..................................................................................................................................... 72
1.2.2.4. Layout ................................................................................................................................................ 72
1.2.2.5. Permissões ........................................................................................................................................ 72
1.2.2.6. Cabeçalho .......................................................................................................................................... 73
1.2.2.7. Envio ................................................................................................................................................... 73
1.2.2.8. Retorno Sucesso................................................................................................................................ 73
1.2.2.9. Retorno Erro ...................................................................................................................................... 73
1.2.3. MarcarConsultado ................................................................................................................................... 73
1.2.3.1. Introdução .......................................................................................................................................... 73
1.2.3.2. URL .................................................................................................................................................... 73

Página 2 de 452
1.2.3.3. Exemplo URL ..................................................................................................................................... 74
1.2.3.4. Layout ................................................................................................................................................ 74
1.2.3.5. Permissões......................................................................................................................................... 74
1.2.3.6. Cabeçalho .......................................................................................................................................... 74
1.2.3.7. Envio ................................................................................................................................................... 74
1.2.3.8. Retorno Sucesso ................................................................................................................................ 75
1.2.3.9. Retorno Erro ...................................................................................................................................... 75
1.2.4. ConsultarRpssAguardandoDownload .................................................................................................... 75
1.2.4.1. Introdução .......................................................................................................................................... 75
1.2.4.2. URL .................................................................................................................................................... 75
1.2.4.3. Exemplo URL ..................................................................................................................................... 75
1.2.4.4. Layout ................................................................................................................................................ 75
1.2.4.5. Permissões ........................................................................................................................................ 76
1.2.4.6. Cabeçalho .......................................................................................................................................... 76
1.2.4.7. Envio................................................................................................................................................... 76
1.2.4.8. Retorno Sucesso ............................................................................................................................... 76
1.2.4.10. Retorno Erro .................................................................................................................................... 77
1.2.5. UploadRetornoPrefeitura ........................................................................................................................ 77
1.2.5.1. Introdução .......................................................................................................................................... 77
1.2.5.2. URL .................................................................................................................................................... 77
1.2.5.3. Exemplo URL ..................................................................................................................................... 77
1.2.5.4. Layout ................................................................................................................................................ 77
1.2.5.5. Permissões ........................................................................................................................................78
1.2.5.6. Cabeçalho ..........................................................................................................................................78
1.2.5.7. Envio...................................................................................................................................................78
1.2.5.8. Retorno Sucesso ...............................................................................................................................78
1.2.5.9. Retorno Erro ......................................................................................................................................78
1.2.6. Convertida ................................................................................................................................................ 79
1.2.6.1. Introdução .......................................................................................................................................... 79

Página 3 de 452
1.2.7. NumeroRPS ............................................................................................................................................. 79
1.2.7.1. Introdução .......................................................................................................................................... 79
1.2.7.2. URL .................................................................................................................................................... 79
1.2.7.3. Exemplo URL ..................................................................................................................................... 79
1.2.7.4. Layout ................................................................................................................................................ 79
1.2.7.5. Permissões ........................................................................................................................................ 80
1.2.7.6. Cabeçalho ......................................................................................................................................... 80
1.2.7.7. Envio .................................................................................................................................................. 80
1.2.7.8. Retorno Sucesso ............................................................................................................................... 80
1.2.7.9. Layout Retorno ................................................................................................................................. 80
1.2.7.10. Retorno Erro ..................................................................................................................................... 81
1.2.8. EnviarPacoteAgrupar .............................................................................................................................. 81
1.2.8.1. Introdução .......................................................................................................................................... 81
1.2.8.2. URL .................................................................................................................................................... 81
1.2.8.3. Exemplo URL ..................................................................................................................................... 81
1.2.8.4. Layout ................................................................................................................................................ 81
1.2.8.5.Permissões ........................................................................................................................................ 82
1.2.8.6. Cabeçalho ......................................................................................................................................... 82
1.2.8.7. Envio.................................................................................................................................................. 82
1.2.8.8. Retorno Sucesso .............................................................................................................................. 82
1.2.8.9. Retorno Erro ..................................................................................................................................... 82
1.3. MÉTODO: GET ................................................................................................................................................ 83

1.3.1. Consulta Padrão ...................................................................................................................................... 83
1.3.1.1. Introdução .......................................................................................................................................... 83
1.3.1.2. URL .................................................................................................................................................... 83
1.3.1.3. Filtro de Série, CNPJ Prestador e Quantidade de Resultados (maxResults) .................................. 83
1.3.1.4. Exemplo URL..................................................................................................................................... 83
1.3.1.5. Permissões ........................................................................................................................................ 83
1.3.1.6. Cabeçalho .......................................................................................................................................... 84

Página 4 de 452
1.3.1.7. Envio................................................................................................................................................... 84
1.3.1.8. Retorno Sucesso ............................................................................................................................... 84
1.3.1.10. Retorno Erro .................................................................................................................................... 86
1.3.2. GetRPS .....................................................................................................................................................87
1.3.2.1. Introdução ..........................................................................................................................................87
1.3.2.2. URL ....................................................................................................................................................87
1.3.2.3. Exemplo URL .....................................................................................................................................87
1.3.2.4. Permissões.........................................................................................................................................87
1.3.2.5. Cabeçalho ..........................................................................................................................................87
1.3.2.6. Envio ..................................................................................................................................................87
1.3.2.7. Retorno Sucesso ............................................................................................................................... 88
1.3.2.8. Retorno Erro ..................................................................................................................................... 88
1.3.3. GetStatus (com parâmetros) .................................................................................................................. 88
1.3.3.1. Introdução ......................................................................................................................................... 88
2. MÓDULO NFE (MERCANTIL) ............................................................................................................................... 88
2.1. OBSERVAÇÕES GERAIS ................................................................................................................................ 88

2.2. MÉTODO: POST............................................................................................................................................. 89
2.2.1. EnviarPacote ........................................................................................................................................... 89
2.2.1.1. Introdução ......................................................................................................................................... 89
2.2.1.2. URL ................................................................................................................................................... 89
2.2.1.3. Exemplo URL .................................................................................................................................... 89
2.2.1.4. Layout ............................................................................................................................................... 89
2.2.1.5. Permissões ....................................................................................................................................... 94
2.2.1.6. Cabeçalho ......................................................................................................................................... 94
2.2.1.7. Envio .................................................................................................................................................. 94
2.2.1.8. Retorno Sucesso............................................................................................................................... 95
2.2.1.9. Retorno Erro ..................................................................................................................................... 95
2.2.2. Cancelar ................................................................................................................................................. 95
2.2.2.1. Introdução ........................................................................................................................................ 95

Página 5 de 452
2.2.2.2. URL .................................................................................................................................................. 95
2.2.2.3. Exemplo URL ................................................................................................................................... 95
2.2.2.4. Layout .............................................................................................................................................. 96
2.2.2.5. Permissões ....................................................................................................................................... 96
2.2.2.6. Cabeçalho ........................................................................................................................................ 96
2.2.2.7. Envio ................................................................................................................................................. 96
2.2.2.8. Retorno Sucesso ............................................................................................................................... 97
2.2.2.9. Retorno Erro ..................................................................................................................................... 97
2.2.3. Inutilizar .................................................................................................................................................. 97
2.2.3.1. Introdução.......................................................................................................................................... 97
2.2.3.2.URL .................................................................................................................................................... 97
2.2.3.3. Exemplo URL .................................................................................................................................... 97
2.2.3.4. Layout .............................................................................................................................................. 98
2.2.3.5. Permissões ....................................................................................................................................... 98
2.2.3.6. Cabeçalho ........................................................................................................................................ 98
2.2.3.7. Envio ................................................................................................................................................. 98
2.2.3.8. Retorno Sucesso .............................................................................................................................. 99
2.2.3.9. Retorno Erro .................................................................................................................................... 99
2.2.4. EnviarCartaCorrecaoNfe ........................................................................................................................ 99
2.2.4.1. Introdução ........................................................................................................................................ 99
2.2.4.2. URL .................................................................................................................................................. 99
2.2.4.3. Exemplo URL ................................................................................................................................... 99
2.2.4.4. Layout .............................................................................................................................................100
2.2.4.5. Permissões ......................................................................................................................................100
2.2.4.6. Cabeçalho .......................................................................................................................................100
2.2.4.7. Envio ................................................................................................................................................100
2.2.4.8. Retorno Sucesso .............................................................................................................................. 101
2.2.4.9. Retorno Erro .................................................................................................................................... 101
2.2.5. MarcarConsultado ................................................................................................................................. 101

Página 6 de 452
2.2.5.1. Introdução ........................................................................................................................................ 101
2.2.5.2. URL .................................................................................................................................................. 101
2.2.5.3. Exemplo URL ................................................................................................................................... 101
2.2.5.4. Layout ............................................................................................................................................. 102
2.2.5.5. Permissões ...................................................................................................................................... 102
2.2.5.6. Cabeçalho ....................................................................................................................................... 102
2.2.5.7. Envio ................................................................................................................................................ 102
2.2.5.8. Retorno Sucesso ............................................................................................................................. 102
2.2.5.9. Retorno Erro ................................................................................................................................... 102
2.2.6. MarcarImpresso .................................................................................................................................... 103
2.2.6.1. Introdução ....................................................................................................................................... 103
2.2.6.2. URL ................................................................................................................................................. 103
2.2.6.3. Exemplo URL .................................................................................................................................. 103
2.2.6.4. Layout ............................................................................................................................................. 103
2.2.6.5. Permissões ...................................................................................................................................... 103
2.2.6.6. Cabeçalho ....................................................................................................................................... 104
2.2.6.7. Envio ................................................................................................................................................ 104
2.2.6.8. Retorno Sucesso ............................................................................................................................. 104
2.2.6.9. Retorno Erro ................................................................................................................................... 104
2.2.7. MarcarCartaCorrecaoImpresso ............................................................................................................ 104
2.2.7.1. Introdução ........................................................................................................................................ 104
2.2.7.2. URL .................................................................................................................................................. 104
2.2.7.3. Exemplo URL .................................................................................................................................. 105
2.2.7.4. Layout.............................................................................................................................................. 105
2.2.7.5. Permissões ...................................................................................................................................... 105
2.2.7.6. Cabeçalho ....................................................................................................................................... 105
2.2.7.7. Envio ................................................................................................................................................ 105
2.2.7.8. Retorno Sucesso ............................................................................................................................. 106
2.2.7.9. Retorno Erro.................................................................................................................................... 106

Página 7 de 452
2.2.8. ReimpressaoDanfe ............................................................................................................................... 106
2.2.8.1. Introdução ....................................................................................................................................... 106
2.2.8.2. URL ................................................................................................................................................. 106
2.2.8.3. Exemplo URL .................................................................................................................................. 106
2.2.8.4. Layout ............................................................................................................................................. 106
2.2.8.5. Permissões...................................................................................................................................... 107
2.2.8.6. Cabeçalho ....................................................................................................................................... 107
2.2.8.7. Envio ................................................................................................................................................ 107
2.2.8.8. Retorno Sucesso ............................................................................................................................. 107
2.2.8.9. Retorno Erro ................................................................................................................................... 107
2.2.9. Consultar Cadastro ............................................................................................................................... 107
2.2.9.1. Introdução ....................................................................................................................................... 107
2.2.9.2. URL ................................................................................................................................................. 108
2.2.9.3. Exemplo URL .................................................................................................................................. 108
2.2.9.4. Layout ............................................................................................................................................. 108
2.2.9.5. Detalhamento campo XML ............................................................................................................ 108
2.2.9.6. Permissões ...................................................................................................................................... 109
2.2.9.7. Cabeçalho ....................................................................................................................................... 109
2.2.9.8. Envio ............................................................................................................................................... 109
2.2.9.9. Retorno Sucesso ............................................................................................................................. 109
2.2.9.10. Retorno Erro .................................................................................................................................. 109
2.2.10. EnviarEmail.......................................................................................................................................... 109
2.2.10.1. Introdução ...................................................................................................................................... 109
2.2.10.2. URL ................................................................................................................................................. 110
2.2.10.3. Exemplo URL ................................................................................................................................. 110
2.2.10.4. Layout ............................................................................................................................................. 110
2.2.10.5. Detalhamento campo txt_conteudo ............................................................................................. 110
2.2.10.6. Permissões ...................................................................................................................................... 111
2.2.10.7. Cabeçalho ........................................................................................................................................ 111

Página 8 de 452
2.2.10.8. Envio ................................................................................................................................................ 111
2.2.10.9. Retorno Sucesso ............................................................................................................................. 111
2.2.10.10. Retorno Erro .................................................................................................................................. 111
2.2.11. Pedido de Prorrogação ICMS ................................................................................................................. 111
2.2.11.1. Introdução ......................................................................................................................................... 111
2.2.11.2. URL .................................................................................................................................................. 112
2.2.11.3. Exemplo URL .................................................................................................................................. 112
2.2.11.4. Layout .............................................................................................................................................. 112
2.2.11.5. Permissões ...................................................................................................................................... 112
2.2.11.6. Cabeçalho ....................................................................................................................................... 113
2.2.11.7. Envio ................................................................................................................................................ 113
2.2.11.8. Retorno Sucesso ............................................................................................................................. 113
2.2.11.9. Retorno Erro .................................................................................................................................... 113
2.2.12. Pedido de Cancelamento de Prorrogação ICMS ................................................................................. 113
2.2.12.1. Introdução ....................................................................................................................................... 113
2.2.12.2. URL ................................................................................................................................................. 113
2.2.12.3. Exemplo URL .................................................................................................................................. 114
2.2.12.4. Layout ............................................................................................................................................. 114
2.2.12.5. Permissões ..................................................................................................................................... 114
2.2.12.6. Cabeçalho ....................................................................................................................................... 115
2.2.12.7. Envio................................................................................................................................................ 115
2.2.12.8. Retorno Sucesso ............................................................................................................................ 115
2.2.12.9. Retorno Erro ................................................................................................................................... 115
2.2.13. Consulta Chave Acesso Sefaz .............................................................................................................. 115
2.2.13.1. Introdução ....................................................................................................................................... 115
2.2.13.2. URL ................................................................................................................................................. 115
2.2.13.3. Exemplo URL .................................................................................................................................. 116
2.2.13.4. Layout ............................................................................................................................................. 116
2.2.13.5. Detalhamento campo XML ............................................................................................................ 116

Página 9 de 452
2.2.13.6. Permissões ..................................................................................................................................... 116
2.2.13.7. Condições/Observações ................................................................................................................. 117
2.2.13.8. Cabeçalho ....................................................................................................................................... 117
2.2.13.9. Envio ............................................................................................................................................... 117
2.2.13.10. Retorno Sucesso ........................................................................................................................... 117
2.2.13.11. Retorno Erro................................................................................................................................... 117
2.2.14. Comprovante de Entrega ..................................................................................................................... 117
2.2.14.1. Introdução ....................................................................................................................................... 118
2.2.14.2. URL ................................................................................................................................................. 118
2.2.14.3. Exemplo URL .................................................................................................................................. 118
2.2.14.4. Layout ............................................................................................................................................. 118
2.2.14.5. Permissões ..................................................................................................................................... 118
2.2.14.6. Cabeçalho....................................................................................................................................... 119
2.2.14.7. Envio ............................................................................................................................................... 119
2.2.14.8. Retorno Sucesso ............................................................................................................................ 119
2.2.14.9. Retorno Erro ................................................................................................................................... 119
2.2.15. Cancelamento de Comprovante de Entrega ....................................................................................... 119
2.2.15.1. Introdução ....................................................................................................................................... 119
2.2.15.2. URL ................................................................................................................................................. 119
2.2.15.3. Exemplo URL ................................................................................................................................. 120
2.2.15.4. Layout ............................................................................................................................................ 120
2.2.15.5. Permissões .................................................................................................................................... 120
2.2.15.6. Cabeçalho....................................................................................................................................... 121
2.2.15.7. Envio ............................................................................................................................................... 121
2.2.15.8. Retorno Sucesso ............................................................................................................................ 121
2.2.15.9. Retorno Erro ................................................................................................................................... 121
2.3. MÉTODO: GET ............................................................................................................................................... 121

2.3.1. Consulta Padrão ..................................................................................................................................... 121
2.3.1.1. Introdução ......................................................................................................................................... 121

Página 10 de 452
2.3.1.2. URL .................................................................................................................................................. 122
2.3.1.3. Definir quantidade de Results da consulta: ................................................................................... 122
2.3.1.4. Exemplo URL ................................................................................................................................... 122
2.3.1.5. Permissões....................................................................................................................................... 122
2.3.1.6. Cabeçalho ........................................................................................................................................ 122
2.3.1.7. Envio ................................................................................................................................................. 123
2.3.1.8. Retorno Sucesso .............................................................................................................................. 123
2.3.1.9. Layout Retorno ................................................................................................................................ 123
2.3.1.10. Retorno Erro ................................................................................................................................... 125
2.3.2. GetXml ................................................................................................................................................... 125
2.3.2.1. Introdução........................................................................................................................................ 125
2.3.2.2. URL.................................................................................................................................................. 125
2.3.2.3. Exemplo URL .................................................................................................................................. 125
2.3.2.4. Permissões ...................................................................................................................................... 126
2.3.2.5. Cabeçalho ....................................................................................................................................... 126
2.3.2.6. Envio ................................................................................................................................................ 126
2.3.2.7. Retorno Sucesso ............................................................................................................................. 126
2.3.2.8. Retorno Erro ................................................................................................................................... 126
2.3.3. GetXmlCancelamento........................................................................................................................... 126
2.3.3.1. Introdução ........................................................................................................................................ 126
2.3.3.2. URL .................................................................................................................................................. 127
2.3.3.3. Exemplo URL .................................................................................................................................. 127
2.3.3.4. Permissões ...................................................................................................................................... 127
2.3.3.5. Cabeçalho ....................................................................................................................................... 127
2.3.3.6. Envio ................................................................................................................................................ 127
2.3.3.7. Retorno Sucesso ............................................................................................................................. 127
2.3.3.8. Retorno Erro.................................................................................................................................... 128
2.3.4. GetDanfe ............................................................................................................................................... 128
2.3.4.1. Introdução ....................................................................................................................................... 128

Página 11 de 452
2.3.4.2. URL ................................................................................................................................................. 128
2.3.4.3. Exemplo URL .................................................................................................................................. 128
2.3.4.4. Permissões ...................................................................................................................................... 128
2.3.4.5. Cabeçalho ....................................................................................................................................... 128
2.3.4.6. Envio................................................................................................................................................ 128
2.3.4.7. Retorno Sucesso ............................................................................................................................. 129
2.3.4.8. Retorno Erro ................................................................................................................................... 129
2.3.5. GetXmlCartaCorrecao........................................................................................................................... 129
2.3.5.1. Introdução ....................................................................................................................................... 129
2.3.5.2. URL ................................................................................................................................................. 129
2.3.5.3. Exemplo URL .................................................................................................................................. 129
2.3.5.4. Permissões ...................................................................................................................................... 130
2.3.5.5. Cabeçalho ....................................................................................................................................... 130
2.3.5.6. Envio................................................................................................................................................ 130
2.3.5.7. Retorno Sucesso ............................................................................................................................. 130
2.3.5.8. Retorno Erro ................................................................................................................................... 130
2.3.6. GetCartaCorrecao ................................................................................................................................. 130
2.3.6.1. Introdução ....................................................................................................................................... 130
2.3.6.2. URL .................................................................................................................................................. 131
2.3.6.3. Exemplo URL ................................................................................................................................... 131
2.3.6.4. Permissões ....................................................................................................................................... 131
2.3.6.5. Cabeçalho ........................................................................................................................................ 131
2.3.6.6. Envio................................................................................................................................................. 131
2.3.6.7. Retorno Sucesso .............................................................................................................................. 131
2.3.6.8. Retorno Erro ................................................................................................................................... 132
2.3.7. GetStatus ............................................................................................................................................... 132
2.3.7.1. Introdução ........................................................................................................................................ 132
2.3.7.2. URL .................................................................................................................................................. 132
2.3.7.3. Exemplo URL .................................................................................................................................. 133

Página 12 de 452
2.3.7.4. Permissões ...................................................................................................................................... 133
2.3.7.5. Cabeçalho ....................................................................................................................................... 133
2.3.7.6. Envio ................................................................................................................................................ 133
2.3.7.7. Retorno Sucesso.............................................................................................................................. 133
2.3.5.8. Layout Retorno ............................................................................................................................... 134
2.3.5.9. Retorno Erro ................................................................................................................................... 134
2.3.8. GetStatus (com parâmetros) ................................................................................................................ 134
2.3.8.1. Introdução ....................................................................................................................................... 134
2.3.8.2. URL ................................................................................................................................................. 134
2.3.8.3. Filtro de CNPJ Emissor, Número da NF-e e Série da NF-e ........................................................... 135
2.3.8.4. Exemplo URL .................................................................................................................................. 135
2.3.8.5. Permissões ...................................................................................................................................... 135
2.3.8.6. Cabeçalho ....................................................................................................................................... 135
2.3.8.7. Envio ................................................................................................................................................ 135
2.3.8.8. Retorno Sucesso ............................................................................................................................. 135
2.3.8.9. Layout Retorno ............................................................................................................................... 136
2.3.8.10. Retorno Erro .................................................................................................................................. 136
2.3.9. Consulta Retorno .................................................................................................................................. 136
2.3.9.1. Introdução ....................................................................................................................................... 136
2.3.9.2. URL ................................................................................................................................................. 136
2.3.9.3. Definir quantidade de Results da consulta ................................................................................... 137
2.3.9.4. Filtro de Série.................................................................................................................................. 137
2.3.9.5. Exemplo URL com filtro ................................................................................................................. 137
2.3.9.6. Exemplo URL sem filtro ................................................................................................................. 137
2.3.9.7. Permissões ...................................................................................................................................... 137
2.3.9.8. Cabeçalho ....................................................................................................................................... 138
2.3.9.9. Envio................................................................................................................................................ 138
2.3.9.10. Retorno Sucesso ........................................................................................................................... 138
2.3.9.11. Layout Retorno............................................................................................................................... 139

Página 13 de 452
2.3.9.12. Retorno Erro .................................................................................................................................. 139
2.3.10. Consulta Impressão ............................................................................................................................. 139
2.3.10.1. Introdução ...................................................................................................................................... 139
2.3.10.2. URL ................................................................................................................................................ 139
2.3.10.3. Exemplo URL................................................................................................................................. 139
2.3.10.4. Permissões .................................................................................................................................... 140
2.3.10.5. Cabeçalho...................................................................................................................................... 140
2.3.10.6. Envio .............................................................................................................................................. 140
2.3.10.7. Retorno Sucesso ............................................................................................................................ 140
2.3.10.8. Layout Retorno ............................................................................................................................. 140
2.3.10.9. Retorno Erro ................................................................................................................................... 141
2.3.11. Consulta Impressão NFe ....................................................................................................................... 141
2.3.11.1. Introdução ........................................................................................................................................ 141
2.3.11.2. URL .................................................................................................................................................. 141
2.3.11.3. Exemplo URL................................................................................................................................... 141
2.3.11.4. Permissões ...................................................................................................................................... 141
2.3.11.5. Cabeçalho........................................................................................................................................ 141
2.3.11.6. Envio ............................................................................................................................................... 142
2.3.11.7. Retorno Sucesso ............................................................................................................................. 142
2.3.11.8. Layout Retorno .............................................................................................................................. 142
2.3.11.9. Retorno Erro ................................................................................................................................... 142
2.3.12. Consulta Impressão Carta Correção NFe ........................................................................................... 142
2.3.12.1. Introdução ...................................................................................................................................... 142
2.3.13. Consulta Log da NF-e .......................................................................................................................... 142
2.3.13.1. Introdução ...................................................................................................................................... 142
2.3.13.2. URL ................................................................................................................................................ 143
2.3.13.3. Exemplo URL ................................................................................................................................. 143
2.3.13.4. Permissões..................................................................................................................................... 144
2.3.13.5. Cabeçalho ...................................................................................................................................... 144

Página 14 de 452
2.3.13.6. Envio .............................................................................................................................................. 144
2.3.13.7. Retorno Sucesso ............................................................................................................................ 144
2.3.13.8. Layout Retorno .............................................................................................................................. 144
2.3.13.9. Retorno Erro .................................................................................................................................. 145
2.3.14. Consulta Listagem de NF-e ................................................................................................................ 146
2.3.14.1. Introdução ...................................................................................................................................... 146
2.3.14.2. URL ................................................................................................................................................ 146
2.3.14.3. Exemplo URL ................................................................................................................................. 146
2.3.14.4. Permissões .................................................................................................................................... 146
2.3.14.5. Cabeçalho ...................................................................................................................................... 147
2.3.14.6. Envio .............................................................................................................................................. 147
2.3.14.7. Retorno Sucesso ............................................................................................................................ 147
2.3.14.8. Layout Retorno .............................................................................................................................. 147
2.3.14.9. Retorno Erro .................................................................................................................................. 149
2.3.15. GetXmlInutilizacao .............................................................................................................................. 149
2.3.15.1. Introdução ...................................................................................................................................... 150
2.3.15.2. URL ................................................................................................................................................ 150
2.3.15.3. Exemplo URL ................................................................................................................................. 150
2.3.15.4. Permissões .................................................................................................................................... 150
2.3.15.5. Cabeçalho ...................................................................................................................................... 150
2.3.15.6. Envio .............................................................................................................................................. 150
2.3.15.7. Retorno Sucesso ............................................................................................................................ 150
2.3.15.8. Retorno Erro ................................................................................................................................... 151
2.3.16. GetEventos ............................................................................................................................................ 151
2.3.16.1. Introdução ....................................................................................................................................... 151
2.3.16.2. URL ................................................................................................................................................. 151
2.3.16.3. Exemplo URL .................................................................................................................................. 151
2.3.16.4. Permissões .................................................................................................................................... 152
2.3.16.5. Cabeçalho ...................................................................................................................................... 152

Página 15 de 452
2.3.16.6. Envio .............................................................................................................................................. 152
2.3.16.7. Retorno Sucesso ............................................................................................................................ 152
2.3.16.8. Layout Retorno .............................................................................................................................. 152
2.3.16.9. Retorno Erro .................................................................................................................................. 153
2.3.17. GetRetornoConsultaChaveSefaz......................................................................................................... 153
2.3.17.1. Introdução ...................................................................................................................................... 153
2.3.17.2. URL ................................................................................................................................................ 153
2.3.17.3. Definir quantidade de Results da consulta .................................................................................. 153
2.3.17.4. Exemplo URL ................................................................................................................................. 153
2.3.17.5. Permissões ..................................................................................................................................... 153
2.3.17.6. Cabeçalho ...................................................................................................................................... 154
2.3.17.7. Envio ............................................................................................................................................... 154
2.3.17.8. Retorno Sucesso ............................................................................................................................ 154
2.3.17.9. Layout Retorno .............................................................................................................................. 154
2.2.17.10. Detalhamento campo consultaChaveSefaz ............................................................................... 154
2.3.17.11. Retorno Erro .................................................................................................................................. 155
2.3.17.12. Condições/Observações .............................................................................................................. 155
2.3.18. GetEventoEntrega ............................................................................................................................... 155
2.3.18.1. Introdução ...................................................................................................................................... 155
2.3.18.2. URL ................................................................................................................................................ 155
2.3.18.3. Exemplo URL ................................................................................................................................. 156
2.3.18.4. Permissões .................................................................................................................................... 156
2.3.18.5. Cabeçalho ...................................................................................................................................... 156
2.3.18.6. Envio .............................................................................................................................................. 156
2.3.18.7. Retorno Sucesso ............................................................................................................................ 156
2.3.18.8. Layout Retorno.............................................................................................................................. 156
2.3.18.9. Detalhamento campo loteEventoEntrega ................................................................................ 157
2.3.18.10. Retorno Erro ............................................................................................................................. 157
3. MÓDULO CTE .................................................................................................................................................. 157

Página 16 de 452
3.1. OBSERVAÇÕES GERAIS ............................................................................................................................... 157

3.2. MÉTODO: POST ............................................................................................................................................ 158
3.2.1. EnviarPacote .......................................................................................................................................... 158
3.2.1.1. Introdução ........................................................................................................................................ 158
3.2.1.2. URL .................................................................................................................................................. 158
3.2.1.3. Exemplo URL ................................................................................................................................... 158
3.2.1.4. Layout .............................................................................................................................................. 158
3.2.1.5. Permissões....................................................................................................................................... 159
3.2.1.6. Cabeçalho ........................................................................................................................................ 159
3.2.1.7. Envio ................................................................................................................................................. 160
3.2.1.8. Retorno Sucesso .............................................................................................................................. 160
3.2.1.9. Retorno Erro .................................................................................................................................... 160
3.2.2. Cancelar................................................................................................................................................. 160
3.2.2.1. Introdução........................................................................................................................................ 160
3.2.2.2. URL.................................................................................................................................................. 160
3.2.2.3. Exemplo URL .................................................................................................................................. 160
3.2.2.4. Layout ............................................................................................................................................. 160
3.2.2.5. Permissões ....................................................................................................................................... 161
3.2.2.6. Cabeçalho ........................................................................................................................................ 161
3.2.2.7. Envio ................................................................................................................................................. 161
3.2.2.8. Retorno Sucesso .............................................................................................................................. 161
3.2.2.9. Retorno Erro .................................................................................................................................... 161
3.2.3. EnviarCartaCorrecaoCte ....................................................................................................................... 162
3.2.3.1. Introdução ........................................................................................................................................ 162
3.2.3.2. URL .................................................................................................................................................. 162
3.2.3.4. Exemplo URL .................................................................................................................................. 162
3.2.3.5. Layout.............................................................................................................................................. 162
3.2.3.6. Permissões ...................................................................................................................................... 162
3.2.3.7. Cabeçalho........................................................................................................................................ 162

Página 17 de 452
3.2.3.8. Envio ................................................................................................................................................ 164
3.2.3.9. Retorno Sucesso ............................................................................................................................. 164
3.2.3.10. Retorno Erro .................................................................................................................................. 164
3.2.4. Inutilizar ................................................................................................................................................ 164
3.2.4.1. Introdução ....................................................................................................................................... 164
3.2.4.2. URL ................................................................................................................................................. 164
3.2.4.3. Exemplo URL .................................................................................................................................. 164
3.2.4.4. Layout ............................................................................................................................................. 165
3.2.4.5. Permissões ...................................................................................................................................... 165
3.2.4.6. Cabeçalho ....................................................................................................................................... 165
3.2.4.7. Envio ................................................................................................................................................ 165
3.2.4.8. Retorno Sucesso ............................................................................................................................. 165
3.2.4.9. Retorno Erro ................................................................................................................................... 166
3.2.5. MarcarConsultado ................................................................................................................................ 166
3.2.5.1. Introdução ....................................................................................................................................... 166
3.2.5.2. URL ................................................................................................................................................. 166
3.2.5.3. Exemplo URL .................................................................................................................................. 166
3.2.5.4. Layout ............................................................................................................................................. 166
3.2.5.5. Permissões ...................................................................................................................................... 166
3.2.5.6. Cabeçalho ....................................................................................................................................... 167
3.2.5.7. Envio ................................................................................................................................................ 167
3.2.5.8. Retorno Sucesso ............................................................................................................................. 167
3.2.5.9. Retorno Erro ................................................................................................................................... 167
3.2.6. MarcarImpresso .................................................................................................................................... 167
3.2.6.1. Introdução ....................................................................................................................................... 167
3.2.6.2. URL ................................................................................................................................................. 167
3.2.6.3. Exemplo URL .................................................................................................................................. 168
3.2.6.4. Layout ............................................................................................................................................. 168
3.2.6.5. Permissões ...................................................................................................................................... 168

Página 18 de 452
3.2.6.6. Cabeçalho ....................................................................................................................................... 168
3.2.6.7. Envio ................................................................................................................................................ 168
3.2.6.8. Retorno Sucesso ............................................................................................................................. 169
3.2.6.9. Retorno Erro ................................................................................................................................... 169
3.2.7. MarcarCartaCorrecaoImpresso............................................................................................................. 169
3.2.7.1. Introdução ........................................................................................................................................ 169
3.2.7.2. URL .................................................................................................................................................. 169
3.2.7.3. Exemplo URL .................................................................................................................................. 169
3.2.7.4. Layout .............................................................................................................................................. 170
3.2.7.5. Permissões ...................................................................................................................................... 170
3.2.7.6. Cabeçalho ....................................................................................................................................... 170
3.2.7.7. Envio ................................................................................................................................................ 170
3.2.7.8. Retorno Sucesso ............................................................................................................................. 170
3.2.7.9. Retorno Erro ..................................................................................................................................... 171
3.2.8. EnviarRegistroMultimodal .................................................................................................................... 171
3.2.8.1. Introdução ........................................................................................................................................ 171
3.2.8.2. URL .................................................................................................................................................. 171
3.2.8.3. Exemplo URL ................................................................................................................................... 171
3.2.8.4. Layout .............................................................................................................................................. 171
3.2.8.5. Permissões ....................................................................................................................................... 171
3.2.8.6. Cabeçalho ....................................................................................................................................... 172
3.2.8.7. Envio ................................................................................................................................................ 172
3.2.8.8. Retorno Sucesso ............................................................................................................................. 172
3.2.8.9. Retorno Erro ................................................................................................................................... 172
3.2.9. EnviarEntregaCte .................................................................................................................................. 172
3.2.9.1. Introdução ....................................................................................................................................... 172
3.2.9.2. URL ................................................................................................................................................. 172
3.2.9.3. Exemplo URL .................................................................................................................................. 173
3.2.9.4. Layout ............................................................................................................................................. 173

Página 19 de 452
3.2.9.5. Permissões ...................................................................................................................................... 173
3.2.9.6. Cabeçalho ....................................................................................................................................... 173
3.2.9.7. Envio ................................................................................................................................................ 173
3.2.9.8. Retorno Sucesso ............................................................................................................................. 174
3.2.9.9. Retorno Erro ................................................................................................................................... 174
3.2.10. CancelarEntregaCte ............................................................................................................................ 174
3.2.10.1. Introdução ...................................................................................................................................... 174
3.2.10.2. URL ................................................................................................................................................ 174
3.2.10.3. Exemplo URL................................................................................................................................. 174
3.2.10.4. Layout ............................................................................................................................................ 174
3.2.10.5. Permissões .................................................................................................................................... 175
3.2.10.6. Cabeçalho...................................................................................................................................... 175
3.2.10.7. Envio .............................................................................................................................................. 175
3.2.10.8. Retorno Sucesso ........................................................................................................................... 175
3.2.10.9. Retorno Erro .................................................................................................................................. 175
3.2.11. SolicitarImpressao ................................................................................................................................ 175
3.2.11.1. Introdução ....................................................................................................................................... 175
3.2.11.2. URL ................................................................................................................................................. 176
3.2.11.3. Exemplo URL.................................................................................................................................. 176
3.2.11.4. Layout ............................................................................................................................................. 176
3.2.11.5. Permissões ..................................................................................................................................... 176
3.2.11.6. Condições/Observações ................................................................................................................. 177
3.2.11.7. Cabeçalho ....................................................................................................................................... 178
3.2.11.8. Envio ............................................................................................................................................... 178
3.2.11.9. Retorno Sucesso ............................................................................................................................ 178
3.2.11.10. Retorno Erro ................................................................................................................................. 179
3.2.11.11. Fluxo .............................................................................................................................................. 179
3.2.12. CancelarImpressao .............................................................................................................................. 179
3.2.12.1. Introdução ...................................................................................................................................... 179

Página 20 de 452
3.2.12.2. URL ................................................................................................................................................ 179
3.2.12.3. Exemplo URL ................................................................................................................................. 180
3.2.12.4. Layout ............................................................................................................................................ 180
3.2.12.5. Permissões .................................................................................................................................... 180
3.2.12.6. Condições/Observações ............................................................................................................... 180
3.2.12.7. Cabeçalho ....................................................................................................................................... 181
3.2.12.8. Envio ............................................................................................................................................... 181
3.2.12.9. Retorno Sucesso............................................................................................................................. 181
3.2.12.10. Retorno Erro.................................................................................................................................. 181
3.2.12.11. Fluxo .............................................................................................................................................. 182
3.2.13. Consulta Chave Acesso Sefaz ............................................................................................................. 182
3.2.13.1. Introdução ...................................................................................................................................... 182
3.2.13.2. URL ................................................................................................................................................ 182
3.2.13.3. Exemplo URL ................................................................................................................................. 182
3.2.13.4. Layout ............................................................................................................................................ 183
3.2.13.5. Detalhamento campo XML ........................................................................................................... 183
3.2.13.6. Permissões..................................................................................................................................... 183
3.2.13.7. Condições/Observações ................................................................................................................ 183
3.2.13.8. Cabeçalho ...................................................................................................................................... 184
3.2.13.9. Envio .............................................................................................................................................. 184
3.2.13.10. Retorno Sucesso .......................................................................................................................... 184
3.2.13.11. Retorno Erro .................................................................................................................................. 184
3.3. MÉTODO: GET .............................................................................................................................................. 184

3.3.1. Consulta Padrão .................................................................................................................................... 184
3.3.1.1. Introdução ........................................................................................................................................ 184
3.3.1.2. URL .................................................................................................................................................. 185
3.3.1.3. Definir quantidade de Results da consulta .................................................................................... 185
3.3.1.4. Exemplo URL ................................................................................................................................... 185
3.3.1.5. Permissões ....................................................................................................................................... 185

Página 21 de 452
3.3.1.6. Cabeçalho ........................................................................................................................................ 185
3.3.1.7. Envio ................................................................................................................................................. 186
3.3.1.8. Retorno Sucesso .............................................................................................................................. 186
3.3.1.9. Layout Retorno ................................................................................................................................ 186
3.3.1.10. Retorno Erro ................................................................................................................................... 186
3.3.2. GetXml ................................................................................................................................................... 186
3.3.2.1. Introdução ........................................................................................................................................ 186
3.3.2.3. URL .................................................................................................................................................. 186
3.3.2.4. Exemplo URL .................................................................................................................................. 188
3.3.2.5. Permissões ...................................................................................................................................... 188
3.3.2.6. Cabeçalho ....................................................................................................................................... 188
3.3.2.7. Envio ................................................................................................................................................ 188
3.3.2.8. Retorno Sucesso ............................................................................................................................. 188
3.3.2.9. Retorno Erro.................................................................................................................................... 188
3.3.3. GetXmlCancelamento ........................................................................................................................... 189
3.3.3.1. Introdução ........................................................................................................................................ 189
3.3.3.2. URL .................................................................................................................................................. 189
3.3.3.3. Exemplo URL .................................................................................................................................. 189
3.3.3.4. Permissões ...................................................................................................................................... 189
3.3.3.5. Cabeçalho ....................................................................................................................................... 189
3.3.3.6. Envio ................................................................................................................................................ 190
3.3.3.7. Retorno Sucesso ............................................................................................................................. 190
3.3.3.8. Retorno Erro.................................................................................................................................... 190
3.3.4. GetDacte................................................................................................................................................ 190
3.3.4.1. Introdução........................................................................................................................................ 190
3.3.4.2. URL.................................................................................................................................................. 190
3.3.4.3. Exemplo URL .................................................................................................................................. 190
3.3.4.4. Permissões ...................................................................................................................................... 190
3.3.4.5. Cabeçalho ........................................................................................................................................ 191

Página 22 de 452
3.3.4.6. Envio ................................................................................................................................................. 191
3.3.4.7. Retorno Sucesso .............................................................................................................................. 191
3.3.4.8. Retorno Erro .................................................................................................................................... 191
3.3.5. GetXmlCartaCorrecao ............................................................................................................................ 191
3.3.5.1. Introdução......................................................................................................................................... 191
3.3.5.2. URL................................................................................................................................................... 191
3.3.5.3. Exemplo URL ................................................................................................................................... 191
3.3.5.4. Permissões ...................................................................................................................................... 192
3.3.5.5. Cabeçalho ....................................................................................................................................... 192
3.3.5.6. Envio ................................................................................................................................................ 192
3.3.5.7. Retorno Sucesso ............................................................................................................................. 192
3.3.5.8. Retorno Erro ................................................................................................................................... 192
3.3.6.1. Introdução........................................................................................................................................ 193
3.3.6.2. URL.................................................................................................................................................. 193
3.3.6.3. Exemplo URL .................................................................................................................................. 193
3.3.6.4. Permissões ...................................................................................................................................... 193
3.3.6.5. Cabeçalho ....................................................................................................................................... 193
3.3.6.6. Envio ................................................................................................................................................ 193
3.3.6.7. Retorno Sucesso ............................................................................................................................. 193
3.3.6.8. Retorno Erro ................................................................................................................................... 194
3.3.7. GetStatus ............................................................................................................................................... 194
3.3.7.1. Introdução ....................................................................................................................................... 194
3.3.7.2. URL .................................................................................................................................................. 194
3.3.7.3. Exemplo URL................................................................................................................................... 194
3.3.7.4. Permissões ...................................................................................................................................... 194
3.3.7.5. Cabeçalho........................................................................................................................................ 195
3.3.7.6. Envio ................................................................................................................................................ 195
3.3.7.7. Retorno Sucesso.............................................................................................................................. 195

Página 23 de 452
3.3.7.8. Layout Retorno ............................................................................................................................... 195
3.3.7.9. Retorno Erro .................................................................................................................................... 196
3.3.8. Consulta Retorno .................................................................................................................................. 196
3.3.8.1. Introdução........................................................................................................................................ 196
3.3.8.2. URL ................................................................................................................................................. 196
3.3.8.3. Definir quantidade de Results da consulta: .................................................................................. 196
3.3.8.4. Filtro de Série.................................................................................................................................. 196
3.3.8.5. Exemplo URL com filtro ................................................................................................................. 196
3.3.8.6. Exemplo URL sem filtro ................................................................................................................. 197
3.3.8.7. Permissões ...................................................................................................................................... 197
3.3.8.8. Cabeçalho ....................................................................................................................................... 197
3.3.8.9. Envio................................................................................................................................................ 197
3.3.8.10. Retorno Sucesso ........................................................................................................................... 197
3.3.8.11. Layout Retorno............................................................................................................................... 198
3.3.8.12. Retorno Erro .................................................................................................................................. 198
3.3.9. Consulta Impressão .............................................................................................................................. 198
3.3.9.1. Introdução........................................................................................................................................ 198
3.3.9.2. URL.................................................................................................................................................. 198
3.3.9.3. Exemplo URL .................................................................................................................................. 198
3.3.9.4. Permissões ...................................................................................................................................... 198
3.3.9.5. Cabeçalho ....................................................................................................................................... 199
3.3.9.6. Envio ................................................................................................................................................ 199
3.3.9.7. Retorno Sucesso ............................................................................................................................. 199
3.3.9.8. Layout Retorno ............................................................................................................................... 199
3.3.9.9. Retorno Erro ................................................................................................................................... 199
3.3.10. GetStatus (com parâmetros)............................................................................................................... 199
3.3.10.1. Introdução ...................................................................................................................................... 199
3.3.10.2. URL ............................................................................................................................................... 200
3.3.10.3. Filtro de CNPJ Emissor, Número da CT-e e Série da CT-e ......................................................... 200

Página 24 de 452
3.3.10.4. Exemplo URL ............................................................................................................................... 200
3.3.10.5. Permissões ................................................................................................................................... 200
3.3.10.6. Cabeçalho..................................................................................................................................... 200
3.3.10.7. Envio .............................................................................................................................................. 201
3.3.10.8. Retorno Sucesso ........................................................................................................................... 201
3.3.10.9. Layout Retorno.............................................................................................................................. 201
3.3.10.10. Retorno Erro ................................................................................................................................ 201
3.3.11. Consulta Log do CT-e ........................................................................................................................... 201
3.3.11.1. Introdução ....................................................................................................................................... 201
3.3.11.2. URL ................................................................................................................................................ 202
3.3.11.3. Exemplo URL ................................................................................................................................. 202
3.3.11.4. Permissões .................................................................................................................................... 203
3.3.11.5. Cabeçalho ...................................................................................................................................... 203
3.3.11.6. Envio .............................................................................................................................................. 203
3.3.11.7. Retorno Sucesso ............................................................................................................................ 203
3.3.11.8. Layout Retorno.............................................................................................................................. 203
2.3.13.9. Retorno Erro ................................................................................................................................. 204
3.3.12. Consulta Listagem de CT-e ................................................................................................................ 204
3.3.12.1. Introdução ..................................................................................................................................... 204
3.3.12.2. URL ............................................................................................................................................... 204
3.3.12.3. Exemplo URL ................................................................................................................................ 204
3.3.12.4. Permissões.................................................................................................................................... 205
3.3.12.5. Cabeçalho ..................................................................................................................................... 205
3.3.12.6. Envio ............................................................................................................................................. 205
3.3.12.7. Retorno Sucesso ........................................................................................................................... 205
3.3.12.8. Layout Retorno ............................................................................................................................. 206
3.3.12.9. Retorno Erro ................................................................................................................................. 206
3.3.13. Consulta Solicitação de Impressão (getConsultaImpressao) ........................................................... 206
3.3.13.1. Introdução ..................................................................................................................................... 207

Página 25 de 452
3.3.13.2. URL ............................................................................................................................................... 207
3.3.13.3. Exemplo URL ................................................................................................................................ 207
3.3.13.4. Permissões .................................................................................................................................... 207
3.3.13.5. Cabeçalho ..................................................................................................................................... 207
3.3.13.6. Envio ............................................................................................................................................. 207
3.3.13.7. Retorno Sucesso ........................................................................................................................... 208
3.3.13.8. Layout Retorno ............................................................................................................................. 208
3.3.13.9. Retorno Erro HTTP ....................................................................................................................... 209
3.2.13.10. Condições/Observações ............................................................................................................. 209
3.2.13.11. Fluxo .............................................................................................................................................. 210
3.3.14. GetRetornoConsultaChaveSefaz ........................................................................................................ 210
3.3.14.1. Introdução ...................................................................................................................................... 210
3.3.14.2. URL ................................................................................................................................................ 210
3.3.14.4. Exemplo URL ................................................................................................................................. 210
3.3.14.5. Permissões ..................................................................................................................................... 211
3.3.14.6. Cabeçalho ....................................................................................................................................... 211
3.3.14.7. Envio ................................................................................................................................................ 211
3.3.14.8. Retorno Sucesso............................................................................................................................. 211
3.3.14.9. Layout Retorno ............................................................................................................................... 211
3.3.14.10. Detalhamento campo consultaChaveSefaz ............................................................................... 212
3.3.14.11. Retorno Erro.................................................................................................................................. 212
3.3.14.12. Condições/Observações .............................................................................................................. 212
4. MÓDULO MDFE .............................................................................................................................................. 212

4.2. MÉTODO: POST............................................................................................................................................ 213
4.2.1. EnviarPacote .......................................................................................................................................... 213
4.2.1.1. Introdução ........................................................................................................................................ 213
4.2.1.2. URL .................................................................................................................................................. 213

Página 26 de 452
4.2.1.3. Exemplo URL ................................................................................................................................... 213
4.2.1.4. Layout .............................................................................................................................................. 213
4.2.1.5. Permissões ...................................................................................................................................... 214
4.2.1.6. Cabeçalho ........................................................................................................................................ 214
4.2.1.7. Envio................................................................................................................................................. 214
4.2.1.8. Retorno Sucesso ............................................................................................................................. 214
4.2.1.9. Retorno Erro .................................................................................................................................... 214
4.2.2. Cancelar ................................................................................................................................................ 215
4.2.2.1. Introdução ....................................................................................................................................... 215
4.2.2.2. URL ................................................................................................................................................. 215
4.2.2.3. Exemplo URL .................................................................................................................................. 215
4.2.2.4. Layout ............................................................................................................................................. 215
4.2.2.5. Permissões ...................................................................................................................................... 216
4.2.2.6. Cabeçalho ....................................................................................................................................... 216
4.2.2.7. Envio ................................................................................................................................................ 216
4.2.2.8. Retorno Sucesso ............................................................................................................................. 216
5.2.2.9. Retorno Erro ................................................................................................................................... 216
4.2.3. Encerrar ................................................................................................................................................. 216
4.2.3.1. Introdução ....................................................................................................................................... 216
4.2.3.2. URL ................................................................................................................................................. 217
4.2.3.3. Exemplo URL .................................................................................................................................. 217
4.2.3.4. Layout ............................................................................................................................................. 217
4.2.3.5. Permissões ...................................................................................................................................... 217
4.2.3.6. Cabeçalho ....................................................................................................................................... 217
4.2.3.7. Envio ................................................................................................................................................ 218
4.2.3.8. Retorno Sucesso ............................................................................................................................. 218
4.2.3.9. Retorno Erro ................................................................................................................................... 218
4.2.4.1. Introdução ....................................................................................................................................... 218

Página 27 de 452
4.2.4.2. URL ................................................................................................................................................. 218
4.2.4.3. Exemplo URL .................................................................................................................................. 218
4.2.4.4. Layout ............................................................................................................................................. 219
4.2.4.5. Permissões...................................................................................................................................... 219
4.2.4.6. Cabeçalho ....................................................................................................................................... 219
4.2.4.7. Envio ................................................................................................................................................ 219
4.2.4.8. Retorno Sucesso............................................................................................................................. 219
4.2.4.9. Retorno Erro ................................................................................................................................... 219
4.2.5. MarcarImpresso ................................................................................................................................... 220
4.2.5.1. Introdução ...................................................................................................................................... 220
4.2.5.2. URL ................................................................................................................................................ 220
4.2.5.3. Exemplo URL ................................................................................................................................. 220
4.2.5.4. Layout ............................................................................................................................................ 220
4.2.5.5. Permissões..................................................................................................................................... 220
4.2.5.6. Cabeçalho ....................................................................................................................................... 221
4.2.5.7. Envio ................................................................................................................................................ 221
4.2.5.8. Retorno Sucesso............................................................................................................................. 221
4.2.5.9. Retorno Erro ................................................................................................................................... 221
4.2.6. Inclusão de Condutor............................................................................................................................ 221
4.2.6.1. Introdução ....................................................................................................................................... 221
4.2.6.2. URL ................................................................................................................................................. 221
4.2.6.3. Exemplo URL .................................................................................................................................. 221
4.2.6.4. Layout ............................................................................................................................................ 222
4.2.6.5. Permissões..................................................................................................................................... 222
4.2.6.6. Cabeçalho ...................................................................................................................................... 222
4.2.6.7. Envio ............................................................................................................................................... 222
4.2.6.8. Retorno Sucesso............................................................................................................................ 223
4.2.6.9. Retorno Erro .................................................................................................................................. 223
4.2.7. Pagamento da Operação de Transporte ............................................................................................. 223

Página 28 de 452
4.2.7.1. Introdução....................................................................................................................................... 223
4.2.7.2. URL................................................................................................................................................. 223
4.2.7.3. Exemplo URL ................................................................................................................................. 223
4.2.7.4. Layout ............................................................................................................................................ 223
4.2.7.5. Permissões ..................................................................................................................................... 224
4.2.7.6. Cabeçalho ...................................................................................................................................... 224
4.2.7.7. Envio ............................................................................................................................................... 224
4.2.7.8. Retorno Sucesso ............................................................................................................................ 224
4.2.7.9. Retorno Erro................................................................................................................................... 224
4.3. MÉTODO: GET ............................................................................................................................................. 225

4.3.1. Consulta Padrão ................................................................................................................................... 225
4.3.1.1. Introdução ....................................................................................................................................... 225
4.3.1.2. URL ................................................................................................................................................. 225
4.3.1.3. Exemplo URL .................................................................................................................................. 225
4.3.1.4. Permissões ..................................................................................................................................... 225
4.3.1.5. Cabeçalho ....................................................................................................................................... 225
4.3.1.6. Envio ............................................................................................................................................... 226
4.3.1.7. Retorno Sucesso ............................................................................................................................. 226
4.3.1.8. Layout Retorno ............................................................................................................................... 226
4.3.1.9. Retorno Erro ................................................................................................................................... 226
4.3.2. GetXml.................................................................................................................................................. 226
4.3.2.1. Introdução ...................................................................................................................................... 226
4.3.2.2. URL ................................................................................................................................................ 226
4.3.2.3. Exemplo URL .................................................................................................................................. 227
4.3.2.4. Permissões ...................................................................................................................................... 227
4.3.2.5. Cabeçalho ....................................................................................................................................... 227
4.3.2.6. Envio................................................................................................................................................ 227
4.3.2.7. Retorno Sucesso ............................................................................................................................. 227
4.3.2.8. Retorno Erro ................................................................................................................................... 227

Página 29 de 452
4.3.3. Consulta Retorno ................................................................................................................................. 228
4.3.3.1. Introdução....................................................................................................................................... 228
4.3.3.2. URL................................................................................................................................................. 228
4.3.3.4. Filtro de Série ................................................................................................................................. 228
4.3.3.5. Exemplo URL com filtro ................................................................................................................ 228
4.3.3.6. Exemplo URL sem filtro ................................................................................................................ 228
4.3.3.7. Permissões ..................................................................................................................................... 229
4.3.3.8. Cabeçalho ...................................................................................................................................... 229
4.3.3.9. Envio ............................................................................................................................................... 229
4.3.3.12. Retorno Sucesso ........................................................................................................................... 229
4.3.3.11. Layout Retorno.............................................................................................................................. 229
4.3.3.12. Retorno Erro ................................................................................................................................. 229
4.3.4.1. Introdução ...................................................................................................................................... 230
4.3.4.2. URL ................................................................................................................................................ 230
4.3.4.3. Exemplo URL ................................................................................................................................. 230
4.3.4.4. Permissões..................................................................................................................................... 230
4.3.4.5. Cabeçalho ...................................................................................................................................... 230
4.3.4.6. Envio .............................................................................................................................................. 230
4.3.4.7. Retorno Sucesso ............................................................................................................................ 230
4.3.4.8. Layout Retorno ............................................................................................................................... 231
4.3.4.9. Retorno Erro ................................................................................................................................... 231
4.3.5. GetDamdfe ............................................................................................................................................ 231
4.3.5.1. Introdução ....................................................................................................................................... 231
4.3.5.2. URL ................................................................................................................................................. 231
4.3.5.3. Exemplo URL .................................................................................................................................. 231
4.3.5.4. Permissões ...................................................................................................................................... 231
4.3.5.5. Cabeçalho ...................................................................................................................................... 232

Página 30 de 452
4.3.5.6. Envio .............................................................................................................................................. 232
4.3.5.7. Retorno Sucesso ............................................................................................................................ 232
4.3.5.8. Retorno Erro .................................................................................................................................. 232
4.3.6. GetXmlCancelamento ......................................................................................................................... 232
4.3.6.1. Introdução ...................................................................................................................................... 232
4.3.6.2. URL ................................................................................................................................................ 232
4.3.6.3. Exemplo URL ................................................................................................................................. 233
4.3.6.4. Permissões ..................................................................................................................................... 233
4.3.6.5. Cabeçalho ...................................................................................................................................... 233
4.3.6.6. Envio .............................................................................................................................................. 233
4.3.6.7. Retorno Sucesso ............................................................................................................................ 233
4.3.6.8. Retorno Erro .................................................................................................................................. 233
4.3.7. GetXmlEncerramento .......................................................................................................................... 234
4.3.7.1. Introdução ....................................................................................................................................... 234
4.3.7.2. URL ................................................................................................................................................. 234
4.3.7.3. Exemplo URL ................................................................................................................................. 234
4.3.7.4. Permissões ..................................................................................................................................... 234
4.3.7.5. Cabeçalho ...................................................................................................................................... 234
4.3.7.6. Envio ............................................................................................................................................... 235
4.3.7.7. Retorno Sucesso ............................................................................................................................ 235
4.3.7.8. Retorno Erro................................................................................................................................... 235
5. MÓDULO RECEPTOR NFSE (SERVIÇO) ....................................................................................................... 235
5.1. OBSERVAÇÕES GERAIS .............................................................................................................................. 235

5.2. MÉTODO: POST........................................................................................................................................... 235
5.2.1.1. Introdução ....................................................................................................................................... 235
5.2.1.2. URL ................................................................................................................................................. 236
5.2.1.3. Exemplo URL .................................................................................................................................. 236
5.2.1.4. Layout .............................................................................................................................................. 237

Página 31 de 452
5.2.1.5. Permissões ...................................................................................................................................... 237
5.2.1.6. Cabeçalho ........................................................................................................................................ 237
5.2.1.7. Envio................................................................................................................................................. 237
5.2.1.8. Retorno Sucesso ............................................................................................................................. 237
5.2.1.9. Retorno Erro .................................................................................................................................... 237
5.3. MÉTODO: GET ............................................................................................................................................. 238

5.3.1. Consulta Padrão ................................................................................................................................... 238
5.3.1.1. Introdução ....................................................................................................................................... 238
5.3.1.2. URL ................................................................................................................................................. 238
5.3.1.3. Exemplo URL .................................................................................................................................. 238
5.3.1.4. Permissões ..................................................................................................................................... 238
5.3.1.5. Cabeçalho ....................................................................................................................................... 238
5.3.1.6. Envio ............................................................................................................................................... 238
5.3.1.7. Retorno Sucesso ............................................................................................................................. 239
5.3.1.8. Layout Retorno ............................................................................................................................... 239
5.3.1.9. Retorno Erro ................................................................................................................................... 239
6. MÓDULO RECEPTOR NFE (MERCANTIL) .................................................................................................... 240

6.2. MÉTODO: POST........................................................................................................................................... 240
6.2.1. EnviarRecebimento .............................................................................................................................. 240
6.2.1.1. Introdução ....................................................................................................................................... 240
6.2.1.2. URL ................................................................................................................................................. 240
6.2.1.3. Exemplo URL .................................................................................................................................. 240
6.2.1.4. Layout .............................................................................................................................................. 241
6.2.1.5. Permissões ...................................................................................................................................... 241
6.2.1.6. Cabeçalho ........................................................................................................................................ 241
6.2.1.7. Envio................................................................................................................................................. 241
6.2.1.8. Retorno Sucesso ............................................................................................................................. 241
6.2.1.9. Layout Retorno ................................................................................................................................ 241
6.2.1.10. Retorno Erro ................................................................................................................................. 242

Página 32 de 452
6.2.2. EnviarEventoManifestacao .................................................................................................................. 242
6.2.2.1. Introdução ...................................................................................................................................... 242
6.2.2.2. URL ................................................................................................................................................ 242
6.2.2.3. Exemplo URL ................................................................................................................................. 242
6.2.2.4. Layout ............................................................................................................................................ 243
6.2.2.5. Permissões ..................................................................................................................................... 243
6.2.2.6. Cabeçalho ...................................................................................................................................... 243
6.2.2.7. Envio ............................................................................................................................................... 243
6.2.2.8. Retorno Sucesso ............................................................................................................................ 243
6.2.2.9. Layout Retorno .............................................................................................................................. 244
6.2.2.10. Retorno Erro ................................................................................................................................. 244
6.2.3. MarcarConsultado ............................................................................................................................... 244
6.2.3.1. Introdução ...................................................................................................................................... 244
6.2.3.2. URL ................................................................................................................................................ 244
6.2.3.3. Exemplo URL: ................................................................................................................................ 244
6.2.3.4. Layout ............................................................................................................................................ 245
6.2.3.5. Permissões ..................................................................................................................................... 245
6.2.3.6. Cabeçalho ...................................................................................................................................... 245
6.2.3.7. Envio ............................................................................................................................................... 245
6.2.3.8. Retorno Sucesso ............................................................................................................................ 245
6.2.3.9. Retorno Erro .................................................................................................................................. 246
6.2.4. MarcarImpresso ................................................................................................................................... 246
6.2.4.1. Introdução ...................................................................................................................................... 246
6.2.4.2. URL ................................................................................................................................................ 246
6.2.4.3. Exemplo URL ................................................................................................................................. 246
6.2.4.4. Layout ............................................................................................................................................ 246
6.2.4.5. Permissões..................................................................................................................................... 247
6.2.4.6. Cabeçalho ...................................................................................................................................... 247
6.2.4.7. Envio ............................................................................................................................................... 247

Página 33 de 452
6.2.4.8. Retorno Sucesso............................................................................................................................ 247
6.2.4.9. Retorno Erro .................................................................................................................................. 247
6.3. MÉTODO: GET ............................................................................................................................................. 248

6.3.1. Consulta Padrão ................................................................................................................................... 248
6.3.1.1. Introdução ....................................................................................................................................... 248
6.3.1.2. URL ................................................................................................................................................. 248
6.3.1.3. Exemplo URL .................................................................................................................................. 248
6.3.1.4. Permissões ..................................................................................................................................... 248
6.3.1.5. Cabeçalho ....................................................................................................................................... 248
6.3.1.6. Envio ............................................................................................................................................... 248
6.3.1.7. Retorno Sucesso ............................................................................................................................. 249
6.3.1.8. Layout Retorno ............................................................................................................................... 249
6.3.1.9. Retorno Erro ................................................................................................................................... 250
6.3.2. GetXml.................................................................................................................................................. 250
6.3.2.1. Introdução ...................................................................................................................................... 250
6.3.2.2. URL ................................................................................................................................................ 250
6.3.2.3. Exemplo URL ................................................................................................................................. 250
6.3.2.4. Permissões ..................................................................................................................................... 250
6.3.2.5. Cabeçalho ....................................................................................................................................... 251
6.3.2.6. Envio................................................................................................................................................ 251
6.3.2.7. Retorno Sucesso ............................................................................................................................. 251
6.3.2.8. Retorno Erro ................................................................................................................................... 251
6.3.3. GetXmlCancelamento........................................................................................................................... 251
6.3.3.1. Introdução........................................................................................................................................ 251
6.3.3.2. URL................................................................................................................................................. 252
6.3.3.3. Exemplo URL ................................................................................................................................. 252
6.3.3.4. Permissões ..................................................................................................................................... 252
6.3.3.5. Cabeçalho ...................................................................................................................................... 252
6.3.3.6. Envio ............................................................................................................................................... 252

Página 34 de 452
6.3.3.7. Retorno Sucesso ............................................................................................................................ 252
6.3.3.8. Retorno Erro .................................................................................................................................. 253
6.3.4. GetStatus ............................................................................................................................................. 253
6.3.4.1. Introdução ...................................................................................................................................... 253
6.3.4.2. URL ................................................................................................................................................ 253
6.3.4.3. Exemplo URL ................................................................................................................................. 253
6.3.4.4. Permissões ..................................................................................................................................... 253
6.3.4.5. Cabeçalho ...................................................................................................................................... 254
6.3.4.6. Envio .............................................................................................................................................. 254
6.3.4.7. Retorno Sucesso ............................................................................................................................ 254
6.3.4.8. Layout Retorno .............................................................................................................................. 254
6.3.4.9. Retorno Erro .................................................................................................................................. 254
6.3.5.1. Introdução ...................................................................................................................................... 255
6.3.5.2. URL ................................................................................................................................................ 255
6.3.5.3. Exemplo URL ................................................................................................................................. 255
6.3.5.4. Permissões ..................................................................................................................................... 255
6.3.5.5. Cabeçalho ...................................................................................................................................... 255
6.3.5.6. Envio .............................................................................................................................................. 255
6.3.5.7. Retorno Sucesso ............................................................................................................................ 256
6.3.5.8. Layout Retorno .............................................................................................................................. 256
6.3.5.9. Retorno Erro .................................................................................................................................. 256
6.3.6.1. Introdução ...................................................................................................................................... 256
6.3.6.2. URL ................................................................................................................................................ 256
6.3.6.3. Exemplo URL ................................................................................................................................. 256
6.3.6.4. Permissões ..................................................................................................................................... 257
6.3.6.5. Cabeçalho ...................................................................................................................................... 257
6.3.6.6. Envio .............................................................................................................................................. 257

Página 35 de 452
6.3.6.7. Retorno Sucesso ............................................................................................................................ 257
6.3.6.8. Layout Retorno .............................................................................................................................. 257
6.3.7. GetDanfe .............................................................................................................................................. 258
6.3.7.1. Introdução ....................................................................................................................................... 258
6.3.7.2. URL ................................................................................................................................................. 258
6.3.7.3. Exemplo URL ................................................................................................................................. 258
6.3.7.4. Permissões ..................................................................................................................................... 258
6.3.7.5. Cabeçalho ...................................................................................................................................... 258
6.3.7.6. Envio ............................................................................................................................................... 258
6.3.7.7. Retorno Sucesso ............................................................................................................................ 258
6.3.7.8. Retorno Erro................................................................................................................................... 259
6.3.8. GetXmlCartaCorrecao ......................................................................................................................... 259
6.3.8.1. Introdução ...................................................................................................................................... 259
6.3.8.2. URL ................................................................................................................................................ 259
6.3.8.3. Exemplo URL ................................................................................................................................. 259
6.3.8.4. Permissões..................................................................................................................................... 259
6.3.8.5. Cabeçalho ...................................................................................................................................... 260
6.3.8.6. Envio .............................................................................................................................................. 260
6.3.8.7. Retorno Sucesso ............................................................................................................................ 260
6.3.8.8. Retorno Erro .................................................................................................................................. 260
6.3.9. GetCartaCorrecao ................................................................................................................................ 260
6.3.9.1. Introdução ...................................................................................................................................... 260
6.3.9.2. URL ................................................................................................................................................. 261
6.3.9.3. Exemplo URL .................................................................................................................................. 261
6.3.9.4. Permissões ...................................................................................................................................... 261
6.3.9.5. Cabeçalho ....................................................................................................................................... 261
6.3.9.6. Envio ............................................................................................................................................... 261
6.3.9.7. Retorno Sucesso ............................................................................................................................. 261
6.3.9.8. Retorno Erro .................................................................................................................................. 262

Página 36 de 452
6.3.10. Consulta Log da NF-e ........................................................................................................................ 262
6.3.10.1. Introdução ..................................................................................................................................... 262
6.3.10.2. URL ............................................................................................................................................... 262
6.3.10.3. Exemplo URL ............................................................................................................................... 263
6.3.10.4. Permissões ................................................................................................................................... 263
6.3.10.5. Cabeçalho .................................................................................................................................... 263
6.3.10.6. Envio ............................................................................................................................................. 263
6.3.10.7. Retorno Sucesso........................................................................................................................... 264
6.3.10.8. Layout Retorno ............................................................................................................................ 264
6.3.10.9. Retorno Erro ................................................................................................................................. 264
6.3.11. Consulta Listagem de NF-e ................................................................................................................ 264
6.3.11.1. Introdução ...................................................................................................................................... 264
6.3.11.2. URL ................................................................................................................................................ 265
6.3.11.3. Exemplo URL ................................................................................................................................ 265
6.3.11.4. Permissões .................................................................................................................................... 265
6.3.11.5. Cabeçalho ..................................................................................................................................... 266
6.3.11.6. Envio .............................................................................................................................................. 266
6.3.11.7. Retorno Sucesso............................................................................................................................ 266
6.3.11.8. Layout Retorno ............................................................................................................................. 266
6.3.11.9. Retorno Erro .................................................................................................................................. 268
7. MÓDULO RECEPTOR CTE ............................................................................................................................. 268

7.2. MÉTODO: POST ........................................................................................................................................... 268
7.2.1. EnviarRecebimento ............................................................................................................................... 268
7.2.1.1. Introdução ....................................................................................................................................... 268
7.2.1.2. URL ................................................................................................................................................. 268
7.2.1.3. Exemplo URL .................................................................................................................................. 269
7.2.1.4. Layout ............................................................................................................................................. 270
7.2.1.5. Permissões ...................................................................................................................................... 270

Página 37 de 452
7.2.1.6. Cabeçalho ....................................................................................................................................... 270
7.2.1.7. Envio ................................................................................................................................................ 270
7.2.1.8. Retorno Sucesso ............................................................................................................................. 270
7.2.1.9. Layout Retorno ................................................................................................................................ 271
7.2.1.10. Retorno Erro ................................................................................................................................... 271
7.2.2. ConsultarDocFornecedor ...................................................................................................................... 271
7.2.2.1. Introdução ........................................................................................................................................ 271
7.2.2.2. URL .................................................................................................................................................. 271
7.2.2.3. Exemplo URL .................................................................................................................................. 271
7.2.2.4. Layout.............................................................................................................................................. 272
7.2.2.5. Permissões ...................................................................................................................................... 272
7.2.2.6. Cabeçalho ....................................................................................................................................... 272
7.2.2.7. Envio ................................................................................................................................................ 272
7.2.2.8. Retorno Sucesso ............................................................................................................................. 273
7.2.2.9. Layout Retorno ............................................................................................................................... 273
7.2.2.10. Retorno Erro .................................................................................................................................. 273
7.2.3. ResgatarXmlFornecedor ....................................................................................................................... 273
7.2.3.1. Introdução ........................................................................................................................................ 273
7.2.3.2. URL .................................................................................................................................................. 273
7.2.3.3. Exemplo URL ................................................................................................................................. 274
7.2.3.4. Layout ............................................................................................................................................. 274
7.2.3.5. Permissões ..................................................................................................................................... 274
7.2.3.6. Cabeçalho ...................................................................................................................................... 275
7.2.3.7. Envio ............................................................................................................................................... 275
7.2.3.8. Retorno Sucesso ............................................................................................................................ 275
7.2.3.9. Layout Retorno .............................................................................................................................. 275
7.2.3.10. Retorno Erro ................................................................................................................................. 275
7.2.4. MarcarConsultado................................................................................................................................ 276
7.2.4.1. Introdução....................................................................................................................................... 276

Página 38 de 452
7.2.4.2. URL................................................................................................................................................. 276
7.2.4.3. Exemplo URL ................................................................................................................................. 276
7.2.4.4. Layout ............................................................................................................................................ 276
7.2.4.5. Permissões ..................................................................................................................................... 276
7.2.4.6. Cabeçalho ....................................................................................................................................... 277
7.2.4.7. Envio ................................................................................................................................................ 277
7.2.4.8. Retorno Sucesso ............................................................................................................................. 277
7.2.4.9. Retorno Erro.................................................................................................................................... 277
7.2.5. EnviarPrestacaoServicoDesacordo ....................................................................................................... 277
7.2.5.1. Introdução ........................................................................................................................................ 277
7.2.5.2. URL.................................................................................................................................................. 277
7.2.5.3. Exemplo URL ................................................................................................................................. 278
7.2.5.4. Layout............................................................................................................................................. 278
7.2.5.5. Permissões ..................................................................................................................................... 278
7.2.5.6. Cabeçalho ...................................................................................................................................... 278
7.2.5.7. Envio ............................................................................................................................................... 278
7.2.5.8. Retorno Sucesso ............................................................................................................................ 279
7.2.5.9. Retorno Erro................................................................................................................................... 279
7.3. MÉTODO: GET ............................................................................................................................................. 279

7.3.1. Consulta Padrão.................................................................................................................................... 279
7.3.1.1. Introdução........................................................................................................................................ 279
7.3.1.2. URL.................................................................................................................................................. 279
7.3.1.3. Exemplo URL .................................................................................................................................. 279
7.3.1.4. Permissões ...................................................................................................................................... 279
7.3.1.5. Cabeçalho ....................................................................................................................................... 280
7.3.1.6. Envio ................................................................................................................................................ 280
7.3.1.7. Retorno Sucesso ............................................................................................................................. 280
7.3.1.8. Layout Retorno ............................................................................................................................... 280
7.3.1.9. Retorno Erro ................................................................................................................................... 280

Página 39 de 452
7.3.2. GetXml ................................................................................................................................................... 281
7.3.2.1. Introdução ........................................................................................................................................ 281
7.3.2.2. URL .................................................................................................................................................. 281
7.3.2.3. Exemplo URL .................................................................................................................................. 281
7.3.2.4. Permissões ...................................................................................................................................... 281
7.3.2.5. Cabeçalho ....................................................................................................................................... 281
7.3.2.6. Envio ............................................................................................................................................... 282
7.3.2.7. Retorno Sucesso............................................................................................................................. 282
7.3.2.8. Retorno Erro ................................................................................................................................... 282
7.3.3. GetXmlCancelamento .......................................................................................................................... 282
7.3.3.1. Introdução ....................................................................................................................................... 282
7.3.3.2. URL ................................................................................................................................................. 282
7.3.3.3. Exemplo URL.................................................................................................................................. 282
7.3.3.4. Permissões ..................................................................................................................................... 283
7.3.3.5. Cabeçalho....................................................................................................................................... 283
7.3.3.6. Envio ............................................................................................................................................... 283
7.3.3.7. Retorno Sucesso............................................................................................................................. 283
7.3.3.8. Retorno Erro ................................................................................................................................... 283
7.3.4. GetStatus .............................................................................................................................................. 284
7.3.4.1. Introdução ....................................................................................................................................... 284
7.3.4.2. URL ................................................................................................................................................. 284
7.3.4.3. Exemplo URL ................................................................................................................................. 284
7.3.4.4. Permissões ..................................................................................................................................... 284
7.3.4.5. Cabeçalho ...................................................................................................................................... 284
7.3.4.6. Envio ............................................................................................................................................... 285
7.3.4.7. Retorno Sucesso ............................................................................................................................ 285
7.3.4.8. Layout Retorno .............................................................................................................................. 285
7.3.4.9. Retorno Erro................................................................................................................................... 285

Página 40 de 452
7.3.5.1. Introdução ....................................................................................................................................... 285
7.3.5.2. URL ................................................................................................................................................. 286
7.3.5.3. Exemplo URL ................................................................................................................................. 286
7.3.5.4. Permissões ..................................................................................................................................... 286
7.3.5.5. Cabeçalho ...................................................................................................................................... 286
7.3.5.6. Envio ............................................................................................................................................... 286
7.3.5.7. Retorno Sucesso ............................................................................................................................ 286
7.3.5.8. Layout Retorno .............................................................................................................................. 287
7.3.6. GetXmlCartaCorrecao .......................................................................................................................... 287
7.3.6.1. Introdução ....................................................................................................................................... 287
7.3.6.2. URL ................................................................................................................................................. 287
7.3.6.3. Exemplo URL ................................................................................................................................. 287
7.3.6.4. Permissões ..................................................................................................................................... 287
7.3.6.5. Cabeçalho ...................................................................................................................................... 288
7.3.6.6. Envio ............................................................................................................................................... 288
7.3.6.7. Retorno Sucesso ............................................................................................................................ 288
7.3.6.8. Retorno Erro................................................................................................................................... 288
7.3.7.1. Introdução ....................................................................................................................................... 288
7.3.7.2. URL ................................................................................................................................................. 289
7.3.7.3. Exemplo URL .................................................................................................................................. 289
7.3.7.4. Permissões ..................................................................................................................................... 289
7.3.7.5. Cabeçalho ....................................................................................................................................... 289
7.3.7.6. Envio ............................................................................................................................................... 289
7.3.7.7. Retorno Sucesso ............................................................................................................................. 289
7.3.7.8. Retorno Erro ................................................................................................................................... 290
7.3.8. Consulta Log do CT-e .......................................................................................................................... 290
7.3.8.1. Introdução ....................................................................................................................................... 290
7.3.8.2. URL ................................................................................................................................................. 290

Página 41 de 452
7.3.8.3. Exemplo URL .................................................................................................................................. 291
7.3.8.4. Permissões ...................................................................................................................................... 291
7.3.8.5. Cabeçalho ....................................................................................................................................... 291
7.3.8.6. Envio ................................................................................................................................................ 291
7.3.8.7. Retorno Sucesso ............................................................................................................................. 291
7.3.8.8. Layout Retorno ............................................................................................................................... 291
7.3.8.9. Retorno Erro................................................................................................................................... 292
7.3.9. Consulta Listagem de CT-e ................................................................................................................. 292
7.3.9.1. Introdução ....................................................................................................................................... 292
7.3.9.2. URL ................................................................................................................................................. 292
7.3.9.3. Exemplo URL ................................................................................................................................. 293
7.3.9.4. Permissões ..................................................................................................................................... 293
7.3.9.5. Cabeçalho ...................................................................................................................................... 293
7.3.9.6. Envio ............................................................................................................................................... 294
7.3.9.7. Retorno Sucesso ............................................................................................................................ 294
7.3.9.8. Layout Retorno .............................................................................................................................. 294
7.3.9.9. Retorno Erro................................................................................................................................... 295
7.3.10. GetDacte ............................................................................................................................................. 295
7.3.10.1. Introdução ..................................................................................................................................... 295
7.3.10.2. URL ............................................................................................................................................... 295
7.3.10.3. Exemplo URL ................................................................................................................................ 295
7.3.10.4. Permissões ................................................................................................................................... 295
7.3.10.5. Cabeçalho ..................................................................................................................................... 295
7.3.10.6. Envio ............................................................................................................................................. 296
7.3.10.7. Retorno Sucesso ........................................................................................................................... 296
7.3.10.8. Retorno Erro ................................................................................................................................. 296
8. MÓDULO ADM ............................................................................................................................................... 296

8.2. MÉTODO: POST .......................................................................................................................................... 296

Página 42 de 452
8.2.1. Manutenção de Empresa ..................................................................................................................... 296
8.2.1.1. Introdução ....................................................................................................................................... 296
8.2.1.2. URL ................................................................................................................................................. 296
8.2.1.3. Exemplo URL .................................................................................................................................. 297
8.2.1.4. Layout para inclusão de Empresa ................................................................................................. 298
8.2.1.5. Layout para edição de Empresa .................................................................................................... 298
8.2.1.6. Layout para exclusão de Empresa................................................................................................. 298
8.2.1.7. Permissões ...................................................................................................................................... 300
8.2.1.8. Cabeçalho....................................................................................................................................... 300
8.2.1.9. Envio ............................................................................................................................................... 300
8.2.1.10. Retorno Sucesso ........................................................................................................................... 300
8.2.1.11. Retorno Erro .................................................................................................................................. 300
8.2.2. Upload Certificado Digital .................................................................................................................... 301
8.2.2.1. Introdução ....................................................................................................................................... 301
8.2.2.2. URL ................................................................................................................................................. 301
8.2.2.3. Exemplo URL .................................................................................................................................. 301
8.2.2.4. Layout ............................................................................................................................................. 301
8.2.2.5. Permissões..................................................................................................................................... 302
8.2.2.6. Cabeçalho ...................................................................................................................................... 302
8.2.2.7. Envio ............................................................................................................................................... 302
8.2.2.8. Retorno Sucesso ............................................................................................................................ 302
8.2.2.9. Retorno Erro .................................................................................................................................. 302
8.3. MÉTODO: GET ............................................................................................................................................. 303

8.3.1. Listagem Municípios ............................................................................................................................. 303
8.3.1.1. Introdução ....................................................................................................................................... 303
8.3.1.2. URL ................................................................................................................................................. 303
8.3.1.3. Exemplo URL .................................................................................................................................. 303
8.3.1.4. Exemplo URL com Parâmetro: ...................................................................................................... 303
8.3.1.5. Permissões ..................................................................................................................................... 303

Página 43 de 452
8.3.1.6. Cabeçalho ....................................................................................................................................... 304
8.3.1.7. Envio ................................................................................................................................................ 304
8.3.1.8. Retorno Sucesso ............................................................................................................................ 304
8.3.1.9. Retorno Erro ................................................................................................................................... 304
8.3.2. InfoEmpresaServico ............................................................................................................................. 304
8.3.2.1. Introdução ...................................................................................................................................... 304
8.3.2.2. URL ................................................................................................................................................ 304
8.3.2.3. Filtro de CNPJ, IM e Serviço .......................................................................................................... 305
8.3.2.4. Exemplo URL ................................................................................................................................. 305
8.3.2.5. Permissões ..................................................................................................................................... 305
8.3.2.6. Cabeçalho ...................................................................................................................................... 305
8.3.2.7. Envio ............................................................................................................................................... 305
8.3.2.8. Retorno Sucesso ............................................................................................................................ 305
8.3.2.9. Layout Retorno .............................................................................................................................. 306
8.3.2.10. Retorno Erro ................................................................................................................................. 307
8.3.3. InfoUsuario ........................................................................................................................................... 307
8.3.3.1. Introdução....................................................................................................................................... 307
8.3.3.2. URL ................................................................................................................................................ 307
8.3.3.3. Filtro de Login ................................................................................................................................ 307
8.3.3.4. Exemplo URL ................................................................................................................................. 307
8.3.3.5. Permissões ..................................................................................................................................... 308
8.3.3.6. Cabeçalho ...................................................................................................................................... 308
8.3.3.7. Envio ............................................................................................................................................... 308
8.3.3.8. Retorno Sucesso ............................................................................................................................ 308
8.3.3.9. Layout Retorno .............................................................................................................................. 309
8.3.3.10. Retorno Erro ................................................................................................................................. 309
9. MÓDULO CTE OS ............................................................................................................................................ 310

9.2. MÉTODO: POST............................................................................................................................................ 310

Página 44 de 452
9.2.1. EnviarPacote .......................................................................................................................................... 310
9.2.1.1. Introdução ........................................................................................................................................ 310
9.2.1.2. URL .................................................................................................................................................. 310
9.2.1.3. Exemplo URL .................................................................................................................................... 311
9.2.1.4. Layout ............................................................................................................................................... 311
9.2.1.5. Permissões ....................................................................................................................................... 311
9.2.1.6. Cabeçalho ......................................................................................................................................... 311
9.2.1.7. Envio.................................................................................................................................................. 311
9.2.1.8. Retorno Sucesso ............................................................................................................................. 312
9.2.1.9. Retorno Erro .................................................................................................................................... 312
9.2.2. Cancelar ................................................................................................................................................ 312
9.2.2.1. Introdução ....................................................................................................................................... 312
9.2.2.2. URL ................................................................................................................................................. 312
9.2.2.3. Exemplo URL .................................................................................................................................. 312
9.2.2.4. Layout ............................................................................................................................................. 312
9.2.2.5. Permissões ...................................................................................................................................... 314
9.2.2.6. Cabeçalho ....................................................................................................................................... 314
9.2.2.7. Envio ................................................................................................................................................ 314
9.2.2.8. Retorno Sucesso ............................................................................................................................. 314
9.2.2.9. Retorno Erro ................................................................................................................................... 314
9.2.3. EnviarCartaCorrecaoCte ....................................................................................................................... 314
9.2.3.1. Introdução ....................................................................................................................................... 314
9.2.3.2. URL ................................................................................................................................................. 315
9.2.3.3. Exemplo URL .................................................................................................................................. 315
9.2.3.4. Layout ............................................................................................................................................. 315
9.2.3.5. Permissões ...................................................................................................................................... 315
9.2.3.6. Cabeçalho ....................................................................................................................................... 315
9.2.3.7. Envio ................................................................................................................................................ 315
9.2.3.8. Retorno Sucesso ............................................................................................................................. 316

Página 45 de 452
9.2.3.9. Retorno Erro ................................................................................................................................... 316
9.2.4. Inutilizar ................................................................................................................................................ 316
9.2.4.1. Introdução ....................................................................................................................................... 316
9.2.4.2. URL ................................................................................................................................................. 316
9.2.4.3. Exemplo URL .................................................................................................................................. 316
9.2.4.4. Layout ............................................................................................................................................. 317
9.2.4.5. Permissões...................................................................................................................................... 317
9.2.4.6. Cabeçalho ....................................................................................................................................... 317
9.2.4.7. Envio ................................................................................................................................................ 317
9.2.4.8. Retorno Sucesso............................................................................................................................. 317
9.2.4.9. Retorno Erro ................................................................................................................................... 318
9.2.5.1. Introdução ....................................................................................................................................... 318
9.2.5.2. URL ................................................................................................................................................. 318
9.2.5.3. Exemplo URL .................................................................................................................................. 318
9.2.5.4. Layout ............................................................................................................................................. 318
9.2.5.5. Permissões...................................................................................................................................... 318
9.2.5.6. Cabeçalho ....................................................................................................................................... 319
9.2.5.7. Envio ................................................................................................................................................ 319
9.2.5.8. Retorno Sucesso............................................................................................................................. 319
9.2.5.9. Retorno Erro ................................................................................................................................... 319
9.2.6. EnviarGTV.............................................................................................................................................. 319
9.2.6.1. Introdução ....................................................................................................................................... 319
9.2.6.2. URL ................................................................................................................................................. 319
9.2.6.3. Exemplo URL ................................................................................................................................. 320
9.2.6.4. Layout ............................................................................................................................................ 320
9.2.6.5. Permissões..................................................................................................................................... 320
9.2.6.6. Cabeçalho ...................................................................................................................................... 320
9.2.6.7. Envio ............................................................................................................................................... 320

Página 46 de 452
9.2.6.8. Retorno Sucesso............................................................................................................................ 320
9.2.6.9. Retorno Erro ................................................................................................................................... 321
9.3. MÉTODO: GET .............................................................................................................................................. 321

9.3.1. Consulta Padrão .................................................................................................................................... 321
9.3.1.1. Introdução ........................................................................................................................................ 321
9.3.1.2. URL .................................................................................................................................................. 321
9.3.1.3. Definir quantidade de Results da consulta .................................................................................... 321
9.3.1.4. Exemplo URL ................................................................................................................................... 321
9.3.1.5. Permissões ..................................................................................................................................... 322
9.3.1.6. Cabeçalho ....................................................................................................................................... 322
9.3.1.7. Envio ................................................................................................................................................ 322
9.3.1.8. Retorno Sucesso............................................................................................................................. 322
9.3.1.9. Layout Retorno ............................................................................................................................... 323
9.3.1.10. Retorno Erro.................................................................................................................................. 323
9.3.2. GetXml.................................................................................................................................................. 323
9.3.2.1. Introdução ...................................................................................................................................... 323
9.3.2.2. URL ................................................................................................................................................ 323
9.3.2.3. Exemplo URL ................................................................................................................................. 323
9.3.2.4. Permissões ..................................................................................................................................... 324
9.3.2.5. Cabeçalho ...................................................................................................................................... 324
9.3.2.6. Envio............................................................................................................................................... 324
9.3.2.7. Retorno Sucesso ............................................................................................................................ 324
9.3.2.8. Retorno Erro .................................................................................................................................. 324
9.3.3. GetXmlCancelamento.......................................................................................................................... 325
9.3.3.1. Introdução....................................................................................................................................... 325
9.3.3.2. URL................................................................................................................................................. 325
9.3.3.3. Exemplo URL ................................................................................................................................. 325
9.3.3.4. Permissões ..................................................................................................................................... 325
9.3.3.5. Cabeçalho ...................................................................................................................................... 325

Página 47 de 452
9.3.3.6. Envio ............................................................................................................................................... 325
9.3.3.7. Retorno Sucesso ............................................................................................................................ 326
9.3.3.8. Retorno Erro .................................................................................................................................. 326
9.3.4.1. Introdução ...................................................................................................................................... 326
9.3.4.2. URL ................................................................................................................................................ 326
9.3.4.3. Exemplo URL ................................................................................................................................. 326
9.3.4.4. Permissões ..................................................................................................................................... 326
9.3.4.5. Cabeçalho ....................................................................................................................................... 327
9.3.4.6. Envio ............................................................................................................................................... 327
9.3.4.7. Retorno Sucesso ............................................................................................................................. 327
9.3.4.8. Retorno Erro ................................................................................................................................... 327
9.3.5. GetStatus .............................................................................................................................................. 327
9.3.5.1. Introdução ...................................................................................................................................... 327
9.3.5.2. URL ................................................................................................................................................ 328
9.3.5.3. Exemplo URL ................................................................................................................................. 328
9.3.5.4. Permissões ..................................................................................................................................... 328
9.3.5.5. Cabeçalho ...................................................................................................................................... 328
9.3.5.6. Envio .............................................................................................................................................. 328
9.3.5.7. Retorno Sucesso ............................................................................................................................ 328
9.3.5.8. Layout Retorno .............................................................................................................................. 329
9.3.5.9. Retorno Erro .................................................................................................................................. 329
9.3.6.1. Introdução ...................................................................................................................................... 329
9.3.6.2. URL ................................................................................................................................................ 329
9.3.6.4. Filtro de Série ................................................................................................................................ 330
9.3.6.6. Exemplo URL sem filtro ................................................................................................................ 330

Página 48 de 452
9.3.6.7. Permissões ..................................................................................................................................... 330
9.3.6.8. Cabeçalho ...................................................................................................................................... 330
9.3.6.9. Envio ............................................................................................................................................... 331
9.3.6.10. Retorno Sucesso ........................................................................................................................... 331
9.3.6.11. Layout Retorno .............................................................................................................................. 331
9.3.6.12. Retorno Erro .................................................................................................................................. 331
9.3.7. GetStatus (com parâmetros) ................................................................................................................ 331
9.3.7.1. Introdução ........................................................................................................................................ 331
9.3.7.2. URL ................................................................................................................................................. 332
9.3.7.3. Filtro de CNPJ Emissor, Número da CT-e OS e Série da CT-e OS ............................................... 332
9.3.7.4. Exemplo URL ................................................................................................................................. 332
9.3.7.5. Permissões ..................................................................................................................................... 332
9.3.7.6. Cabeçalho ...................................................................................................................................... 332
9.3.7.7. Envio ................................................................................................................................................ 333
9.3.7.8. Retorno Sucesso ............................................................................................................................. 333
9.3.7.9. Layout Retorno ............................................................................................................................... 333
9.3.7.10. Retorno Erro .................................................................................................................................. 333
9.3.8. GetDacteOS .......................................................................................................................................... 333
9.3.8.1. Introdução ....................................................................................................................................... 333
9.3.8.2. URL ................................................................................................................................................. 333
9.3.8.3. Exemplo URL ................................................................................................................................. 334
9.3.8.4. Permissões..................................................................................................................................... 334
9.3.8.5. Cabeçalho ...................................................................................................................................... 334
9.3.8.6. Envio .............................................................................................................................................. 334
9.3.8.7. Retorno Sucesso ............................................................................................................................ 334
9.3.8.8. Retorno Erro .................................................................................................................................. 334
9.3.9.1. Introdução ...................................................................................................................................... 335
9.3.9.2. URL ................................................................................................................................................ 335
9.3.9.3. Exemplo URL ................................................................................................................................. 335

Página 49 de 452
9.3.9.4. Permissões ..................................................................................................................................... 336
9.3.9.5. Cabeçalho ...................................................................................................................................... 336
9.3.9.6. Envio .............................................................................................................................................. 336
9.3.9.7. Retorno Sucesso ............................................................................................................................ 336
9.3.9.8. Layout Retorno .............................................................................................................................. 336
9.3.9.9. Retorno Erro ................................................................................................................................... 337
9.3.10. Consulta Listagem de CT-e OS ........................................................................................................... 337
9.3.10.1. Introdução ...................................................................................................................................... 337
9.3.10.2. URL ................................................................................................................................................ 337
9.3.10.3. Exemplo URL ............................................................................................................................... 338
9.3.10.4. Permissões ................................................................................................................................... 338
9.3.10.5. Cabeçalho .................................................................................................................................... 338
9.3.10.6. Envio ............................................................................................................................................. 338
9.3.10.7. Retorno Sucesso........................................................................................................................... 338
9.3.10.8. Layout Retorno ............................................................................................................................ 340
9.3.10.9. Retorno Erro ................................................................................................................................. 340
10. MÓDULO RECEPTOR CTE OS.................................................................................................................... 342
10.1. OBSERVAÇÕES GERAIS ............................................................................................................................ 342

10.2. MÉTODO: POST ......................................................................................................................................... 342
10.2.1. EnviarRecebimento ............................................................................................................................. 342
10.2.1.1. Introdução...................................................................................................................................... 342
10.2.1.2. URL................................................................................................................................................ 342
10.2.1.3. Exemplo URL ................................................................................................................................ 342
10.2.1.4. Layout ........................................................................................................................................... 343
10.2.1.5. Permissões .................................................................................................................................... 343
10.2.1.6. Cabeçalho ..................................................................................................................................... 343
10.2.1.7. Envio .............................................................................................................................................. 343
10.2.1.8. Retorno Sucesso ........................................................................................................................... 343
10.2.1.9. Layout Retorno ............................................................................................................................. 344

Página 50 de 452
10.2.1.10. Retorno Erro ................................................................................................................................ 344
10.2.2. ConsultarDocFornecedor ................................................................................................................... 344
10.2.2.1. Introdução ..................................................................................................................................... 344
10.2.2.2. URL ............................................................................................................................................... 344
10.2.2.3. Exemplo URL ............................................................................................................................... 344
10.2.2.4. Layout ........................................................................................................................................... 345
10.2.2.5. Permissões ................................................................................................................................... 345
10.2.2.6. Cabeçalho .................................................................................................................................... 345
10.2.2.7. Envio ............................................................................................................................................. 346
10.2.2.8. Retorno Sucesso .......................................................................................................................... 346
10.2.2.9. Layout Retorno ............................................................................................................................ 346
10.2.2.10. Retorno Erro ............................................................................................................................... 346
10.2.3. MarcarConsultado .............................................................................................................................. 346
10.2.3.1. Introdução ..................................................................................................................................... 346
10.2.3.2. URL ............................................................................................................................................... 346
10.2.3.3. Exemplo URL................................................................................................................................. 347
10.2.3.4. Layout ............................................................................................................................................ 347
10.2.3.5. Permissões .................................................................................................................................... 347
10.2.3.6. Cabeçalho...................................................................................................................................... 347
10.2.3.7. Envio ............................................................................................................................................. 348
10.2.3.8. Retorno Sucesso .......................................................................................................................... 348
10.2.3.9. Retorno Erro ................................................................................................................................. 348
10.2.4. EnviarPrestacaoServicoDesacordo .................................................................................................... 348
10.2.4.1. Introdução ..................................................................................................................................... 348
10.2.4.2. URL ............................................................................................................................................... 348
10.2.4.3. Exemplo URL ............................................................................................................................... 348
10.2.4.4. Layout........................................................................................................................................... 348
10.2.4.5. Permissões ................................................................................................................................... 349
10.2.4.6. Cabeçalho .................................................................................................................................... 349

Página 51 de 452
10.2.4.7. Envio ............................................................................................................................................. 349
10.2.4.8. Retorno Sucesso .......................................................................................................................... 349
10.2.4.9. Retorno Erro ................................................................................................................................. 349
10.3. MÉTODO: GET............................................................................................................................................ 350

10.3.1. Consulta Padrão .................................................................................................................................. 350
10.3.1.1. Introdução ...................................................................................................................................... 350
10.3.1.2. URL ................................................................................................................................................ 350
10.3.1.3. Exemplo URL ................................................................................................................................ 350
10.3.1.4. Permissões .................................................................................................................................... 350
10.3.1.5. Cabeçalho ...................................................................................................................................... 351
10.3.1.6. Envio ............................................................................................................................................... 351
10.3.1.7. Retorno Sucesso ............................................................................................................................ 351
10.3.1.8. Layout Retorno .............................................................................................................................. 351
10.3.1.9. Retorno Erro................................................................................................................................... 351
10.3.2. GetXml ................................................................................................................................................. 351
10.3.2.1. Introdução ...................................................................................................................................... 351
10.3.2.2. URL ............................................................................................................................................... 352
10.3.2.3. Exemplo URL................................................................................................................................ 352
10.3.2.4. Permissões ................................................................................................................................... 352
10.3.2.5. Cabeçalho..................................................................................................................................... 352
10.3.2.6. Envio ............................................................................................................................................. 352
10.3.2.7. Retorno Sucesso ........................................................................................................................... 352
10.3.2.8. Retorno Erro ................................................................................................................................. 353
10.3.3. GetXmlCancelamento ........................................................................................................................ 353
10.3.3.1. Introdução ..................................................................................................................................... 353
10.3.3.2. URL ............................................................................................................................................... 353
10.3.3.3. Exemplo URL ................................................................................................................................ 353
10.3.3.4. Permissões ................................................................................................................................... 353
10.3.3.5. Cabeçalho ..................................................................................................................................... 354

Página 52 de 452
10.3.3.6. Envio ............................................................................................................................................. 354
10.3.3.7. Retorno Sucesso ........................................................................................................................... 354
10.3.3.8. Retorno Erro ................................................................................................................................. 354
10.3.4. GetStatus ............................................................................................................................................ 354
10.3.4.1. Introdução ..................................................................................................................................... 354
10.3.4.2. URL ............................................................................................................................................... 355
10.3.4.3. Exemplo URL ............................................................................................................................... 355
10.3.4.4. Permissões ................................................................................................................................... 355
10.3.4.5. Cabeçalho .................................................................................................................................... 355
10.3.4.6. Envio ............................................................................................................................................. 355
10.3.4.7. Retorno Sucesso........................................................................................................................... 356
10.3.4.8. Layout Retorno ............................................................................................................................ 356
10.3.4.9. Retorno Erro ................................................................................................................................. 356
10.3.5. Consulta Retorno ............................................................................................................................... 356
10.3.5.1. Introdução ..................................................................................................................................... 356
10.3.5.2. URL ............................................................................................................................................... 356
10.3.5.3. Exemplo URL ................................................................................................................................ 357
10.3.5.4. Permissões .................................................................................................................................... 357
10.3.5.5. Cabeçalho ..................................................................................................................................... 357
10.3.5.6. Envio .............................................................................................................................................. 357
10.3.5.7. Retorno Sucesso............................................................................................................................ 357
10.3.5.8. Layout Retorno ............................................................................................................................ 358
10.3.6. GetXmlCartaCorrecao ........................................................................................................................ 358
10.3.6.1. Introdução ..................................................................................................................................... 358
10.3.6.2. URL ............................................................................................................................................... 358
10.3.6.3. Exemplo URL ............................................................................................................................... 358
10.3.6.4. Permissões ................................................................................................................................... 358
10.3.6.5. Cabeçalho .................................................................................................................................... 359
10.3.6.6. Envio ............................................................................................................................................. 359

Página 53 de 452
10.3.6.7. Retorno Sucesso........................................................................................................................... 359
10.3.6.8. Retorno Erro ................................................................................................................................. 359
10.3.7. GetCartaCorrecao ............................................................................................................................... 359
10.3.7.1. Introdução ..................................................................................................................................... 359
10.3.7.2. URL ............................................................................................................................................... 360
10.3.7.3. Exemplo URL ................................................................................................................................ 360
10.3.7.4. Permissões ................................................................................................................................... 360
10.3.7.5. Cabeçalho ..................................................................................................................................... 360
10.3.7.6. Envio ............................................................................................................................................. 360
10.3.7.7. Retorno Sucesso ........................................................................................................................... 360
10.3.7.8. Retorno Erro .................................................................................................................................. 361
10.3.8. Consulta Log do CT-e OS .................................................................................................................... 361
10.3.8.1. Introdução ...................................................................................................................................... 361
10.3.8.2. URL ................................................................................................................................................ 361
10.3.8.3. Exemplo URL ............................................................................................................................... 362
10.3.8.4. Permissões ................................................................................................................................... 362
10.3.8.5. Cabeçalho .................................................................................................................................... 362
10.3.8.6. Envio ............................................................................................................................................. 362
10.3.8.7. Retorno Sucesso .......................................................................................................................... 362
10.3.8.8. Layout Retorno ............................................................................................................................ 363
10.3.8.9. Retorno Erro ................................................................................................................................. 363
10.3.9. Consulta Listagem de CT-e OS .......................................................................................................... 363
10.3.9.1. Introdução ..................................................................................................................................... 363
10.3.9.2. URL ............................................................................................................................................... 363
10.3.9.3. Exemplo URL ............................................................................................................................... 364
10.3.9.4. Permissões ................................................................................................................................... 364
10.3.9.5. Cabeçalho .................................................................................................................................... 364
10.3.9.6. Envio ............................................................................................................................................. 365
10.3.9.7. Retorno Sucesso........................................................................................................................... 365

Página 54 de 452
10.3.9.8. Layout Retorno ............................................................................................................................ 365
10.3.9.9. Retorno Erro ................................................................................................................................. 366
10.3.10. GetDacteOS ...................................................................................................................................... 366
10.3.10.1. Introdução ................................................................................................................................... 366
10.3.10.2. URL ............................................................................................................................................. 366
10.3.10.3. Exemplo URL .............................................................................................................................. 366
10.3.10.4. Permissões.................................................................................................................................. 366
10.3.10.5. Cabeçalho .................................................................................................................................... 367
10.3.10.6. Envio ............................................................................................................................................ 367
10.3.10.7. Retorno Sucesso .......................................................................................................................... 367
10.3.10.8. Retorno Erro ................................................................................................................................ 367
11. MÓDULO NFCE (Consumidor)....................................................................................................................... 368
11.1. OBSERVAÇÕES GERAIS ............................................................................................................................. 368

11.2. MÉTODO: POST .......................................................................................................................................... 368
11.2.1. EnviarPacote ........................................................................................................................................ 368
11.2.1.1. Introdução....................................................................................................................................... 368
11.2.1.2. URL................................................................................................................................................. 368
11.2.1.3. Exemplo URL ................................................................................................................................. 369
11.2.1.4. Layout ............................................................................................................................................ 369
11.2.1.5. Permissões ..................................................................................................................................... 370
11.2.1.6. Cabeçalho ...................................................................................................................................... 370
11.2.1.7. Envio ............................................................................................................................................... 370
11.2.1.8. Retorno Sucesso ............................................................................................................................ 370
11.2.1.9. Retorno Erro................................................................................................................................... 370
11.2.2. Cancelar ............................................................................................................................................... 370
11.2.2.1. Introdução ....................................................................................................................................... 371
11.2.2.2. URL ................................................................................................................................................. 371
11.2.2.3. Exemplo URL ................................................................................................................................. 371
11.2.2.4. Layout ............................................................................................................................................. 372

Página 55 de 452
11.2.2.5. Permissões ..................................................................................................................................... 372
11.2.2.6. Cabeçalho ...................................................................................................................................... 373
11.2.2.7. Envio ............................................................................................................................................... 373
11.2.2.8. Retorno Sucesso ............................................................................................................................ 373
11.2.2.9. Retorno Erro ................................................................................................................................... 373
11.2.3. Inutilizar ................................................................................................................................................ 373
11.2.3.1. Introdução ....................................................................................................................................... 373
11.2.3.2.URL .................................................................................................................................................. 373
11.2.3.3. Exemplo URL.................................................................................................................................. 374
11.2.3.4. Layout ............................................................................................................................................. 374
11.2.3.5. Permissões ..................................................................................................................................... 374
11.2.3.6. Cabeçalho....................................................................................................................................... 374
11.2.3.7. Envio ............................................................................................................................................... 374
11.2.3.8. Retorno Sucesso ............................................................................................................................ 375
11.2.3.9. Retorno Erro ................................................................................................................................... 375
11.2.4.1. Introdução ....................................................................................................................................... 376
11.2.4.2. URL ................................................................................................................................................. 376
11.2.4.3. Exemplo URL ................................................................................................................................. 376
11.2.4.4. Layout ............................................................................................................................................. 376
11.2.4.5. Permissões ..................................................................................................................................... 376
11.2.4.6. Cabeçalho ...................................................................................................................................... 377
11.2.4.7. Envio ............................................................................................................................................... 377
11.2.4.8. Retorno Sucesso ............................................................................................................................ 377
11.2.4.9. Retorno Erro ................................................................................................................................... 377
11.2.5. MarcarImpresso.................................................................................................................................... 377
11.2.5.1. Introdução ....................................................................................................................................... 377
11.2.5.2. URL ................................................................................................................................................. 377
11.2.5.3. Exemplo URL ................................................................................................................................ 378

Página 56 de 452
11.2.5.4. Layout ............................................................................................................................................ 378
11.2.5.5. Permissões .................................................................................................................................... 378
11.2.5.6. Cabeçalho ..................................................................................................................................... 378
11.2.5.7. Envio .............................................................................................................................................. 378
11.2.5.8. Retorno Sucesso ............................................................................................................................ 379
11.2.5.9. Retorno Erro ................................................................................................................................... 379
11.2.6. ReimpressaoDanfe ............................................................................................................................... 379
11.2.6.1. Introdução ....................................................................................................................................... 379
11.2.6.2. URL ................................................................................................................................................. 379
11.2.6.3. Exemplo URL ................................................................................................................................. 379
11.2.6.4. Layout ............................................................................................................................................. 379
11.2.6.5. Permissões .................................................................................................................................... 380
11.2.6.6. Cabeçalho ..................................................................................................................................... 380
11.2.6.7. Envio .............................................................................................................................................. 380
11.2.6.8. Retorno Sucesso ........................................................................................................................... 380
11.2.6.9. Retorno Erro .................................................................................................................................. 380
11.2.7. EnviarEmail .......................................................................................................................................... 380
11.2.7.1. Introdução ...................................................................................................................................... 380
11.2.7.2. URL ................................................................................................................................................. 381
11.2.7.3. Exemplo URL .................................................................................................................................. 381
11.2.7.4. Layout ............................................................................................................................................. 381
11.2.7.5. Detalhamento campo txt_conteudo.............................................................................................. 381
11.2.7.6. Permissões .................................................................................................................................... 382
11.2.7.7. Cabeçalho ...................................................................................................................................... 382
11.2.7.8. Envio .............................................................................................................................................. 382
11.2.7.9. Retorno Sucesso ........................................................................................................................... 382
11.2.7.10. Retorno Erro ................................................................................................................................ 382
11.3. MÉTODO: GET............................................................................................................................................. 383


Página 57 de 452
11.3.1.1. Introdução ....................................................................................................................................... 383
11.3.1.2. URL ................................................................................................................................................. 383
11.3.1.4. Filtro de Série ................................................................................................................................. 383
11.3.1.6. Exemplo URL sem filtro................................................................................................................. 384
11.3.1.7. Permissões ..................................................................................................................................... 384
11.3.1.8. Cabeçalho ...................................................................................................................................... 384
11.3.1.9. Envio ............................................................................................................................................... 384
11.3.1.10. Retorno Sucesso........................................................................................................................... 384
11.3.1.11. Layout Retorno .............................................................................................................................. 385
11.3.1.12. Retorno Erro ................................................................................................................................. 385
11.3.2.1. Introdução ...................................................................................................................................... 385
11.3.2.2. URL ................................................................................................................................................ 385
11.3.2.3. Exemplo URL................................................................................................................................. 385
11.3.2.4. Permissões .................................................................................................................................... 385
11.3.2.5. Cabeçalho...................................................................................................................................... 386
11.3.2.6. Envio .............................................................................................................................................. 386
11.3.2.7. Retorno Sucesso ............................................................................................................................ 386
11.3.2.8. Layout Retorno ............................................................................................................................. 386
11.3.2.9. Retorno Erro .................................................................................................................................. 386
11.3.3. GetXml ................................................................................................................................................. 386
11.3.3.1. Introdução ...................................................................................................................................... 386
11.3.3.2. URL ................................................................................................................................................ 387
11.3.3.3. Exemplo URL ................................................................................................................................. 387
11.3.3.4. Permissões .................................................................................................................................... 387
11.3.3.5. Cabeçalho ...................................................................................................................................... 387
11.3.3.6. Envio .............................................................................................................................................. 387

Página 58 de 452
11.3.3.7. Retorno Sucesso ............................................................................................................................ 387
11.3.3.8. Retorno Erro .................................................................................................................................. 388
11.3.4. GetXmlCancelamento ......................................................................................................................... 388
11.3.4.1. Introdução ...................................................................................................................................... 388
11.3.4.2. URL ................................................................................................................................................ 388
11.3.4.3. Exemplo URL ................................................................................................................................ 388
11.3.4.4. Permissões .................................................................................................................................... 388
11.3.4.5. Cabeçalho ..................................................................................................................................... 388
11.3.4.6. Envio .............................................................................................................................................. 389
11.3.4.7. Retorno Sucesso............................................................................................................................ 389
11.3.4.8. Retorno Erro .................................................................................................................................. 389
11.3.5. GetDanfe .............................................................................................................................................. 389
11.3.5.1. Introdução ...................................................................................................................................... 389
11.3.5.2. URL ................................................................................................................................................ 389
11.3.5.3. Exemplo URL ................................................................................................................................ 389
11.3.5.4. Permissões .................................................................................................................................... 389
11.3.5.5. Cabeçalho ..................................................................................................................................... 390
11.3.5.6. Envio .............................................................................................................................................. 390
11.3.5.7. Retorno Sucesso............................................................................................................................ 390
11.3.5.8. Retorno Erro .................................................................................................................................. 390
11.3.6. GetStatus ............................................................................................................................................. 390
11.3.6.1. Introdução ...................................................................................................................................... 390
11.3.6.2. URL ................................................................................................................................................. 391
11.3.6.3. Exemplo URL ................................................................................................................................. 391
11.3.6.4. Permissões ..................................................................................................................................... 391
11.3.6.5. Cabeçalho ...................................................................................................................................... 391
11.3.6.6. Envio ............................................................................................................................................... 391
11.3.6.7. Retorno Sucesso............................................................................................................................ 392
11.3.6.8. Layout Retorno ............................................................................................................................. 392

Página 59 de 452
11.3.6.9. Retorno Erro .................................................................................................................................. 392
11.3.7. GetStatus (com parâmetros) ............................................................................................................... 393
11.3.7.1. Introdução ...................................................................................................................................... 393
11.3.7.2. URL ................................................................................................................................................ 393
11.3.7.3. Filtro de CNPJ Emissor, Número da NFC-e e Série da NFC-e ..................................................... 393
11.3.7.4. Exemplo URL ................................................................................................................................. 393
11.3.7.5. Permissões .................................................................................................................................... 393
11.3.7.6. Cabeçalho ...................................................................................................................................... 394
11.3.7.7. Envio ............................................................................................................................................... 394
11.3.7.8. Retorno Sucesso............................................................................................................................ 394
11.3.7.9. Layout Retorno .............................................................................................................................. 394
11.3.7.10. Retorno Erro................................................................................................................................. 395
11.3.8. Consulta Log da NFC-e ....................................................................................................................... 395
11.3.8.1. Introdução ...................................................................................................................................... 395
11.3.8.2. URL ................................................................................................................................................ 395
11.3.8.3. Exemplo URL ................................................................................................................................ 396
11.3.8.4. Permissões .................................................................................................................................... 396
11.3.8.5. Cabeçalho ..................................................................................................................................... 396
11.3.8.6. Envio .............................................................................................................................................. 396
11.3.8.7. Retorno Sucesso............................................................................................................................ 396
11.3.8.8. Layout Retorno .............................................................................................................................. 397
11.3.8.9. Retorno Erro ................................................................................................................................... 397
11.3.9. Consulta Listagem de NFC-e ............................................................................................................... 397
11.3.9.1. Introdução ....................................................................................................................................... 397
11.3.9.2. URL ................................................................................................................................................. 397
11.3.9.3. Exemplo URL ................................................................................................................................ 398
11.3.9.4. Permissões .................................................................................................................................... 398
11.3.9.5. Cabeçalho ..................................................................................................................................... 398
11.3.9.6. Envio .............................................................................................................................................. 399

Página 60 de 452
11.3.9.7. Retorno Sucesso............................................................................................................................ 399
11.3.9.8. Layout Retorno ............................................................................................................................. 399
11.3.9.9. Retorno Erro ................................................................................................................................... 401
12. MÓDULO RECEPTOR NFE TRANSPORTADOR (MERCANTIL) .................................................................... 401
12.1. OBSERVAÇÕES GERAIS.............................................................................................................................. 401

12.2. MÉTODO: POST .......................................................................................................................................... 401
12.2.1. EnviarRecebimento .............................................................................................................................. 401
12.2.1.1. Introdução ....................................................................................................................................... 401
12.2.1.2. URL ................................................................................................................................................ 402
12.2.1.3. Exemplo URL ................................................................................................................................ 402
12.2.1.4. Layout ............................................................................................................................................ 402
12.2.1.5. Permissões .................................................................................................................................... 402
12.2.1.6. Cabeçalho ..................................................................................................................................... 402
12.2.1.7. Envio .............................................................................................................................................. 402
12.2.1.8. Retorno Sucesso ........................................................................................................................... 403
12.2.1.9. Layout Retorno ............................................................................................................................. 403
12.2.1.10. Retorno Erro ................................................................................................................................ 403
12.2.3. MarcarConsultado .............................................................................................................................. 403
12.2.3.1. Introdução ..................................................................................................................................... 403
12.2.3.2. URL ............................................................................................................................................... 404
12.2.3.3. Exemplo URL: ............................................................................................................................... 404
12.2.3.4. Layout ........................................................................................................................................... 404
12.2.3.5. Permissões ................................................................................................................................... 404
12.2.3.6. Cabeçalho ..................................................................................................................................... 404
12.2.3.7. Envio .............................................................................................................................................. 404
12.2.3.8. Retorno Sucesso........................................................................................................................... 405
12.2.3.9. Retorno Erro ................................................................................................................................. 406
12.2.4. MarcarImpresso .................................................................................................................................. 406
12.2.4.1. Introdução ..................................................................................................................................... 406

Página 61 de 452
12.2.4.2. URL ............................................................................................................................................... 406
12.2.4.3. Exemplo URL ................................................................................................................................ 406
12.2.4.4. Layout ........................................................................................................................................... 406
12.2.4.5. Permissões ................................................................................................................................... 407
12.2.4.6. Cabeçalho..................................................................................................................................... 407
12.2.4.7. Envio ............................................................................................................................................. 407
12.2.4.8. Retorno Sucesso .......................................................................................................................... 407
12.2.4.9. Retorno Erro ................................................................................................................................. 407
12.3. MÉTODO: GET ............................................................................................................................................ 408

12.3.1. Consulta Padrão .................................................................................................................................. 408
12.3.1.1. Introdução ...................................................................................................................................... 408
12.3.1.2. URL ................................................................................................................................................ 408
12.3.1.3. Exemplo URL................................................................................................................................. 408
12.3.1.4. Permissões .................................................................................................................................... 408
12.3.1.5. Cabeçalho...................................................................................................................................... 408
12.3.1.6. Envio .............................................................................................................................................. 408
12.3.1.7. Retorno Sucesso ............................................................................................................................ 409
12.3.1.8. Layout Retorno ............................................................................................................................. 409
12.3.1.9. Retorno Erro ................................................................................................................................... 410
12.3.2. GetXml ................................................................................................................................................. 410
12.3.2.1. Introdução ...................................................................................................................................... 410
12.3.2.2. URL ................................................................................................................................................ 410
12.3.2.3. Exemplo URL ................................................................................................................................. 410
12.3.2.4. Permissões .................................................................................................................................... 410
12.3.2.5. Cabeçalho ....................................................................................................................................... 411
12.3.2.6. Envio ............................................................................................................................................... 411
12.3.2.7. Retorno Sucesso ............................................................................................................................. 411
12.3.2.8. Retorno Erro ................................................................................................................................... 411
12.3.3. GetXmlCancelamento .......................................................................................................................... 411

Página 62 de 452
12.3.3.1. Introdução ....................................................................................................................................... 411
12.3.3.2. URL ................................................................................................................................................ 412
12.3.3.3. Exemplo URL ................................................................................................................................. 412
12.3.3.4. Permissões..................................................................................................................................... 412
12.3.3.5. Cabeçalho ...................................................................................................................................... 412
12.3.3.6. Envio .............................................................................................................................................. 412
12.3.3.7. Retorno Sucesso ............................................................................................................................ 412
12.3.3.8. Retorno Erro .................................................................................................................................. 413
12.3.4. GetStatus ............................................................................................................................................. 413
12.3.4.1. Introdução ...................................................................................................................................... 413
12.3.4.2. URL ................................................................................................................................................ 413
12.3.4.3. Exemplo URL ................................................................................................................................. 413
12.3.4.4. Permissões .................................................................................................................................... 413
12.3.4.5. Cabeçalho ...................................................................................................................................... 414
12.3.4.6. Envio .............................................................................................................................................. 414
12.3.4.7. Retorno Sucesso ............................................................................................................................ 414
12.3.4.8. Layout Retorno .............................................................................................................................. 414
12.3.4.9. Retorno Erro .................................................................................................................................. 414
12.3.5.1. Introdução ...................................................................................................................................... 415
12.3.5.2. URL ................................................................................................................................................ 415
12.3.5.3. Exemplo URL ................................................................................................................................. 415
12.3.5.4. Permissões .................................................................................................................................... 415
12.3.5.5. Cabeçalho ...................................................................................................................................... 415
12.3.5.6. Envio .............................................................................................................................................. 415
12.3.5.7. Retorno Sucesso ............................................................................................................................ 416
12.3.5.8. Layout Retorno .............................................................................................................................. 416
12.3.5.9. Retorno Erro .................................................................................................................................. 416
12.3.6. Consulta Retorno................................................................................................................................. 416

Página 63 de 452
12.3.6.1. Introdução ...................................................................................................................................... 416
12.3.6.2. URL ................................................................................................................................................ 416
12.3.6.3. Exemplo URL ................................................................................................................................. 416
12.3.6.4. Permissões .................................................................................................................................... 417
12.3.6.5. Cabeçalho ...................................................................................................................................... 417
12.3.6.6. Envio .............................................................................................................................................. 417
12.3.6.7. Retorno Sucesso ............................................................................................................................ 417
12.3.6.8. Layout Retorno .............................................................................................................................. 417
12.3.7. GetDanfe .............................................................................................................................................. 418
12.3.7.1. Introdução ...................................................................................................................................... 418
12.3.7.2. URL ................................................................................................................................................ 418
12.3.7.3. Exemplo URL ................................................................................................................................. 418
12.3.7.4. Permissões ..................................................................................................................................... 418
12.3.7.5. Cabeçalho ...................................................................................................................................... 418
12.3.7.6. Envio............................................................................................................................................... 418
12.3.7.7. Retorno Sucesso ............................................................................................................................ 419
12.3.7.8. Retorno Erro .................................................................................................................................. 419
12.3.8.1. Introdução ...................................................................................................................................... 419
12.3.8.2. URL ................................................................................................................................................ 419
12.3.8.3. Exemplo URL ................................................................................................................................. 419
12.3.8.4. Permissões ................................................................................................................................... 420
12.3.8.5. Cabeçalho ..................................................................................................................................... 420
12.3.8.6. Envio ............................................................................................................................................. 420
12.3.8.7. Retorno Sucesso ........................................................................................................................... 420
12.3.8.8. Retorno Erro ................................................................................................................................. 420
12.3.9. GetCartaCorrecao ............................................................................................................................... 420
12.3.9.1. Introdução ..................................................................................................................................... 420
12.3.9.2. URL ................................................................................................................................................ 421

Página 64 de 452
12.3.9.3. Exemplo URL ................................................................................................................................. 421
12.3.9.4. Permissões .................................................................................................................................... 421
12.3.9.5. Cabeçalho ...................................................................................................................................... 421
12.3.9.6. Envio .............................................................................................................................................. 421
12.3.9.7. Retorno Sucesso ............................................................................................................................ 421
12.3.9.8. Retorno Erro ................................................................................................................................. 422
12.3.10. Consulta Log da NF-e ....................................................................................................................... 422
12.3.10.1. Introdução.................................................................................................................................... 422
12.3.10.2. URL.............................................................................................................................................. 422
12.3.10.3. Exemplo URL .............................................................................................................................. 423
12.3.10.4. Permissões .................................................................................................................................. 423
12.3.10.5. Cabeçalho ................................................................................................................................... 423
12.3.10.6. Envio ............................................................................................................................................ 423
12.3.10.7. Retorno Sucesso ......................................................................................................................... 424
12.3.10.8. Layout Retorno ........................................................................................................................... 424
12.3.10.9. Retorno Erro ............................................................................................................................... 424
12.3.11. Consulta Listagem de NF-e ............................................................................................................... 424
12.3.11.1. Introdução..................................................................................................................................... 424
12.3.11.2. URL............................................................................................................................................... 425
12.3.11.3. Exemplo URL ............................................................................................................................... 425
12.3.11.4. Permissões ................................................................................................................................... 425
12.3.11.5. Cabeçalho .................................................................................................................................... 426
12.3.11.6. Envio ............................................................................................................................................. 426
12.3.11.7. Retorno Sucesso .......................................................................................................................... 426
12.3.11.8. Layout Retorno ............................................................................................................................ 426
12.3.11.9. Retorno Erro ................................................................................................................................ 428
13. LISTAGEM DE ERROS.................................................................................................................................... 429
14. EXEMPLO DE COMO UTILIZAR O WEBSERVICE ......................................................................................... 429
14.1. OBSERVAÇÕES GERAIS ............................................................................................................................ 429

Página 65 de 452
14.2. UTILIZANDO A EXTENSÃO REST CLIENT DO FIREFOX ......................................................................... 430

14.2.1. Como informar os dados? ................................................................................................................... 430
14.2.2. Exemplo de POST ................................................................................................................................ 431
14.2.3. Exemplo de GET ................................................................................................................................. 432
15. PROGRAMA EXEMPLO EM JAVA.................................................................................................................. 432
16. RELAÇÃO DE MUDANÇAS DE VERSÕES DO MANUAL .............................................................................. 433
| SUPORTE TÉCNICO ............................................................................................................................................. 452

Página 66 de 452
INTRODUÇÃO
O módulo Webservice da Solução MASTERSAF DFE V3 é baseado em requisições REST. Utilizamos dois tipos de
requisições: POST e GET. Todas as requisições podem ser feitas com tipo de autenticação = Basic Authentication
ou Bearer Token, basic exige um usuário e senha informados e bearer exige um token. Por enquanto estamos
aceitando os dois tipos de autenticação, mas no futuro desejamos manter somente bearer token.
As requisições do tipo POST exigem algum conteúdo (Request Body). É através desse conteúdo que a
requisição será processada.
Nas requisições do tipo GET não é necessário informar nenhum conteúdo, pois na própria URL serão passados
os parâmetros.
O produto DFE utiliza o padrão JSON para compartilhamento dos dados dos documentos via integração
webservice. JSON segue a RFC 7159 (https://tools.ietf.org/html/rfc7159). Na RFC explica que JSON não possui
ordem nos campos, portanto, o software que for ler os dados nesse padrão deve ignorar a posição dos campos
e apenas observar a estrutura no qual os campos devem estar organizados.
Nos arquivos de exemplos que serão mostrados a seguir, a ordem dos campos podem ser alteradas, tanto no
envio (POST) quanto na consulta (GET). Por isso a leitura deve ser feita pelo campo, e não de forma posicional.
Atenção: Estamos construindo uma nova base de conhecimento no Apiary, que é uma plataforma de
documentação de API, no link: https://mastersafdfev3.docs.apiary.io/
Sendo assim, alguns métodos poderão ser consultados neste link.

Página 67 de 452
AUTENTICAÇÃO
A autenticação do webservice do DF-e permite dois tipos: Basic Authentication ou Bearer Token.
Na Basic Authentication é passado usuário e senha do usuário de integração cadastrado.
Já a Bearer Token, foi criada para trazer mais segurança à comunicação e autenticação com o Webservice, não
utilizamos o protocolo OAuth 2.0, mas implementamos alguns conceitos do protocolo OAuth 2.0, como a
autenticação em duas fases e a utilização de token para conceder acesso aos recursos da aplicação, sem a
necessidade de expor dados do usuário, como login e senha, do lado da aplicação cliente.
A autenticação via Bearer Token, será feita utilizando uma chave de acesso gerada pelo portal. Esta chave será
enviada ao endpoint de login para obter um token de acesso JWT. De posse deste token, todas as requisições
seguintes (até a hora de expiração do token) poderão ser feitas utilizando este token.
Nos cabeçalhos dos métodos especificados neste manual, estão com o tipo: “Basic Authentication”, porém,
implementamos recentemente o tipo “Bearer Token” e está opção já pode ser utilizada. Futuramente iremos
avaliar a desativação da opção basic authentication.
Mais detalhes para autenticação por token podem ser consultados no link: FAQ - Autenticação no Webservice
DFe via Token

Página 68 de 452
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

• 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 serão mostrados no response da consulta também.
No response existem 2 atributos que podem ser utilizados:
• 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.
O maxResults deve ser um valor numérico entre 1 e 100. Caso seja omitido será utilizado o valor padrão: 10.
Atenção: a paginação passa a existir no método getListagem a partir da versão 3.95.1 e no getLog a partir da
versão 3.96.1.

Página 69 de 452
1. MÓDULO NFSE (SERVIÇO)
1.1. 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.
1.2. MÉTODO: POST
1.2.1. EnviarPacote
1.2.1.1. Introdução
Método utilizado para enviar RPSs ao WebService.
1.2.1.2. URL
<host>:<port>/<webservice>/api/dfe
1.2.1.3. Exemplo 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)

Página 70 de 452
1.2.1.4. Layout
CAMPO DESCRIÇÃO CONTEÚDO OBRIG

Action Ação solicitada “EnviarPacote” Sim
Conteúdo do RPS. Informar dados do RPS conforme layout padrão
txt_conteudo Sim
do produto.
*Outras tags informadas não serão utilizadas, portanto, não as informe.
1.2.1.5.Permissões
Permissões conforme cadastro de usuários:

• NFS-e Integrador (ROLE_INTEGRADOR)
• Administrar o sistema (ROLE_SUPER_ADMIN)
* O usuário informado na requisição deve possuir ao menos uma destas permissões.
1.2.1.6. Cabeçalho
Detalhes que devem ser informados na requisição:

• “Basic Autentication”: Para todos os requests é preciso usar basic authentication utilizando o usuário e
a senha fornecidos.
• “Content-type”: “application/json”.
1.2.1.7. Envio
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 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__|).
Exemplo de Request Body conforme arquivo de exemplo: nfse_request_post_enviar_pacote.txt
1.2.1.8. Retorno Sucesso
Response Body: {“result”:”OK”}

Http status: 202

Página 71 de 452
1.2.1.9. Retorno Erro
Response Body: {“result”:”<descrição do erro>“}

Http status: 400, 412, 500.
*Consultar título LISTAGEM DE ERROS para maiores informações sobre os erros.
1.2.2. Cancelar
Método para cancelar RPSs enviados ao webservice.
1.2.2.2. URL

ou
1.2.2.4. Layout
CAMPO DESCRIÇÃO CONTEÚDO OBRIG.

action Ação solicitada “Cancelar” Sim
Conteúdo do Cancelamento de RPS. Informar dados do RPS
txt_conteudo Sim
conforme layout padrão do produto.
1.2.2.5. Permissões


Página 72 de 452
1.2.2.6. Cabeçalho

a senha fornecidos.
1.2.2.7. Envio
separador de campos do conteúdo é o pipe ( | ).
Exemplo de Request Body conforme arquivo de exemplo: nfse_request_post_cancelar.tx
Body: {“result”:”OK”}
Http status: 200 (Solicitação enviada com sucesso)

Http status: 400, 412, 500.
1.2.3. MarcarConsultado
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.
1.2.3.2. URL

Página 73 de 452

ou
1.2.3.4. Layout

action Ação solicitada “MarcarConsultado” Sim
Listagem de ids dos processamentos a serem marcados como
ids Sim
consultados.

1.2.3.6. Cabeçalho

a senha fornecidos.
1.2.3.7. Envio
O corpo do POST (request body) deve ser um json contendo uma tag “action” e uma tag “ids” com uma
lista de ids com RPSs a serem marcados.
Exemplo de Request Body conforme arquivo de exemplo: nfse_request_post_marcar_consultado.txt

Página 74 de 452


Http status: 412, 500.
1.2.4. ConsultarRpssAguardandoDownload
Método para consultar RPSs que estão com status de aguardando download no portal. Serão retornados
os arquivos que devem ser utilizados nos portais das prefeituras.
1.2.4.2. URL
url: <host>:<port>/<webservice>/api/dfe

ou
1.2.4.4. Layout

action Ação solicitada “ConsultarRpssAguardandoDownload” Sim
Informar referência da empresa a ser “<CNPJ>_<IM>“:
referencia Sim
consultada. “00910509000171_12345678”

Página 75 de 452

1.2.4.6. Cabeçalho

a senha fornecidos.
1.2.4.7. Envio
O corpo do POST (request body) deve ser um json contendo uma tag “action” e uma tag “referencia” com a
informação “<CNPJ>_<IM>“.
Exemplo de Request Body conforme arquivo de exemplo:
nfse_request_post_consultar_rpss_aguardando_download.txt
Response Body: {“formatoArquivo”:”“,”body”:”“,”result”:”OK”}

1.2.4.9. Layout Retorno
CAMPO DESCRIÇÃO
formatoArquivo Formato do arquivo que está sendo retornado: TXT ou XML
body Conteúdo do arquivo.
result “OK”. Confirmação da operação.
*Consultar arquivo de exemplo: nfse_response_post_consultar_rpss_aguardando_download.txt

Página 76 de 452

Http status: 400, 412, 500.
1.2.5. UploadRetornoPrefeitura
No campo referencia informar na estrutura: <CNPJ>_<IM>#<nome arquivo de retorno>.xml
1.2.5.2. URL

ou
1.2.5.4. Layout

action Ação solicitada “UploadRetornoPrefeitura” Sim
Informar: <CNPJ>_<IM>#<nome “00910509000171_12345678 #joinville-rps
referencia Sim
arquivo de retorno>.xml 3arquivo_retorno_prefeitura_joinville.xml”
Conteúdo do arquivo recebido da
txt_conteudo prefeitura para ser atualizado no
software.

Página 77 de 452

1.2.5.6. Cabeçalho

a senha fornecidos.
1.2.5.7. Envio
O corpo do POST (request body) deve ser um json contendo todos os campos do layout do método.
nfse_request_post_upload_retorno_prefeitura.txt


Http status: 400, 412, 500.

Página 78 de 452
1.2.6. Convertida
Método para consultar RPS já autorizados e que já foram marcadas como consultados.
<host>:<port>/<webservice>/api/dfe/convertida
NOTA: Esse método foi descontinuado (a partir da versão 3.106.1) e deve ser usado o getStatus (tópico
1.3.3. GetStatus (com parâmetros)) para substituí-lo.
1.2.7. NumeroRPS
Método para consultar a numeração RPS que deve ser utilizada no arquivo de integração do Portal DFE
para uma determinada Série. Ao realizar a requisição pode-se fornecer uma série previamente cadastrada
no Controle de Numeração RPS. Caso não informada a Série, será retornada a numeração do controle
padrão, também previamente cadastrada. A cada requisição o número RPS retornado será incrementado.
1.2.7.2. URL
<host>:<port>/<webservice>/api/dfe/numerorps
http://localhost:8080/webservice/api/dfe/numerorps (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/dfe/numerorps (ambiente de homologação do SaaS)
1.2.7.4. Layout

Lista de campos que
txt_conteudo Dados do RPS para consulta. servirão de filtro para o Sim
RPS.
cnpjPrestador Atributo de txt_conteudo. CNPJ do Prestador. Sim

Página 79 de 452
inscricaoEstadualPres Atributo de txt_conteudo. Inscrição Estadual do

Não
tador Prestador.
Atributo de txt_conteudo. Inscrição Municipal
inscricaoPrestador Sim
do Prestador.
Atributo de txt_conteudo. Série do controle de
serieRps Não
numeração RPS já cadastrada no Portal.
*Caso a inscrição estadual do prestador esteja em branco e seja necessário utilizar esta informação
como filtro, utilizar a notação “inscricaoEstadualPrestador”:””, conforme arquivo exemplo
“nfse_request_post_numerorps_2.txt”.

1.2.7.6. Cabeçalho

a senha fornecidos.
1.2.7.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: nfse_request_post_numerorps.txt
Response Body: {“ids”:[],”rpss”:[]}

Http status: 200

Página 80 de 452
CAMPO DESCRIÇÃO
Série fornecida na requisição POST. Caso não seja fornecida nenhuma Série está será a Série
serierps
padrão do prestador.
numerorps Número da RPS a ser utilizado no arquivo de integração.
*Consultar arquivo de exemplo: nfse_response_numerorps.txt


Http status: 400.
1.2.8. EnviarPacoteAgrupar
Método utilizado para enviar RPSs via Webservice para a funcionalidade Agrupamento.
1.2.8.2. URL

ou
1.2.8.4. Layout

action Ação solicitada “EnviarPacoteAgrupar” Sim
Conteúdo do RPS. Informar dados do RPS conforme
txt_conteudo Sim
layout padrão do produto. Os campos NumeroRPS e

Página 81 de 452
SerieRPS não são obrigatórios, e o campo docNum passa

a ser obrigatório.
1.2.8.5.Permissões

1.2.8.6. Cabeçalho

a senha fornecidos.
1.2.8.7. Envio
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__|).
Exemplo de Request Body conforme arquivo de exemplo: nfse_request_post_enviar_pacote_agrupar.txt

Http status: 202

Http status: 400, 412, 500.

Página 82 de 452
1.3. MÉTODO: GET
1.3.1. Consulta Padrão
Método para obter os retornos dos documentos enviados e a lista de documentos não consultados.
1.3.1.2. URL
1.3.1.3. Filtro de Série, CNPJ Prestador e Quantidade de Resultados (maxResults)
Pode ser informado os parâmetros de Série NF-e, CNPJ Prestador e MaxResults para realizar filtro na
busca. Quando não informada quantidade no parâmetro maxResults, será considerada a quantidade de
50 (cinquenta) results para cada consulta.

ou
http://localhost:8080/webservice/api/dfe/serie=TR5,171,A02&cnpj=57036351000213,78917809000179?
maxResults=100 (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/dfe/serie=TR5,171,A02&cnpj=57036351000213,78917809000179?
maxResults=100 (ambiente de homologação do SaaS)


Página 83 de 452
1.3.1.6. Cabeçalho

a senha fornecidos.
1.3.1.7. Envio
Nenhum dado além do cabeçalho deverá ser informado.
Response Body: {“retorno”:{“ids”:[],”rpss”:[]}}

Http status: 200
ID CAMPO DESCRIÇÃO PAI

A01 Retorno Conteúdo do retorno. Possui uma lista dos IDs dos processamentos Raiz
e uma listagem de seus respectivos RPSs.
B01 Ids Listagem dos IDs dos processamentos. A01
C01 Rpss Listagem dos RPSs. A01
C02 Nota Item da listagem dos RPSs. Possui os dados de cada um dos C01
documentos retornados.
D01 aliquotaServicos Alíquota do serviço prestado C02
D02 idProcessamentoLote ID interno do DFE para controle do processamento do Lote do RPS. C02
D03 numeroProtocolo Número do Protocolo disponibilizado pela Prefeitura C02
D04 numeroNfe Número da NFS-e C02
D05 tipoRetorno Corresponde ao fluxo da transação: C02
1. Emissão,
2. Cancelamento.
D06 situacaoRps Situação do RPS C02
D07 siafiPrestador Código SIAFI da cidade da declaração C02
D08 valorIss Valor do ISS C02
D09 serieRps Série do RPS C02

Página 84 de 452
D10 tipoAmbienteSistema Tipo do Ambiente que a nota foi processada C02

D11 dataEmissaoRps Data e Hora de Emissão C02
D12 descricaoStatus Descrição do Status da última transação C02
D13 numeroLote Número do Lote C02
D14 valorDeduzir Valor das deduções para Redução da Base de Cálculo C02
D15 codigoVerificacao Código de Verificação, gerado para identificação da NFS-e C02
D16 cnpjPrestador Número do CNPJ do Prestador do Serviço C02
D17 numeroRps Número do RPS C02
D18 tipoRps Tipo de RPS C02
D19 codCidade Município do Prestador - Código do IBGE. C02
D20 Status Código do Status da última transação C02
D21 docNum Número para identificar o documento C02
D22 codigoCancelamento Código de Verificação, gerado para identificação da NFS-e C02
cancelada
D23 dataAprovacao Data e Hora de Aprovação da Nota fiscal C02
D24 dataCancelamento Data e Hora de Cancelamento da Nota Fiscal C02
D25 inscricaoPrestador Inscrição Municipal do Prestador que emitiu a NFSe C02
D26 valorServicos Valor dos serviços em R$ C02
D27 urlConsulta Link da Nota Fiscal No site da prefeitura C02
D28 idProcessamentoRps ID interno do DFE para controle do processamento do RPS. C02
C03 Referencia Retorna valor conforme enviado na integração do documento. C01
Exemplo: o integrador TXT utiliza para armazenar o nome do
arquivo enviado para integração da respectiva nota.
*Observações:
• Maiores detalhes sobre os campos de retorno de nota consulte a planilha de integração TXT;
• Os campos em negrito nesse layout de retorno são exclusivos do layout de integração webservice,
atualmente não estão disponíveis no layout TXT de NFS-e;
• A situação do documento deve ser analisada somando o conteúdo dos campos “tipoRetorno” +
“status”. Por exemplo: tipoRetorno = 2 + status = 200 significa que a tentativa de cancelamento
foi rejeitada, além de que a nota voltou para o status de aprovada. Caso o status fosse igual a 101
então a nota estaria Cancelada.
No método GET, os resultados dos campos numéricos retornarão sem aspas, demais campos serão
retornados entre aspas (‘ ’).

Página 85 de 452
**Consultar arquivo de exemplo: nfse_response_get.txt
Não há.

Página 86 de 452
1.3.2. GetRPS
Método para obter o PDF de uma RPS.
1.3.2.2. URL
<host>:<port>/<webservice>/api/dfe/getRPS?cnpj=<cnpj>&im=<insc.
municipal>&serie=<série>&numero<númerp RPS>
http://localhost:8080/webservice>/api/dfe/getRPS?cnpj=<cnpj>&im=<insc.
municipal>&serie=<série>&numero<númerp RPS> (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/dfe/getRPS?cnpj=<cnpj>&im=<insc.
municipal>&serie=<série>&numero<número RPS> (ambiente de homologação do SaaS)

• NFS-e Integrador (ROLE _INTEGRADOR)
1.3.2.5. Cabeçalho

a senha fornecidos.
1.3.2.6. Envio

Página 87 de 452
Response Body: retornará um array de bytes (byte[]). Esse retorno terá de ser escrito em disco com
extensão “.pdf”.
Http status: 200

Http status: 203, 404, 500.
1.3.3. GetStatus (com parâmetros)
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.
Conforme informado no tópico INTRODUÇÃO, estamos construindo uma nova base de conhecimento no
Apiary, que é uma plataforma de documentação de API, no link: https://mastersafdfev3.docs.apiary.io/
Sendo assim, este método poderá ser consultado neste link.
2. MÓDULO NFE (MERCANTIL)
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. Com isso,
basta realizar POST para enviar os pacotes e GET para consultar o resultado do processamento. O corpo do

Página 88 de 452
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.
2.2. MÉTODO: POST
2.2.1. EnviarPacote
Método para envio de NF-es para serem autorizadas pela Sefaz correspondente.
2.2.1.2. URL
<host>:<port>/<webservice>/api/nfe
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)
2.2.1.4. Layout

Referencia Nome do arquivo utilizado na integração. Não
txt_conteudo Grupo de informação da NF-e Sim
Conteúdo do XML de Emissão da NF-e.
• Formato TXT: Informar dados conforme layout padrão TXT de
Emissão de NF-e (layout/planilha está disponível no Web
Xml Help > Manuais Técnicos > Integração de Dados DFE > Sim
Mastersaf_Layout_DFe_V3_NFe_NFCe).
• Formato XML: Informar dados do NF-e conforme layout XML
padrão da Receita Federal.
Informações para contingência, parâmetros para filtro de
Mastersaf Não
impressão e outros parâmetros.

Página 89 de 452
id_integrador Nome do integrador responsável pelo envio do documento. Não

Grupo mastersaf é composto de:

OBRIG
CAMPO DESCRIÇÃO CONTEÚDO
.
Informar o valor
"4.03" ou “4.04”.
Caso não seja
informado, será
versaoLayoutDfe Fica dentro de mastersaf. Versão do layout DFE considerada a Não
versão "4.00",
ficando sujeito a
rejeição pela
SEFAZ.
Fica dentro de mastersaf. Grupo com informações de
contingencias contingencia. Caso emissão em contingência externa, Não
caso contrário não informar.
Fica dentro de mastersaf. Grupo com informações do
Responsável Técnico pelo sistema de emissão do
Documento Fiscal eletrônico. Se enviar informações de
responsável técnico tanto na tag do xml como neste Preencher caso
grupo, serão consideradas as informações do grupo desejar informar
"mastersaf". Se não enviar no grupo um Responsável
"mastersaf"("resptec") irá gerar o conforme enviado no Técnico que não
resptec xml. seja da Thomson Não
Caso seja preenchido o grupo de informações de Reuters. Função
Responsável Técnico na integração e no cadastro do disponível apenas
Grupo de Empresa o parâmetro “Informar Resp. para integração
Técnico nos Documentos” estiver como Sim, o grupo TXT
“infRespTec” é gerado no XML com os dados
informados na integração. (Função disponível apenas
para integração TXT);
Fica dentro de mastersaf. Grupo de parâmetros de
parametros Não
controle de impressão e filtro.

Página 90 de 452
Ao incluir o
parâmetro, mesmo
que em branco (""),
é assumido como
integracaoXml Fica dentro de mastersaf. Parâmetro integração xml. TRUE, o correto é Não
não enviar o
parâmetro caso não
seja integração
XML.
Ao incluir o
parâmetro, mesmo
que em branco (""),
é assumido como
TRUE, o correto é
Fica dentro de mastersaf. Parâmetro integração de
xmlLegado não enviar o Não
xml legado.
parâmetro caso
não seja legado.
Arquivo deve conter
tag <nfeProc> se
existir o parâmetro.
Exemplo:
"mastersaf":{"resptec":{"respTecCnpj":"23622719000160","respTecContato":"Teste","respTecEmail":"respons
avel.tecnico@teste.com","respTecFone":"4730473148","respTecIdCsrt":"01","respTecCsrt":"ljKblriAsJArzTsbP
mrV6gi25SU="}, "integracaoXml": "TRUE", "xmlLegado": "TRUE"}
Grupo contingencias:
OBRIG
.
cnpjEmissor Cnpj do emissor. Não
Serie Série da Nota. Não
numeroNota Número da Nota. Não
Caso o campo
dataEntrada Início da entrada em contingência tpEmis = Sim
contingência, este

Página 91 de 452
campo se torna
obrigatório.
dataSaida Término da saída de contingência Não

Caso o campo
tpEmis =
Motivo Motivo de contingência contingência, este Sim
campo se torna
obrigatório.
Informar o código
110140 somente
para emissão EPEC.
cEvento Código do evento de emissão EPEC (110140) Para outras Não
contingências,
deixar este campo
vazio.
Exemplo:
"mastersaf":{"contingencias":[{"cnpjEmissor":"35402759000188","serie":"335","numeroNota":"32336","dataE
ntrada":"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"}]}
Grupo resptec:
OBRIG
.
Informar o CNPJ da pessoa jurídica responsável pelo
respTecCnpj sistema utilizado na emissão do documento fiscal Não
eletrônico.
Informar o nome da pessoa a ser contatada na
respTecContato empresa desenvolvedora do sistema utilizado na Não
emissão do documento fiscal eletrônico.
Informar o e-mail da pessoa a ser contatada na
respTecEmail Não
empresa desenvolvedora do sistema.

Página 92 de 452
Informar o telefone da pessoa a ser contatada na

respTecFone empresa desenvolvedora do sistema. Preencher com o Não
Código DDD + número do telefone.
Identificador do código de segurança do responsável
respTecIdCsrt Não
técnico
respTecCsrt Código de Segurança do Responsável Técnico Não
Exemplo:
"mastersaf":{"resptec":{"respTecCnpj":"23622719000160","respTecContato":"Teste","respTecEmail":"respons
avel.tecnico@teste.com","respTecFone":"4730473148","respTecIdCsrt":"01","respTecCsrt":"ljKblriAsJArzTsbP
mrV6gi25SU="}}
Grupo parametros:
OBRIG
.
ordemEmbarque Número da ordem de embarque Não
Nome da impressora que será utilizada para imprimir
dsImpressora Não
está NF-e.
nrItens Total de itens Não
Campo livre para uso interno. Os dados informados
neste campo não serão enviados à SEFAZ e não serão
campoUsoInterno exibidos no DANFE. Não
Permitirá refinar os dados via busca Avançada no
Portal.
usuarioEmitente Nome do usuário que emitiu a nota no ERP. Não
Define se o documento será enviado para o Printer.
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
enviaPrinter Não
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", "

Página 93 de 452
ordemEmbarque " e "nomenclaturaArquivos” serão

ignorados.
Nomenclatura específica para os arquivos PDF e XML
gravados pelo Printer. O valor neste campo será
nomenclaturaArqui utilizado para compor a nomenclatura dos arquivos
Não
vos PDF e XML.
Caso não seja preenchido, os arquivos serão gravados
no formato padrão
Exemplo:
"mastersaf":{"parametros":[{"ordemEmbarque":"123456","dsImpressora":"HP
5440","nrItens":"1","campoUsoInterno":"testeCampo uso Interno","usuarioEmitente":"Walter White",
"enviaPrinter":"1", "nomenclaturaArquivos":"nomeArquiNFe"}]}

• NF-e Integrador (ROLE_NFE_INTEGRADOR)
2.2.1.6. Cabeçalho

a senha fornecidos.
2.2.1.7. Envio
nfe_request_post_enviar_pacote_1.txt
Caso necessite de contingencia na origem preencher o atributo “mastersaf”, exemplo:

Página 94 de 452
nfe_request_post_enviar_pacote_2.txt, nfe_request_post_enviar_pacote_3.txt,
nfe_request_post_enviar_pacote_4.txt e nfe_request_post_enviar_pacote_5.txt
Caso necessite informar o Responsável Técnico deixando o DF-e calcular o hash, exemplo:
Caso necessite informar o Responsável Técnico com o hash já calculado, exemplo:


Http status: 202

Http status: 400, 412, 500.
2.2.2. Cancelar
Método para cancelar NF-es enviados ao webservice.
2.2.2.2. URL

ou

Página 95 de 452
2.2.2.4. Layout

referencia Nome do arquivo de integração Não
txt_conteudo Grupo de informações de cancelamento. Sim
Conteúdo do Cancelamento de NF-e.
Cancelamento de NF-e (layout/planilha está disponível no Web
Help > Manuais Técnicos > Integração de Dados DFE >
xml Sim
• Formato XML: Informar dados conforme layout padrão XML de
Cancelamento de NF-e (layout/planilha está disponível no zip do
manual de integração webservice).

2.2.2.6. Cabeçalho

• “Basic Autentication”: Para todos os requests é preciso usar basic authentication utilizando o
usuário e a senha fornecidos.
2.2.2.7. Envio
txt_conteudo é posicional separado por “;” (ponto-e-virgula).
Exemplo de Request Body conforme arquivo de exemplo: nfe_request_post_cancelar.txt

Página 96 de 452


Http status: 400, 412, 500.
2.2.3. Inutilizar
Método para inutilizar numerações de NF-es que ainda não foram utilizadas.
2.2.3.2.URL

ou

Página 97 de 452
2.2.3.4. Layout

action Ação solicitada. “Inutilizar” Sim
referencia Nome do arquivo de integração. Não
txt_conteudo Grupo de informações de inutilização. Sim
Conteúdo da Inutilização de NF-e.
Inutilização de NF-e (layout/planilha está disponível no Web Help
> Manuais Técnicos > Integração de Dados DFE >
xml Sim
Inutilização de NF-e (layout/planilha está disponível no zip do
manual de integração webservice).

2.2.3.6. Cabeçalho

a senha fornecidos.
2.2.3.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: nfe_request_post_inutilizar.txt

Página 98 de 452


Http status: 400, 412, 500.
2.2.4. EnviarCartaCorrecaoNfe
Método para emitir cartas de correção para NF-es já autorizadas.
2.2.4.2. URL

ou

Página 99 de 452
2.2.4.4. Layout

“EnviarCarta
action Ação solicitada Sim
CorrecaoNfe”
txt_conteudo Grupo de informações de carta de correção. Sim
Conteúdo da Carta de Correção de NF-e.
Carta de Correção de NF-e (layout/planilha está disponível no
Web Help > Manuais Técnicos > Integração de Dados DFE >
xml Sim
Carta de Correção de NF-e (layout/planilha está disponível no
zip do manual de integração webservice).

2.2.4.6. Cabeçalho

a senha fornecidos.
2.2.4.7. Envio
txt_conteudo é posicional separado por “;”(ponto-e-virgula).

Página 100 de 452

nfe_request_post_enviar_carta_correcao_nfe.txt


Http status: 400, 412, 500.
2.2.5.2. URL

ou

Página 101 de 452
2.2.5.4. Layout

Listagem de ids dos processamentos a serem marcados
ids Sim
como consultados.
Nome do integrador responsável pelo envio do
id_integrador Não
documento.

2.2.5.6. Cabeçalho

a senha fornecidos.
2.2.5.7. Envio
O corpo do POST (request body) deve ser um json contendo uma tag “action” e uma tag “ids”.
Exemplo de Request Body conforme arquivo de exemplo: nfe_request_post_marcar_consultado.txt


Página 102 de 452

2.2.6. MarcarImpresso
Método para indicar ao WebService que determinados documentos já foram impressos e não precisam
os documentos para que devem ser enviados para o Printer imprimir (getImpressao).
2.2.6.2. URL

ou
2.2.6.4. Layout

action Ação solicitada “MarcarImpresso” Sim
ids Grupo de informações para marcar como impresso. Sim
idProcessamento Id do processamento a ser marcado. Sim
idNota Id da nota a ser marcada. Sim

• NF-e Integrador (ROLE_NFE_INTEGRADOR);
• Administrar o sistema (ROLE_SUPER_ADMIN).

Página 103 de 452
2.2.6.6. Cabeçalho

a senha fornecidos.
2.2.6.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: nfe_request_post_marcar_impresso.txt


2.2.7. MarcarCartaCorrecaoImpresso
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.
2.2.7.2. URL

Página 104 de 452

ou
2.2.7.4. Layout

“MarcarCarta
Action Ação solicitada Sim
CorrecaoImpresso”
Ids Grupo de informações para marcar como impresso. Sim
idNota Id da CCe a ser marcada. Sim

2.2.7.6. Cabeçalho

a senha fornecidos.
2.2.7.7. Envio
nfe_request_post_marcar_carta_correcao_impresso.txt

Página 105 de 452


2.2.8. ReimpressaoDanfe
Método para solicitar reimpressão de NF-es.
2.2.8.2. URL

ou
2.2.8.4. Layout

action Ação solicitada “Reimpressao Danfe” Sim
txt_conteudo Grupo de informações de reimpressão. Sim
Conteúdo da solicitação de Reimpressão de NF-e.
xml Sim
Informar dados conforme layout padrão do produto.

Página 106 de 452

2.2.8.6. Cabeçalho

a senha fornecidos.
2.2.8.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: nfe_request_post_reimpressao_danfe.txt


Http status: 400, 412, 500.
2.2.9. Consultar Cadastro
Método para envio de Consultas de Cadastros pela Sefaz correspondente.

Página 107 de 452
2.2.9.2. URL

ou
2.2.9.4. Layout

action Ação solicitada “ConsultarCadastro” Sim
referencia Nome do arquivo utilizado na integração. Não
txt_conteudo Grupo de informação da consulta. Sim
Conteúdo da Consulta do Cadastro conforme layout padrão
xml Sim
do produto.
2.2.9.5. Detalhamento campo 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 Caractere 14
Inscrição Estadual da para o qual será retornado a 0-14
IE Caractere
empresa. consulta.
UF à qual se destina a 2
UF_pesquisa Caractere
consulta.
Inscrição Estadual a ser 0-14
IE_pesquisa Caractere
consultada. Somente um dos campos
CNPJ_pesquisa CNPJ a ser consultado. deve ser preenchido. Caractere 14
CPF_pesquisa CPF a ser consultado. Caractere 11
--consulta_cadastro
_fim-- --arquivo_fim--

Página 108 de 452

2.2.9.7. Cabeçalho

a senha fornecidos.
2.2.9.8. Envio

Http status: 202

Http status: 400, 412, 500.
2.2.10. EnviarEmail
Método para solicitar o envio/reenvio de email de uma NFe autorizada ou cancelada.

Página 109 de 452
2.2.10.2. URL

ou
2.2.10.4. Layout

action Ação solicitada “EnviarEmail” Sim
txt_conteudo Grupo de informação da consulta Sim
2.2.10.5. Detalhamento campo txt_conteudo

cnpj CNPJ do emissor da NFe Obrigatório Numérico 14
ie Inscrição Estadual do emissor da NFe Obrigatório Caractere 2-14
serie Série da NFe Obrigatório Numérico 1-3
numero Número da NFe Obrigatório Numérico 1-9
Documentos que serão enviados em anexo no e-mail. Se Opcional 0-1
não informado, por padrão será enviado “XML e PDF”. 1 – XML e PDF
anexo 2 – XML Numérico
3 – PDF
4 – Nenhum
Endereço de e-mail do destinatário. Poderá ser 0-1000
informado mais de um endereço separado por vírgula.
endereco_ Se não informado: será enviado para o endereço de e-
Opcional Caractere
email mail existente na NFe.
Se informado: será enviado somente para este(s)
endereço(s) de e-mail.

Página 110 de 452

2.2.10.7. Cabeçalho

a senha fornecidos.
2.2.10.8. Envio
O corpo do POST (request body) deve ser um json contendo todos os campos do layout do método, assim
como o txt_conteudo deve ser um json contendo todos os campos do detalhamento.

Http status: 200

Http status: 400, 412, 500.
2.2.11. Pedido de Prorrogação ICMS
Método para solicitar a prorrogação da suspensão do ICMS para 1° prazo (cód. 111500) e 2° prazo (cód.
111501), de uma NFe autorizada.

Página 111 de 452
2.2.11.2. URL

ou
2.2.11.4. Layout

“EnviarPedido
Prorrogacao”
txt_conteudo Grupo de informações do Pedido de Prorrogação. Sim
Conteúdo do Pedido de Prorrogação de ICMS de NF-e.
Pedido de Prorrogação de NF-e (layout/planilha está disponível
no Web Help > Manuais Técnicos > Integração de Dados DFE >
xml Sim
Pedido de Prorrogação de NF-e (layout/planilha está disponível
no zip do manual de integração webservice).


Página 112 de 452

a senha fornecidos.
2.2.11.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: nfe_request_post_pedido_prorrogacao_.txt


Http status: 400, 412, 500.
2.2.12. Pedido de Cancelamento de Prorrogação ICMS
Método para solicitar o cancelamento da prorrogação da suspensão do ICMS para 1° prazo (cód. 111502) e
2° prazo (cód. 111503), de uma NFe autorizada.
2.2.12.2. URL

Página 113 de 452

ou
2.2.12.4. Layout

“EnviarCancelamento
Action Ação solicitada Sim
Pedido Prorrogacao”
txt_conteudo Grupo de informações do Pedido de Prorrogação. Sim
Conteúdo do Cancelamento do Pedido de Prorrogação
de ICMS da NF-e.
• Formato TXT: Informar dados conforme layout padrão
TXT de Cancelamento do Pedido de Prorrogação de
NF-e (layout/planilha está disponível no Web Help >
Xml Manuais Técnicos > Integração de Dados DFE > Sim
• Formato XML: Informar dados conforme layout padrão
XML de Cancelamento do Pedido de Prorrogação de
NF-e (layout/planilha está disponível no zip do manual
de integração webservice).
id_integrador Não
documento.


Página 114 de 452

a senha fornecidos.
2.2.12.7. Envio
nfe_request_post_pedido_cancelamento_prorrogacao.txt


Http status: 400, 412, 500.
2.2.13. Consulta Chave Acesso Sefaz
Método para solicitar a consulta de uma chave de Acesso junto a Sefaz.
2.2.13.2. URL

Página 115 de 452

ou
2.2.13.4. Layout

Action Ação solicitada “ConsultarChaveSefaz” Sim
referencia Nome do arquivo de integração Sim
txt_conteudo Grupo de informações da consulta. Sim
Conteúdo da consulta de Chave de Acesso.
xml Sim
• Informar dados conforme layout padrão TXT.
id_integrador Identificação do App responsável pela integração Não

--consulta_chave_sefaz_ini --
ChaveAcesso Chave de Acesso Numérico 44
CNPJ CNPJ Identificação da empresa Numérico 14
que será considerada para 0-14
IE Inscrição Estadual realização da consulta Caractere
(parâmetros/certificado).
--consulta_chave_sefaz_fim --
--arquivo_fim--


Página 116 de 452
• O Usuário informado na requisição tem que estar vinculado a empresa informada.

2.2.13.7. Condições/Observações
• O campo Inscrição Estadual 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.
• 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.
• Solicitações de Consulta de Chave de Acesso serão excluídas após 24 horas, independente se a consulta
junto a Sefaz tenha sido realizada ou não. Esse job de exclusão será executado todos os dias às 01:30
AM.

a senha fornecidos.
2.2.13.9. Envio
nfe_request_post_consulta_chave_sefaz.txt


Http status: 400, 412, 500.
2.2.14. Comprovante de Entrega

Página 117 de 452
Método para enviar o evento de Comprovante de Entrega de uma NFe autorizada.
2.2.14.2. URL

ou
2.2.14.4. Layout

“EnviarEntrega
Nfe”
txt_conteudo Grupo de informações do Comprovante de Entrega. Sim
Conteúdo do Comprovante de Entrega de NF-e.
Comprovante de Entrega de NF-e (layout/planilha está
disponível no Web Help:
xml Mastersaf_Layout_DFe_V3_NFe_Comprovante_Entrega). Sim
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).

Página 118 de 452


a senha fornecidos.
2.2.14.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: nfe_request_post_comprovante_entrega.txt


Http status: 400, 412, 500.
2.2.15. Cancelamento de Comprovante de Entrega
Método para solicitar o cancelamento do Comprovante de Entrega de NF-e, autorizado.
2.2.15.2. URL

Página 119 de 452

ou
2.2.15.4. Layout

action Ação solicitada “CancelarEntregaNfe” Sim
txt_conteudo Grupo de informações do Comprovante de Entrega. Sim
Conteúdo do Cancelamento do 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
Xml Sim
).
• 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).
id_integrador Não
documento.


Página 120 de 452

a senha fornecidos.
2.2.15.7. Envio
nfe_request_post_cancelamento_comprovante_entrega.txt


Http status: 400, 412, 500.
2.3. MÉTODO: GET
Método para obter os retornos dos documentos enviados, lista de documentos não consultados, dados de
lotes inutilizados, dados de cartas de correção emitidas e os documentos que devem ser enviados para o
Printer imprimir.

Página 121 de 452
2.3.1.2. URL
2.3.1.3. Definir quantidade de Results da consulta:
<host>:<port>/<webservice>/api/nfe?maxResults=
Quando informada quantidade no parâmetro, será considerada a quantidade máxima de results para cada
lista e grupo de retorno (impressao[], impressaoCce[], retorno{...}).
Quando não informada quantidade no parâmetro, será considerada a quantidade de 50 (cinquenta)
results para cada lista e grupo de retorno (impressao[], impressaoCce[], retorno{...}).

ou
http://localhost:8080/webservice/api/nfe?maxResults=100 (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/nfe?maxResults=100 (ambiente de homologação do SaaS)

2.3.1.6. Cabeçalho

a senha fornecidos.

Página 122 de 452
2.3.1.7. Envio
Response Body:
{
“impressao”: [],
“impressaoCCe”: [],
“retorno”: {
“loteCartaCorrecao”: [],
“consultaCadastro”: [],
“nfes”: [],
“ids”: [],
“loteInutilizado”: [],
“loteEventoProrrogacaoIcmsRespostaFisco”: [],
“loteEventoProrrogacaoIcms”:[],
“passagemPortariaNfe”:[],
“eventosDistribuicao”:[]
}
} Http status: 200
CAMPO DESCRIÇÃO
Impressao Lista documentos para impressão.
impressaoCce Lista documentos de Carta de Correção para impressão.
idProcessamento Atributo de “impressao”. Id do processamento.
params Atributo de “impressao”. Parâmetros de impressão.
retorno Grupo de informações para geração dos arquivos de retorno.
Atributo de “retorno”. Listagem dos IDs dos processamentos que constam
ids
como não consultados.
Atributo de “retorno”. Listagem dos retornos das NF-es que foram
nfes
processadas pelo software.

Página 123 de 452
Atributo de “retorno”. Listagem dos retornos das Cartas de Correção

loteCartaCorrecao
enviadas.
loteInutilizado Atributo de “retorno”. Listagem dos retornos das Inutilizações enviadas.
Atributo de “retorno”. Listagem dos retornos dos Pedidos de Prorrogação
loteEventoProrrogacaoIcms
ICMS, primeiro retorno, SEFAZ.
loteEventoProrrogacaoIcms Atributo de “retorno”. Listagem dos retornos dos Pedidos de Prorrogação
Resposta Fisco ICMS, segundo retorno, FISCO.
consultaCadastro Atributo de “retorno”. Listagem dos retornos das Consultas de Cadastro.
Atributo de “retorno”. Contém a listagem das pesquisas de Saída de
passagemPortariaNfe
Mercadoria em processamento.
Atributo de “retorno”. Contém a listagem dos eventos recebidos pelo
eventosDistribuicao
Webservice Distribuição.
DETALHAMENTO DE CAMPOS ESPECÍFICOS DO LAYOUT RETORNO

CAMPO DESCRIÇÃO
Disponibilizamos o link para abertura do DANFE.
Este novo campo deverá ser preenchido somente nos retornos em que o status de NF-e
permita a impressão de DANFE (Autorizada ou Cancelada).
Para funcionamento da geração do link do DANFE, o preenchimento do campo “URL de
nfes.nota.url acesso ao portal” da tela Administração do Sistema > Extrato do Sistema torna-se
DanfePortal obrigatório.
Para a visualização do DANFE o usuário deverá ter a permissão “NF-e Visualizar”
habilitada em seu perfil.
Exemplo: nfes”:[{“nota”:{“urlDanfePortal”:”https://h.dfe.mastersaf.com.br
/mvc/nfe/pdf/visualizarDanfe/12345”

Página 124 de 452
Disponibilizamos o link para abertura do PDF da Carta de Correção.

Este novo campo será preenchido somente nos retornos em que o status da Carta de
Correção permita a impressão do PDF (Autorizada).
Para funcionamento da geração do link do PDF CC-e, o preenchimento do campo “URL de
PdfCcePortal obrigatório.
Para a visualização do PDF CC-e o usuário deverá ter a permissão “NF-e Visualizar”
Exemplo:nfes”: [{“nota”:{“urlPdfCcePortal”:”https://h.dfe.mastersaf.com.br/mvc
/nfe/pdf/cartaCorrecao/12345”
*Consultar arquivo de exemplo: nfe_response_get.txt e nfe_response_get_cadastro.txt
Não há.
2.3.2. GetXml
Método para obter o XML processado da respectiva chave de NF-e. XML processado se refere ao xml
completo retornado pela sefaz, de notas autorizadas.
2.3.2.2. URL
<host>:<port>/<webservice>/api/nfe/<chave nfe>/getXml
http://localhost:8080/webservice/api/nfe/<chave nfe>/getXml (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/nfe/<chave nfe>/getXml (ambiente de homologação do SaaS)

Página 125 de 452

2.3.2.5. Cabeçalho

• “Content-type”: “application/json; charset=ISO-8859-1”. Para o xml retornar com a codificação
correta.
2.3.2.6. Envio

Response Body: XML processado.

Http status: 200
Consultar arquivo de exemplo: nfe_response_get_xml.txt

Http status: 203, 404, 500.
2.3.3. GetXmlCancelamento
Método para obter o XML cancelado da respectiva chave de NF-e.

Página 126 de 452
2.3.3.2. URL
<host>:<port>/<webservice>/api/nfe/<chave nfe>/getXmlCancelamento
http://localhost:8080/webservice/api/nfe/<chave nfe>/getXmlCancelamento
(instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/nfe/<chave nfe>/getXmlCancelamento
(ambiente de homologação do SaaS)

2.3.3.5. Cabeçalho

a senha fornecidos.
• “Content-type”: “application/json; charset=ISO-8859-1”. Para o xml retornar com a codificação correta.
2.3.3.6. Envio
Response Body: XML de cancelamento processado.

Http status: 200
Consultar arquivo de exemplo: nfe_response_get_xml_cancelado.txt

Página 127 de 452

Http status: 203, 404, 500.
2.3.4. GetDanfe
Método para obter o DANFE da respectiva chave de NF-e.

2.3.4.2. URL
<host>:<port>/<webservice>/api/nfe/<chave nfe>/getDanfe
http://localhost:8080/webservice/api/nfe/<chave nfe>/getDanfe (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/nfe/<chave nfe>/getDanfe (ambiente de homologação do SaaS)

2.3.4.5. Cabeçalho

a senha fornecidos.
2.3.4.6. Envio

Página 128 de 452
Http status: 200
Para ambiente SaaS: O danfe gerado tem como base o parâmetro “Formato de Impressão” (módulo NF-e)
do cadastro da empresa, porém, se houver cadastro de customização em “Grupo de Empresas >
Documentos Customizados” para o módulo, grupo da empresa e tipo de documento, o parâmetro do
cadastro de empresa será desconsiderado e passará a valer apenas a customização de documento
cadastrada no grupo de empresa.

Http status: 203, 404, 500.
2.3.5. GetXmlCartaCorrecao
Método para obter a última Carta de Correção da respectiva chave de NF-e.

2.3.5.2. URL
<host>:<port>/<webservice>/api/nfe/<chave nfe>/getXmlCartaCorrecao
http://localhost:8080/webservice/api/nfe/<chave nfe>/getXmlCartaCorrecao (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/nfe/<chave nfe>/getXmlCartaCorrecao (ambiente de
homologação do SaaS)

Página 129 de 452

2.3.5.5. Cabeçalho

a senha fornecidos.
correta.
2.3.5.6. Envio

Http status: 200
Consultar arquivo de exemplo: nfe_response_get_xml_carta_correcao.txt

Http status: 203, 404, 500.
2.3.6. GetCartaCorrecao
Método para obter a última Carta de Correção da respectiva chave de NF-e.

Página 130 de 452
2.3.6.2. URL
<host>:<port>/<webservice>/api/nfe/<chave nfe>/getCartaCorrecao
http://localhost:8080/webservice/api/nfe/<chave nfe>/getCartaCorrecao (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/nfe/<chave nfe>/getCartaCorrecao (ambiente de homologação do
SaaS)

2.3.6.5. Cabeçalho

a senha fornecidos.
2.3.6.6. Envio
Http status: 200

Página 131 de 452
Para ambiente SaaS: O pdf gerado é padrão, porém, se houver cadastro de customização em Grupo de
Empresas > Documentos Customizados para o módulo, grupo da empresa e tipo de documento, o parâmetro
do cadastro de empresa será desconsiderado e passará a valer apenas a customização de documento
cadastrada no grupo de empresa.

Http status: 203, 404, 500.
2.3.7. GetStatus
Método para obter o Status (Código-Descrição) da respectiva chave de NF-e. 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.
2.3.7.2. URL
<host>:<port>/<webservice>/api/nfe/<chave nfe>/getStatus

Página 132 de 452
http://localhost:8080/webservice/api/nfe/<chave nfe>/ getStatus (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/nfe/<chave nfe>/ getStatus (ambiente de homologação do SaaS)

2.3.7.5. Cabeçalho

a senha fornecidos.
2.3.7.6. Envio
Response Body:
{
"retorno": {
"loteCartaCorrecao": [],
"consultaCadastro": [],
"nfes": [],
"ids": [],
"loteInutilizado": []
}
}
Http status: 200

Página 133 de 452
CAMPO DESCRIÇÃO
ids Atributo de “retorno”. Não será preenchido.
Atributo de “retorno”. Listagem dos retornos das NF-es.Caso localizado será retornado
nfes
o documento consultado.
Atributo de “retorno”. Listagem dos retornos das Cartas de Correção do documento
loteCartaCorrecao
consultado.
Atributo de “retornoListagem dos retorno de Inutilizações. Será preenchido se o
loteInutilizado
documento consultado estiver inutilizado.
consultaCadastro Atributo de “retorno”. Não será preenchido.
*Consultar arquivo de exemplo: nfe_response_getStatus.txt.

Http status: 203, 404, 500.
Método para obter o Status (Código-Descrição) de NF-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.
2.3.8.2. URL
<host>:<port>/<webservice>/api/nfe/getStatus

Página 134 de 452
2.3.8.3. Filtro de CNPJ Emissor, Número da NF-e e Série da NF-e
É necessário informar os parâmetros de CNPJ Emissor, Número NF-e e Série NF-e para realizar a busca.
Todos os parâmetros são obrigatórios.
http://localhost:8080/webservice/api/nfe/getStatus?cnpjEmissor=1234567890&numeroNfe=1000&serie
=730 (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/nfe/getStatus?cnpjEmissor=1234567890&numeroNfe=1000&serie
=730 (ambiente de homologação do SaaS)

2.3.8.6. Cabeçalho

a senha fornecidos.
2.3.8.7. Envio

Response Body:
{
"retorno": {
"loteCartaCorrecao": [],

Página 135 de 452
"consultaCadastro": [],
"nfes": [],
"ids": [],
"loteInutilizado": []
}
}
Http status: 200

CAMPO DESCRIÇÃO
Atributo de “retorno”. Listagem dos retornos das NF-es. Caso localizado será
nfes
retornado o documento consultado.
Atributo de “retorno”. Listagem dos retornos das Cartas de Correção do documento
loteCartaCorrecao
consultado.
Atributo de “retorno”. Listagem dos retorno de Inutilizações. Será preenchido se o
loteInutilizado
consultaCadastro Atributo de “retorno”. Não será preenchido.
*Consultar arquivo de exemplo: nfe_response_getStatus_com_parametros.txt.

Http status: 203, 404, 500.
2.3.9. Consulta Retorno
lotes inutilizados e dados de cartas de correção.
2.3.9.2. URL

Página 136 de 452
<host>:<port>/<webservice>/api/nfe/getRetorno
2.3.9.3. Definir quantidade de Results da consulta
<host>:<port>/<webservice>/api/nfe/getRetorno?maxResults=
results para cada consulta.
2.3.9.4. Filtro de Série
Para filtrar a consulta pela série, a mesma deverá ser enviada na URL. Se houver mais de uma, separá-las
por vírgula.
2.3.9.5. Exemplo URL com filtro
http://localhost:8085/webservice/api/nfe/getRetorno/serie=700
ou
http://localhost:8085/webservice/api/nfe/getRetorno/serie=700,701,703
http://localhost:8085/webservice/api/nfe/getRetorno/serie=700?maxResults=100
ou
http://localhost:8085/webservice/api/nfe/getRetorno/serie=700,701,703?maxResults=100
2.3.9.6. Exemplo URL sem filtro
http://localhost:8080/webservice/api/nfe/getRetorno (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/nfe/getRetorno (ambiente de homologação do SaaS)
http://localhost:8080/webservice/api/nfe/getRetorno?maxResults=100 (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/nfe/getRetorno?maxResults=100 (ambiente de homologação do
SaaS)


Página 137 de 452

2.3.9.8. Cabeçalho

a senha fornecidos.
2.3.9.9. Envio
Response Body: {retorno”:{“loteCartaCorrecao”:[],”nfes”:[],”ids”:[],”loteInutilizado”:[],”

loteEventoProrrogacaoIcms”:[],”loteEventoProrrogacaoIcmsRespostaFisco”:[], “passagemPortariaNfe”:[],
“eventosDistribuicao”:[]}}
Http status: 200

Página 138 de 452
CAMPO DESCRIÇÃO
Retorno Grupo de informações para geração dos arquivos de retorno.
Atributo de “retorno”. Listagem dos IDs dos processamentos que constam como
Ids
não consultados.
Atributo de “retorno”. Listagem dos retornos das NF-es que foram processadas
Nfes
pelo software.
loteCartaCorrecao Atributo de “retorno”. Listagem dos retornos das Cartas de Correção enviadas.
loteEventoProrrogacao Atributo de “retorno”. Listagem dos retornos de Pedido de Prorrogação de ICMS,
Icms SEFAZ.
loteEventoProrrogacao Atributo de “retorno”. Listagem dos retornos de Pedido de Prorrogação de ICMS,
IcmsRespostaFisco FISCO.
Atributo de “retorno”. Contém a listagem das pesquisas de Saída de Mercadoria
passagemPortariaNfe
em processamento.
Atributo de “retorno”. Contém a listagem dos eventos recebidos pelo Webservice
eventosDistribuicao
Distribuição.
*Consultar arquivo de exemplo: nfe_response_getRetorno.txt
Não há.
2.3.10. Consulta Impressão
Método para obter os retornos dos documentos que devem ser enviados para o Printer imprimir.
2.3.10.2. URL
<host>:<port>/<webservice>/api/nfe/getImpressao

Página 139 de 452
http://localhost:8080/webservice/api/nfe/getImpressao (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/nfe/getImpressao (ambiente de homologação do SaaS)


a senha fornecidos.
2.3.10.6. Envio
Response Body: {“impressao”:[], “impressaoCCe”:[]}

Http status: 200
CAMPO DESCRIÇÃO
impressaoCCe Lista de eventos de carta de correção para impressão.
Params Atributo de “impressao”. Parâmetros de impressão.
*Consultar arquivo de exemplo: nfe_response_getImpressao.txt

Página 140 de 452
Não há.
2.3.11. Consulta Impressão NFe
Método para obter apenas os retornos dos documentos 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.
2.3.11.2. URL
<host>:<port>/<webservice>/api/nfe/getImpressaoNfe
http://localhost:8080/webservice/api/nfe/getImpressaoNfe (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/nfe/getImpressaoNfe (ambiente de homologação do SaaS)


a senha fornecidos.

Página 141 de 452
2.3.11.6. Envio
Response Body: {“impressao”:[]}

Http status: 200
CAMPO DESCRIÇÃO
*Consultar arquivo de exemplo: nfe_response_getImpressaoNfe.txt
Não há.
2.3.12. Consulta Impressão Carta Correção NFe
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.
Sendo assim, este método foi movido para essa nova ferramenta.
2.3.13. Consulta Log da NF-e

Página 142 de 452
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 todos 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.
2.3.13.2. URL
<host>:<port>/<webservice>/api/nfe/getLog?cnpj=<número cnpj>&ie=<número inscrição

estadual>&serie=<série da NF-e>&numero=<número da NF-e>
A partir da versão 3.96.1, passa a ser:
<host>:<port>/<webservice>/api/nfe/getLog?cnpj=<número cnpj>&ie=<número inscrição

estadual>&serie=<série da NF-e>&numero=<número da NF-
e>&offset=<offset>&maxResults=<maxResults>
Sendo assim, este método pode ser consultado neste link.
http://localhost:8080/webservice/api/nfe/getLog?cnpj=00910509000171&ie=0018000282&serie=450&
numero=10006&offset=0&maxResults=10 (instalação in house)
ou

Página 143 de 452
https://ws.h.dfe.mastersaf.com.br/api/nfe/getLog?cnpj=00910509000171&ie=0018000282&serie=450&
numero=10006&offset=0&maxResults=10 (ambiente de homologação do SaaS)


a senha fornecidos.
2.3.13.6. Envio
Response Body:
{“result”:[], “message”:”OK”, “hasMore”: false , “count”: 10, “maxResults”: 10, “offset”: 0}
Http status: 200
CAMPO DESCRIÇÃO
Result Atributo de resultado

Result\dataHora Data e Hora do log, formato “DD/MM/AAAA HH:MM:SS”
Result\status Código do status do log
Result\historico Descrição do log
Result\stackTrace Conteúdo do stackTrace quando existir

Página 144 de 452
message “OK”
Indica se há mais uma página a ser buscada para os filtros informados.
hasMore
true ou false.
count Quantia total de itens para os filtros informados.
maxResults Quantidade de objetos por página, informada nos parâmetros.
Posição do objeto a partir do qual a página deve ser carregada,
offset
informada nos parâmetros.
*Consultar arquivo de exemplo: nfe_response_get_log.txt
Não há.

Página 145 de 452
2.3.14. Consulta Listagem de NF-e
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.
2.3.14.2. URL
<host>:<port>/<webservice>/api/nfe/getListagem?cnpj=<número cnpj>&ie=<número inscrição

estadual>&periodoInicial=<período inicial DD/MM/AAAA HH:MM>&periodoFinal=<período final
DD/MM/AAAA HH:MM>&offset=<offset>&maxResults=<maxResults>&infoAdicionais=<true ou false>
A partir da versão 3.95.1 o intervalo entre período inicial e período final terá como limite 31 dias.
http://localhost:8080/webservice/api/nfe/getListagem?cnpj=00910509000171&ie=0018000282&period
oInicial=01/12/2016 00:00&periodoFinal=13/03/2017 00:00&offset=0&maxResults=10 (instalação in
house)&infoAdicionais=false
ou
https://ws.h.dfe.mastersaf.com.br/api/nfe/getListagem?cnpj=00910509000171&ie=0018000282&perio
doInicial=01/12/2016 00:00&periodoFinal=13/03/2017
00:00&offset=0&maxResults=10&infoAdicionais=false (ambiente de homologação do SaaS)


Página 146 de 452

a senha fornecidos.
2.3.14.6. Envio

Response Body: {“result”:[], “message”:”OK”, “hasMore”: false , “count”: 10, “maxResults”: 10, “offset”: 0}
Http status: 200
Layout resumido (infoAdicionais = false):

CAMPO DESCRIÇÃO
Situação da NF-e (Autorizado, Cancelado, Rejeitado, Inutilizado,
Result\situação
Denegado, Rejeitado, Erro)
Result\tipoEmissao Tag <tpEmis> do XML da NF-e
Result\chaveAcesso Chave de Acesso da NF-e
Result\dataAutorizacao Tag <dhRecbto> do XML de Autorização da NF-e
Result\cnpjEmissor Tag <CNPJ> do emissor do XML da NF-e
Result\valorTotal Tag <vNF> do XML da NF-e
Result\serie Tag <serie> do XML da NF-e
Result\cpfCnpjDest Tag <CNPJ> do destinatário do XML da NF-e
Result\dataEmissao Tag <dhEmi> do XML da NF-e
Result\numeroNfe Tag <nNF> do XML da NF-e
Result\status Status da nota
message “OK”
Indica se há mais uma página a ser buscada para os filtros
hasMore
informados. true ou false.

Página 147 de 452

maxResults Quantidade de objetos por página informada nos parâmetros.
offset
*Consultar arquivo de exemplo: nfe_response_get_listagem_resumido.txt
Layout com informações adicionais (infoAdicionais = true):

CAMPO DESCRIÇÃO
Result\tipoNfe Tag <tpNF> do XML da NF-e
Result\cpfCnpjTransportador Tag <CNPJ> da transportadora do XML da NF-e
Result\tipoFrete Tag <modFrete> do XML da NF-e
Result\municipioDest Tag <xMun> do destinatário do XML da NF-e
Result\cfop Tag <CFOP> do XML da NF-e
Result\naturezaOperacao Tag <natOp> do XML da NF-e
Result\pesoBruto Tag <pesoB> do XML da NF-e
Result\valorTransporte Tag <vServ> do transporte do XML da NF-e
Descrição do Status da NF-e. Em caso de status Rejeição, haverá a
Result\descricaoSituacao
descrição da rejeição
Result\placaVeiculoTransportador Tag <placa> do transportador do XML da NF-e
Result\codigoAntt Tag <RNTC> do transportador do XML da NF-e
Result\ufPlaca Tag <UF> da placa do transportador do XML da NF-e
Result\ufTrans Tag <UF> do transportador do XML da NF-e
Result\razaoSocialDest Tag <xNome> do destinatário do XML da NF-e
Result\enderecoTrans Tag <xEnder> da transportadora do XML da NF-e
Result\dataSaida Tag <dhSaiEnt> do XML da NF-e
Result\situação
Result\razaoSocialEmissor Tag <xNome> do emissor do XML da NF-e
Result\ufFornec Tag <UF> do emissor do XML da NF-e
Result\numeracaoVolume Tag <nVol> do XML da NF-e
Result\cepFornec Tag <CEP> do emissor do XML da NF-e

Página 148 de 452
Result\marca Tag <marca> do XML da NF-e

Result\protocolo Tag <nProt> do XML da NF-e
Result\qtdaVolume Tag <qVol> do XML da NF-e
Result\razaoSocialTrans Tag <xNome> da transportadora do XML da NF-e
Result\bairroFornec Tag <xBairro> do emissor do XML da NF-e
Result\municipioFornec Tag <xMun> do emissor do XML da NF-e
Result\ufDestinatario Tag <UF> do destinarário do XML da NF-e
Result\cepDest Tag <CEP> do destinatário do XML da NF-e
Result\bairroDest Tag <xBairro> do destinatário do XML da NF-e
Result\pesoLiquido Tag <pesoL> do XML da NF-e
Result\municipioTrans Tag <xMun> da transportadora do XML da NF-e
Result\enderecoFornec Tag <xLgr> do emissor do XML da NF-e
Result\enderecoDest Tag <xLgr> do destinatário do XML da NF-e
Result\especie Tag <esp> do XML da NF-e
Result\status Status da nota
Result\tipoEmissao Tag <tpEmis> do XML da NF-e
message “OK”
hasMore
offset
*Consultar arquivo de exemplo: nfe_response_get_listagem_infoadicionais.txt
Não há.
2.3.15. GetXmlInutilizacao

Página 149 de 452
Método para obter o XML de inutilização da respectiva NF-e.
2.3.15.2. URL
<host>:<port>/<webservice>/api/nfe/<cnpj emissor>/<serie nfe>/<numero nfe>/getXmlInutilizacao
http://localhost:8080/webservice/api/nfe/<cnpj emissor>/<serie nfe>/<numero nfe>/getXmlInutilizacao

ou
https://ws.h.dfe.mastersaf.com.br/api/nfe/<cnpj emissor>/<serie nfe>/<numero nfe>/getXmlInutilizacao


a senha fornecidos.
2.3.15.6. Envio
Response Body: XML de inutilização processado.

Página 150 de 452
Http status: 200

Consultar arquivo de exemplo: nfe_response_get_xml_inutilizacao.txt

Http status: 203, 404, 500.
2.3.16. GetEventos
Método de consulta para retornar a listagem dos eventos recebidos da NF-e, apresentados na aba “Outros
Eventos” do detalhamento da NF-e. O método irá retornar todos os eventos de uma única NF-e a cada
consulta, por isso o cliente deverá enviar como parâmetro a identificação da NF-e. Os eventos de
Cancelamento e Carta de Correção já tem Webservices próprios então não são listados nesse WS.
2.3.16.2. URL
<host>:<port>/<webservice>/api/nfe/<chave>/getEventos
http://localhost:8080/webservice/api/nfe/35191235999759000999956160000408171000010049/getE
ventos (instalação in house)
ou

Página 151 de 452
https://ws.h.dfe.mastersaf.com.br/api/nfe/35191235999759000999956160000408171000010049/getE
ventos (ambiente de homologação do SaaS)

a senha fornecidos.
2.3.16.6. Envio
Response Body: {“message”:”OK”,”result”:[]}

Http status: 200
CAMPO DESCRIÇÃO
Message “OK”
Result\protocolo Número do protocolo
Result\sequencia Número sequencial do evento
Result\tipoEvento Código do tipo de evento
Result\dataHoraEvento Data e Hora do evento, formato “DD/MM/AAAA HH:MM:SS”
Result\descricaoEvento Descrição do evento
*Consultar arquivo de exemplo: nfe_response_get_eventos.txt

Página 152 de 452

Http status: 203, 404, 500.
2.3.17. GetRetornoConsultaChaveSefaz
Método para obter os retornos da Consulta de Chave de Acesso junto a Sefaz.
2.3.17.2. URL
<host>:<port>/<webservice>/api/nfe/getRetornoConsultaChaveSefaz
<host>:<port>/<webservice>/api/nfe/getRetornoConsultaChaveSefaz?maxResults=
http://localhost:8080/webservice/api/nfe/getRetornoConsultaChaveSefaz (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/nfe/getRetornoConsultaChaveSefaz (ambiente de homologação
do SaaS)
http://localhost:8080/webservice/api/nfe/getRetornoConsultaChaveSefaz?maxResults=100 (instalação
in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/nfe/getRetornoConsultaChaveSefaz?maxResults=100 (ambiente
de homologação do SaaS)

Página 153 de 452


a senha fornecidos.
2.3.17.7. Envio
Response Body: { "retorno": { "ids": [], "consultaChaveSefaz": [] } }

Http status: 200
CAMPO DESCRIÇÃO
Ids
não consultados.
Atributo de “retorno”. Listagem dos retornos da(s) Consulta(s) de Chave(s) de
consultaChaveSefaz
Acesso que foram processadas pelo DFE.
*Consultar arquivo de exemplo: nfe_response_getRetornoConsultaChaveSefaz.txt
2.2.17.10. Detalhamento campo consultaChaveSefaz
CAMPO DESCRIÇÃO
xDescricao Descrição da consulta de acordo com o status final.
chaveAcesso Chave de Acesso consultada junto a Sefaz.
cnpj CNPJ informado na solicitação da consulta.

Página 154 de 452
idProcessamento ID interno do DFE para controle do processamento da Consulta da Chave de Acesso.

xmlRetornoSefaz Conteúdo da tag “retConsSitNFe” do XML de retorno da consulta junto a Sefaz
referencia Conteúdo do campo referencia informado na solicitação da consulta.
Status final da consulta:
- Código 300 para indicar consulta finalizada com sucesso junto a Sefaz.
status
- Código 999 para indicar erro na consulta junto a Sefaz ou algum erro de
processamento pelo DFE.
Não há.
• As Consultas de Chave de Acesso solicitadas somente estarão disponíveis para retorno quando
processadas pelo DFE, ou seja, que a consulta junto a Sefaz tenha sido executada e finalizada, seja
com sucesso ou erro.
• Para o Usuário autenticado que utilizar este método, será considerado para um melhor controle dos
retornos a opção "Controlar retornos conforme usuário do integrador" do cadastro do Usuário.
Pode ser indicado ao WebService que as Consultas de Chave de Acesso já foram retornadas, pela
utilização do método MarcarConsultado (ítem 2.2.5), informando os ids dos processamentos a serem marcados
como consultados.
2.3.18. 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.
2.3.18.2. URL
<host>:<port>/<webservice>/api/nfe/getEventoEntrega

Página 155 de 452
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)

a senha fornecidos.
2.3.18.6. Envio

Http status: 200
CAMPO DESCRIÇÃO
ids
não consultados.
Atributo de “retorno”. Listagem dos retornos do(s) evento(s) de Comprovante de
loteEventoEntrega Entrega e Cancelamento do Comprovante de Entrega que foram processadas
pelo DFE.

Página 156 de 452
2.3.18.9. Detalhamento campo loteEventoEntrega
CAMPO DESCRIÇÃO
nProt Número do protocolo
nSeqEvento Número sequencial do evento
nomeArquivoRetorno Nome do arquivo
nNF Número da nota fiscal
chave Chave da nota
cStat Código do status retornado
Tipo do evento (tipoComprovanteEntrega ou
tipoComprovanteEntrega
tipoCancelamentoComprovanteEntrega)
serie Série da nota fiscal
dhRegEvento Data e Hora do evento, formato “AAAA-MM-DDTHH:MM:SS”
CNPJ CNPJ do emissor
IE IE do emissor
tpEvento Código do tipo de evento (110130 ou 110131)
*Consultar arquivo de exemplo: nfe_response_get_evento_entrega.txt
Não há.
3. MÓDULO CTE
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

Página 157 de 452
próxima consulta eles não sejam retornados novamente, também são retornados os CT-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.
Para enviar vários CT-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 inutilização
o procedimento é o mesmo.
3.2. MÉTODO: POST
3.2.1. EnviarPacote
Método para envio de CT-es para serem autorizadas pela Sefaz correspondente.
3.2.1.2. URL
<host>:<port>/<webservice>/api/cte
http://localhost:8080/webservice/api/cte (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/cte (ambiente de homologação do SaaS)
3.2.1.4. Layout

action Ação solicitada “EnviarPacote” Sim

Página 158 de 452
txt_conteudo Grupo de informações do CT-e Sim

Conteúdo do XML de CT-e. Informar dados conforme layout
xml Sim
config ** Configurações. Sim
Valores aceitos:
• true:
integração
é
considerada
como
xmlLegado Parâmetro integração de xml legado. Não
legado;
• false:
integração
não é
considerada
como
legado.
** Dentro do config, existe uma tag que deverá ser informada caso queira efetuar o envio de email automa
ticamente, sendo assim, deve ser preenchida a tag emailTomador com o email do tomador. Essa tag não é
obrigatória, devendo ser preenchida somente quando houver necessidade de envio de email automático.
Arquivo de Exemplo: cte_request_post_enviar_pacote_3.00.txt

• CT-e Integrador (ROLE_CTE_INTEGRADOR)
3.2.1.6. Cabeçalho

a senha fornecidos.

Página 159 de 452
3.2.1.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: cte_request_post_enviar_pacote_3.00.txt

Http status: 202

Http status: 400, 412, 500.
3.2.2. Cancelar
Método para cancelar CT-es enviados ao webservice.
3.2.2.2. URL

ou
3.2.2.4. Layout


Página 160 de 452

Conteúdo do Cancelamento de CT-e. Informar dados conforme
xml Sim
layout padrão da Receita Federal.
config Configurações. Sim

3.2.2.6. Cabeçalho

a senha fornecidos.
3.2.2.7. Envio
O corpo do POST (request body) deve ser um json contendo uma tag “action” e uma tag “txt_conteudo”.
Exemplo de Request Body conforme arquivo de exemplo: cte_request_post_cancelar_3.00.txt


Http status: 400, 412, 500.

Página 161 de 452
3.2.3. EnviarCartaCorrecaoCte
Método para emitir cartas de correção para CT-es já autorizadas.
3.2.3.2. URL

ou
3.2.3.5. Layout

action Ação solicitada “EnviarCartaCorrecaoCte” Sim

• CT-e Carta Correção (ROLE_CTE_CARTA_CORRECAO)
3.2.3.7. Cabeçalho

Página 162 de 452
a senha fornecidos.

Página 163 de 452
3.2.3.8. Envio
Exemplo de Request Body conforme arquivo de exemplo: cte_request_post_carta_correcao_3.00.txt


Http status: 400, 412, 500.
3.2.4. Inutilizar
Método para inutilizar numerações de CT-es que ainda não foram utilizadas.
3.2.4.2. URL

ou

Página 164 de 452
3.2.4.4. Layout

action Ação solicitada “Inutilizar” Sim
Conteúdo da Inutilização de CT-e. Informar dados conforme layout
xml Sim

3.2.4.6. Cabeçalho

a senha fornecidos.
3.2.4.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: cte_request_post_inutilizar_3.00.txt


Página 165 de 452

Http status: 400, 412, 500.
3.2.5.2. URL

ou
3.2.5.4. Layout

ids Sim
como consultados.


Página 166 de 452

3.2.5.6. Cabeçalho

a senha fornecidos.
3.2.5.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: cte_request_post_marcar_consultado.txt


3.2.6.2. URL

Página 167 de 452

ou
3.2.6.4. Layout


3.2.6.6. Cabeçalho

a senha fornecidos.
3.2.6.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: cte_request_post_marcar_impresso.txt

Página 168 de 452


3.2.7. MarcarCartaCorrecaoImpresso
Método para indicar ao WebService que determinadas 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.
3.2.7.2. URL

ou

Página 169 de 452
3.2.7.4. Layout

“MarcarCarta
CorrecaoImpresso”
idNota Id da CCe a ser marcada. Sim

• CT-e Integrador (ROLE_CTE_INTEGRADOR);
3.2.7.6. Cabeçalho

3.2.7.7. Envio
cte_request_post_marcar_carta_correcao_impresso.txt


Página 170 de 452

3.2.8. EnviarRegistroMultimodal
Método para envio de evento de registro de multimodal para CT-es já autorizadas.
3.2.8.2. URL

ou
3.2.8.4. Layout

action Ação solicitada “EnviarRegistroMultimodal” Sim
Grupo de informações do evento de registro de
txt_conteudo Sim
multimodal.


Página 171 de 452
3.2.8.6. Cabeçalho

a senha fornecidos.
3.2.8.7. Envio
separador de campos do “txt_conteudo” é o pipe ( | ). Para quebra de linha usa-se \n.
cte_request_post_registro_multimodal_3.00.txt


Http status: 400, 412, 500.
3.2.9. EnviarEntregaCte
Método para envio de evento de comprovante de entrega para CT-es já autorizadas.
3.2.9.2. URL

Página 172 de 452

ou
3.2.9.4. Layout

action Ação solicitada “EnviarEntregaCte” Sim
Grupo de informações do evento de
txt_conteudo Sim
comprovante de entrega

3.2.9.6. Cabeçalho

a senha fornecidos.
3.2.9.7. Envio
cte_request_post_entrega_3.00.txt

Página 173 de 452


Http status: 400, 412, 500.
3.2.10. CancelarEntregaCte
Método para envio de evento de cancelamento de comprovantes de entrega já autorizados.
3.2.10.2. URL

ou
3.2.10.4. Layout

action Ação solicitada “CancelarEntregaCte” Sim
txt_conteudo Sim
cancelamento de comprovante de entrega

Página 174 de 452


a senha fornecidos.
3.2.10.7. Envio
cte_request_post_canc_entrega_3.00.txt


Http status: 400, 412, 500.
3.2.11. SolicitarImpressao
Método para envio de solicitação de impressão de CT-e(s).

Página 175 de 452
3.2.11.2. URL

ou
3.2.11.4. Layout

action Ação solicitada “SolicitarImpressao” Sim
Grupo de informações com a(s) chave(s) de
chaveDeAces
acesso para solicitação de impressão do(s) CT- Sim
so
e(s)
Nome da impressora que será utilizada para
impressora Não
imprimir a(s) CT-e(s) solicitada(s)

Em Administração do Sistema > Mensagerias > Configuração da Mensageria > Editar Configuração
da Mensageria é necessário habilitar a função “Solicitação de Impressão via Webservice”, que por padrão
estará desabilitada. Caso esteja desabilitada, será possível efetuar a requisição, porém, o status retornado
na consulta será sempre de “em processamento”, mas o processamento só ocorrerá de fato quando a função
da mensageria for habilitada.

Página 176 de 452
1) Este método gera apenas a solicitação de impressão de CT-e. Regras de impressão do documento,
ordenação, permissão e demais validações de impressão, seguem as mesmas já definidas no DFE, por
exemplo quando solicitada a impressão automática na autorização do documento ou manualmente via
portal.
2) No momento em que a mensageria iniciar o processamento da requisição, será conferido se o usuário que
efetuou a requisição ainda existe na base de dados, caso não exista, será retornado status 999 na consulta.
3) Quando a mesma chave de acesso for informada mais de uma vez na mesma solicitação, será considerada
apenas como um documento/impressão.
4) Se informada impressora inválida, será efetuada tentativa de qualquer forma, e por fim será retornado
erro 771, de falha na impressão. Caso a impressora não seja informada, o printer irá utilizar a impressora
default da rota.
5) Os status de CTe que permitem impressão são os mesmos permitidos quando é impresso via portal:
Aprovado (100), Cancelado (101), Anulado (128), Substituído (129), Contingência (990), Aguardando
Impressão Contingência (440). Caso status não seja permitido para impressão será retornado status 732 na
consulta do documento.
6) Ao solicitar impressão da CTe vai registrar no log a mensagem: “Impressão do DACTE solicitada via
Webservice. (username)”. O status ficará como 720 no documento ao realizar consulta.
7) Antes de criar os processamentos, é verificado o parâmetro de quantidade de registros de requisição de

impressão que devem ser processados a cada consulta no banco
(dfe_config.QTDE_REGISTROS_PROCESSAMENTO_IMPRESSAO), por padrão e por questão de
performance configuramos como 100. SOMENTE deve ser alterado esse parâmetro após análise da
capacidade de processamento do ambiente do cliente.
Desta forma, a requisição é dividida em lotes para processamento quando o número de documentos
ultrapassar os 100, e será processado cada lote de uma vez, para que não onere os demais processamentos.
Exemplo: ao enviar uma requisição 200 documentos, serão criados dois lotes de 100 e será processado um
lote de cada vez até que a terminem os lotes relacionados àquela requisição.

Página 177 de 452
8)Solicitações de impressão serão excluídas após 7 dias (parâmetro

dfe_config.QTDE_DIAS_EXCLUSAO_SOLICITACAO_IMPRESSAO que determina a quantidade de dias para
exclusão dos registros de solicitação de impressão via webservice (de acordo com o campo data_requisicao
da tabela dfe_req_impressao_cte), independente do status atual da requisição. Default para este campo é 7.
Esse job de exclusão será executado todos os dias ás 02:00 AM.
9) Para que seja possível imprimir um documento, é verificada permissão do usuário no CTE correspondente
à chave de acesso, validando a empresa emitente da CTE contra os CNPJs(empresas) que o usuário possui
permissão: Se Administrador do Sistema (tem permissão total). Se usuário administrador do grupo (busca
empresas vinculadas ao grupo) ou se usuário comum (busca empresas emissoras habilitadas para o
usuário).

a senha fornecidos.
3.2.11.8. Envio
O corpo do POST (request body) deve ser um json contendo uma tag “action” e uma tag “chaveDeAcesso”
como obrigatórios, já o campo “impressora” não é obrigatório. O separador de chaves de acesso da tag
“chaveDeAcesso” é a vírgula(,).
Exemplo de Request Body no arquivo cte_request_post_solicitar_impressao.txt.
Será retornado um UUID (Universally Unique IDentifier – 128 bits), que pode ser utilizado posteriormente
para consulta do processamento da solicitação de impressão ou cancelamento. O UUID é também vinculado
ao usuário autenticado que efetuou a solicitação.
Response Body: {“result”:””, “uuid”:””}
Exemplo:
{“result”:”OK”, “uuid”:”4d0xb315-ass9–4fr2-aa61–3b11b9a9x701”}
Http status: 200

Página 178 de 452

Http status: 400, 412, 500.
As mensagens tratadas especificamente para este webservice para o status 412:
STATUS HTTP 412 (PRÉ-VALIDAÇÕES)

Mensagem Descrição
Layout do Campo Quando o preenchimento do campo chaveDeAcesso for
chaveDeAcesso inválido. inválido/incorreto.
Campo chaveDeAcesso não Quando não for preenchido o campo chaveDeAcesso.
informado.
Quantidade de registros de Foram informadas mais chaves de acesso na requisição do que o
chaveDeAcesso maior que o informado como limite de registros para impressão (parâmetro
permitido. dfe.config.MAX_REGISTROS_IMPRESSAO). Esse parâmetro tem
como default 5000 registros e somente deverá ser alterado após
análise da capacidade de processamento do ambiente do cliente.
3.2.11.11. Fluxo
No documento Fluxo_Webservice_SolicitaImpressão_CTE.pdf consta o desenho do funcionamento do

método.
3.2.12. CancelarImpressao
Método para cancelamento de uma solicitação de impressão de CT-e(s). Associada ao método

SolicitarImpressao.
3.2.12.2. URL

Página 179 de 452

ou
3.2.12.4. Layout

action Ação solicitada “CancelarImpressao” Sim
Informar UUID retornado na solicitação de
uuid Sim
impressão do(s) CT-e(s)

Em Administração do Sistema > Configuração da Mensageria > Editar Configuração da Mensageria

é necessário habilitar a função “Solicitação de Impressão via Webservice”, que por padrão estará
desabilitada. Caso esteja desabilitada, será possível efetuar a requisição, porém, o status retornado na
consulta será sempre de “em processamento”, mas o processamento só ocorrerá de fato quando a função
da mensageria for habilitada.
O usuário que está efetuando cancelamento deve ser o mesmo usuário que fez a requisição, caso
contrário, será retornado erro http 401.
1) Quando for solicitado um cancelamento e a requisição já estiver cancelada, será retornado erro
“Solicitação de Impressão já se encontra cancelada.” com status HTTP 400.

Página 180 de 452
2) Quando for solicitado um cancelamento e a requisição estiver com status de Erro (999), será retornado
erro “Solicitação de Impressão com Status de ERRO não permite cancelamento.” com status HTTP 400.
3) Solicitações de impressão serão excluídas após 7 dias (parâmetro

4) A requisição pode ficar com status cancelada, mas não quer dizer necessariamente que os documentos
também estejam com este status, é necessário conferir cada documento, pois já podem ter sido impressos
por exemplo, ou ter obtido algum erro.

a senha fornecidos.
3.2.12.8. Envio
O corpo do POST (request body) deve ser um json contendo os campos do layout do método.
Exemplo de Request Body no arquivo cte_request_post_cancelar_impressao.txt.
Http status 200

Response Body: {“result”:”” }
Exemplo:
{“result”:”OK”}

Http status: 400, 412, 500.

Página 181 de 452
As mensagens tratadas especificamente para este webservice para o status 412 e 400:

UUID inválido. UUID informado possui formato inválido.
UUID não localizado. UUID informado não foi localizado.

Solicitação de Impressão já se encontra cancelada. Quando a requisição que está sendo cancelada
já possui status de cancelada.
Solicitação de Impressão com Status de ERRO não Quando a requisição está com status de Erro
permite cancelamento. 999 não é permitido cancelamento.
3.2.12.11. Fluxo

método.
3.2.13. Consulta Chave Acesso Sefaz
Método para solicitar a consulta de uma chave de Acesso junto a Sefaz.
3.2.13.2. URL

ou

Página 182 de 452
3.2.13.4. Layout

Action Ação solicitada “ConsultarChaveSefaz” Sim
referencia Nome do arquivo de integração Sim
txt_conteudo Grupo de informações da consulta. Sim
xml Conteúdo da consulta de Chave de Acesso. Sim

__consulta_chave_sefaz_cte_ini__
chave Chave de Acesso Numérico 44
CNPJ CNPJ Identificação da empresa Numérico 14
que será considerada para 0-14
IE Inscrição Estadual realização da consulta Caractere
(parâmetros/certificado).
__consulta_chave_sefaz_cte_fim__
__arquivo_fim__

• O Usuário informado na requisição tem que estar vinculado a empresa informada.
• O campo Inscrição Estadual 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.
• 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.

Página 183 de 452
• Solicitações de Consulta de Chave de Acesso serão excluídas após 24 horas, independente se a consulta
junto a Sefaz tenha sido realizada ou não. Esse job de exclusão será executado todos os dias às 01:30
AM.

a senha fornecidos.
3.2.13.9. Envio
txt_conteudo é separado por “|” (pipe) e deve ser enviado chave de cada campo e valor.
cte_request_post_consulta_chave_sefaz.txt


Http status: 400, 412, 500.
3.3. MÉTODO: GET

Página 184 de 452
lotes inutilizados e os documentos que devem ser enviados para o Printer imprimir.
3.3.1.2. URL
<host>:<port>/<webservice>/api/cte?maxResults=
lista e grupo de retorno (impressao[], retorno{...}).
results para cada lista e grupo de retorno (impressao[], retorno{...}).

ou
http://localhost:8080/webservice/api/cte?maxResults=100 (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/cte?maxResults=100 (ambiente de homologação do SaaS)

3.3.1.6. Cabeçalho

a senha fornecidos.

Página 185 de 452
3.3.1.7. Envio

Response Body:
{“impressao”:[],”retorno”:{“loteCartaCorrecao”:[],”nfes”:[],”ids”:[],”loteInutilizado”:[]}}
Http status: 200
CAMPO DESCRIÇÃO
impressao Lista documentos para impressão.
Id Atributo de “impressao”. Id do processamento.
nota Atributo de “impressao”. Parâmetros da nota a ser impressa.
Atributo de “retorno”. Listagem dos IDs dos processamentos que constam como não
Ids
consultados.
Atributo de “retorno”. Listagem dos retornos das CT-es que foram processadas pelo
Ctes
software.
*Consultar arquivo de exemplo: cte_response_get_3.00.txt
Não há.
3.3.2. GetXml
Método para obter o XML processado da respectiva chave de CT-e.
3.3.2.3. URL

Página 186 de 452
<host>:<port>/<webservice>/api/cte/<chave cte>/getXml

Página 187 de 452
http://localhost:8080/webservice/api/cte/<chave cte>/getXml (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/cte/<chave cte>/getXml (ambiente de homologação do SaaS)

3.3.2.6. Cabeçalho

a senha fornecidos.
correta.
3.3.2.7. Envio

Http status: 200
Consultar arquivo de exemplo: cte_response_get_xml.txt

Http status: 203, 404, 500.

Página 188 de 452
Método para obter o XML cancelado da respectiva chave de CT-e.
3.3.3.2. URL
<host>:<port>/<webservice>/api/cte/<chave cte>/getXmlCancelamento
http://localhost:8080/webservice/api/cte/<chave cte>/getXmlCancelamento (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/cte/<chave cte>/getXmlCancelamento (ambiente de

3.3.3.5. Cabeçalho

a senha fornecidos.
correta.

Página 189 de 452
3.3.3.6. Envio

Http status: 200
Consultar arquivo de exemplo: cte_response_get_xml_cancelamento_3.00.txt

Http status: 203, 404, 500.
3.3.4. GetDacte
Método para obter o DACTE da respectiva chave de CT-e.
3.3.4.2. URL
<host>:<port>/<webservice>/api/cte/<chave cte>/getDacte
http://localhost:8080/webservice/api/cte/<chave cte>/getDacte (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/cte/<chave cte>/getDacte (ambiente de homologação do SaaS)


Página 190 de 452

3.3.4.5. Cabeçalho

a senha fornecidos.
3.3.4.6. Envio
Http status: 200

Http status: 203, 404, 500.
Método para obter o XML da última Carta de Correção da respectiva chave de CT-e.
3.3.5.2. URL
<host>:<port>/<webservice>/api/cte/<chave cte>/getXmlCartaCorrecao

Página 191 de 452
http://localhost:8080/webservice/api/cte/<chave cte>/getXmlCartaCorrecao (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/cte/<chave cte>/getXmlCartaCorrecao (ambiente de

3.3.5.5. Cabeçalho

a senha fornecidos.
correta.
3.3.5.6. Envio

Http status: 200
Consultar arquivo de exemplo: cte_response_get_xml_carta_correcao_3.00.txt

Http status: 203, 404, 500.

Página 192 de 452
Método para obter a última Carta de Correção da respectiva chave de CT-e.
3.3.6.2. URL
<host>:<port>/<webservice>/api/cte/<chave cte>/getCartaCorrecao
http://localhost:8080/webservice/api/cte/<chave cte>/getCartaCorrecao (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/cte/<chave cte>/getCartaCorrecao (ambiente de homologação do
SaaS)

3.3.6.5. Cabeçalho

a senha fornecidos.
3.3.6.6. Envio


Página 193 de 452
Http status: 200

Http status: 203, 404, 500.
3.3.7. GetStatus
Método para obter o STATUS da respectiva chave de CT-e. 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.
3.3.7.2. URL
host>:<port>/<webservice>/api/cte/<chave cte>/getStatus
http://localhost:8080/webservice/api/cte/<chave cte>/ getStatus (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/cte/<chave cte>/ getStatus (ambiente de homologação do SaaS)


Página 194 de 452

3.3.7.5. Cabeçalho

a senha fornecidos.
3.3.7.6. Envio
Response Body: {“retorno”:{“ctes”:[],”ids”:[],”loteInutilizado”:[]}}

Http status: 200
CAMPO DESCRIÇÃO
Atributo de “retorno”. Listagem dos retornos das CT-es. Caso localizado será retornado o
Ctes
documento consultado.
Ids Atributo de “retorno”. Listagem dos IDs dos processamentos (*somente para inutilizações).
loteInutilizado
*Consultar arquivo de exemplo: cte_response_getStatus.txt.

Página 195 de 452

Http status: 203, 404, 500.
Método para obter os retornos dos documentos enviados, lista de documentos não consultados e dados
de lotes inutilizados.
3.3.8.2. URL
<host>:<port>/<webservice>/api/cte/getRetorno
3.3.8.3. Definir quantidade de Results da consulta:
<host>:<port>/<webservice>/api/cte/getRetorno?maxResults=
por vírgula.
http://localhost:8085/webservice/api/cte/getRetorno/serie=700
ou
http://localhost:8085/webservice/api/cte/getRetorno/serie=700,701,703
http://localhost:8085/webservice/api/cte/getRetorno/serie=700?maxResults=100
ou

Página 196 de 452
http://localhost:8085/webservice/api/cte/getRetorno/serie=700,701,703?maxResults=100
http://localhost:8080/webservice/api/cte/getRetorno (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/cte/getRetorno (ambiente de homologação do SaaS)

3.3.8.8. Cabeçalho

a senha fornecidos.
3.3.8.9. Envio
Response Body: {“retorno”:{“loteCartaCorrecao”:[],”nfes”:[],”ids”:[],”loteInutilizado”:[]}}

Http status: 200

Página 197 de 452
CAMPO DESCRIÇÃO
Ids
consultados.
Atributo de “retorno”. Listagem dos retornos das CT-es que foram processadas pelo
Ctes
software.
*Consultar arquivo de exemplo: cte_response_getRetorno.txt
Não há.
3.3.9.2. URL
<host>:<port>/<webservice>/api/cte/getImpressao
http://localhost:8080/webservice/api/cte/getImpressao (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/cte/getImpressao (ambiente de homologação do SaaS)


Página 198 de 452
3.3.9.5. Cabeçalho

a senha fornecidos.
3.3.9.6. Envio
Response Body: {“impressao”:[], “impressaoCCe”:[]}

Http status: 200
CAMPO DESCRIÇÃO
impressoCCe Lista de eventos de carta de correção para impressão.
id Atributo de “impressao”. Id do processamento.
*Consultar arquivo de exemplo: cte_response_getImpressao.txt
Não há.
Método para obter o Status de uma CT-e apartir de um conjunto de filtros. Deve ser utilizado para obter

Página 199 de 452
finalizado.
3.3.10.2. URL
<host>:<port>/<webservice>/api/cte/getStatus
3.3.10.3. Filtro de CNPJ Emissor, Número da CT-e e Série da CT-e
É necessário informar os parâmetros de CNPJ Emissor, Número CT-e e Série CT-e para realizar a busca.
Todos os parâmetros acima são obrigatórios.
Existe também o parâmetro opcional “incluiXmlProc”, default é false, porém, caso seja informado como
true, no retorno da requisição será adicionado o campo “xmlProcessado”, que irá conter o xml processado
de autorização da nota ou de cancelamento.
http://localhost:8080/webservice/api/cte/getStatus?cnpjEmissor=1234567890&numeroCte=1000&serie
=730 (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/cte/getStatus?cnpjEmissor=1234567890&numeroCte=1000&serie
=730 (ambiente de homologação do SaaS)


Página 200 de 452

a senha fornecidos.
3.3.10.7. Envio

Http status: 200
CAMPO DESCRIÇÃO
Atributo de “retorno”. Listagem dos retornos das CT-es. Caso localizado será retornado o
ctes
ids Atributo de “retorno”. Listagem dos IDs dos processamentos. (*somente para inutilizações)
loteInutilizado
*Consultar arquivo de exemplo: cte_response_getStatus_com_parametros.txt.

Http status: 203, 404, 500.
3.3.11. Consulta Log do CT-e
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. Este método retorna uma

Página 201 de 452
3.3.11.2. URL
<host>:<port>/<webservice>/api/cte/getLog?cnpj=<número cnpj>&ie=<número inscrição

estadual>&serie=<série do CT-e>&numero=<número do CT-e>
<host>:<port>/<webservice>/api/cte/getLog?cnpj=<número cnpj>&ie=<número inscrição

estadual>&serie=<série do CT-e>&numero=<número do CT-
http://localhost:8080/webservice/api/cte/getLog?cnpj=00910509000171&ie=0018000282&serie=450&
numero=10006&offset=0&maxResults=10 (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/cte/getLog?cnpj=00910509000171&ie=0018000282&serie=450&
numero=10006&offset=0&maxResults=10 (ambiente de homologação do SaaS)

Página 202 de 452

• CT-e - Integrador (ROLE_CTE_INTEGRADOR)
* O usuário informado na requisição deve possuir esta permissão.

a senha fornecidos.
3.3.11.6. Envio

Http status: 200
CAMPO DESCRIÇÃO

Result\stackTrace Conteúdo do stackTrace quando existir, quando não existir será null.
message “OK”
Indica se há mais uma página a ser buscada para os filtros informados. true ou
hasMore
false.
Posição do objeto a partir do qual a página deve ser carregada, informada nos
offset
parâmetros.

Página 203 de 452
*Consultar arquivo de exemplo: cte_response_getLog.txt
Não há.
3.3.12. Consulta Listagem de CT-e
Método de consulta para retornar uma listagem de CT-e, irá retornar alguns dados principais de 1 ou N CT-
e por consulta. Este método retorna uma lista paginada com os documentos para os filtros informados.
Mais informações sobre paginação podem ser consultadas no tópico LISTAGEM E PAGINAÇÃO neste
documento.
3.3.12.2. URL
<host>:<port>/<webservice>/api/cte/getListagem?cnpj=<número cnpj>&ie=<número inscrição

DD/MM/AAAA HH:MM>
<host>:<port>/<webservice>/api/cte/getListagem?cnpj=<número cnpj>&ie=<número inscrição

DD/MM/AAAA HH:MM>&offset=<offset>&maxResults=<maxResults>

Página 204 de 452
http://localhost:8080/webservice/api/cte/getListagem?cnpj=00910509000171&ie=0018000282&period
oInicial=01/12/2016 00:00&periodoFinal=13/03/2017 00:00&offset=0&maxResults=10 (instalação in
house)
ou
https://ws.h.dfe.mastersaf.com.br/api/cte/getListagem?cnpj=00910509000171&ie=0018000282&period
oInicial=01/12/2016 00:00&periodoFinal=13/03/2017 00:00&offset=0&maxResults=10 (ambiente de


a senha fornecidos.
3.3.12.6. Envio
Http status: 200

Página 205 de 452
CAMPO DESCRIÇÃO

Result\situacao Status do CT-e
Result\valorTotalMercadoria Tag <infCarga>\<vCarga> do XML do CT-e
Result\valorTotalPrestacao Tag <vPrest>\<vTPrest> do XML do CT-e
Result\cnpjEmissor Tag <emit>\<CNPJ> do XML do CT-e
Result\cpfCnpjDest Tag <dest>\<CNPJ> do XML do CT-e
Result\dataEmissao Tag <dhEmi> do XML do CT-e
Result\razaoSocialEmissor Tag <emit>\<xNome> do XML do CT-e
Result\protocolo Tag <nProt> do XML de Autorização do CT-e
Result\ufOrigem Tag <UFIni> do XML da CT-e
Result\numeroCte Tag <nCT> do XML do CT-e
Descrição do Status do CT-e. Em caso de status Rejeição, haverá a descrição
da rejeição
Result\chaveAcesso Chave de Acesso do CT-e
Result\naturezaOperacao Tag <natOp> do XML do CT-e
Result\razaoSocialDest Tag <dest>\<xNome> do XML do CT-e
Result\serie Tag <serie> do XML do CT-e
message “OK”
Indica se há mais uma página a ser buscada para os filtros informados. true
hasMore
ou false.
Posição do objeto a partir do qual a página deve ser carregada, informada
offset
nos parâmetros.
*Consultar arquivo de exemplo: cte_response_getListagem.txt
Não há.
3.3.13. Consulta Solicitação de Impressão (getConsultaImpressao)

Página 206 de 452
Método GET para consulta do processamento de uma solicitação de impressão de CT-e(s). Resposta do
post “SolicitarImpressao”.
3.3.13.2. URL
<host>:<port>/<webservice>/api/cte/getConsultaImpressao?uuid=<informar_uuid_solicitacao>
http://localhost:8080/webservice/api/cte/getConsultaImpressao?uuid=<informar_uuid_solicitacao>
ou
https://ws.h.dfe.mastersaf.com.br/api/cte/getConsultaImpressao?uuid=<informar_uuid_solicitacao>

O usuário que está efetuando a consulta deve ser o mesmo usuário que fez a requisição, caso contrário,
será retornado erro http 412.

a senha fornecidos.
3.3.13.6. Envio

Página 207 de 452
Http status: 200

Response Body: {“status”:””, “documentos”:[]}
CAMPO DESCRIÇÃO
status Código do status do processamento da solicitação de impressão
Lista com o código do status de impressão e chave de acesso dos documentos,
documentos
agrupados por status de impressão.
*Consultar arquivo de exemplo: cte_response_getConsultaImpressao.txt
Possíveis status para o layout de retorno:
STATUS REQUISIÇÃO IMPRESSÃO (campo status)

Descrição Status
Aguardando processamento 700
Em processamento 701
Processamento finalizado 702
Processamento finalizado com erro(s) 703
Solicitação de Impressão Cancelada 710
Erro geral 999
STATUS DOCUMENTOS IMPRESSÃO (campo documentos)

Descrição Status
Impressão solicitada 720
Chave de Acesso inválida 730
Já existe solicitação de Impressão para o documento 731
Status do documento inválido para impressão 732
Documento impresso 770
Falha na impressão 771
Impressão cancelada 772

Página 208 de 452
Erro geral 999
Será retornado status com código 701 até que a mensageria comece a processar. Após a mensageria ter
processado todos os processamentos criados para à requisição, vai retornar status 702 ou 703. Status 703
vai ocorrer somente em caso de falha interna em algum dos processamentos.
Status 702, significa que a mensageria percorreu todos os documentos da requisição e agendou impressão,
mas NÃO possui relação com o status interno do grupo documentos, onde é mostrado o status de cada
documento.
3.3.13.9. Retorno Erro HTTP
Http status 400, 412, 500.

Response Body: {“result”:”“}
Exemplo:
{“result”:”descricao do erro” }
As mensagens tratadas especificamente para este webservice para o status 412:

UUID inválido. UUID informado na URL do método GET
possui formato inválido.
UUID não localizado. UUID informado na URL do método GET não
foi localizado.
1) Os status de CTe que permitem impressão são os mesmos permitidos quando é impresso via portal:
Aprovado (100), Cancelado (101), Anulado (128), Substituído (129), Contingência (990), Aguardando
Impressão Contingência (440). Caso status não seja permitido para impressão será retornado status 732 na
consulta do documento.
2) É verificado se já existe impressão solicitada para o CTe em andamento. Caso já exista, na consulta do
documento é retornado o status 731.

Página 209 de 452
3) O status da requisição somente será alterado no momento em que for efetuada a consulta da solicitação
de impressão, onde serão percorridos os documentos da requisição e atualizado status da requisição com
base nos status dos documentos.
4) Solicitações de impressão serão excluídas após 7 dias (parâmetro

3.2.13.11. Fluxo

método.
3.3.14. GetRetornoConsultaChaveSefaz
Método para obter os retornos da Consulta de Chave de Acesso junto a Sefaz.
3.3.14.2. URL
<host>:<port>/<webservice>/api/cte/getRetornoConsultaChaveSefaz
<host>:<port>/<webservice>/api/cte/getRetornoConsultaChaveSefaz?maxResults=
http://localhost:8080/webservice/api/cte/getRetornoConsultaChaveSefaz (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/cte/getRetornoConsultaChaveSefaz (ambiente de homologação
do SaaS)

Página 210 de 452
http://localhost:8080/webservice/api/cte/getRetornoConsultaChaveSefaz?maxResults=100 (instalação
in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/cte/getRetornoConsultaChaveSefaz?maxResults=100 (ambiente


a senha fornecidos.
3.3.14.7. Envio

Http status: 200
CAMPO DESCRIÇÃO
Ids
não consultados.
Atributo de “retorno”. Listagem dos retornos da(s) Consulta(s) de Chave(s) de
consultaChaveSefaz
Acesso que foram processadas pelo DFE.
*Consultar arquivo de exemplo: cte_response_getRetornoConsultaChaveSefaz.txt

Página 211 de 452
3.3.14.10. Detalhamento campo consultaChaveSefaz
CAMPO DESCRIÇÃO
chaveAcesso Chave de Acesso consultada junto a Sefaz.
cnpj CNPJ informado na solicitação da consulta.
idProcessamento ID interno do DFE para controle do processamento da Consulta da Chave de Acesso.
xmlRetornoSefaz Conteúdo da tag “retConsSitCte” do XML de retorno da consulta junto a Sefaz
referencia Conteúdo do campo referencia informado na solicitação da consulta.
Status final da consulta:
- Código 300 para indicar consulta finalizada com sucesso junto a Sefaz.
status
- Código 999 para indicar erro na consulta junto a Sefaz ou algum erro de
processamento pelo DFE.
Não há.
• As Consultas de Chave de Acesso solicitadas somente estarão disponíveis para retorno quando
processadas pelo DFE, ou seja, que a consulta junto a Sefaz tenha sido executada e finalizada, seja com
sucesso ou erro.
• Para o Usuário autenticado que utilizar este método, será considerado para um melhor controle dos
retornos a opção "Controlar retornos conforme usuário do integrador" do cadastro do Usuário.
Pode ser indicado ao WebService que as Consultas de Chave de Acesso já foram retornadas, pela
utilização do método MarcarConsultado (ítem 3.2.5), informando os ids dos processamentos a serem marcados
como consultados.
4. MÓDULO MDFE

Página 212 de 452
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
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.
4.2. MÉTODO: POST
4.2.1. EnviarPacote
Método para envio de MDF-es para serem autorizadas pela Sefaz correspondente.
4.2.1.2. URL
<host>:<port>/<webservice>/api/mdfe
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)
4.2.1.4. Layout

Página 213 de 452

txt_conteudo Grupo de informações do MDF-e Sim
Conteúdo do XML de MDF-e. Informar dados conforme layout
xml Sim

• MDF-e Integrador (ROLE_MDFE_INTEGRADOR);
4.2.1.6. Cabeçalho

a senha fornecidos.
4.2.1.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: dfe_request_post_enviar_pacote_3.00.txt

Http status: 202

Http status: 400, 412, 500.

Página 214 de 452
4.2.2. Cancelar
Método para cancelar MDF-es enviados ao webservice.
4.2.2.2. URL
<host>: <port>/<webservice>/api/mdfe

ou
4.2.2.4. Layout

Conteúdo do Cancelamento de MDF-e. Informar dados conforme
xml layout padrão da Receita Federal mais a tag <IE> para ser utilizada Sim
em processos internos.

Página 215 de 452

4.2.2.6. Cabeçalho

a senha fornecidos.
4.2.2.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: mdfe_request_post_cancelar_3.00.txt


Http status: 400, 412, 500.
4.2.3. Encerrar
Método para encerrar MDF-es.

Página 216 de 452
4.2.3.2. URL

ou
4.2.3.4. Layout

action Ação solicitada “Encerrar” Sim
Conteúdo do Encerramento de MDF-e. Informar dados conforme
Xml layout padrão da Receita Federal mais a tag <IE> para ser utilizada Sim

4.2.3.6. Cabeçalho

a senha fornecidos.

Página 217 de 452
4.2.3.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: mdfe_request_post_encerrar_3.00.txt


Http status: 400, 412, 500.
4.2.4.2. URL

ou

Página 218 de 452
4.2.4.4. Layout

Action Ação solicitada “MarcarConsultado” Sim
Ids Sim
consultados.

4.2.4.6. Cabeçalho

a senha fornecidos.
4.2.4.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: mdfe_request_post_marcar_consultado.txt



Página 219 de 452
4.2.5.2. URL

ou
4.2.5.4. Layout

Action Ação solicitada “MarcarImpresso” Sim


Página 220 de 452
4.2.5.6. Cabeçalho

a senha fornecidos.
4.2.5.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: mdfe_request_post_marcar_impresso.txt


4.2.6. Inclusão de Condutor
Método para incluir condutores no MDF-e.
4.2.6.2. URL

Página 221 de 452
ou
4.2.6.4. Layout

Action Ação solicitada “EnviarMdfeInclusaoCondutor” Sim
Referencia Nome do arquivo de integração Não
Conteúdo da Inclusão de Condutor de MDF-e.
Informar dados conforme layout padrão da
Xml Sim
Receita Federal mais a tag <IE> para ser utilizada
Config Configurações. Sim

4.2.6.6. Cabeçalho

a senha fornecidos.
4.2.6.7. Envio
mdfe_request_post_incluirCondutor_3.00.txt

Página 222 de 452


Http status: 400, 412, 500.
4.2.7. Pagamento da Operação de Transporte
Método para evento de Pagamento da Operação de Transporte.
4.2.7.2. URL

ou
4.2.7.4. Layout

Action Ação solicitada “EnviarMdfePagtoOperacao” Sim
Referencia Nome do arquivo de integração Não

Página 223 de 452
Conteúdo do evento de Pagamento da Operação

de Transporte de MDF-e. Informar dados
Xml Sim
conforme layout padrão da Receita Federal mais a
tag <IE> para ser utilizada em processos internos.
Config Configurações. Sim

4.2.7.6. Cabeçalho

a senha fornecidos.
4.2.7.7. Envio
mdfe_request_post_pagtoOperacao_3.00.txt


Http status: 400, 412, 500.

Página 224 de 452
4.3. MÉTODO: GET
lotes inutilizados e os documentos que devem ser enviados para o Printer imprimir.
4.3.1.2. URL

ou

4.3.1.5. Cabeçalho


Página 225 de 452
4.3.1.6. Envio

Response Body: {“impressao”:[],”retorno”:{“mdfeCtes”:[],”ids”:[]}}

Http status: 200
CAMPO DESCRIÇÃO
ids
consultados.
Atributo de “retorno”. Listagem dos retornos das MDF-es que foram processadas pelo
mdfeCtes
software.
*Consultar arquivo de exemplo: mdfe_response_get_3.00.txt
Não há.
4.3.2. GetXml
Método para obter o XML de envio da respectiva chave de MDF-e.
4.3.2.2. URL
<host>:<port>/<webservice>/api/mdfe/<chave cte>/getXml

Página 226 de 452
http://localhost:8080/webservice/api/mdfe/<chave cte>/getXml (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/mdfe/<chave cte>/getXml (ambiente de homologação do SaaS)

4.3.2.5. Cabeçalho

a senha fornecidos.
correta.
4.3.2.6. Envio

Http status: 200
Consultar arquivo de exemplo: mdfe_response_get_xml.txt


Http status: 203, 404, 500.

Página 227 de 452
Método para obter os retornos dos documentos enviados, lista de documentos não consultados e dados de
lotes inutilizados.
4.3.3.2. URL
<host>:<port>/<webservice>/api/mdfe/getRetorno
<host>:<port>/<webservice>/api/mdfe/getRetorno/maxResults=
por vírgula.
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
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)

Página 228 de 452

4.3.3.8. Cabeçalho

a senha fornecidos.
4.3.3.9. Envio
Response Body: {“retorno”:{“mdfeCtes”:[],”ids”:[]}}

Http status: 200
CAMPO DESCRIÇÃO
ids
consultados.
Atributo de “retorno”. Listagem dos retornos das MDF-es que foram processadas pelo
mdfeCtes
software.
*Consultar arquivo de exemplo: mdfe_response_getRetorno_3.00.txt

Página 229 de 452
Não há.
4.3.4.2. URL
<host>:<port>/<webservice>/api/mdfe/getImpressao
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)

4.3.4.5. Cabeçalho

a senha fornecidos.
4.3.4.6. Envio

Página 230 de 452

Http status: 200
CAMPO DESCRIÇÃO
*Consultar arquivo de exemplo: mdfe_response_getImpressao.txt
Não há.
4.3.5. GetDamdfe
Método para obter o DAMDFE da respectiva chave de MDF-e.
4.3.5.2. URL
<host>:<port>/<webservice>/api/mdfe/<chave mdfe>/getDamdfe
http://localhost:8080/webservice/api/mdfe/<chave mdfe>/getDamdfe (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/mdfe/<chave mdfe>/getDamdfe (ambiente de homologação do
SaaS)


Página 231 de 452

4.3.5.5. Cabeçalho

a senha fornecidos.
4.3.5.6. Envio
Http status: 200

Http status: 203, 404, 500.
Método para obter o XML cancelado da respectiva chave de MDF-e.
4.3.6.2. URL
<host>:<port>/<webservice>/api/mdfe/<chave mdfe>/getXmlCancelamento

Página 232 de 452
http://localhost:8080/webservice/api/mdfe/<chave mdfe>/getXmlCancelamento (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/mdfe/<chave mdfe>/getXmlCancelamento (ambiente de

4.3.6.5. Cabeçalho

a senha fornecidos.
correta.
4.3.6.6. Envio

Http status: 200
Consultar arquivo de exemplo: mdfe_response_get_xml_cancelamento_3.00.txt

Http status: 203, 404, 500.

Página 233 de 452
4.3.7. GetXmlEncerramento
Método para obter o XML de encerramento da respectiva chave de MDF-e.
4.3.7.2. URL
<host>:<port>/<webservice>/api/mdfe/<chave mdfe>/getXmlEncerramento
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

4.3.7.5. Cabeçalho

a senha fornecidos.
correta.

Página 234 de 452
4.3.7.6. Envio
Response Body: XML de encerramento processado.

Http status: 200
Consultar arquivo de exemplo: mdfe_response_get_xml_encerramento_3.00.txt

Http status: 203, 404, 500.
5. MÓDULO RECEPTOR NFSE (SERVIÇO)
Existem poucos métodos para esse módulo, existe somente um método POST (MarcarConsultado) e um
método GET (Consulta Padrão).
Resumindo o processo, é 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.
5.2. MÉTODO: POST

Página 235 de 452
5.2.1.2. URL
<host>:<port>/<webservice>/api/receptor_nfs
http://localhost:8080/webservice/api/receptor_nfs (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/receptor_nfs (ambiente de homologação do SaaS)

Página 236 de 452
5.2.1.4. Layout

ids Sim
consultados.

5.2.1.6. Cabeçalho

a senha fornecidos.
5.2.1.7. Envio
lista de ids dos documentos a serem marcados.
receptor_nfs_request_post_marcar_consultado.txt



Página 237 de 452
5.3. MÉTODO: GET
Método para obter os retornos dos documentos recebidos e uma lista de documentos não consultados.
5.3.1.2. URL
<host>:<port>/<webservice>/api/receptor_nfs
http://localhost:8080/webservice/api/receptor_nfs (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/receptor_nfs (ambiente de homologação do SaaS)

5.3.1.5. Cabeçalho

a senha fornecidos.
5.3.1.6. Envio

Página 238 de 452
Response Body: {“retorno”:{“ids”:[],”nfss”:[]}}

Http status: 200
Consultar arquivo de exemplo: receptor_nfse_response_get.txt
CAMPO DESCRIÇÃO
ids
consultados.
nfss Atributo de “retorno”. Listagem dos retornos das NFS-es que foram processadas pelo software.
Não há.

Página 239 de 452
6. MÓDULO RECEPTOR NFE (MERCANTIL)
Esse módulo necessita que sejam enviados os XMLs recebidos de fornecedores e depois que sejam marcados
como consultados.
Como em todos os módulos existe uma consulta padrão (GET) e também alguns métodos para consulta de
XMLs (processados e cancelados).
6.2. MÉTODO: POST
6.2.1. EnviarRecebimento
Método para envio de NF-es de fornecedores ao WebService. Neste método também é possível enviar CC-e
e Cancelamento.
6.2.1.2. URL
<host>:<port>/<webservice>/api/recebimentoNfe
http://localhost:8080/webservice/api/recebimentoNfe (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfe (ambiente de homologação do SaaS)

Página 240 de 452
6.2.1.4. Layout

action Ação solicitada “EnviarRecebimento” Sim
Conteúdo do XML de NF-e. Informar dados conforme layout
txt_conteudo Sim

• Receptor Integrador (ROLE_RECEBIMENTO_INTEGRADOR);
6.2.1.6. Cabeçalho

a senha fornecidos.
6.2.1.7. Envio
receptor_nfe_request_post_enviar_recebimento.txt
Response Body: {“result”:”OK”,”anoMes”:”“,”cnpjEmitente”:”“,”recebimento”:”“, “cnpjDestinatario”:”“}

Http status: 202

Página 241 de 452
CAMPO DESCRIÇÃO
result Informação de método bem sucedido. “OK”
anoMes Ano e mês da emissão.
cnpjEmitente CNPJ do Emitente.
recebimento Tipo do recebimento. Ex.: “xmlEmissao”.
cnpjDestinatario CNPJ do Destinatário.
*Consultar arquivo de exemplo: receptor_nfe_response_post_enviar_recebimento.txt

Http status: 400, 412, 500.
6.2.2. EnviarEventoManifestacao
Método para envio de eventos de manifestação do destinatário.
6.2.2.2. URL

ou

Página 242 de 452
6.2.2.4. Layout

action Ação solicitada “EnviarEventoManifestacao” Sim
Conteúdo do XML de NF-e. Informar dados
txt_conteudo Sim
conforme layout padrão da Receita Federal.

6.2.2.6. Cabeçalho

a senha fornecidos.
6.2.2.7. Envio
receptor_nfe_request_post_enviar_evento_manifestacao.txt
Response Body: {“result”:”OK”,”descricao”:”Evento [CIENCIA_OPERACAO] solicitado com sucesso.”}

Http status: 202

Página 243 de 452
CAMPO DESCRIÇÃO
descricao Descrição do resultado do envio.
*Consultar arquivo de exemplo: receptor_nfe_response_post_enviar_evento_manifestacao_ok.txt
Response Body: {“result”: “erro”,”descricao”: “Não foi encontrada nota recebida com chave de acesso:
12345 para a empresa com CNPJ: 000 e Inscrição Estadual: 000”}
Http status: 400, 412, 500.
Consultar arquivos de exemplo para erros:

receptor_nfe_response_post_enviar_evento_manifestacao_erro.txt
receptor_nfe_response_post_enviar_evento_manifestacao_erro_2.txt
6.2.3.2. URL
6.2.3.3. Exemplo URL:

ou

Página 244 de 452
6.2.3.4. Layout

ids Sim
consultados.

6.2.3.6. Cabeçalho

a senha fornecidos.
6.2.3.7. Envio
receptor_nfe_request_post_marcar_consultado.txt


Página 245 de 452

6.2.4.2. URL

ou
6.2.4.4. Layout


Página 246 de 452

6.2.4.6. Cabeçalho

a senha fornecidos.
6.2.4.7. Envio
receptor_nfe_request_post_marcar_impresso.txt



Página 247 de 452
6.3. MÉTODO: GET
6.3.1.2. URL

ou

6.3.1.5. Cabeçalho

a senha fornecidos.
6.3.1.6. Envio

Página 248 de 452
Response Body: {“retorno”:{“recebimentos”:[],”ids”:[], “eventosDistribuicao”:[]}}

Http status: 200
CAMPO DESCRIÇÃO
ids
consultados.
Atributo de “retorno”. Listagem dos retornos das NF-es que foram processadas pelo
recebimentos
software.
eventosDistribuicao
Distribuição.
*Consultar arquivo de exemplo: receptor_nfe_response_get.txt

CAMPO DESCRIÇÃO
Disponibilizamos o link para abertura do DANFE. Este novo campo deverá ser preenchido
somente nos retornos em que o status de NF-e permita a impressão de DANFE (Autorizada
ou Cancelada).
Para a visualização do DANFE o usuário deverá ter a permissão “NF-e Visualizar” habilitada
em seu perfil.
Exemplo: nfes”:[{“nota”:{“urlDanfePortal”:”https://h.dfe.mastersaf.com.br/
mvc /receptorNfe/visualizarDanfeRecebimento/3360767”

Página 249 de 452
Disponibilizamos o link para abertura do PDF da Carta de Correção. Este novo campo será
preenchido somente nos retornos em que o status da Carta de Correção permita a impressão
do PDF (Autorizada).
Exemplo: nfes”: [{“nota”:{“urlPdfCcePortal”:”https://h.dfe.mastersaf.com.br/mvc/
nfe/pdf/cartaCorrecao/receptorNfe/46736”
Não há.
6.3.2. GetXml
Método para obter o XML processado da respectiva chave de NF-e.
6.3.2.2. URL
<host>:<port>/<webservice>/api/recebimentoNfe/<chave nfe>/getXml
http://localhost:8080/webservice/api/recebimentoNfe/<chave nfe>/getXml (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfe/<chave nfe>/getXml (ambiente de homologação
do SaaS)

Página 250 de 452

6.3.2.5. Cabeçalho

a senha fornecidos.
correta.
6.3.2.6. Envio

Http status: 200
Consultar arquivo de exemplo: receptor_nfe_response_get_xml.txt

Http status: 203, 404, 500.
Método para obter o XML cancelado da respectiva chave de NFe.

Página 251 de 452
6.3.3.2. URL
<host>:<port>/<webservice>/api/recebimentoNfe/<chave nfe>/getXmlCancelamento
http://localhost:8080/webservice/api/recebimentoNfe/<chave nfe>/getXmlCancelamento
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfe/<chave nfe>/getXmlCancelamento

6.3.3.5. Cabeçalho

a senha fornecidos.
correta.
6.3.3.6. Envio

Http status: 200
Consultar arquivo de exemplo: receptor_nfe_response_get_xml_cancelado.txt

Página 252 de 452

Http status: 203, 404, 500.
6.3.4. GetStatus
finalizado.
6.3.4.2. URL
<host>:<port>/<webservice>/api/ recebimentoNfe/<chave nfe>/getStatus
http://localhost:8080/webservice/api/recebimentoNfe/<chave nfe>/getStatus (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfe/<chave nfe>/getStatus (ambiente de


Página 253 de 452
6.3.4.5. Cabeçalho

a senha fornecidos.
6.3.4.6. Envio
Response Body:
{
"retorno": {
“ids”: [],
"recebimentos": [],
"eventosDistribuicao": [],
}
}
Http status: 200
CAMPO DESCRIÇÃO
ids Não há.
recebimentos Atributo de “retorno”. Listagem dos retornos das NF-es que foram solicitados.
eventosDistribuicao Atributo de “retorno”. Não será preenchido.
*Consultar arquivo de exemplo: receptor_nfe_response_getStatus.txt.
Não há.

Página 254 de 452
6.3.5.2. URL
<host>:<port>/<webservice>/api/recebimentoNfe/getImpressao
http://localhost:8080/webservice/api/recebimentoNfe/getImpressao (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfe/getImpressao (ambiente de homologação do
SaaS)

6.3.5.5. Cabeçalho

a senha fornecidos.
6.3.5.6. Envio

Página 255 de 452

Http status: 200
CAMPO DESCRIÇÃO
params Atributo de “impressao”. Parâmetros de impressão.
*Consultar arquivo de exemplo: receptor_nfe_response_getImpressao.txt
Não há.
Método para obter os retornos dos documentos enviados, lista de documentos não consultados.
6.3.6.2. URL
<host>:<port>/<webservice>/api/recebimentoNfe/getRetorno
http://localhost:8080/webservice/api/recebimentoNfe/getRetorno (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfe/getRetorno (ambiente de homologação do SaaS)

Página 256 de 452

6.3.6.5. Cabeçalho

a senha fornecidos.
6.3.6.6. Envio

Http status: 200
CAMPO DESCRIÇÃO
ids
consultados.
Atributo de “retorno”. Listagem dos retornos dos Recebimentos que foram processados
recebimentos
pelo software.
Eventos Atributo de “retorno”. Contém a listagem dos eventos recebidos pelo Webservice
Distribuicao Distribuição.
*Consultar arquivo de exemplo: receptor_nfe_response_getRetorno.txt

Página 257 de 452
6.3.7. GetDanfe
6.3.7.2. URL
<host>:<port>/<webservice>/api/recebimentoNfe/<chave nfe>/getDanfe
http://localhost:8080/webservice/api/ recebimentoNfe /<chave nfe>/getDanfe (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/ recebimentoNfe /<chave nfe>/getDanfe (ambiente de

• NF-e Integrador (ROLE_RECEBIMENTO_INTEGRADOR);
6.3.7.5. Cabeçalho

a senha fornecidos.
6.3.7.6. Envio

Página 258 de 452
Http status: 200
do cadastro da empresa, porém, se houver cadastro de customização em “Grupo de Empresas > Documentos
Customizados” para o módulo, grupo da empresa e tipo de documento, o parâmetro do cadastro de empresa
será desconsiderado e passará a valer apenas a customização de documento cadastrada no grupo de empresa.

Http status: 203, 404, 500.
Método para obter o XML da carta de correção de recebimento da respectiva chave de NF-e.
6.3.8.2. URL
<host>:<port>/<webservice>/api/recebimentoNfe/<chave nfe>/getXmlCartaCorrecao
http://localhost:8080/webservice/api/recebimentoNfe/<chave nfe>/getXmlCartaCorrecao
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfe/<chave nfe>/getXmlCartaCorrecao

Página 259 de 452

6.3.8.5. Cabeçalho

a senha fornecidos.
correta.
6.3.8.6. Envio

Http status: 200
Consultar arquivo de exemplo: receptor_nfe_response_get_xml_carta_correcao.txt

Http status: 203, 404, 500.
* Consultar título LISTAGEM DE ERROS para maiores informações sobre os erros.
Método para obter o DANFE da carta de correção de recebimento para a respectiva chave de NF-e.

Página 260 de 452
6.3.9.2. URL
<host>:<port>/<webservice>/api/recebimentoNfe/<chave nfe>/getCartaCorrecao
http://localhost:8080/webservice/api/ recebimentoNfe /<chave nfe>/getCartaCorrecao

ou
https://ws.h.dfe.mastersaf.com.br/api/ recebimentoNfe /<chave nfe>/getCartaCorrecao

6.3.9.5. Cabeçalho

a senha fornecidos.
6.3.9.6. Envio
Http status: 200

Página 261 de 452
Para ambiente SaaS: O pdf gerado é padrão, porém, se houver cadastro de customização em “Grupo
de Empresas > Documentos Customizados” para o módulo, grupo da empresa e tipo de documento, o
parâmetro do cadastro de empresa será desconsiderado e passará a valer apenas a customização de
documento cadastrada no grupo de empresa.

Http status: 203, 404, 500.
Método de consulta para retornar os logs da NF-e do Receptor, 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 todos 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.
6.3.10.2. URL
<host>:<port>/<webservice>/api/recebimentoNfe/getLog?cnpj=<número cnpj>&ie=<número inscrição

estadual>&serie=<série da NF-e>&numero=<número da NF-e>

Página 262 de 452
<host>:<port>/<webservice>/api/recebimentoNfe/getLog?cnpj=<número cnpj>&ie=<número inscrição

estadual>&serie=<série da NF-e>&numero=<número da NF-
http://localhost:8080/webservice/api/recebimentoNfe/getLog?cnpj=00910509000171&ie=0018000282
&serie=450&numero=10006&offset=0&maxResults=10 (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfe/getLog?cnpj=00910509000171&ie=0018000282
&serie=450&numero=10006&offset=0&maxResults=10 (ambiente de homologação do SaaS)

• Administração do Sistema - Integrador (ROLE_USUARIO_INTEGRADOR)

a senha fornecidos.
6.3.10.6. Envio

Página 263 de 452
Http status: 200
CAMPO DESCRIÇÃO

message “OK”
hasMore
true ou false.
offset
*Consultar arquivo de exemplo: receptor_nfe_response_get_log.txt
Não há.
Método de consulta para retornar uma listagem de NF-e do Receptor, irá retornar alguns dados principais
de 1 ou N NF-e por consulta. Este método retorna uma lista paginada com os documentos para os filtros
informados. Mais informações sobre a paginação podem ser consultadas no tópico LISTAGEM E

Página 264 de 452
6.3.11.2. URL
<host>:<port>/<webservice>/api/recebimentoNfe/getListagem?cnpj=<número cnpj>&ie=<número
inscrição estadual>&periodoInicial=<período inicial DD/MM/AAAA HH:MM>&periodoFinal=<período final
DD/MM/AAAA HH:MM>
<host>:<port>/<webservice>/api/recebimentoNfe/getListagem?cnpj=<número cnpj>&ie=<número
http://localhost:8080/webservice/api/recebimentoNfe/getListagem?cnpj=00910509000171&ie=001800
0282&periodoInicial=01/12/2016 00:00&periodoFinal=13/03/2017 00:00&offset=0&maxResults=10
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfe/getListagem?cnpj=00910509000171&ie=001800


Página 265 de 452

a senha fornecidos.
6.3.11.6. Envio
Response Body: {“result”:[], “message”:”OK”, “hasMore”: false , “count”: 10, “maxResults”: 10, “offset”:
0}Http status: 200
CAMPO DESCRIÇÃO


Página 266 de 452

Result\situação
message “OK”
hasMore

Página 267 de 452

offset
*Consultar arquivo de exemplo: adm_response_get_Listagem.txt
Não há.
7. MÓDULO RECEPTOR CTE
Esse módulo necessita que sejam enviados os XMLs recebidos e depois que sejam marcados como
consultados. É possível ainda consultar um documento e obter o seu XML.
Como em todos os módulos existe uma consulta padrão (GET) e também alguns métodos para consulta
de XMLs (processados e cancelados).
7.2. MÉTODO: POST
Método para envio de CT-es de fornecedores ao WebService.
7.2.1.2. URL
<host>:<port>/<webservice>/api/recebimento

Página 268 de 452
http://localhost:8080/webservice/api/recebimento (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/recebimento (ambiente de homologação do SaaS)

Página 269 de 452
7.2.1.4. Layout

Conteúdo do XML de CT-e. Informar dados conforme
txt_conteudo Sim

• Administrar o sistema (ROLE_SUPER_ADMIN);
• Receptor CT-e Consultar Chave via Webservice (ROLE_RECEBIMENTO_CONSULTACHAVE_CTE);
• Receptor CT-e Resgatar XML via Webservice (ROLE_RECEBIMENTO_RESGATAXML_CTE).
7.2.1.6. Cabeçalho

a senha fornecidos.
7.2.1.7. Envio
receptor_cte_request_post_enviar_recebimento.txt

Http status: 202

Página 270 de 452
CAMPO DESCRIÇÃO
Recebimento Tipo do recebimento. Ex.: “xmlEmissao”.
*Consultar arquivo de exemplo: receptor_cte_response_post_enviar_recebimento.txt

Http status: 400, 412, 500.
7.2.2. ConsultarDocFornecedor
Método para consultar status de CT-e recebido. A consulta pode ser feita usando a chave do documento ou
através da combinação de CNPJ, IE, número e série.
7.2.2.2. URL

ou

Página 271 de 452
7.2.2.4. Layout

“ConsultarDoc
Fornecedor”
txt_conteudo Grupo de informações para consulta. Sim
tpDoc Atributo de “txt_conteudo”. Tipo do documento para consulta. “CT-e” Sim
Atributo de “txt_conteudo”. Chave do CT-e. Informar quando não
chave Não
for informar os outros campos “cnpj”, “ie”, “nrDoc” e “serie”.
Atributo de “txt_conteudo”. CNPJ da empresa. Não informar
cnpj Não
quando campo “chave” for informado.
Atributo de “txt_conteudo”. IE da empresa. Não informar quando
ie Não
campo “chave” for informado.
Atributo de “txt_conteudo”. Número do CT-e. Não informar
nrDoc Não
Atributo de “txt_conteudo”. Série do CT-e. Não informar quando
serie Não

7.2.2.6. Cabeçalho

a senha fornecidos.
7.2.2.7. Envio

Página 272 de 452
Exemplo de Request Body conforme arquivo de exemplo (Consulta pela Chave):

receptor_cte_request_post_consultar_doc_fornecedor_1.txt
Exemplo de Request Body conforme arquivo de exemplo (Consulta pelos dados do CT-e):
receptor_cte_request_post_consultar_doc_fornecedor_2.txt
Response Body: {“result”:”OK”,”status”:100}

Http status: 202
CAMPO DESCRIÇÃO
status Código do status do documento.

Http status: 400, 412, 500.
7.2.3. ResgatarXmlFornecedor
Método para resgatar XML de CT-e recebido. A consulta pode ser feita usando a chave do documento ou
através da combinação de CNPJ, IE, número e série.
7.2.3.2. URL

Página 273 de 452

ou
7.2.3.4. Layout

“ResgatarXml
Fornecedor”
tpDoc Atributo de “txt_conteudo”. Tipo do documento para consulta. “CT-e” Sim
Atributo de “txt_conteudo”. Chave do CT-e. Informar quando não
chave Não
for informar os outros campos “cnpj”, “ie”, “nrDoc” e “serie”.
Atributo de “txt_conteudo”. CNPJ da empresa. Não informar
cnpj Não
Atributo de “txt_conteudo”. IE da empresa. Não informar quando
ie Não
Atributo de “txt_conteudo”. Número do CT-e. Não informar
nrDoc Não
Atributo de “txt_conteudo”. Série do CT-e. Não informar quando
serie Não


Página 274 de 452
7.2.3.6. Cabeçalho

a senha fornecidos.
7.2.3.7. Envio
receptor_cte_request_post_resgatar_xml_fornecedor_1.txt
Exemplo de Request Body conforme arquivo de exemplo (Consulta pelos dados do CT-e):
receptor_cte_request_post_resgatar_xml_fornecedor_2.txt

Http status: 202
CAMPO DESCRIÇÃO
xml Conteúdo do XML.
*Consultar arquivo de exemplo: receptor_cte_response_post_resgatar_xml_fornecedor.txt

Http status: 400, 412, 500.

Página 275 de 452
7.2.4.2. URL

ou
7.2.4.4. Layout

ids Sim
consultados.


Página 276 de 452
7.2.4.6. Cabeçalho

a senha fornecidos.
7.2.4.7. Envio
receptor_cte_request_post_marcar_consultado.txt


7.2.5. EnviarPrestacaoServicoDesacordo
Método para envio de evento de prestação de serviço em desacordo para CT-e recebida e autorizada.
7.2.5.2. URL

Página 277 de 452

ou
7.2.5.4. Layout

“EnviarPrestacao
ServicoDesacordo”
Grupo de informações do evento de prestação de serviço
txt_conteudo Sim
em desacordo.

7.2.5.6. Cabeçalho

a senha fornecidos.
7.2.5.7. Envio
receptor_cte_request_post_enviar_prestacao_servico_desacordo.txt

Página 278 de 452


Http status: 400, 412, 500.
7.3. MÉTODO: GET
7.3.1.2. URL

ou


Página 279 de 452

7.3.1.5. Cabeçalho

a senha fornecidos.
7.3.1.6. Envio

Response Body: {“retorno”:{“recebimentos”:[], “eventoDesacordo”:[],”ids”:[]}}

Http status: 200
CAMPO DESCRIÇÃO
Atributo de “retorno”. Listagem dos Ids dos processamentos que constam como não
Ids
consultados.
Atributo de “retorno”. Listagem dos retornos dos CT-es que foram processadas pelo
Recebimentos
software.
Atributo de “retorno”. Contém a listagem dos eventos de prestação de serviço em
eventoDesacordo
desacordo que foram processados pelo software.
*Consultar arquivo de exemplo: receptor_cte_response_get.txt
Não há.

Página 280 de 452
7.3.2. GetXml
Método para obter o XML processado da respectiva chave de CT-e.
7.3.2.2. URL
<host>:<port>/<webservice>/api/recebimento/<chave cte>/getXml
http://localhost:8080/webservice/api/recebimento/<chave cte>/getXml (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/recebimento/<chave cte>/getXml (ambiente de homologação do
SaaS)

7.3.2.5. Cabeçalho

a senha fornecidos.
correta.

Página 281 de 452
7.3.2.6. Envio

Http status: 200
Consultar arquivo de exemplo: receptor_cte_response_get_xml.txt

Http status: 203, 404, 500.
Método para obter o XML cancelado da respectiva chave de CT-e.
7.3.3.2. URL
<host>:<port>/<webservice>/api/recebimento/<chave cte>/getXmlCancelamento
http://localhost:8080/webservice/api/recebimento/<chave cte>/getXmlCancelamento
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimento/<chave cte>/getXmlCancelamento

Página 282 de 452

7.3.3.5. Cabeçalho

a senha fornecidos.
correta.
7.3.3.6. Envio

Http status: 200
Consultar arquivo de exemplo: receptor_cte_response_get_xml_cancelado.txt

Http status: 203, 404, 500.

Página 283 de 452
7.3.4. GetStatus
Método para obter o Status (Código-Descrição) da respectiva chave de CT-e. Deve ser utilizado para obter
finalizado.
7.3.4.2. URL
<host>:<port>/<webservice>/api/recebimento/<chave nfe>/getStatus
http://localhost:8080/webservice/api/recebimento/<chave nfe>/getStatus (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/recebimento/<chave nfe>/getStatus (ambiente de homologação
do SaaS)

7.3.4.5. Cabeçalho

a senha fornecidos.

Página 284 de 452
7.3.4.6. Envio
Response Body:
{
"retorno": {
"recebimentos": [],
"ids": [],
"eventoDesacordo": []
}
}
Http status: 200
CAMPO DESCRIÇÃO
ids Não há.
recebimentos Atributo de “retorno”. Listagem dos retornos das CT-es que foram solicitados.
eventoDesacordo Atributo de “retorno”. Não será preenchido.
*Consultar arquivo de exemplo: receptor_cte_response_getStatus.txt.
Não há.

Página 285 de 452
7.3.5.2. URL
<host>:<port>/<webservice>/api/recebimento/getRetorno
http://localhost:8080/webservice/api/recebimento/getRetorno (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/recebimento/getRetorno (ambiente de homologação do SaaS)

7.3.5.5. Cabeçalho

a senha fornecidos.
7.3.5.6. Envio
Response Body: {“retorno”:{“recebimentos”:[],”eventoDesacordo”:[],”ids”:[]}}

Http status: 200

Página 286 de 452
CAMPO DESCRIÇÃO
ids
consultados.
recebimentos
pelo software.
Evento Atributo de “retorno”. Contém a listagem dos eventos de prestação de serviço em
Desacordo desacordo que foram processados pelo software.
*Consultar arquivo de exemplo: receptor_cte_response_getRetorno.txt
Método para obter o XML da carta de correção de recebimento processado da respectiva chave de CT-e.
7.3.6.2. URL
<host>:<port>/<webservice>/api/recebimento/<chave cte>/getXmlCartaCorrecao
http://localhost:8080/webservice/api/recebimento/<chave cte>/getXmlCartaCorrecao (instalação in

house)
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimento/<chave cte>/getXmlCartaCorrecao (ambiente de


Página 287 de 452

7.3.6.5. Cabeçalho

a senha fornecidos.
correta.
7.3.6.6. Envio

Http status: 200
Consultar arquivo de exemplo: receptor_cte_response_get_xml_carta_correcao.txt

Http status: 203, 404, 500.
Método para obter o DANFE da carta de correção de recebimento para a respectiva chave de CT-e.

Página 288 de 452
7.3.7.2. URL
<host>:<port>/<webservice>/api/recebimento/<chave cte>/getCartaCorrecao
http://localhost:8080/webservice/api/recebimento/<chave cte>/getCartaCorrecao (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/recebimento/<chave cte>/getCartaCorrecao (ambiente de

7.3.7.5. Cabeçalho

a senha fornecidos.
7.3.7.6. Envio
Http status: 200

Página 289 de 452

Http status: 203, 404, 500.
7.3.8. Consulta Log do CT-e
Método de consulta para retornar os logs do CT-e do Receptor, 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. Este método retorna
7.3.8.2. URL
<host>:<port>/<webservice>/api/recebimento/getLog?cnpj=<número cnpj>&ie=<número inscrição

estadual>&serie=<série do CT-e>&numero=<número do CT-e>
<host>:<port>/<webservice>/api/recebimento/getLog?cnpj=<número cnpj>&ie=<número inscrição

estadual>&serie=<série do CT-e>&numero=<número do CT-

Página 290 de 452
http://localhost:8080/webservice/api/recebimento/getLog?cnpj=00910509000171&ie=0018000282&se
rie=450&numero=10006&offset=0&maxResults=10 (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimento/getLog?cnpj=00910509000171&ie=0018000282&se
rie=450&numero=10006&offset=0&maxResults=10 (ambiente de homologação do SaaS)

7.3.8.5. Cabeçalho

a senha fornecidos.
7.3.8.6. Envio

0}Http status: 200

Página 291 de 452
CAMPO DESCRIÇÃO

message “OK”
Indica se há mais uma página a ser buscada para os filtros informados. true ou
hasMore
false.
Posição do objeto a partir do qual a página deve ser carregada, informada nos
offset
parâmetros.
*Consultar arquivo de exemplo: receptor_cte_response_getLog.txt
Não há.
7.3.9. Consulta Listagem de CT-e
Método de consulta para retornar uma listagem de CT-e do Receptor,irá retornar alguns dados principais
de 1 ou N CT-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
7.3.9.2. URL
<host>:<port>/<webservice>/api/recebimento/getListagem?cnpj=<número cnpj>&ie=<número inscrição

DD/MM/AAAA HH:MM>

Página 292 de 452
<host>:<port>/<webservice>/api/recebimento/getListagem?cnpj=<número cnpj>&ie=<número inscrição

http://localhost:8080/webservice/api/recebimento/getListagem?cnpj=00910509000171&ie=001800028
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimento/getListagem?cnpj=00910509000171&ie=00180002

7.3.9.5. Cabeçalho

a senha fornecidos.

Página 293 de 452
7.3.9.6. Envio
0}Http status: 200
CAMPO DESCRIÇÃO
Result\situacao Status do CT-e
Result\valorTotalMercadoria Tag <infCarga>\<vCarga> do XML do CT-e
Result\valorTotalPrestacao Tag <vPrest>\<vTPrest> do XML do CT-e
Result\cnpjEmissor Tag <emit>\<CNPJ> do XML do CT-e
Result\cpfCnpjDest Tag <dest>\<CNPJ> do XML do CT-e
Result\dataEmissao Tag <dhEmi> do XML do CT-e
Result\razaoSocialEmissor Tag <emit>\<xNome> do XML do CT-e
Result\protocolo Tag <nProt> do XML de Autorização do CT-e
Result\ufOrigem Tag <UFIni> do XML da CT-e
Result\numeroCte Tag <nCT> do XML do CT-e
Descrição do Status do CT-e. Em caso de status Rejeição, haverá a
Result\chaveAcesso Chave de Acesso do CT-e
Result\naturezaOperacao Tag <natOp> do XML do CT-e
Result\razaoSocialDest Tag <dest>\<xNome> do XML do CT-e
Result\serie Tag <serie> do XML do CT-e
message “OK”
hasMore
offset

Página 294 de 452
*Consultar arquivo de exemplo: receptor_cte_response_getListagem.txt
Não há.
7.3.10. GetDacte
Método para obter o DACTE da respectiva chave de CT-e.
7.3.10.2. URL
<host>:<port>/<webservice>/api/recebimento/<chave cte>/getDacte
http://localhost:8080/webservice/api/ recebimento/<chave cte>/getDacte (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/ recebimento/<chave cte>/getDacte (ambiente de homologação
do SaaS)

• Receptores CT-e e NF-e Integrador (ROLE_RECEBIMENTO_INTEGRADOR);

a senha fornecidos.

Página 295 de 452
7.3.10.6. Envio
Http status: 200

Http status: 203, 404, 500.
8. MÓDULO ADM
Esse módulo deverá ser utilizado para manutenções do módulo Administração do Sistema.
8.2. MÉTODO: POST
8.2.1. Manutenção de Empresa
Método para cadastrar, editar e/ou excluir Empresas através de integração WebService.
8.2.1.2. URL

Página 296 de 452
<host>:<port>/<webservice>/api/adm
http://localhost:8080/webservice/api/adm (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/adm (ambiente de homologação do SaaS)

Página 297 de 452
8.2.1.4. Layout para inclusão de Empresa

action Ação solicitada “IncluirEmpresa” Sim
referencia Nome do arquivo utilizado na integração Não
Conteúdo com dados para inclusão de empresa.
Seguir layout disponível na planilha
txt_conteudo Sim
“Mastersaf_Layout_DFe_V3_Adm.xlsx”, subplanilha
“Empresa”
8.2.1.5. Layout para edição de Empresa

action Ação solicitada “EditarEmpresa” Sim
Conteúdo com dados para edição de empresa. Seguir layout
disponível na planilha “Mastersaf_Layout_DFe_V3_Adm.xlsx”,
subplanilha “Empresa”. Ao editar uma empresa, deverão ser
enviados no layout apenas os campos obrigatórios (conferir a
observação dos campos obrigatórios, pois alguns são
obrigatórios somente na inclusão de empresa) e os campos
que precisam ser alterados.
txt_conteudo Sim
IMPORTANTE: Ao enviar um campo no layout sem valor, a
rotina de edição irá interpretar que este campo deverá ficar
sem valor no cadastro da empresa. Para atualização da
empresa, ao enviar os campos __msg-contingencia-sefaz-
ini__, __param-destinatario-ini__, __param-email-envio-ini__,
__param-csc-ini__ o produto irá remover os registros antigos
da base e cadastrar os novos enviados.
8.2.1.6. Layout para exclusão de Empresa

Página 298 de 452

Action Ação solicitada “ExcluirEmpresa” Sim
Conteúdo com dados para exclusão de empresa. Seguir layout
disponível na planilha “Mastersaf_Layout_DFe_V3_Adm.xlsx”,
subplanilha “Empresa (Exclusão)”.
txt_conteudo Sim
IMPORTANTE: Ao enviar um campo no layout sem valor, a
rotina de exclusão irá interpretar que este campo não possui
valor no cadastro da empresa.

Página 299 de 452

8.2.1.8. Cabeçalho

a senha fornecidos.
8.2.1.9. Envio
adm_request_post_IncluirEmpresa.txt
adm_request_post_EditarEmpresa.txt
adm_request_post_ExcluirEmpresa.txt
Esta resposta corresponde que a empresa foi Incluída, Editada ou Excluída com sucesso.
Http status: 200
Exemplo de Response Body conforme arquivo de exemplo:
adm_response_post_IncluirEmpresa_OK.txt
Http status: 400, 412, 500


Página 300 de 452
Caso a empresa não seja encontrada na exclusão de empresa:

adm_response_post_ExcluirEmpresa_NOK.txt
Caso a empresa possua documentos vinculados na exclusão de empresa:

adm_response_post_ExcluirEmpresa_NOK_2.txt
Caso a empresa possua vínculo com e-mail personalizado na exclusão de empresa:

Caso a empresa possua vínculo com fila exclusiva da mensageria na exclusão de empresa:
Caso a empresa possua vínculo com tax analyser na exclusão de empresa:

8.2.2. Upload Certificado Digital
Método para realizar Upload do Certificado Digital através de integração WebService.
8.2.2.2. URL
<host>:<port>/<webservice>/api/adm
http://localhost:8080/webservice/api/adm (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/adm (ambiente de homologação do SaaS)
8.2.2.4. Layout

Action Ação solicitada “UploadCertificado” Sim

Página 301 de 452
Referencia Nome do arquivo utilizado na integração Não

Conteúdo com dados para inclusão de empresa. Seguir
layout disponível na planilha
txt_conteudo Sim
“Mastersaf_Layout_DFe_V3_Adm.xlsx”, subplanilha
“Certificados”

8.2.2.6. Cabeçalho

a senha fornecidos.
8.2.2.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: adm_request_post_UploadCertificado.txt
Esta resposta corresponde que o certificado digital foi inserido ou atualizado com sucesso.
Http status: 200
adm_response_post_UploadCertificado.txt
Http status: 400, 412, 500


Página 302 de 452
8.3. MÉTODO: GET
8.3.1. Listagem Municípios
Método para retornar uma lista com dados dos municípios que possuem integração com a prefeitura para
emissão de Nota Fiscal de Serviço. Neste método é possível retornar a lista completa de municípios
utilizando a URL padrão (8.3.1.2) ou retornar apenas os dados de um único município utilizando a URL
com Parâmetro (8.3.1.4).
8.3.1.2. URL
<host>:<port>/<webservice>/api/adm?action=ListagemMunicipio
http://localhost:8080/webservice/api/adm?action=ListagemMunicipio (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/adm?action=ListagemMunicipio (ambiente de homologação do
SaaS)
8.3.1.4. Exemplo URL com Parâmetro:
http://localhost:8080/webservice/api/adm?action=ListagemMunicipio&codIBGE=3538709
Na URL acima é possível utilizar o código do IBGE do município como parâmetro para consultar
apenas os dados referente ao município em questão.


Página 303 de 452
8.3.1.6. Cabeçalho

a senha fornecidos.
8.3.1.7. Envio
Esta resposta corresponde que o certificado digital foi inserido ou atualizado com sucesso.
Http status: 200
{“status”:”OK”,”listagemMunicipios”:[]}

adm_response_get_ListagemMunicipio.txt
Http status: 400, 412, 500

8.3.2. InfoEmpresaServico
Método para obter dados do Cadastro da Empresa como endereço do prestador/emissor, descrição do
serviço, Item Lista, CNAE, Codigo Serviço Município e Alíquota ISS conforme Cadastro de Serviço
Municipal. Deve ser utilizado para obter informações de um CNPJ e Serviço por consulta.
8.3.2.2. URL
<host>:<port>/<webservice>/api/adm?action=InfoEmpresaServico&cnpj=<CNPJ>&im=<IM>&codServico=
<CodigoServiço>

Página 304 de 452
8.3.2.3. Filtro de CNPJ, IM e Serviço
Não há um body na requisição, somente é necessário informar os parâmetros:

• cnpj: CNPJ do emissor/prestador (Cadastro de Empresa);
• im: Inscrição Municipal do emissor/tomador (Cadastro de Empresa);
• codServico: código do serviço municipal (Cadastro Serviço Municipal).
http://localhost:8080/webservice/api/adm?action=InfoEmpresaServico&cnpj=00910509000171&im=123
456789&codServico=1002 (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/adm?action=InfoEmpresaServico&cnpj=00910509000171&im=123
456789&codServico=1002 (ambiente de homologação do SaaS)

8.3.2.6. Cabeçalho

a senha fornecidos.
8.3.2.7. Envio

Response Body:
{
"status":"OK",
"empresa":

Página 305 de 452
{"enderecoPrestador":"",
"codCidade":"",
"municipioPrestacao":"",
"paisServico":"",
"municipioIncidencia":"",
"telefonePrestador":"",
"cnpj":"",
"emailPrestador":"",
"cepPrestador":"",
"dddPrestador":"",
"complementoEnderecoPrestador":"",
"ufPrestador":"",
"bairroPrestador":"",
"numeroEnderecoPrestador":"",
"paisPrestador":"",
"inscricaoPrestador":"",
"razaoSocialPrestador":""
},
"servicoMunicipal":
{"cnae":"",
"codServicoMunicipal":"",
"itemListaServico":"",
"descricaoRps":"",
"aliquotaServico": }
}
Http status: 200

CAMPO DESCRIÇÃO
“OK” quando encontrar o cadastro da empresa através dos parâmetros CNPJ + IM.
status
“BAD_REQUEST” quando não encontrar o cadastro da empresa através do parâmetros
CNPJ + IM.
Todos os atributos deste grupo serão retornados com os dados do Cadastro de
empresa
Empresa do Mastersaf DFE

Página 306 de 452
Se encontrar serviço municipal cadastrado no Mastersaf DFE (administração do

sistema > cadastros nfse > serviço municipal) com o código do serviço interno
servicoMunicipal
correspondente ao parâmetro, retornará todos os atributos deste grupo, do contrário
será retornado em branco.
Retornado somente quando ocorre uma rejeição ou erro, por exemplo de empresa não
result
cadastrada.
*Consultar arquivo de exemplo: adm_response_get_InfoEmpresaServico_OK.txt.
Response Body: {“result”:”<descrição do erro>“, “status”:”BAD_REQUEST”}

Http status: 203, 404, 500.
*Consultar arquivo de exemplo: adm_response_get_InfoEmpresaServico_NOK.txt.
8.3.3. InfoUsuario
Método para obter dados de um Usuário como nome, data de expiração, permissões e empresas liberadas
para o usuário. As permissões seguirão o formato padrão usado no cadastro de usuários.
* Só constarão no retorno as empresas que também estejam liberadas para o usuário informado na
requisição.
8.3.3.2. URL
<host>:<port>/<webservice>/api/adm?action=InfoUsuario&login=<LOGIN>
8.3.3.3. Filtro de Login
Não há um body na requisição, somente é necessário informar os parâmetros:

• login: Login do usuário que está sendo consultado
http://localhost:8080/webservice/api/adm?action=InfoUsuario&login=jose.silva (instalação in house)

Página 307 de 452
ou
https://ws.h.dfe.mastersaf.com.br/api/adm?action=InfoUsuario&login=jose.silva (ambiente de

8.3.3.6. Cabeçalho

a senha fornecidos.
8.3.3.7. Envio
Response Body:
{"empresas": [{
"cnpj": "00000123456790",
"ie": "0756453609090",
"im": "1234",
"razaoSocial": "Emp 1",
"nomeFantasia": "Emp 1 Fant",
"cidade": "Brasília",
"uf": "DF",
"parametrosNFe": {"versaoLayoutDfe": "4.03"},
"parametrosNFCe": {"versaoLayoutDfe": "4.03"},
"parametrosNDFe": {"versaoLayoutDfe": "Informado na Integração"}
}, {
"cnpj": "35402759009393",

Página 308 de 452
"ie": "110337609393",
"im": "",
"razaoSocial": "Emp 3",
"nomeFantasia": "Emp 3 Fant",
"cidade": "São Paulo",
"uf": "SP",
"parametrosNFe": {"versaoLayoutDfe": "4.03"},
"parametrosNFCe": {"versaoLayoutDfe": "4.03"},
"parametrosNDFe": {"versaoLayoutDfe": "Informado na Integração"}
}
],
"usuario": {
"dataExpiracao": "",
"permissoes": "ROLE_SUPER_ADMIN",
"nome": "Marcos",
"login": "marcos.tr",
"status": "Habilitado"},
"status": "OK"
}
CAMPO DESCRIÇÃO
“OK” quando encontrar o cadastro do usuário através do login passado por parâmetro.
status
“BAD_REQUEST” quando não encontrar o cadastro do usuário através do login
passado por parâmetro
empresas Dados sobre cada empresa liberada para o usuário
usuario Informações do usuário como nome, data de expiração e permissões.
Retornado somente quando ocorre uma rejeição ou erro, por exemplo usuário não
result
cadastrado.
*Consultar arquivo de exemplo: adm_response_get_InfoUsuario_OK.txt.

Página 309 de 452
Response Body: {“result”:”<descrição do erro>“, “status”:”BAD_REQUEST”}

Http status: 203, 404, 500.
*Consultar arquivo de exemplo: adm_response_get_InfoUsuario_NOK.txt.
9. MÓDULO CTE OS
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. 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
Para enviar vários CT-es OS 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
inutilização o procedimento é o mesmo.
9.2. MÉTODO: POST
9.2.1. EnviarPacote
Método para envio de CT-es OS para serem autorizadas pela Sefaz correspondente.
9.2.1.2. URL
<host>:<port>/<webservice>/api/cteos

Página 310 de 452
http://localhost:8080/webservice/api/cteos (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/cteos (ambiente de homologação do SaaS)
9.2.1.4. Layout

txt_conteudo Grupo de informações do CT-e OS Sim
Conteúdo do XML de CT-e OS. Informar dados conforme layout
xml Sim

9.2.1.6. Cabeçalho

a senha fornecidos.
9.2.1.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: teos_request_post_enviar_pacote_3.00.txt

Página 311 de 452

Http status: 202

Http status: 400, 412, 500.
9.2.2. Cancelar
Método para cancelar CT-es OS enviados ao webservice.
9.2.2.2. URL

ou
9.2.2.4. Layout

Conteúdo do Cancelamento de CT-e OS. Informar dados
xml Sim
conforme layout padrão da Receita Federal.

Página 312 de 452

Página 313 de 452

9.2.2.6. Cabeçalho

a senha fornecidos.
9.2.2.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: cteos_request_post_cancelar_3.00.txt


Http status: 400, 412, 500.
9.2.3. EnviarCartaCorrecaoCte
Método para emitir cartas de correção para CT-es OS já autorizadas.

Página 314 de 452
9.2.3.2. URL

ou
9.2.3.4. Layout

action Ação solicitada “EnviarCartaCorrecaoCte” Sim

9.2.3.6. Cabeçalho

a senha fornecidos.
9.2.3.7. Envio

Página 315 de 452

cteos_request_post_carta_correcao_3.00.txt


Http status: 400, 412, 500.
9.2.4. Inutilizar
Método para inutilizar numerações de CT-es OS que ainda não foram utilizadas.
9.2.4.2. URL

ou

Página 316 de 452
9.2.4.4. Layout

action Ação solicitada “Inutilizar” Sim
Conteúdo da Inutilização de CT-e OS. Informar dados, conforme
xml Sim

9.2.4.6. Cabeçalho

a senha fornecidos.
9.2.4.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: cteos_request_post_inutilizar_3.00.txt


Página 317 de 452

Http status: 400, 412, 500.
9.2.5.2. URL

ou
9.2.5.4. Layout

ids Sim
consultados.


Página 318 de 452

9.2.5.6. Cabeçalho

a senha fornecidos.
9.2.5.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: cteos_request_post_marcar_consultado.txt


9.2.6. EnviarGTV
Método para envio de evento Informações da GTV para CT-es OS já autorizadas.
9.2.6.2. URL

Página 319 de 452

ou
9.2.6.4. Layout

Action Ação solicitada “EnviarGTV” Sim
txt_conteudo Grupo de informações do evento Informações da GTV. Sim

9.2.6.6. Cabeçalho

a senha fornecidos.
9.2.6.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: cteos_request_post_gtv_3.00.txt

Página 320 de 452


Http status: 400, 412, 500.
9.3. MÉTODO: GET
lotes inutilizados.
9.3.1.2. URL
<host>:<port>/<webservice>/api/cteos?maxResults=
lista e grupo de retorno (impressao[], retorno{...}).
results para cada lista e grupo de retorno (impressao[], retorno{...}).

ou

Página 321 de 452
http://localhost:8080/webservice/api/cteos?maxResults=100 (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/cteos?maxResults=100 (ambiente de homologação do SaaS)

9.3.1.6. Cabeçalho

a senha fornecidos.
9.3.1.7. Envio
Response Body:
{“impressao”:[], “impressaoCCe”:[],”retorno”:{”ctes”:[],”ids”:[],”loteInutilizado”:[]}}
Http status: 200

Página 322 de 452
CAMPO DESCRIÇÃO
impressaoCCe Lista documentos de Carta de Correção para impressão.
ids
consultados.
Atributo de “retorno”. Listagem dos retornos das CT-es OS que foram processadas pelo
ctes
software.
*Consultar arquivo de exemplo: cteos_response_get.txt

Http status: 203, 404, 500.
9.3.2. GetXml
Método para obter o XML processado da respectiva chave de CT-e OS.
9.3.2.2. URL
<host>:<port>/<webservice>/api/cteos/<chave cte>/getXml
http://localhost:8080/webservice/api/cteos/<chave cte>/getXml (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/cteos/<chave cte>/getXml (ambiente de homologação do SaaS)

Página 323 de 452

9.3.2.5. Cabeçalho

a senha fornecidos.
correta.
9.3.2.6. Envio

Http status: 200
Consultar arquivo de exemplo: cteos_response_get_xml.txt

Http status: 203, 404, 500.

Página 324 de 452
Método para obter o XML cancelado da respectiva chave de CT-e OS.
9.3.3.2. URL
<host>:<port>/<webservice>/api/cteos/<chave cte>/getXmlCancelamento
http://localhost:8080/webservice/api/cteos/<chave cte>/getXmlCancelamento (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/cteos/<chave cte>/getXmlCancelamento (ambiente de

9.3.3.5. Cabeçalho

a senha fornecidos.
correta.
9.3.3.6. Envio

Página 325 de 452

Http status: 200
Consultar arquivo de exemplo: cteos_response_get_xml_cancelamento.txt

Http status: 203, 404, 500.
Método para obter o XML da última Carta de Correção da respectiva chave de CT-e OS.
9.3.4.2. URL
<host>:<port>/<webservice>/api/cteos/<chave cte>/getXmlCartaCorrecao
http://localhost:8080/webservice/api/cteos/<chave cte>/getXmlCartaCorrecao (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/cteos/<chave cte>/getXmlCartaCorrecao (ambiente de


Página 326 de 452
9.3.4.5. Cabeçalho

a senha fornecidos.
correta.
9.3.4.6. Envio

Http status: 200
Consultar arquivo de exemplo: cteos_response_get_xml_carta_correcao.txt

Http status: 203, 404, 500.
9.3.5. GetStatus
Método para obter o STATUS da respectiva chave de CT-e OS. 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.

Página 327 de 452
9.3.5.2. URL
host>:<port>/<webservice>/api/cteos/<chave cte>/getStatus
http://localhost:8080/webservice/api/cteos/<chave cte>/getStatus (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/cteos/<chave cte>/getStatus (ambiente de homologação do SaaS)

9.3.5.5. Cabeçalho

a senha fornecidos.
9.3.5.6. Envio

Http status: 200

Página 328 de 452
CAMPO DESCRIÇÃO
Atributo de “retorno”. Listagem dos retornos das CT-es OS. Caso localizado será retornado
ctes
Atributo de “retorno”. Listagem dos IDs dos processamentos. (*somente para
ids
inutilizações).
loteInutilizado
*Consultar arquivo de exemplo: cteos_response_getStatus.txt.

Http status: 203, 404, 500.
lotes inutilizados.
9.3.6.2. URL
<host>:<port>/<webservice>/api/cteos/getRetorno
<host>:<port>/<webservice>/api/cteos/getRetorno?maxResults=

Página 329 de 452
por vírgula.
http://localhost:8085/webservice/api/cteos/getRetorno/serie=700
ou
http://localhost:8085/webservice/api/cteos/getRetorno/serie=700,701,703
http://localhost:8085/webservice/api/cteos/getRetorno/serie=700?maxResults=100
ou
http://localhost:8085/webservice/api/cteos/getRetorno/serie=700,701,703?maxResults=100
http://localhost:8080/webservice/api/cteos/getRetorno (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/cteos/getRetorno (ambiente de homologação do SaaS)

9.3.6.8. Cabeçalho

a senha fornecidos.

Página 330 de 452
9.3.6.9. Envio

Response Body: {“retorno”:{”ctes”:[],”ids”:[],”loteInutilizado”:[]}}

Http status: 200
CAMPO DESCRIÇÃO
ids
consultados.
Atributo de “retorno”. Listagem dos retornos das CT-es OS que foram processadas pelo
ctes
software.
*Consultar arquivo de exemplo: cte_response_getRetorno.txt

Http status: 203, 404, 500.
Método para obter o Status de uma CT-e OS 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. É diferente da
finalizado.

Página 331 de 452

9.3.7.2. URL
<host>:<port>/<webservice>/api/cteos/getStatus
9.3.7.3. Filtro de CNPJ Emissor, Número da CT-e OS e Série da CT-e OS
É necessário informar os parâmetros de CNPJ Emissor, Número CT-e OS e Série CT-e OS para realizar a
busca. Todos os parâmetros são obrigatórios.
http://localhost:8080/webservice/api/cteos/getStatus?cnpjEmissor=1234567890&numeroCte=1000&ser
ie=730 (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/cteos/getStatus?cnpjEmissor=1234567890&numeroCte=1000&se
rie=730 (ambiente de homologação do SaaS)

9.3.7.6. Cabeçalho

a senha fornecidos.

Página 332 de 452
9.3.7.7. Envio

Http status: 200
CAMPO DESCRIÇÃO
Atributo de “retorno”. Listagem dos retornos das CT-es OS. Caso localizado será retornado
ctes
ids Atributo de “retorno”. Listagem dos IDs dos processamentos (*somente para inutilizações).
loteInutilizado
*Consultar arquivo de exemplo: cteos_response_getStatus_com_parametros.txt.

Http status: 203, 404, 500.
9.3.8. GetDacteOS
Método para obter o DACTE OS da respectiva chave de CT-e OS.

9.3.8.2. URL
<host>:<port>/<webservice>/api/cteos/<chave cte>/getDacteOS

Página 333 de 452
http://localhost:8080/webservice/api/cteos/<chave cte>/getDacteOS (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/cteos/<chave cte>/getDacteOS (ambiente de homologação do
SaaS)

9.3.8.5. Cabeçalho

a senha fornecidos.
9.3.8.6. Envio
Http status: 200

Http status: 203, 404, 500.

Página 334 de 452
9.3.9. Consulta Log do CT-e OS
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. Este método retorna uma
9.3.9.2. URL
<host>:<port>/<webservice>/api/cteos/getLog?cnpj=<número cnpj>&ie=<número inscrição

estadual>&serie=<série do CT-e OS>&numero=<número do CT-e OS>
<host>:<port>/<webservice>/api/cteos/getLog?cnpj=<número cnpj>&ie=<número inscrição

estadual>&serie=<série do CT-e OS>&numero=<número do CT-e
OS>&offset=<offset>&maxResults=<maxResults>

Página 335 de 452
http://localhost:8080/webservice/api/cteos/getLog?cnpj=00910509000171&ie=0018000282&serie=45
0&numero=10006&offset=0&maxResults=10 (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/cteos/getLog?cnpj=00910509000171&ie=0018000282&serie=45
0&numero=10006&offset=0&maxResults=10 (ambiente de homologação do SaaS)

9.3.9.5. Cabeçalho

a senha fornecidos.
9.3.9.6. Envio

Http status: 200
CAMPO DESCRIÇÃO
Message “OK”

Página 336 de 452
message “OK”
hasMore
true ou false.
offset
*Consultar arquivo de exemplo: cteos_response_getLog.txt
Não há.
9.3.10. Consulta Listagem de CT-e OS
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. 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.
9.3.10.2. URL
<host>:<port>/<webservice>/api/cteos/getListagem?cnpj=<número cnpj>&ie=<número inscrição

DD/MM/AAAA HH:MM>
<host>:<port>/<webservice>/api/cteos/getListagem?cnpj=<número cnpj>&ie=<número inscrição


Página 337 de 452
http://localhost:8080/webservice/api/cteos/getListagem?cnpj=00910509000171&ie=0018000282&peri
odoInicial=01/12/2016 00:00&periodoFinal=13/03/2017 00:00&offset=0&maxResults=10 (instalação in
house)
ou
https://ws.h.dfe.mastersaf.com.br/api/cteos/getListagem?cnpj=00910509000171&ie=0018000282&peri
odoInicial=01/12/2016 00:00&periodoFinal=13/03/2017 00:00&offset=0&maxResults=10 (ambiente de


a senha fornecidos.
9.3.10.6. Envio

Página 338 de 452
Http status: 200

Página 339 de 452
CAMPO DESCRIÇÃO

Result\inicioPrest Tag <xMunIni> + <UFIni> do XML do CT-e OS
Result\fimPrest Tag <xMunFim> + <UFFim> do XML do CT-e OS
Result\naturezaOperacao Tag <natOp> do XML do CT-e OS
Result\protocolo Tag <nProt> do XML de Autorização do CT-e OS
Result\locEnvio Tag <xMunEnv> + <UFEnv> do XML do CT-e OS
Result\serie Tag <serie> do XML do CT-e OS
Result\numeroCte Tag <nCT> do XML do CT-e OS
Descrição do Status do CT-e OS. Em caso de status Rejeição,
haverá a descrição da rejeição
Result\dataEmissao Tag <dhEmi> do XML da CT-e OS
Result\cpfCnpjDest Tag <toma>\<CNPJ> do XML do CT-e OS
Result\razaoSocialDest Tag <toma>\<xNome> do XML do CT-e OS
Result\situacao Status do CT-e OS
Result\cnpjEmit Tag <emit>\<CNPJ> do XML do CT-e OS
Result\chaveAcesso Chave de Acesso do CT-e OS
Result\valorTotalPrestacao Tag <vTPrest> do XML do CT-e OS
Result\razaoSocialEmit Tag <emit>\<xNome> do XML do CT-e OS
Message “OK”
hasMore
Count Quantia total de itens para os filtros informados.
Offset
*Consultar arquivo de exemplo: cte_response_getListagem.txt
Não há.

Página 340 de 452

Página 341 de 452
10. MÓDULO RECEPTOR CTE OS
Esse módulo necessita que sejam enviados os XMLs recebidos e depois que sejam marcados como
consultados. É possível ainda consultar um documento e obter o seu XML.
Como em todos os módulos existe uma consulta padrão (GET) e também alguns métodos para consulta
de XMLs (processados e cancelados).
10.2. MÉTODO: POST
Método para envio de CT-es OS de fornecedores ao WebService.
10.2.1.2. URL
<host>:<port>/<webservice>/api/recebimentoCteos
http://localhost:8080/webservice/api/recebimentoCteos (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoCteos (ambiente de homologação do SaaS)

Página 342 de 452
10.2.1.4. Layout

Conteúdo do XML de CT-e OS. Informar dados conforme
txt_conteudo Sim


a senha fornecidos.
10.2.1.7. Envio
receptor_cteos_request_post_enviar_recebimento.txt

Http status: 202

Página 343 de 452
CAMPO DESCRIÇÃO
Recebimento Tipo do recebimento. Ex.: “xmlEmissao”.
*Consultar arquivo de exemplo: receptor_cteos_response_post_enviar_recebimento.txt

Http status: 400, 412, 500.
10.2.2. ConsultarDocFornecedor
Método para consultar status de CT-e OS recebido. A consulta pode ser feita usando a chave do
documento ou através da combinação de CNPJ, IE, número e série.
10.2.2.2. URL

ou

Página 344 de 452
10.2.2.4. Layout

action Ação solicitada “ConsultarDocFornecedor” Sim
Atributo de “txt_conteudo”. Tipo do documento
tpDoc “CT-e OS” Sim
para consulta.
Atributo de “txt_conteudo”. Chave do CT-e OS.
chave Informar quando não for informar os outros campos Não
“cnpj”, “ie”, “nrDoc” e “serie”.
Atributo de “txt_conteudo”. CNPJ da empresa. Não
cnpj Não
informar quando campo “chave” for informado.
Atributo de “txt_conteudo”. IE da empresa. Não
ie Não
Atributo de “txt_conteudo”. Número do CT-e OS.
nrDoc Não
Não informar quando campo “chave” for informado.
Atributo de “txt_conteudo”. Série do CT-e OS. Não
serie Não


a senha fornecidos.

Página 345 de 452
10.2.2.7. Envio
receptor_cteos_request_post_consultar_doc_fornecedor_1.txt
Exemplo de Request Body conforme arquivo de exemplo (Consulta pelos dados do CT-e OS):
receptor_cteos_request_post_consultar_doc_fornecedor_2.txt

Http status: 202
CAMPO DESCRIÇÃO
status Código do status do documento.

Http status: 400, 412, 500.
10.2.3.2. URL

Página 346 de 452

ou
10.2.3.4. Layout

ids Sim
consultados.


a senha fornecidos.

Página 347 de 452
10.2.3.7. Envio
receptor_cteos_request_post_marcar_consultado.txt


10.2.4. EnviarPrestacaoServicoDesacordo
Método para envio de evento de prestação de serviço em desacordo para CT-e OS recebida e autorizada.
10.2.4.2. URL

ou
10.2.4.4. Layout

Página 348 de 452

action Ação solicitada “EnviarPrestacaoServicoDesacordo” Sim
txt_conteudo Sim
prestação de serviço em desacordo.


a senha fornecidos.
10.2.4.7. Envio
receptor_cteos_request_post_enviar_prestacao_servico_desacordo.txt


Página 349 de 452
Http status: 400, 412, 500.

10.3. MÉTODO: GET
10.3.1.2. URL

ou


Página 350 de 452

a senha fornecidos.
10.3.1.6. Envio
Response Body: {“retorno”:{“recebimentos”:[], “eventoDesacordo”:[],”ids”:[]}}

Http status: 200
CAMPO DESCRIÇÃO
Atributo de “retorno”. Listagem dos Ids dos processamentos que constam como não
Ids
consultados.
Atributo de “retorno”. Listagem dos retornos dos CT-es OS que foram processadas pelo
Recebimentos
software.
eventoDesacordo
*Consultar arquivo de exemplo: receptor_cteos_response_get.txt
Não há.
10.3.2. GetXml
Método para obter o XML processado da respectiva chave de CT-e OS.

Página 351 de 452
10.3.2.2. URL
<host>:<port>/<webservice>/api/recebimentoCteos/<chave cte>/getXml
http://localhost:8080/webservice/api/recebimentoCteos/<chave cte>/getXml (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoCteos/<chave cte>/getXml (ambiente de


a senha fornecidos.
correta.
10.3.2.6. Envio

Http status: 200

Página 352 de 452
Consultar arquivo de exemplo: receptor_cteos_response_get_xml.txt

Http status: 203, 404, 500.
Método para obter o XML cancelado da respectiva chave de CT-e OS.
10.3.3.2. URL
<host>:<port>/<webservice>/api/recebimentoCteos/<chave cte>/getXmlCancelamento
http://localhost:8080/webservice/api/recebimentoCteos/<chave cte>/getXmlCancelamento
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoCteos/<chave cte>/getXmlCancelamento


Página 353 de 452

a senha fornecidos.
correta.
10.3.3.6. Envio

Http status: 200
Consultar arquivo de exemplo: receptor_cteos_response_get_xml_cancelado.txt

Http status: 203, 404, 500.
10.3.4. GetStatus
Método para obter o Status (Código-Descrição) da respectiva chave de CT-e OS. Deve ser utilizado para
finalizado.

Página 354 de 452

10.3.4.2. URL
<host>:<port>/<webservice>/api/recebimentoCteos/<chave cte>/getStatus
http://localhost:8080/webservice/api/recebimentoCteos/<chave cte>/getStatus (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoCteos/<chave cte>/getStatus (ambiente de


a senha fornecidos.
10.3.4.6. Envio

Página 355 de 452
Response Body:
{
"retorno": {
"recebimentos": [],
"ids": [],
"eventoDesacordo": []
}
}
Http status: 200
CAMPO DESCRIÇÃO
ids Não há.
recebimentos Atributo de “retorno”. Listagem dos retornos das CT-es OS que foram solicitados.
eventoDesacordo Atributo de “retorno”. Não será preenchido.
*Consultar arquivo de exemplo: receptor_cteos_response_getStatus.txt.
Não há.
10.3.5.2. URL
<host>:<port>/<webservice>/api/recebimentoCteos/getRetorno

Página 356 de 452
http://localhost:8080/webservice/api/recebimentoCteos/getRetorno (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoCteos/getRetorno (ambiente de homologação do
SaaS)


a senha fornecidos.
10.3.5.6. Envio
Response Body: {“retorno”:{“recebimentos”:[],”eventoDesacordo”:[],”ids”:[]}}

Http status: 200

Página 357 de 452
CAMPO DESCRIÇÃO
ids
consultados.
recebimentos
pelo software.
eventoDesacordo
*Consultar arquivo de exemplo: receptor_cteos_response_getRetorno.txt
Método para obter o XML da carta de correção de recebimento processado da respectiva chave de CT-e
OS.
10.3.6.2. URL
<host>:<port>/<webservice>/api/recebimentoCteos/<chave cte>/getXmlCartaCorrecao
http://localhost:8080/webservice/api/recebimentoCteos/<chave cte>/getXmlCartaCorrecao (instalação

in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoCteos/<chave cte>/getXmlCartaCorrecao (ambiente


Página 358 de 452


a senha fornecidos.
correta.
10.3.6.6. Envio

Http status: 200
Consultar arquivo de exemplo: receptor_cteos_response_get_xml_carta_correcao.txt

Http status: 203, 404, 500.
Método para obter o DACTE da carta de correção de recebimento para a respectiva chave de CT-e OS.

Página 359 de 452
10.3.7.2. URL
<host>:<port>/<webservice>/api/recebimentoCteos/<chave cte>/getCartaCorrecao
http://localhost:8080/webservice/api/recebimentoCteos/<chave cte>/getCartaCorrecao (instalação in

house)
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoCteos/<chave cte>/getCartaCorrecao (ambiente de


a senha fornecidos.
10.3.7.6. Envio
Http status: 200

Página 360 de 452

Http status: 203, 404, 500.
10.3.8. Consulta Log do CT-e OS
Método de consulta para retornar os logs do CT-e OS do Receptor, 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. Este método
retorna uma lista paginada com todos 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.
10.3.8.2. URL
<host>:<port>/<webservice>/api/recebimentoCteos/getLog?cnpj=<número cnpj>&ie=<número inscrição

estadual>&serie=<série do CT-e OS>&numero=<número do CT-e OS>
<host>:<port>/<webservice>/api/recebimentoCteos/getLog?cnpj=<número cnpj>&ie=<número inscrição

estadual>&serie=<série do CT-e OS>&numero=<número do CT-e
OS>&offset=<offset>&maxResults=<maxResults>

Página 361 de 452
http://localhost:8080/webservice/api/recebimentoCteos/getLog?cnpj=00910509000171&ie=00180002
82&serie=450&numero=10006&offset=0&maxResults=10 (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoCteos/getLog?cnpj=00910509000171&ie=00180002
82&serie=450&numero=10006&offset=0&maxResults=10 (ambiente de homologação do SaaS)


a senha fornecidos.
10.3.8.6. Envio

Http status: 200

Página 362 de 452
CAMPO DESCRIÇÃO
Message “OK”
message “OK”
Indica se há mais uma página a ser buscada para os filtros informados. true
hasMore
ou false.
Posição do objeto a partir do qual a página deve ser carregada, informada
offset
nos parâmetros.
*Consultar arquivo de exemplo: receptor_cteos_response_getLog.txt
Não há.
10.3.9. Consulta Listagem de CT-e OS
Método de consulta para retornar uma listagem de CT-e OS do Receptor, irá retornar alguns dados principais
de 1 ou N CT-e OS 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
10.3.9.2. URL

Página 363 de 452
<host>:<port>/<webservice>/api/recebimentoCteos/getListagem?cnpj=<número cnpj>&ie=<número
DD/MM/AAAA HH:MM>
<host>:<port>/<webservice>/api/recebimentoCteos/getListagem?cnpj=<número cnpj>&ie=<número
http://localhost:8080/webservice/api/recebimentoCteos/getListagem?cnpj=00910509000171&ie=0018
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoCteos/getListagem?cnpj=00910509000171&ie=0018


Página 364 de 452
a senha fornecidos.
10.3.9.6. Envio
Http status: 200
CAMPO DESCRIÇÃO

Result\inicioPrest Tag <xMunIni> + <UFIni> do XML do CT-e OS
Result\fimPrest Tag <xMunFim> + <UFFim> do XML do CT-e OS
Result\naturezaOperacao Tag <natOp> do XML do CT-e OS
Result\protocolo Tag <nProt> do XML de Autorização do CT-e OS
Result\locEnvio Tag <xMunEnv> + <UFEnv> do XML do CT-e OS
Result\serie Tag <serie> do XML do CT-e OS
Result\numeroCte Tag <nCT> do XML do CT-e OS
Descrição do Status do CT-e OS. Em caso de status Rejeição,
haverá a descrição da rejeição
Result\dataEmissao Tag <dhEmi> do XML da CT-e OS
Result\cpfCnpjDest Tag <toma>\<CNPJ> do XML do CT-e OS
Result\razaoSocialDest Tag <toma>\<xNome> do XML do CT-e OS
Result\situacao Status do CT-e OS
Result\cnpjEmit Tag <emit>\<CNPJ> do XML do CT-e OS
Result\chaveAcesso Chave de Acesso do CT-e OS
Result\valorTotalPrestacao Tag <vTPrest> do XML do CT-e OS
Result\razaoSocialEmit Tag <emit>\<xNome> do XML do CT-e OS
message “OK”

Página 365 de 452

hasMore
offset
*Consultar arquivo de exemplo: receptor_cteos_response_getListagem.txt
Não há.
10.3.10. GetDacteOS
Método para obter o DACTE da respectiva chave de CT-e OS.
10.3.10.2. URL
<host>:<port>/<webservice>/api/recebimento/<chave cteos>/getDacteOS
http://localhost:8080/webservice/api/ recebimento/<chave cteos>/getDacteOS (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/ recebimento/<chave cteos>/getDacteOS (ambiente de

• Receptores CT-e e NF-e Integrador (ROLE_RECEBIMENTO_INTEGRADOR);

Página 366 de 452

a senha fornecidos.
10.3.10.6. Envio
Http status: 200

Http status: 203, 404, 500.

Página 367 de 452
11. MÓDULO NFCE (Consumidor)
Resumo do processo: primeiramente deve-se enviar um pacote de dados; depois deve-se realizar uma consulta
para receber uma lista de ids e por fim; deve-se enviar um novo pacote para marcar os ids consultados para que
na 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. Com isso,
basta realizar POST para enviar os pacotes e GET para consultar o resultado do processamento.
txt_conteudo é formado por um objeto json, cujo atributo “xml” deve ser preenchido de acordo com
layout/formato descrito em cada método.
11.2. MÉTODO: POST
11.2.1. EnviarPacote
Método para envio de NFC-e para ser autorizada pela Sefaz correspondente.
11.2.1.2. URL
<host>:<port>/<webservice>/api/nfce

Página 368 de 452
http://localhost:8080/webservice/api/nfce (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/nfce (ambiente de homologação do SaaS)
11.2.1.4. Layout

txt_conteudo Grupo de informação da NFC-e Sim
Conteúdo do XML de Emissão da NFC-e.
• Formato XML: Informar dados do NFC-e conforme layout XML
Xml Sim
padrão da Receita Federal. O grupo “<infNFeSupl>” não
precisa constar no XML, o DFE irá gerar esta informação.
Informações para contingência ou parâmetros para filtro de
mastersaf Não
impressão.
Ao incluir o
parâmetro,
mesmo que
em branco (""),
é assumido
como TRUE, o
correto é não
xmlLegado Fica dentro de mastersaf. Parâmetro integração de xml legado. Não
enviar o
parâmetro
caso não seja
legado.
Arquivo deve
conter tag
<nfeProc> se

Página 369 de 452
existir o
parâmetro.

• NFC-e Integrador (ROLE_NFCE_INTEGRADOR)

a senha fornecidos.
11.2.1.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: nfce_request_post_enviar_pacote.txt
Exemplo de Request Body informando o Responsável Técnico: nfce_request_post_enviar_pacote2.txt

Http status: 202

Http status: 400, 412, 500.
11.2.2. Cancelar

Página 370 de 452
Método para cancelar NFC-e enviado ao webservice.
11.2.2.2. URL

ou

Página 371 de 452
11.2.2.4. Layout

Action Ação solicitada “Cancelar” Sim
Conteúdo do Cancelamento de NF-e.
Xml Cancelamento de NFC-e (layout/planilha está disponível no Sim
Web Help > Manuais Técnicos > Integração de Dados DFE >
Ao incluir o
parâmetro,
mesmo que
em branco
(""), é
assumido
como TRUE,
o correto é
xmlLegado Fica dentro de mastersaf. Parâmetro integração de xml legado. não enviar o Não
parâmetro
caso não
seja legado.
Arquivo deve
conter tag
<nfeProc> se
existir o
parâmetro.


Página 372 de 452

11.2.2.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: nfce_request_post_cancelar.txt


Http status: 400, 412, 500.
11.2.3. Inutilizar
Método para inutilizar numerações de NFC-e que ainda não foram utilizadas.
11.2.3.2.URL

Página 373 de 452

ou
11.2.3.4. Layout

action Ação solicitada. “Inutilizar” Sim
referencia Nome do arquivo de integração. Não
Conteúdo da Inutilização de NF-e.
Xml Inutilização de NF-e (layout/planilha está disponível no Web Help Sim
> Manuais Técnicos > Integração de Dados DFE >


a senha fornecidos.
11.2.3.7. Envio

Página 374 de 452
Exemplo de Request Body conforme arquivo de exemplo: nfce_request_post_inutilizar.txt


Http status: 400, 412, 500.

Página 375 de 452
11.2.4.2. URL

ou
11.2.4.4. Layout

Action Ação solicitada “MarcarConsultado” Sim
Ids Sim
como consultados.
id_integrador Não
documento.


Página 376 de 452

a senha fornecidos.
11.2.4.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: nfce_request_post_marcar_consultado.txt


11.2.5.2. URL

Página 377 de 452

ou
11.2.5.4. Layout


• NFC-e Integrador (ROLE_NFCE_INTEGRADOR);

a senha fornecidos.
11.2.5.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: nfce_request_post_marcar_impresso.txt

Página 378 de 452


11.2.6. ReimpressaoDanfe
Método para solicitar reimpressão de NFC-es.
11.2.6.2. URL

ou
11.2.6.4. Layout

action Ação solicitada “ReimpressaoDanfe” Sim
txt_conteudo Grupo de informações de reimpressão. Sim
Conteúdo da solicitação de Reimpressão de NFC-e.
xml Sim
Informar dados conforme layout padrão do produto.

Página 379 de 452


a senha fornecidos.
11.2.6.7. Envio
Exemplo de Request Body conforme arquivo de exemplo: nfce_request_post_reimpressao_danfe.txt


Http status: 400, 412, 500.
11.2.7. EnviarEmail
Método para solicitar o envio/reenvio de email de uma NFC-e autorizada ou cancelada.

Página 380 de 452
11.2.7.2. URL

ou
11.2.7.4. Layout

action Ação solicitada “EnviarEmail” Sim
txt_conteudo Grupo de informação da consulta Sim
11.2.7.5. Detalhamento campo txt_conteudo

cnpj CNPJ do emissor da NFC-e Obrigatório Numérico 14
ie Inscrição Estadual do emissor da NFC-e Obrigatório Caractere 2-14
serie Série da NFC-e Obrigatório Numérico 1-3
numero Número da NFC-e Obrigatório Numérico 1-9
Documentos que serão enviados em anexo no e-mail. Se Opcional 0-1
não informado, por padrão será enviado “XML e PDF”. 1 – XML e PDF
anexo 2 – XML Numérico
3 – PDF
4 – Nenhum
Endereço de e-mail do destinatário. Poderá ser 0-1000
informado mais de um endereço separado por vírgula.
endereco_ Se não informado: será enviado para o endereço de e-
Opcional Caractere
email mail existente na NFC-e.
Se informado: será enviado somente para este(s)
endereço(s) de e-mail.

Página 381 de 452


a senha fornecidos.
11.2.7.8. Envio
O corpo do POST (request body) deve ser um json contendo todos os campos do layout do método, assim
como o txt_conteudo deve ser um json contendo todos os campos do detalhamento.
Exemplo de Request Body conforme arquivo de exemplo: nfce_request_post_enviar_email.txt

Http status: 200

Http status: 400, 412, 500.

Página 382 de 452
11.3. MÉTODO: GET
lotes inutilizados.
11.3.1.2. URL
<host>:<port>/<webservice>/api/nfce/getRetorno
<host>:<port>/<webservice>/api/nfce/getRetorno?maxResults=
por vírgula.
http://localhost:8085/webservice/api/nfce/getRetorno/serie=700
ou
http://localhost:8085/webservice/api/nfce/getRetorno/serie=700,701,703
http://localhost:8085/webservice/api/nfce/getRetorno/serie=700?maxResults=100
ou
http://localhost:8085/webservice/api/nfce/getRetorno/serie=700,701,703?maxResults=100

Página 383 de 452
http://localhost:8080/webservice/api/nfce/getRetorno (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/nfce/getRetorno (ambiente de homologação do SaaS)
http://localhost:8080/webservice/api/nfce/getRetorno?maxResults=100 (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/nfce/getRetorno?maxResults=100 (ambiente de homologação do
SaaS)


a senha fornecidos.
11.3.1.9. Envio
Response Body: {"retorno": {"nfces": [],"ids": [],"loteInutilizado": []}}

Http status: 200

Página 384 de 452
CAMPO DESCRIÇÃO
Atributo de “retorno”.
Ids
Listagem dos IDs dos processamentos que constam como não consultados.
Nfces
Listagem dos retornos das NFC-es que foram processadas pelo software.
loteInutilizado
Listagem dos retornos das Inutilizações enviadas.
*Consultar arquivo de exemplo: nfce_response_getRetorno.txt
Não há.
11.3.2.2. URL
<host>:<port>/<webservice>/api/nfce/getImpressao
http://localhost:8080/webservice/api/nfce/getImpressao (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/nfce/getImpressao (ambiente de homologação do SaaS)


Página 385 de 452


a senha fornecidos.
11.3.2.6. Envio
Response Body: {"impressao": []}

Http status: 200
CAMPO DESCRIÇÃO
*Consultar arquivo de exemplo: nfce_response_getImpressao.txt
Não há.
11.3.3. GetXml
Método para obter o XML processado da respectiva chave de NFC-e.

Página 386 de 452
11.3.3.2. URL
<host>:<port>/<webservice>/api/nfce/<chave nfce>/getXml
http://localhost:8080/webservice/api/nfce/<chave nfce>/getXml (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/nfce/<chave nfce>/getXml (ambiente de homologação do SaaS)


correta.
11.3.3.6. Envio

Http status: 200
Consultar arquivo de exemplo: nfce_response_get_xml.txt

Página 387 de 452

Http status: 203, 404, 500.
Método para obter o XML cancelado da respectiva chave de NFC-e.
11.3.4.2. URL
<host>:<port>/<webservice>/api/nfce/<chave nfce>/getXmlCancelamento
http://localhost:8080/webservice/api/nfce/<chave nfce>/getXmlCancelamento
ou
https://ws.h.dfe.mastersaf.com.br/api/nfce/<chave nfce>/getXmlCancelamento


a senha fornecidos.

Página 388 de 452
11.3.4.6. Envio

Http status: 200
Consultar arquivo de exemplo: nfce_response_get_xml_cancelamento.txt

Http status: 203, 404, 500.
11.3.5. GetDanfe
Método para obter o DANFE da respectiva chave de NFC-e.

11.3.5.2. URL
<host>:<port>/<webservice>/api/nfce/<chave nfce>/getDanfe
http://localhost:8080/webservice/api/nfce/<chave nfce>/getDanfe (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/nfce/<chave nfce>/getDanfe (ambiente de homologação do SaaS)

Página 389 de 452


a senha fornecidos.
11.3.5.6. Envio
Http status: 200

Http status: 203, 404, 500.
11.3.6. GetStatus
Método para obter o Status (Código-Descrição) da respectiva chave de NFC-e. Deve ser utilizado para
finalizado.
Os atributos relacionados ao id de processamento do documento (“ids”, “idProcessamento” ou

Página 390 de 452
11.3.6.2. URL
<host>:<port>/<webservice>/api/nfce/<chave nfce>/getStatus
http://localhost:8080/webservice/api/nfce/<chave nfce>/ getStatus (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/nfce/<chave nfce>/ getStatus (ambiente de homologação do
SaaS)


a senha fornecidos.
11.3.6.6. Envio

Página 391 de 452
Response Body:
{
"retorno": {
"ids": [],
"loteInutilizado": [],
"nfces": [],
"referencia":""
}
}
Http status: 200
CAMPO DESCRIÇÃO
Atributo de “retorno”. Listagem dos retornos das NFC-es.Caso localizado será retornado o
nfces
Atributo de “retornoListagem dos retorno de Inutilizações. Será preenchido se o
loteInutilizado
referencia Nome do arquivo utilizado na integração.
*Consultar arquivo de exemplo: nfce_response_getStatus.txt.

Http status: 203, 404, 500.

Página 392 de 452
Método para obter o Status (Código-Descrição) de NFC-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.
Os atributos relacionados ao id de processamento do documento (“ids”, “idProcessamento” ou
11.3.7.2. URL
<host>:<port>/<webservice>/api/nfce/getStatus
11.3.7.3. Filtro de CNPJ Emissor, Número da NFC-e e Série da NFC-e
É necessário informar os parâmetros de CNPJ Emissor, Número NFC-e e Série NFC-e para realizar a busca.
Todos os parâmetros são obrigatórios.
http://localhost:8080/webservice/api/nfce/getStatus?cnpjEmissor=1234567890&numeroNfce=1000&ser
ie=730 (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/nfce/getStatus?cnpjEmissor=1234567890&numeroNfce=1000&se
rie=730 (ambiente de homologação do SaaS)


Página 393 de 452

a senha fornecidos.
11.3.7.7. Envio
Response Body:
{
"retorno": {
"ids": [],
"loteInutilizado": [],
"nfces": [],
"referencia":""
}
}
Http status: 200
CAMPO DESCRIÇÃO
Atributo de “retorno”. Listagem dos retornos das NFC-es. Caso localizado será retornado o
nfces
loteInutilizado
referencia Nome do arquivo utilizado na integração.
*Consultar arquivo de exemplo: nfce_response_getStatus_com_parametros.txt.

Página 394 de 452

Http status: 203, 404, 500.
11.3.8. Consulta Log da NFC-e
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. Este método retorna uma
11.3.8.2. URL
<host>:<port>/<webservice>/api/nfce/getLog?cnpj=<número cnpj>&ie=<número inscrição

estadual>&serie=<série da NFC-e>&numero=<número da NFC-e>
<host>:<port>/<webservice>/api/nfce/getLog?cnpj=<número cnpj>&ie=<número inscrição

estadual>&serie=<série da NFC-e>&numero=<número da NFC-

Página 395 de 452
http://localhost:8080/webservice/api/nfce/getLog?cnpj=00910509000171&ie=0018000282&serie=450
&numero=10006&offset=0&maxResults=10 (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/nfce/getLog?cnpj=00910509000171&ie=0018000282&serie=450
&numero=10006&offset=0&maxResults=10 (ambiente de homologação do SaaS)


a senha fornecidos.
11.3.8.6. Envio
Http status: 200

Página 396 de 452
CAMPO DESCRIÇÃO

message “OK”
hasMore
true ou false.
offset
*Consultar arquivo de exemplo: nfce_response_get_log.txt
Não há.
11.3.9. Consulta Listagem de NFC-e
Método de consulta para retornar uma listagem de NFC-e, irá retornar alguns dados principais de 1 ou N NFC-
es 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.
11.3.9.2. URL

Página 397 de 452
<host>:<port>/<webservice>/api/nfce/getListagem?cnpj=<número cnpj>&ie=<número inscrição

DD/MM/AAAA HH:MM>
<host>:<port>/<webservice>/api/nfce/getListagem?cnpj=<número cnpj>&ie=<número inscrição

http://localhost:8080/webservice/api/nfce/getListagem?cnpj=00910509000171&ie=0018000282&perio
doInicial=01/12/2016 00:00&periodoFinal=13/03/2017 00:00&offset=0&maxResults=10 (instalação in
house)
ou
https://ws.h.dfe.mastersaf.com.br/api/nfce/getListagem?cnpj=00910509000171&ie=0018000282&perio
doInicial=01/12/2016 00:00&periodoFinal=13/03/2017 00:00&offset=0&maxResults=10 (ambiente de


Página 398 de 452
a senha fornecidos.
11.3.9.6. Envio
Http status: 200
CAMPO DESCRIÇÃO

Result\tipoNfe Tag <tpNF> do XML da NFC-e
Result\cpfCnpjTransportador Tag <CNPJ> da transportadora do XML da NFC-e
Result\tipoFrete Tag <modFrete> do XML da NFC-e
Result\municipioDest Tag <xMun> do destinatário do XML da NFC-e
Result\cfop Tag <CFOP> do XML da NFC-e
Result\dataAutorizacao Tag <dhRecbto> do XML de Autorização da NFC-e
Result\numeroNfce Tag <nNF> do XML da NFC-e
Result\naturezaOperacao Tag <natOp> do XML da NFC-e
Result\pesoBruto Tag <pesoB> do XML da NFC-e
Result\valorTransporte Tag <vServ> do transporte do XML da NFC-e
Descrição do Status da NFC-e. Em caso de status Rejeição, haverá a
Result\placaVeiculoTransportador Tag <placa> do transportador do XML da NFC-e
Result\codigoAntt Tag <RNTC> do transportador do XML da NFC-e
Result\ufPlaca Tag <UF> da placa do transportador do XML da NFC-e
Result\ufTrans Tag <UF> do transportador do XML da NFC-e
Result\razaoSocialDest Tag <xNome> do destinatário do XML da NFC-e
Result\cpfCnpjDest Tag <CNPJ> do destinatário do XML da NFC-e

Página 399 de 452
Result\enderecoTrans Tag <xEnder> da transportadora do XML da NFC-e

Result\dataSaida Tag <dhSaiEnt> do XML da NFC-e
Situação da NFC-e (Autorizado, Cancelado, Rejeitado, Inutilizado,
Result\situação
Result\chaveAcesso Chave de Acesso da NFC-e
Result\razaoSocialEmissor Tag <xNome> do emissor do XML da NFC-e
Result\ufFornec Tag <UF> do emissor do XML da NFC-e
Result\numeracaoVolume Tag <nVol> do XML da NFC-e
Result\cepFornec Tag <CEP> do emissor do XML da NFC-e
Result\marca Tag <marca> do XML da NFC-e
Result\protocolo Tag <nProt> do XML da NFC-e
Result\serie Tag <serie> do XML da NFC-e
Result\cnpjEmissor Tag <CNPJ> do emissor do XML da NFC-e
Result\qtdaVolume Tag <qVol> do XML da NFC-e
Result\razaoSocialTrans Tag <xNome> da transportadora do XML da NFC-e
Result\dataEmissao Tag <dhEmi> do XML da NFC-e
Result\bairroFornec Tag <xBairro> do emissor do XML da NFC-e
Result\municipioFornec Tag <xMun> do emissor do XML da NFC-e
Result\ufDestinatario Tag <UF> do destinarário do XML da NFC-e
Result\valorTotal Tag <vNF> do XML da NFC-e
Result\cepDest Tag <CEP> do destinatário do XML da NFC-e
Result\bairroDest Tag <xBairro> do destinatário do XML da NFC-e
Result\pesoLiquido Tag <pesoL> do XML da NFC-e
Result\municipioTrans Tag <xMun> da transportadora do XML da NFC-e
Result\enderecoFornec Tag <xLgr> do emissor do XML da NFC-e
Result\enderecoDest Tag <xLgr> do destinatário do XML da NFC-e
Result\especie Tag <esp> do XML da NFC-e
message “OK”
hasMore
offset
*Consultar arquivo de exemplo: nfce_response_get_listagem.txt

Página 400 de 452
Não há.
12. MÓDULO RECEPTOR NFE TRANSPORTADOR

(MERCANTIL)
Esse módulo necessita que sejam enviados os XMLs recebidos de fornecedores e depois que sejam marcados
como consultados.
Como em todos os módulos existe uma consulta padrão (GET) e também alguns métodos para consulta de
XMLs (processados e cancelados).
12.2. MÉTODO: POST
Método para envio de NF-es de fornecedores ao WebService contemplando o interesse do agente

transportador. Será utilizado os mesmos métodos, já existentes, para receber documentos NF-e como
destinatário. Para que o webesrvice receba documentos validando o cnpj do tranportador faz-se necessário que
a empresa esteja habilitada para receber este tipo de documento, configurado via edição de empresa nos
parâmetros “Receptor NF-e -> Receber Documentos Transportador”.

Página 401 de 452
12.2.1.2. URL

ou
12.2.1.4. Layout

Conteúdo do XML de NF-e. Informar dados conforme layout
txt_conteudo Sim


a senha fornecidos.
12.2.1.7. Envio

Página 402 de 452
receptor_nfe_request_post_enviar_recebimento.txt
Retornará sucesso sempre que um dos atores (destinatário/transportador) receber o documento.

Http status: 202
CAMPO DESCRIÇÃO
recebimento Tipo do recebimento. Ex.: “xmlEmissao”.
cnpjDestinatario CNPJ do destinatário ou transportador.
*Consultar arquivo de exemplo: receptor_nfe_response_post_enviar_recebimento.txt
Retornará erro caso nenhum dos atores (destinatário/transportador) receber o documento.

Http status: 400, 412, 500.

Página 403 de 452
12.2.3.2. URL
<host>:<port>/<webservice>/api/recebimentoNfeTransp
12.2.3.3. Exemplo URL:
http://localhost:8080/webservice/api/recebimentoNfeTransp (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfeTransp (ambiente de homologação do SaaS)
12.2.3.4. Layout

ids Sim
consultados.


a senha fornecidos.
12.2.3.7. Envio

Página 404 de 452
receptor_nfe_request_post_marcar_consultado.txt


Página 405 de 452

12.2.4.2. URL

ou
12.2.4.4. Layout


Página 406 de 452


a senha fornecidos.
12.2.4.7. Envio
receptor_nfe_request_post_marcar_impresso.txt



Página 407 de 452
12.3. MÉTODO: GET
12.3.1.2. URL

ou


a senha fornecidos.
12.3.1.6. Envio

Página 408 de 452

Http status: 200
CAMPO DESCRIÇÃO
ids
consultados.
Atributo de “retorno”. Listagem dos retornos das NF-es que foram processadas pelo
recebimentos
software.
eventosDistribuicao
Distribuição.
*Consultar arquivo de exemplo: receptor_nfe_response_get.txt

CAMPO DESCRIÇÃO
Disponibilizamos o link para abertura do DANFE. Este novo campo deverá ser preenchido
somente nos retornos em que o status de NF-e permita a impressão de DANFE (Autorizada
ou Cancelada).
Para a visualização do DANFE o usuário deverá ter a permissão “NF-e Visualizar” habilitada
em seu perfil.
Exemplo: nfes”:[{“nota”:{“urlDanfePortal”:”https://h.dfe.mastersaf.com.br/
mvc /receptorNfeTransp/visualizarDanfeRecebimento/3360767”

Página 409 de 452
Disponibilizamos o link para abertura do PDF da Carta de Correção. Este novo campo será
preenchido somente nos retornos em que o status da Carta de Correção permita a impressão
do PDF (Autorizada).
Exemplo: nfes”: [{“nota”:{“urlPdfCcePortal”:”https://h.dfe.mastersaf.com.br/mvc/
nfe/pdf/cartaCorrecao/receptorNfeTransp/46736”
Não há.
12.3.2. GetXml
Método para obter o XML processado da respectiva chave de NF-e.
12.3.2.2. URL
<host>:<port>/<webservice>/api/recebimentoNfeTransp/<chave nfe>/getXml
http://localhost:8080/webservice/api/recebimentoNfeTransp/<chave nfe>/getXml (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfeTransp/<chave nfe>/getXml (ambiente de

Página 410 de 452


a senha fornecidos.
correta.
12.3.2.6. Envio

Http status: 200
Consultar arquivo de exemplo: receptor_nfe_response_get_xml.txt

Http status: 203, 404, 500.
Método para obter o XML cancelado da respectiva chave de NFe.

Página 411 de 452
12.3.3.2. URL
<host>:<port>/<webservice>/api/recebimentoNfeTransp/<chave nfe>/getXmlCancelamento
http://localhost:8080/webservice/api/recebimentoNfeTransp/<chave nfe>/getXmlCancelamento
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfeTransp/<chave nfe>/getXmlCancelamento


a senha fornecidos.
correta.
12.3.3.6. Envio

Http status: 200
Consultar arquivo de exemplo: receptor_nfe_response_get_xml_cancelado.txt

Página 412 de 452

Http status: 203, 404, 500.
12.3.4. GetStatus
finalizado.
12.3.4.2. URL
<host>:<port>/<webservice>/api/recebimentoNfeTransp/<chave nfe>/getStatus
http://localhost:8080/webservice/api/recebimentoNfeTransp/<chave nfe>/getStatus (instalação in

house)
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfeTransp/<chave nfe>/getStatus (ambiente de


Página 413 de 452

a senha fornecidos.
12.3.4.6. Envio
Response Body:
{
"retorno": {
"eventosDistribuicao": [],
"recebimentos": [],
"ids": []
}
}
Http status: 200
CAMPO DESCRIÇÃO
ids Não há.
recebimentos Atributo de “retorno”. Listagem dos retornos das NF-es que foram solicitados.
eventosDistribuicao Atributo de “retorno”. Não será preenchido.
*Consultar arquivo de exemplo: receptor_nfe_response_getStatus.txt.

Página 414 de 452
Não há.
12.3.5.2. URL
<host>:<port>/<webservice>/api/recebimentoNfeTransp/getImpressao
http://localhost:8080/webservice/api/recebimentoNfeTransp/getImpressao (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfeTransp/getImpressao (ambiente de homologação
do SaaS)


a senha fornecidos.
12.3.5.6. Envio

Página 415 de 452

Http status: 200
CAMPO DESCRIÇÃO
*Consultar arquivo de exemplo: receptor_nfe_response_getImpressao.txt
Não há.
12.3.6.2. URL
<host>:<port>/<webservice>/api/recebimentoNfeTransp/getRetorno
http://localhost:8080/webservice/api/recebimentoNfeTransp/getRetorno (instalação in house)

ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfeTransp/getRetorno (ambiente de homologação do
SaaS)

Página 416 de 452


a senha fornecidos.
12.3.6.6. Envio

Http status: 200
CAMPO DESCRIÇÃO
ids
consultados.
recebimentos
pelo software.
Eventos Atributo de “retorno”. Contém a listagem dos eventos recebidos pelo Webservice
Distribuicao Distribuição.
*Consultar arquivo de exemplo: receptor_nfe_response_getRetorno.txt

Página 417 de 452
12.3.7. GetDanfe
12.3.7.2. URL
<host>:<port>/<webservice>/api/recebimentoNfeTransp/<chave nfe>/getDanfe
http://localhost:8080/webservice/api/recebimentoNfeTransp/<chave nfe>/getDanfe (instalação in

house)
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfeTransp/<chave nfe>/getDanfe (ambiente de


a senha fornecidos.
12.3.7.6. Envio

Página 418 de 452
Http status: 200
do cadastro da empresa, porém, se houver cadastro de customização em “Grupo de Empresas > Documentos
Customizados” para o módulo, grupo da empresa e tipo de documento, o parâmetro do cadastro de empresa
será desconsiderado e passará a valer apenas a customização de documento cadastrada no grupo de empresa.

Http status: 203, 404, 500.
Método para obter o XML da carta de correção de recebimento da respectiva chave de NF-e.
12.3.8.2. URL
<host>:<port>/<webservice>/api/recebimentoNfeTransp/<chave nfe>/getXmlCartaCorrecao
http://localhost:8080/webservice/api/recebimentoNfeTransp/<chave nfe>/getXmlCartaCorrecao
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfeTransp/<chave nfe>/getXmlCartaCorrecao

Página 419 de 452


a senha fornecidos.
correta.
12.3.8.6. Envio

Http status: 200
Consultar arquivo de exemplo: receptor_nfe_response_get_xml_carta_correcao.txt

Http status: 203, 404, 500.
* Consultar título LISTAGEM DE ERROS para maiores informações sobre os erros.
Método para obter o DANFE da carta de correção de recebimento para a respectiva chave de NF-e.

Página 420 de 452
12.3.9.2. URL
<host>:<port>/<webservice>/api/recebimentoNfeTransp/<chave nfe>/getCartaCorrecao
http://localhost:8080/webservice/api/recebimentoNfeTransp/<chave nfe>/getCartaCorrecao
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfeTransp/<chave nfe>/getCartaCorrecao


a senha fornecidos.
12.3.9.6. Envio
Http status: 200

Página 421 de 452
Para ambiente SaaS: O pdf gerado é padrão, porém, se houver cadastro de customização em “Grupo
de Empresas > Documentos Customizados” para o módulo, grupo da empresa e tipo de documento, o
parâmetro do cadastro de empresa será desconsiderado e passará a valer apenas a customização de
documento cadastrada no grupo de empresa.

Http status: 203, 404, 500.
Método de consulta para retornar os logs da NF-e do Receptor, 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
12.3.10.2. URL
<host>:<port>/<webservice>/api/recebimentoNfeTransp/getLog?cnpj=<número cnpj>&ie=<número
inscrição estadual>&serie=<série da NF-e>&numero=<número da NF-e>

Página 422 de 452
<host>:<port>/<webservice>/api/recebimentoNfeTransp/getLog?cnpj=<número cnpj>&ie=<número
inscrição estadual>&serie=<série da NF-e>&numero=<número da NF-
http://localhost:8080/webservice/api/recebimentoNfeTransp/getLog?cnpj=00910509000171&ie=00180
00282&serie=450&numero=10006&offset=0&maxResults=10 (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/recebimentoNfeTransp/getLog?cnpj=00910509000171&ie=00180
00282&serie=450&numero=10006&offset=0&maxResults=10 (ambiente de homologação do SaaS)


a senha fornecidos.
12.3.10.6. Envio

Página 423 de 452
0}Http status: 200
CAMPO DESCRIÇÃO

message “OK”
hasMore
true ou false.
offset
*Consultar arquivo de exemplo: receptor_nfe_response_get_log.txt
Não há.
Método de consulta para retornar uma listagem de NF-e do Receptor, 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.

Página 424 de 452
12.3.11.2. URL
<host>:<port>/<webservice>/api/recebimentoNfeTransp/getListagem?cnpj=<número cnpj>&ie=<número
DD/MM/AAAA HH:MM>
<host>:<port>/<webservice>/api/recebimentoNfeTransp/getListagem?cnpj=<número cnpj>&ie=<número
http://localhost:8080/webservice/api/
recebimentoNfeTransp/getListagem?cnpj=00910509000171&ie=0018000282&periodoInicial=01/12/2016
00:00&periodoFinal=13/03/2017 00:00&offset=0&maxResults=10 (instalação in house)
ou
https://ws.h.dfe.mastersaf.com.br/api/
recebimentoNfeTransp/getListagem?cnpj=00910509000171&ie=0018000282&periodoInicial=01/12/2016
00:00&periodoFinal=13/03/2017 00:00&offset=0&maxResults=10 (ambiente de homologação do SaaS)


Página 425 de 452

a senha fornecidos.
12.3.11.6. Envio
Http status: 200
CAMPO DESCRIÇÃO


Página 426 de 452

Result\situação
Message “OK”
hasMore
Count Quantia total de itens para os filtros informados.

Página 427 de 452

Offset
*Consultar arquivo de exemplo: adm_response_get_Listagem.txt
Não há.

Página 428 de 452
13. 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: Chave de acesso não encontrada.
• 412: JSON nao informado ou invalido ou nenhuma ação (campo action) encontrada.
• 415: Unsupported Media Type – 429étodos429-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
14. EXEMPLO DE COMO UTILIZAR O WEBSERVICE
Utilize a extensão REST Client do Firefox para realizar os testes de comunicação.

http://restclient.net/

Página 429 de 452
14.2. UTILIZANDO A EXTENSÃO REST CLIENT DO FIREFOX
14.2.1. Como informar os dados?
1. Informar tipo de requisição no campo “Method”:
2. Informar a URL:
3. Informando usuário e senha:
Selecionar menu “Authentication”, opção “Basic Authentication”.
Informar o usuário e senha:
4. Informando dados no cabeçalho (Content-type se necessário).
Selecionar menu “Headers”, opção “Custom Header”:

Página 430 de 452
Informar dados de tipo de conteúdo, por exemplo:
Informando conteúdo (corpo) da mensagem (se necessário):
14.2.2. Exemplo de POST

Página 431 de 452
14.2.3. Exemplo de GET
15. PROGRAMA EXEMPLO EM JAVA

Junto deste Manual está disponível o código fonte de software capaz de testar os serviços oferecidos por
nosso WebService. Depois de descompactá-lo siga os seguintes passos para utilizá-lo:
1. Importar este projeto no eclipse como um projeto maven. Para isto, acessar opção pelo menu File >
Import > Existing Maven Projects.
2.Com o projeto importado, abrir a classe br.com.mastersaf.WSTest (Para testar método POST
enviarPacote da NF-e) ou br.com.mastersaf.WSPdfDacteTest (Teste para método GET getDacte do CT-e).
2.1. Configurar os atributos URL_WEBSERVICE, USER e PASSWORD.
2.2. O usuário informado deverá ter a permissão de integrador no portal MASTERSAF.
2.3. Retornar no método getBodyRequest, o json da NFE com os seus dados. Este formato foi o mesmo
descrito neste manual.

Página 432 de 452
16. RELAÇÃO DE MUDANÇAS DE VERSÕES DO

MANUAL
VER
DATA MUDANÇAS DFE
SÃO
Criação do manual baseado em MASTERSAFDFE – Integração com
1.00 22/08/2012 -
Webservice.pdf.
1.01 25/09/2012 Incluído capítulo 5 – MDF-E. -
1.02 08/10/2012 Incluído item 3.3.4 – GetDanfe. -
Incluído item 3.3.5 – GetStatus;
1.03 29/11/2012 3.13.2
Incluído capítulo 12 – Relação das Mudanças de Versões do Manual.
1.04 27/03/2013 Incluídos itens 3.3.6, 3.3.7, 4.3.5, 4.3.6, 5.3.3, 5.3.4. 3.16.0
Incluído exemplo de retorno do método GET para o módulo Receptor NFS-
1.05 05/04/2013 3.16.1
e.
1.06 11/04/2013 Incluído item 7.2.2 referente a Eventos de Manifestação. 3.16.1
1.07 13/05/2013 Incluídos itens 3.3.6.3 e 3.3.6.4 referentes a Filtro do método getRetorno. 3.17.0
26/06/2013 Alterado nomes dos métodos getXmlCancelado para ficar igual ao nome no
1.08 produto (getXmlCancelamento). 3.19.1
08/08/2013 Incluído item 4.3.5 – GetStatus.
Incluída informação de charset na parte de cabeçalhos dos métodos getXml
1.09 16/08/2013 3.19.1
e getXmlCancelamento para todos os módulos.
Atualizado item 3.3.5.7 – Retorno Sucesso;
1.10 19/08/2013 3.19.2
Adicionado item 3.3.5.8 – Layout Retorno.
Adicionado item 2.3.1.3 – Definir quantidade de Results da consulta;
Atualizado item 2.3.1.4 – Exemplo URL;
Atualizado item 3.3.1.8 – Retorno Sucesso;
1.11 20/09/2013 Atualizado item 3.3.1.8.1 – Layout Retorno; 3.20.1
Atualizado item 3.3.6.5 – Exemplo URL com filtro;
Atualizado item 3.3.6.6 – Exemplo URL sem filtro;

Página 433 de 452

Atualizado item 4.3.6.4 – Exemplo URL.
Alteração deste manual para incluir um novo arquivo de exemplo
“nfe_request_post_enviar_pacote_3.txt” com todos os métodos corretos
referentes à métodos para filtro. O mesmo encontra-se no pacote.
1.13 01/04/2014 3.24.2
Alteração neste manual, no ponto 3.2.1.4 de post Nfe onde diz: Informações
para contingência, pois seguem mais informações, além das informações de
contingencia dentro do atributo..
Atualizado item 2.3.1.8.1 – Layout Retorno
1.14 05/05/2014 3.25.2
padronização do retorno.
Incluído item: 4.2.3 EnviarCartaCorrecaoCte;
1.15 22/07/2014 3.27.1
Atualizado 4.3.1 – ConsultaPadrao módulo CT-e.
3.28.
1.16 19/08/2014 Incluído item 2.2.6 – Convertida, do módulo NFS-e.
0
Incluido método getStatus para Recebimento NFE/CTE;
1.17 02/09/2014 3.28.1
Incluido ‘https’ nos exemplos da url de integração com o Saas.
Atualizado para alguns métodos do módulo nfe o novo 3.30.
1.18 31/10/2014
parâmetro na requisição id_integrador. 0
Atualizado a estrutura de retorno para métodos GET com
1.19 25/11/2014 3.30.1
novo parâmetro contendo link de acesso direto ao DANFE.
2.3.1 – Consulta Padrão – Atualizado parâmetros de filtro 3.26.
1.20 29/12/2014
disponíveis. 0
1.20 30/12/2014 3.2.7 – MarcarCartaCorrecaoImpresso – Incluindo método. 3.13.0
1.20 30/12/2014 4.2.7 – MarcarCartaCorrecaoImpresso – Incluindo método. 3.27.1
4.3.6 – Consulta Retorno – Atualizado parâmetros de filtro
1.20 30/12/2014 3.25.3
disponíveis.
5.3.3 – Consulta Retorno – Atualizado parâmetros de filtro
1.20 30/12/2014 3.25.3
disponíveis.
1.20 30/12/2014 5.3.5 – GetDamdfe – Incluindo método. 3.27.0
1.20 30/12/2014 7.2.4 – MarcarImpresso – Incluindo método. 3.19.1
1.20 30/12/2014 7.3.5 – Consulta Impressão – Incluindo método. 3.19.1
Atualizando arquivos de exemplo de consulta de MDF-e. Itens do
1.21 12/05/2015 3.34.1
manual: 5.3.1 e 5.3.3.

Página 434 de 452
Atualizando arquivos de exemplo de consulta de NF-e. Itens do

manual:
1.21 12/05/2015 3.34.1
3.3.1 - Consulta Padrão
3.3.7 - Consulta Retorno
Atualizando arquivos de exemplo de consulta de CT-e. Itens do
manual:
1.21 12/05/2015 3.34.1
4.3.1 - Consulta Padrão
1.22 21/07/2015 Atualizando arquivos de exemplo .txt refrente o getRetorno. 3.36.
Itens do manual: 0

1.23 29/09/2015 Adicionado arquivo de exemplo .txt de EnviarEmail. 3.37.2
Método Get (Padrão, Status, Retorno) do módulo NFe irá retornar URL para
visualização do PDF CC-e no portal DFE quando configurado.
Método Get (Padrão, Retorno) do módulo Receptor NFe irá retornar URL
para visualização do DANFE e PDF CC-e quando configurado.
Itens do manual:
3.2.10 – EnviarEmail (método incluído)
3.3.1.9 – Layout Retorno Emissor NFe (incluído novo campo no método)
7.3.1.8 – Layout Retorno Receptor NFe (incluído dois novos campos no
método)
1.24 13/10/2015 Incluído item 7.3.7 – GetDanfe. 3.38.
0
1.25 01/03/2015 Arquivos de exemplo nfe: 3.41.1
1 - Adicionado arquivos de requisição de pedido de prorrogação e pedido de
cancelamento de prorrogação ICMS.
2 - Atualizados arquivos de retorno getRetorno, getStatus, get
Itens do manual:
3.2.11 – Documentação do método de pedido de prorrogação ICMS via
POST.
3.2.12 – Documentação do método de pedido de cancelamento de
prorrogação de ICMS via POST.

Página 435 de 452
3.3.1 / 3.3.5 / 3.3.6 / 3.3.7 – Atualização dos itens de retorno e layout com
os novos parâmetros de prorrogação ICMS
(loteEventoProrrogacaoIcmsRespostaFisco e loteEventoProrrogacaoIcms.)
1.26 21/06/2016 Inclusão do modelo/exemplo de envio POST NFe – EPEC: 3.44.
nfe_request_post_enviar_pacote_4.txt e 0
1.27 19/07/2016 Atualização módulo NFe – Saída de Mercadoria: 3.44.2
1 - Inclusão de um novo item de retorno (passagemPortariaNfe),
para consulta getRetorno do módulo Nfe (3.3.7.10 / 3.3.7.11).
2 - Atualização do arquivo de exemplo nfe_response_getRetorno.txt
1.28 30/08/2016 Incluído item 3.3.5 – GetXmlCartaCorrecao (Emissor NF-e); 3.45.2
Incluído item 3.3.6 – GetCartaCorrecao (Emissor NF-e);
Incluído item 4.3.5 – GetXmlCartaCorrecao (Emissor CT-e);
Incluído item 4.3.6 – GetCartaCorrecao (Emissor CT-e);
Inclusão de documentos de exemplo (*response):
1. nfe_response_get_xml_carta_correcao.txt
2. cte_response_get_xml_carta_correcao.txt
1.29 13/09/2016 Incluído item 6.3.8 – GetXmlCartaCorrecao (Receptor NF-e); 3.46.
Incluído item 6.3.9 – GetCartaCorrecao (Receptor NF-e); 0
Incluído item 7.3.6 – GetXmlCartaCorrecao (Receptor CT-e);
Incluído item 7.3.7 – GetCartaCorrecao (Receptor CT-e);
Inclusão dos documentos de exemplo (*response):
1. receptor_cte_response_get_xml_carta_correcao.txt
2. receptor_nfe_response_get_xml_carta_correcao.txt
3. Atualização dos arquivos de exemplo:
a. nfe_request_post_cancelar.txt
b. nfe_request_post_inutilizar.txt
1.30 27/09/2016 1. Atualização dos arquivos de exemplo MDF-e: 3.46.1
a. mdfe_request_post_cancelar.txt
b. mdfe_request_post_encerrar.txt
c. mdfe_request_post_enviar_pacote.txt
1.31 25/10/2016 Incluído item 1.3.2. Consulta Retorno (GetRetorno NFS-e). 3.47.0
1. Inclusão do arquivo de exemplo NFSe:
a. nfse_response_getRetorno.txt

Página 436 de 452
1.32 22/11/2016 1. Atualização da documentação de retorno no item 3.3.7 3.47.2

(getStatus - CTe);
2. Inclusão do item 3.3.10 – GetStatus (Com parâmetros - CTe);
3. Inclusão do arquivo de exemplo (*response):
a. cte_response_getStatus.txt
1.33 06/12/2016 1. Atualização item 3. MÓDULO CTE: 3.48.
a. Atualização na citação dos arquivos de exemplo (3.2.1 – EnviarPacote, 0
3.2.2 Cancelar, 3.2.3 – EnviarCartaCorrecao e 3.2.4 – Inutilizar, 3.3.1 –
Consulta Padrão, 3.3.3 GetXmlCancelamento e 3.3.5 -
GetXmlCartaCorrecao)
2. Atualização item 4. MÓDULO MDFE:
a. Atualização na citação dos arquivos de exemplo (4.2.1 –
EnviarPacote, 4.2.2 – Cancelar, 4.2.3 – Encerrar, 4.3.1 – Consulta
Padrão e 4.3.3 – Consulta Retorno)
3. Inclusão do arquivos de exemplo CT-e 3.00:
a. cte_request_post_cancelar_3.00.txt
b. cte_request_post_carta_correcao_3.00.txt
c. cte_request_post_enviar_pacote_3.00.txt
d. cte_request_post_inutilizar_3.00.txt
e.cte_response_get_xml_3.00.txt
f. cte_response_get_xml_cancelamento_3.00.txt
g.cte_response_get_xml_carta_correcao _3.00.txt
4. Atualização da nomenclatura dos arquivos de exemplo CT-e 2.00;
5. Inclusão do arquivo de exemplo MDF-e 3.00:
a. mdfe_request_post_cancelar_3.00.txt
b. mdfe_request_post_encerrar_3.00.txt
c. mdfe_request_post_enviar_pacote_3.00.txt
d. mdfe_response_get_3.00.txt
e. mdfe_response_getRetorno_3.00.txt
6. Atualização da nomenclatura dos arquivos de exemplo MDF-e 1.00.

Página 437 de 452
1.34 20/12/2016 1.Inclusão de um novo item de retorno 3.48.1

(eventosDistribuicao), para consulta get módulo NF-e
(2.3.1.8 / 2.3.1.9);
2. Inclusão de um novo item de retorno
(eventosDistribuicao),
para consulta getRetorno módulo NF-e (2.3.9.10 / 2.3.9.11);
para consulta get módulo Receptor NF-e (6.3.1.7 / 6.3.1.8);
para consulta getRetorno módulo Receptor NF-e (6.3.6.7 /
6.3.6.8);
5. Atualização dos arquivos de exemplo nfe_response_get.txt,
nfe_response_getRetorno.txt, receptor_nfe_response_get.txt e
receptor_nfe_response_getRetorno.txt.
1.35 31/01/2017 Incluído item 3.2.8 – EnviarRegistroMultimodal (CT-e): 3.49.1
1.Inclusão do arquivo de exemplo CT-e 3.00:
a. cte_request_post_registro_multimodal_3.00.txt
2.Atualização do arquivo de exemplo CT-e:
b. cte_response_getRetorno.txt
1.36 14/02/2017 Incluído item 7.2.5 – EnviarPrestacaoServicoDesacordo 3.49.2
(Receptor CT-e):
1. Inclusão do arquivo de exemplo Receptor CT-e:
a.receptor_cte_request_post_enviar_prestacao_servico_desacordo.tx
t
2. Atualização dos arquivos de exemplo Receptor CT-e:
a. receptor_cte_response_get.txt
b. receptor_cte_response_getRetorno.txt
1.37 14/03/2017 Inlcuído item 8 – Módulo ADM: 3.50.1
• 8.2.1 Manutenção de Empresa;
• 8.2.2 Upload Certificado Digital;
• 8.3.1 Listagem Municípios;
• Novos arquivos de exemplo:

Página 438 de 452
⋅ adm\adm_request_post_EditarEmpresa.txt
⋅ adm\adm_request_post_IncluirEmpresa.txt
⋅ adm\adm_request_post_UploadCertificado.txt
⋅ adm\adm_response_get_ListagemMunicipio.txt
⋅ adm\adm_response_post_IncluirEmpresa_NOK.txt
⋅ adm\adm_response_post_IncluirEmpresa_OK.txt
⋅ adm\adm_response_post_UploadCertificado.txt
• Nova planilha com layout para os métodos ADM:
⋅ Mastersaf_Layout_DFe_V3_Adm.xlsx
Incluído Item 2.3.13 – Consulta Log da NF-e (Emissor NF-e):
• Novo arquivo de exemplo:
⋅ nfe_response_get_log.txt
Incluído Item 2.3.14 – Consulta Listagem de NF-e (Emissor NF-e):
⋅ nfe_response_get_listagem.txt
Incluído Item 6.3.10 – Consulta Log da NF-e (Receptor NF-e):
⋅ receptor_nfe_response_get_log.txt
Incluído Item 6.3.11 – Consulta Listagem de NF-e (Receptor NF-e):
⋅ receptor_nfe_response_get_listagem.txt
1.38 11/04/2017 • Incluído capítulo 9 – CTE OS; 3.51.0
• Inclusão do arquivos de exemplo CT-e OS:
• cteos\cteos_request_post_cancelar_3.00.txt
• cteos\cteos_request_post_carta_correcao_3.00.txt
• cteos\cteos_request_post_enviar_pacote_3.00.txt
• cteos\cteos_request_post_inutilizar_3.00.txt
• cteos\cteos_request_post_marcar_consultado.txt
• cteos\cteos_response_get.txt
• cteos\cteos_response_get_xml.txt
• cteos\cteos_response_get_xml_cancelamento.txt
• cteos\cteos_response_get_xml_carta_correcao.txt
• cteos\cteos_response_getRetorno.txt
• cteos\cteos_response_getStatus.txt

Página 439 de 452
1.39 25/04/2017 Incluído item 9.2.6 – EnviarGTV (CT-e OS). 3.51.1

1. Inclusão do arquivo de exemplo CT-e OS 3.00:
a. cteos\cteos_request_post_gtv_3.00.txt
1.40 23/05/2017 Atualização item 1.3.1 – Consulta Padrão (NFS-e): 3.52.0
• Foram atualizados os endereços de consulta padrão (In house e
SaaS) devido a inclusão do parâmetro CNPJ Prestador como filtro
da consulta;
Atualização item 1.3.1.9 - Layout Retorno (NFS-e):
• Atualizado planilha de layout de retorno com todos os campos
disponíveis no retorno;
• Atualizado arquivo de exemplo: nfse_response_get.txt;
Removendo item 1.3.2. Consulta Retorno (NFS-e):
• Método na verdade não existe, foi incluído por engano neste
manual;
• Removido arquivo de exemplo: nfse_response_getRetorno.txt;
Atualização item 4.3.3 – Consulta Retorno (MDF-e):
• Atualização de url de consulta retorno com filtros para módulo
MDF-e, o endereço informado anteriormente não considerava o
parâmetro maxResults.
Incluído capítulo 10 – MÓDULO RECEPTOR CTE OS;
Inclusão do arquivos de exemplo Receptor CT-e OS:
• receptor_cteos\receptor_cteos_request_post_consultar_doc_forne
cedor_1.txt
• receptor_cteos\receptor_cteos_request_post_consultar_doc_forne
cedor_2.txt
• receptor_cteos\receptor_cteos_request_post_enviar_prestacao_se
rvico_desacordo.txt
• receptor_cteos\receptor_cteos_request_post_enviar_recebimento.
txt
• receptor_cteos\receptor_cteos_request_post_marcar_consultado.
txt
• receptor_cteos\receptor_cteos_response_get.txt
• receptor_cteos\receptor_cteos_response_get_xml.txt
• receptor_cteos\receptor_cteos_response_get_xml_cancelamento.
txt

Página 440 de 452
• receptor_cteos\receptor_cteos_response_get_xml_carta_correcao.
txt
• receptor_cteos\receptor_cteos_response_getRetorno.txt
• receptor_cteos\receptor_cteos_response_post_enviar_recebiment
o.txt
1.41 06/06/2017 Atualização dos documentos de exemplo para integração via 3.52.1
webservice (*Post), para emissão de NF-e’s, agora com versão 4.00:
• nfe_request_post_enviar_pacote_1
1.42 18/07/2017 Atualização dos documentos de exemplo para integração via 3.53.1
webservice (*Post), para emissão de NF-e’s 4.00 conforme NT
2016.002:
1.43 01/08/2017 Incluído item 9.3.8 – GetDacteOS. 3.53.2
1.44 26/09/2017 Módulo NFS-e: 3.55.0
• Correção na composição da variável referência do método
UploadRetornoPrefeitura.
Módulo NF-e:
• Método Cancelar: a variável txt_conteudo\xml passou a permitir
conteúdo em formato XML e/ou TXT;
• Método Inutilizar: a variável txt_conteudo\xml passou a permitir
conteúdo em formato XML e/ou TXT;
• Método Enviar Carta Correcao NF-e: a variável txt_conteudo\xml
passou a permitir conteúdo em formato XML e/ou TXT;
• Método Pedido de Prorrogação ICMS: a variável
txt_conteudo\xml passou a permitir conteúdo em formato XML
e/ou TXT;

Página 441 de 452
• Método Pedido de Cancelamento de Prorrogação ICMS: a variável

txt_conteudo\xml passou a permitir conteúdo em formato XML
e/ou TXT.
Módulo NFS-e:
• O arquivo de exemplo nfse_request_post_enviar_pacote.txt foi
atualizado.
Disponibilizado junto ao .zip do Manual de Integração Webservice
um novo arquivo de layout formato XML para NF-e. O formato XML
é válido para integração Webservice e integradorTXT. Nome do
arquivo de layout: Mastersaf-Layout_DF-e_V3-NF-e_XML.xlsx
1.45 10/10/2017 Incluído os itens abaixo:
• CT-e
⋅ 3.3.11 Consulta Log do CT-e (Emissor)
⋅ 3.3.12 Consulta Listagem CT-e (Emissor)
⋅ 7.3.8 Consulta Log do CT-e (Receptor)
⋅ 7.3.9 Consulta Listagem CT-e (Receptor)
• CT-e OS
⋅ 9.3.9 Consulta Log do CT-e OS (Emissor)
⋅ 9.3.10 Consulta Listagem CT-e OS (Emissor)
⋅ 10.3.8 Consulta Log do CT-e OS (Receptor)
⋅ 10.3.9 Consulta Listagem CT-e OS (Receptor)
Também foram incluídos novos arquivos de exemplo:
• CT-e
⋅ cte_response_getLog.txt
⋅ cte_response_getListagem.txt
⋅ receptor_cte_response_getLog.txt
⋅ receptor_cte_response_getListagem.txt
• CT-e OS
⋅ cteos_response_getLog.txt
⋅ cteos_response_getListagem.txt
⋅ receptor_cteos_response_getLog.txt
⋅ receptor_cteos_response_getListagem.txt
1.46 24/10/2017 Módulo NFSE (Método GET) 3.55.2
• 1.3.2 getRPS: descrição e documentação do novo método
webservice disponibilizado para obter o pdf da RPS desejada.

Página 442 de 452
1.47 07/11/2017 Módulo MDF-e 3.56.0

• 4.2.3.3: correção da descrição da tag XML
• 4.2.5.4: correção do nome da Action de “MarcarConsultado” para
“MarcarImpresso”
• 4.2.6: incluído documentação sobre o método “Inclusão de
Condutor”.
• Inlcuído novo arquivo de exemplo:
mdfe_request_post_incluirCondutor_3.00.txt
Modulo NF-e
• 2.2.1: ajuste na descrição da tag XML para aceitar formato TXT
como layout de integração de emissão de NF-e
• Incluído novo arquivo de exemplo:
1.48 21/11/2017 Módulo NFC-e (Consumidor) 3.56.1
• Inclusão de todo o item 11 – Módulo NFC-e (Consumidor)
• Inclusão dos arquivos de exemplo:
⋅ nfce_request_post_enviar_pacote.txt
⋅ nfce_request_post_cancelar.txt
⋅ nfce_request_post_inutilizar.txt
⋅ nfce_request_post_marcar_consultado.txt
⋅ nfce_request_post_marcar_impresso.txt
⋅ nfce_response_getImpressao.txt
⋅ nfce_response_getRetorno.txt
Módulo ADM
• 8.2.1.5: Incluída descrição sobre a regra de Edição de Empresa,
tag/campo txt_conteudo.
1.49 30/01/2018 Módulo NFSE (Serviço) - Método POST 3.58.0
• Inclusão do item 1.2.7 – NumeroRPS – descrição do serviço
utilizado para obter número de rps por Série.
• Inclusão dos arquivos de exemplo
⋅ nfse_request_post_numerorps.txt
⋅ nfse_response_numerorps.txt
1.50 13/02/2018 Módulo NFSE (Serviço) - Método POST 3.58.1
• Atualização do item 1.2.7 – NumeroRPS – inclusão de um novo
parâmetro (inscricaoEstadualPrestador), não obrigatório.

Página 443 de 452
1.51 27/02/2018 Módulo NF-e – Método GET 3.58.2

• Alteração do itens 2.3.7. GetStatus e 2.3.8. GetStatus (com
parâmetros): melhoria na descrição dos métodos e suas
estruturas;
• Atualizado arquivo de exemplo: nfe_response_getStatus.txt;
• Incluído arquivo de exemplo:
nfe_response_getStatus_com_parametros.txt.
Módulo CT-e – Método GET
estruturas;
• Atualizado arquivo de exemplo: cte_response_getStatus.txt;
cte_response_getStatus_com_parametros.txt.
Módulo Receptor NF-e – Método GET
• Alteração do item 6.3.4. GetStatus: melhoria na descrição do
método e sua estrutura;
receptor_nfe_response_getStatus.txt.
Módulo Receptor CT-e – Método GET
receptor_cte_response_getStatus.txt.
Módulo CT-e OS – Método GET
estruturas;
• Atualizado arquivo de exemplo: cteos_response_getStatus.txt;
cteos_response_getStatus_com_parametros.txt.
Módulo Receptor CT-e OS – Método GET
receptor_cteos_response_getStatus.txt.

Página 444 de 452
1.52 27/03/2018 Incluído os itens abaixo para módulo NFC-e: 3.59.1

• 11.2.6 ReimpressaoDanfe
• 11.2.7 EnviarEmail
• 11.3.3 GetXml
• 11.3.4 GetXmlCancelamento
• 11.3.5 GetDanfe
• 11.3.6 GetStatus
• 11.3.7 GetStatus (com parâmetros)
• 11.3.8 Consulta Log da NFC-e
• 11.3.9 Consulta Listagem de NFC-e
Incluídos novos arquivos de exemplo para módulo NFC-e:
• nfce_request_post_reimpressao_danfe.txt
• nfce_request_post_enviar_email.txt
• nfce_response_get_xml.txt
• nfce_response_get_xml_cancelamento.txt
• nfce_response_getStatus.txt
• nfce_response_getStatus_com_parametros.txt
• nfce_response_get_log.txt
• nfce_response_get_listagem.txt
1.53 05/06/2018 Incluído o item abaixo para módulo NFS-e: 3.61.0
• 1.2.8 EnviarPacoteAgrupar
Incluído o item abaixo para módulo ADM:
• 8.3.2 InfoEmpresaServico
Incluído novo arquivo de exemplo para módulo NFS-e:
• nfse_request_post_enviar_pacote_agrupar.txt
Incluído novo arquivo de exemplo para módulo ADM:
• adm_response_get_infoEmpresaServico_OK.txt
• adm_response_get_infoEmpresaServico_NOK.txt
1.54 30/10/2018 Atualização dos arquivos de exemplo: 3.64.2
• adm_request_post_IncluirEmpresa.txt
Atualização do layout de integração para cadastro de empresas via
webservice: (*inclusão dos parâmetros de configuração para módulo
NF-e)
• Mastersaf_Layout_DFe_V3_Adm.xlsx

Página 445 de 452

NF-e)
Mastersaf_Layout_DFe_V3_Adm.xlsx
webservice: (*inclusão de parâmetro de configuração para módulo
NFS-e)
webservice: (*inclusão de parâmetro de configuração para módulo
NF-e)
1.58 27/08/2019 Incluído novo arquivo de exemplo para módulo MDF-e: 3.71.2
• mdfe_request_post_enviar_pacote_3.01.txt
Incluído novo arquivo de exemplo para módulo NF-e:
• nfe_request_post_enviar_pacote_7.txt
Incluído novo arquivo de exemplo para módulo NFC-e:
• nfce_request_post_enviar_pacote2.txt
1.59 10/11/2019 Incluído os itens abaixo para módulo ADM: 3.73.1
• 8.3.3. InfoUsuario
Incluídos novos arquivos de exemplo para módulo ADM:
• adm_response_get_InfoUsuario_OK.txt
• adm_response_get_InfoUsuario_NOK.txt
1.60 05/01/2020 Incluído os itens abaixo para módulo RECEPTOR CTE: 3.74.2
7.3.10. GetDacte.

Página 446 de 452
Incluído os itens abaixo para módulo RECEPTOR CTE OS:

• 10.3.10. GetDacteOS.
1.61 02/02/2020 Módulo NF-e (Método GET) 3.75.1
2.3.16 getEventos: descrição e documentação do novo método
webservice disponibilizado para obter a listagem dos eventos
recebidos da NF-e.
Incluído novo arquivo de exemplo para módulo NF-e:
• nfe_response_get_eventos.txt
Atualização dos arquivos de exemplo:

NF-e)
NF-e)
1.63 12/04/2020 Módulo MDF-e 3.77.0
4.2.7: incluído documentação sobre o método “Evento de
Pagamento da Operação de Transporte”.
Incluído novo arquivo de exemplo:
• mdfe_request_post_pagtoOperacao_3.00.txt
1.64 24/05/2020 Módulo CT-e: 3.78.0

3.2.1: incluída documentação sobre o emailTomador no config.
Alterado arquivo de exemplo:
• cte_request_post_enviar_pacote_3.00.txt
webservice: (*inclusão dos parâmetros de configuração para
módulo NF-e) - Mastersaf_Layout_DFe_V3_Adm.xlsx

Página 447 de 452
1.66 11/09/2020 Módulo CT-e: 3.82.0

3.2.11.: incluída documentação sobre o método
“SolicitarImpressao”.
3.2.12: incluída documentação sobre o método
“CancelarImpressao”.
3.3.13: incluída documentação sobre o método
“getConsultaImpressao”.
Incluídos novos arquivos de exemplo:

• cte_request_post_solicitar_impressao.txt
• cte_request_post_cancelar_impressao.txt
• cte_response_getConsultaImpressao.txt
Incluído documento:
Fluxo_Webservice_SolicitaImpressão_CTE.pdf
1.67 25/09/2020 Módulo NF-e: 3.82.1
2.2.1.: incluída documentação sobre o método “EnviarPacote”,
especificando os campos do grupo Mastersaf.
Módulo ADM:
8.2.1.5.: incluída tag __param-csc-ini__ na descrição do campo
txt_conteudo.
Atualizado arquivo de exemplo:

1.68 15/11/2020 Módulo MDF-e: 3.84.0
“GetXmlCancelamento”; e
“GetXmlEncerramento”;
Inclusão arquivos de exemplo:

mdfe_response_get_xml_cancelamento_3.00.txt
mdfe_response_get_xml_encerramento_3.00.txt
1.69 13/12/2020 Módulo NF-e: 3.85.0
2.3.4.7.: No método getDanfe incluída observação sobre a
customização de documentos implementada para ambiente SaaS.

Página 448 de 452
2.3.6.7.: No método getCartaCorrecao incluída observação sobre a

Módulo Receptor NF-e:
6.3.7.7.: No método getDanfe incluída observação sobre a
6.3.9.7.: No método getCartaCorrecao incluída observação sobre a
1.70 20/12/2020 Módulo NF-e: 3.85.1
2.2.13.: incluída documentação sobre o método “Consulta Chave
Acesso Sefaz”
2.3.17.: incluída documentação sobre o método ”
GetRetornoConsultaChaveSefaz”

nfe_request_post_consulta_chave_sefaz.txt
nfe_response_getRetornoConsultaChaveSefaz.txt
1.71 02/02/2021 Módulo Receptor NF-e Transportador: 3.87.0

Incluído capítulo 12 – MÓDULO RECEPTOR NF-e Transportador;
1.72 11/02/2021 Módulo ADM: 3.87.1

8.2.1.6.: Incluída documentação sobre o método “ExcluirEmpresa”.

adm_request_post_ExcluirEmpresa.txt
adm_response_post_ExcluirEmpresa_NOK.txt
Módulo NF-e:
2.2.1.4.: Adicionada nova opção de versão de layout “4.04” no
campo versaoLayoutDfe.

Página 449 de 452
1.73 22/02/2021 Módulo CT-e: 3.88.0

3.2.13.: incluída documentação sobre o método “Consulta Chave
Acesso Sefaz”
”GetRetornoConsultaChaveSefaz”

cte_request_post_consulta_chave_sefaz.txt
cte_response_getRetornoConsultaChaveSefaz.txt
1.74 12/04/2021 Criado tópico AUTENTICAÇÃO e editado tópico 3.89.1

INTRODUÇÃO.
1.75 10/09/2021 Módulos: NFC-e, NF-e, CT-e, CT-e OS, Receptor NF-e, 3.95.0
Receptor CT-e, Receptor CT-e OS:
Efetuadas alterações no getListagem e getLog para utilizar
paginação.
Criado tópico LISTAGEM E PAGINAÇÃO.
1.76 24/09/2021 Módulo NF-e: 3.95.1
2.2.14.: incluída documentação sobre o método “Comprovante de
Entrega”
2.2.15.: incluída documentação sobre o método “Cancelamento do
Comprovante de Entrega”
2.3.18.: incluída documentação sobre o método ”
GetEventoEntrega”

nfe_request_post_comprovante_entrega.txt
nfe_request_post_cancelamento_comprovante_entrega.txt
nfe_response_get_evento_entrega.txt
1.77 26/10/2021 Módulo NFS-e: 3.96.1
1.3.3.: incluída documentação sobre o método “GetStatus (com
parâmetros).
Editados os métodos getLog e getListagem.

Página 450 de 452
1.78 09/11/2021 Módulo NF-e: 3.97.0

2.3.2.: ajustada descrição do método getXml.
1.79 21/12/2021 Ajustados tópicos: 3.98.1
12.2.4. Marcar Impresso
Ajustada introdução correspondente ao método

MarcarImpresso e ajustado conteúdo da action de
"MarcarConsultado" (do método MarcarImpresso) para
"MarcarImpresso", em todos os módulos existentes.
1.80 22/04/2022 Módulo NF-e 3.103.0
Ajustado tópico:
2.3.12. Consulta Impressão Carta Correção Nfe
Colocadas informações da nova ferramenta no tópico.
1.81 10/05/2022 Módulo NF-e 3.103.1
Ajustado tópico:
2.2.1.4. Layout
Ajustado exemplo e composição do grupo mastersaf.
1.82 24/05/2022 Módulo NF-e 3.104.0
Ajustado tópico:
Adicionado parâmetro infoAdicionais.
Alterado nome do txt de exemplo "nfe_response_get_listagem.txt"
para "nfe_response_get_listagem_infoadicionais.txt".
Criado txt exemplo "nfe_response_get_listagem_resumido.txt".
1.83 19/07/2022 Módulo NFS-e 3.106.0
Ajustado tópico:
1.2.6. Convertida

Página 451 de 452
Método descontinuado (a partir da versão 3.106.1), mais informações

no tópico.
1.84 13/09/2022 Módulo CT-e 3.108.0
Ajustado tópico:
3.3.10.3. Filtro de CNPJ Emissor, Número da CT-e e Série da CT-e
Adicionado parâmetro “incluiXmlProc”, opcional.
1.85 14/03/2023 Módulo ADM 3.114.1
Ajustado tópico:
8.2.1. Manutenção de Empresa
Ajustada descrição do campo txt_conteudo.
| SUPORTE TÉCNICO
Para dúvidas ou problemas, abra um chamado na Central de Ajuda diretamente através deste link Onesource
Mastersaf - Suporte Geral (Zendesk) ou entre em contato com nossa equipe de Suporte Técnico pelo Telefone:
Central Telefônica: (11) 4700-9050 > Opção 4 – Suporte a produtos
• Opção 2 - ONESOURCE MASTERSAF

• Opção 1 – Soluções Fiscais (DW, GF, SMART)
• Opção 2 – Documentos Fiscais Eletrônicos (DFE)
• Opção 3 – Mensageria REINF, eSocial, ECF
• Opção 4 – Checkpoint.
Nosso horário de atendimento é de segunda a sexta-feira das 9h às 18h.

Página 452 de 452

MASTERSAFDFE Integracao Web Service

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

MASTERSAFDFE Integracao Web Service

Enviado por

Direitos autorais:

Formatos disponíveis

MASTERSAF DFE

INTEGRAÇÃO COM WEBSERVICE – DFE V3

Versão do Documento: 1.70

1.1. OBSERVAÇÕES GERAIS ................................................................................................................................. 70

1.2.1.1. Introdução .......................................................................................................................................... 70

1.2.1.2. URL .................................................................................................................................................... 70

1.2.1.3. Exemplo URL ..................................................................................................................................... 70

1.2.1.4. Layout ................................................................................................................................................. 71

1.2.1.7. Envio ................................................................................................................................................... 71

1.2.1.8. Retorno Sucesso ................................................................................................................................ 71

1.2.1.9. Retorno Erro ....................................................................................................................................... 72

1.2.2. Cancelar ................................................................................................................................................... 72

1.2.2.1. Introdução .......................................................................................................................................... 72

1.2.2.2. URL .................................................................................................................................................... 72

1.2.2.3. Exemplo URL ..................................................................................................................................... 72

1.2.2.4. Layout ................................................................................................................................................ 72

1.2.2.5. Permissões ........................................................................................................................................ 72

1.2.2.6. Cabeçalho .......................................................................................................................................... 73

1.2.2.7. Envio ................................................................................................................................................... 73

1.2.2.8. Retorno Sucesso................................................................................................................................ 73

1.2.2.9. Retorno Erro ...................................................................................................................................... 73

1.2.3. MarcarConsultado ................................................................................................................................... 73

1.2.3.1. Introdução .......................................................................................................................................... 73

1.2.3.2. URL .................................................................................................................................................... 73

INTEGRAÇÃO COM WEBSERVICE – DFE V3

1.2.3.3. Exemplo URL ..................................................................................................................................... 74

1.2.3.4. Layout ................................................................................................................................................ 74

1.2.3.6. Cabeçalho .......................................................................................................................................... 74

1.2.3.7. Envio ................................................................................................................................................... 74

1.2.3.8. Retorno Sucesso ................................................................................................................................ 75

1.2.3.9. Retorno Erro ...................................................................................................................................... 75

1.2.4. ConsultarRpssAguardandoDownload .................................................................................................... 75

1.2.4.1. Introdução .......................................................................................................................................... 75

1.2.4.2. URL .................................................................................................................................................... 75

1.2.4.3. Exemplo URL ..................................................................................................................................... 75

1.2.4.4. Layout ................................................................................................................................................ 75

1.2.4.5. Permissões ........................................................................................................................................ 76

1.2.4.6. Cabeçalho .......................................................................................................................................... 76

1.2.4.8. Retorno Sucesso ............................................................................................................................... 76

1.2.4.10. Retorno Erro .................................................................................................................................... 77

1.2.5. UploadRetornoPrefeitura ........................................................................................................................ 77

1.2.5.1. Introdução .......................................................................................................................................... 77

1.2.5.2. URL .................................................................................................................................................... 77

1.2.5.3. Exemplo URL ..................................................................................................................................... 77

1.2.5.4. Layout ................................................................................................................................................ 77

1.2.5.5. Permissões ........................................................................................................................................78

1.2.5.6. Cabeçalho ..........................................................................................................................................78

1.2.5.8. Retorno Sucesso ...............................................................................................................................78

1.2.5.9. Retorno Erro ......................................................................................................................................78

1.2.6. Convertida ................................................................................................................................................ 79

1.2.6.1. Introdução .......................................................................................................................................... 79

INTEGRAÇÃO COM WEBSERVICE – DFE V3

1.2.7. NumeroRPS ............................................................................................................................................. 79

1.2.7.1. Introdução .......................................................................................................................................... 79

1.2.7.2. URL .................................................................................................................................................... 79

1.2.7.3. Exemplo URL ..................................................................................................................................... 79

1.2.7.4. Layout ................................................................................................................................................ 79

1.2.7.5. Permissões ........................................................................................................................................ 80

1.2.7.6. Cabeçalho ......................................................................................................................................... 80

1.2.7.7. Envio .................................................................................................................................................. 80

1.2.7.8. Retorno Sucesso ............................................................................................................................... 80

1.2.7.9. Layout Retorno ................................................................................................................................. 80