Quando é feito o envio de Arquivos pelo Client Suite, como ficamos sabendo a situação que se encontra este arquivo? O DF-e foi autorizado ou não? E o Evento foi feito com sucesso? Bom, para isso, utilizamos os RPs! Eles que nos indicam a resposta dada pela Secretaria da Fazenda para determinada Emissão, Evento ou Função utilizada.
Veja abaixo os padrões que você poderá tratar em seus arquivos já processados pelo Client Suite.
Padrão de campos retornados e seus significados
O Client Suite ao dar andamento do processamento de um arquivo, que foi anteriormente enviado para pasta Remessas, irá coloca-lo em espera no diretório Processados, onde irá ser posteriormente executado seu processo de comunicação com a API. Após todo este tramite os arquivos irão estar na pasta nsConcluidos, que se encontra dentro da Processados. Dessa forma, quando abrirmos os arquivos iremos ver seus retornos com o prefixo RP ou MSG.
Registro MSG :
O registro MSG, é um registro de texto livre onde são adicionadas informações sobre problemas genéricos ocorridos durante o processamento do arquivo de integração, por exemplo, se ocorrer alguma falha de comunicação com a impressora, ou algum diretório não acessível ou arquivo de integração com layout não conhecido. Ele é representado sempre da mesma forma em todos os projetos implementados no Client Suite: MSG | Mensagem. Dessa forma, basta ser pego o campo Mensagem para verificar o erro que esta ocorrendo com a emissão/evento/função utilizada no Client Suite.
Registro RP :
O registro RP é utilizado para informações sobre o status de processamento do documento e possui informações que são necessárias para o gerenciamento deste documento. No RP são adicionadas informações que são geradas pelos nossos integradores como a chave de acesso, são adicionadas também informações retornadas pela Sefaz como o protocolo de autorização, o código de situação e a data e hora de autorização. Além disso são adicionadas também informações sobre a validação do documento, por exemplo se alguma informação do documento estiver inválida será gerado um registro RP com o código de situação de rejeição e o motivo pelo qual o documento foi rejeitado. Ja o MSG, é um registro de texto livre onde são adicionadas informações sobre problemas genéricos ocorridos durante o processamento do arquivo de integração, por exemplo, se ocorrer alguma falha de comunicação com a impressora, ou algum diretório não acessível ou arquivo de integração com layout não conhecido. Abaixo pode-se ver os padrões de prefixo para cada processo da aplicação nos projetos:
NF-e
Emissão
Retorno Emissão NF-e
| ID | Grupo | Campo | Descrição | Tipo | Tamanho | Observação |
|---|---|---|---|---|---|---|
| 1 | RP | nProt | Número do protocolo de autorização da NF-e na Sefaz | N | 15 | Informação do Protocolo da Emissão |
| 2 | RP | dGValue | Digest Value | C | 1 à 255 | Digest Value da autorização |
| 3 | RP | cStat | Código de Status da mensagem de Retorno | N | 3 | Código do status da resposta |
| 4 | RP | xMotivo | Descrição da Resposta de Retorno | C | 255 | Descrição do status da resposta. |
| 5 | RP | chNFe | Chave da NF-e | N | 44 | Chave de Acesso da NF-e. |
| 6 | RP | serie | Serie da NF-e | N | 1 à 3 | |
| 7 | RP | nNF | Numeração da NF-e | N | 1 à 9 | |
| 8 | RP | dhAutorizacao | Data de Autorização | D | TZD (UTC – Universal Coordinated Time, onde TZD pode ser -02:00 (Fernando de Noronha), -03:00 (Brasília) ou -04:00 (Manaus), no horário de verão serão – 01:00, -02:00 e -03:00. Ex.: 2014-02-03T17:01:49-02:00 |
Eventos
Retorno Eventos Gerais da NF-e
| ID | Grupo | Campo | Descrição | Tipo | Tamanho | Observação |
|---|---|---|---|---|---|---|
| 1 | RP | nProt | Numero Protocolo do Evento | N | 15 | Informação do Protocolo do Evento |
| 2 | RP | cStat | Código de Status da mensagem de Retorno | N | 3 | Código do status da resposta |
| 3 | RP | xMotivo | Descrição da Resposta de Retorno | C | 255 | Descrição do status da resposta. |
| 4 | RP | chNFe | Chave da NF-e | N | 44 | Chave de Acesso da NF-e vinculada ao evento. |
| 5 | RP | dhAutorizacao | Data de Autorização | D | TZD (UTC – Universal Coordinated Time, onde TZD pode ser -02:00 (Fernando de Noronha), -03:00 (Brasília) ou -04:00 (Manaus), no horário de verão serão – 01:00, -02:00 e -03:00. Ex.: 2014-02-03T17:01:49-02:00 |
|
| 6 | RP | Reservado | Reservado | Reservado | ||
| 7 | RP | Id | Chave do Evento | C | 54 | Identificador da TAG a ser assinada, a regra de formação do Id é: “ID” + tpEvento + chave da NF-e + nSeqEvento. |
Retorno da Inutilização Numeração NF-e
| ID | Grupo | Campo | Descrição | Tipo | Tamanho | Oberservação |
|---|---|---|---|---|---|---|
| Informações de Retorno do processamento de Inutilizar Numeração | ||||||
| 1 | RP | cStat | Código de Status da mensagem de Retorno | N | 3 | Código do status da resposta |
| 2 | RP | xMotivo | Descrição da Resposta de Retorno | C | 255 | Descrição do status da resposta. “INUTILIZAÇÃO DE NÚMERO HOMOLOGADO” |
| 3 | RP | dhAutorizacao | Data de Autorização | D | TZD (UTC – Universal Coordinated Time, onde TZD pode ser -02:00 (Fernando de Noronha), -03:00 (Brasília) ou 04:00 (Manaus), no horário de verão serão – 01:00, -02:00 e -03:00. Ex.: 2015-02-03T17:01:49-02:00 | |
| 4 | RP | nProt | Numero Protocolo da Inutilização | N | 15 | Informação do Protocolo da Inutilização |
CT-e e CT-e OS
Emissão
Retorno Emissão CT-e
| ID | Grupo | Campo | Descrição | Tipo | Tamanho | Oberservação |
|---|---|---|---|---|---|---|
| 1 | RP | nProt | Número do protocolo de autorização da CT-e na Sefaz | N | 15 | Informação do Protocolo da Emissão |
| 2 | RP | dGValue | Digest Value | C | 1 à 255 | Digest Value da autorização |
| 3 | RP | cStat | Código de Status da mensagem de Retorno | N | 3 | Código do status da resposta |
| 4 | RP | xMotivo | Descrição da Resposta de Retorno | C | 255 | Descrição do status da resposta. |
| 5 | RP | chCTe | Chave da CT-e | N | 44 | Chave de Acesso da CT-e. |
| 6 | RP | serie | Serie da CT-e | N | 1 à 3 | |
| 7 | RP | nCT | Numeração da CT-e | N | 1 à 9 |
Eventos
Retorno Eventos Gerais de CT-e
| ID | Grupo | Campo | Descrição | Tipo | Tamanho | Observação |
|---|---|---|---|---|---|---|
| 1 | RP | nProt | Numero Protocolo do Evento | N | 15 | Informação do Protocolo do Evento |
| 2 | RP | cStat | Código de Status da mensagem de Retorno | N | 3 | Código do status da resposta |
| 3 | RP | xMotivo | Descrição da Resposta de Retorno | C | 255 | Descrição do status da resposta. |
| 4 | RP | chCTe | Chave da CT-e | N | 44 | Chave de Acesso da CT-e vinculada ao evento. |
| 5 | RP | Id | Chave do Evento | C | 54 | Identificador da TAG a ser assinada, a regra de formação do Id é: “ID” + tpEvento + chave da CT-e + nSeqEvento. |
| 6 | RP | dhAutorizacao | Data de Autorização | D | TZD (UTC - Universal Coordinated Time, onde TZD pode ser -02:00 (Fernando de Noronha), -03:00 (Brasília) ou -04:00 (Manaus), no horário de verão serão - 01:00, -02:00 e -03:00. Ex.: 2014-02-03T17:01:49-02:00 |
Retorno da Inutilização Numeração CT-e
| ID | Grupo | Campo | Descrição | Tipo | Tamanho | Observação |
|---|---|---|---|---|---|---|
| Informações de Retorno do processamento de Inutilizar Numeração | ||||||
| 1 | RP | cStat | Código de Status da mensagem de Retorno | N | 3 | Código do status da resposta |
| 2 | RP | xMotivo | Descrição da Resposta de Retorno | C | 255 | Descrição do status da resposta. "INUTILIZAÇÃO DE NÚMERO HOMOLOGADO" |
| 3 | RP | dhAutorizacao | Data de Autorização | D | TZD (UTC - Universal Coordinated Time, onde TZD pode ser -02:00 (Fernando de Noronha), -03:00 (Brasília) ou 04:00 (Manaus), no horário de verão serão - 01:00, -02:00 e -03:00. Ex.: 2015-02-03T17:01:49-02:00 | |
| 4 | RP | nProt | Numero Protocolo da Inutilização | N | 15 | Informação do Protocolo da Inutilização |
MDF-e
Emissão
Retorno Emissão MDF-e
| ID | Grupo | Campo | Descrição | Tipo | Tamanho | Observação |
|---|---|---|---|---|---|---|
| 1 | RP | nProt | Número do protocolo de autorização da MDF-e na Sefaz | N | 15 | Informação do Protocolo do Evento |
| 2 | RP | dGValue | Digest Value | C | 1 à 255 | Digest Value da autorização |
| 3 | RP | cStat | Código de Status da mensagem de Retorno | N | 3 | Código do status da resposta |
| 4 | RP | xMotivo | Descrição da Resposta de Retorno | C | 255 | Descrição do status da resposta. |
| 5 | RP | chMDFe | Chave da MDF-e | N | 44 | Chave de Acesso do Manifesto. |
| 6 | RP | serie | Serie do MDF-e | N | 1 à 3 | |
| 7 | RP | nMDF | Numeração do MDF-e | N | 1 à 9 |
Eventos
Retorno Eventos Gerais de MDF-e
| ID | Grupo | Campo | Descrição | Tipo | Tamanho | Observação |
|---|---|---|---|---|---|---|
| 1 | RP | nProt | Numero Protocolo do Cancelamento | N | 15 | Informação do Protocolo do Evento |
| 2 | RP | cStat | Código de Status da mensagem de Retorno | N | 3 | Código do status da resposta |
| 3 | RP | xMotivo | Descrição da Resposta de Retorno | C | 255 | Descrição do status da resposta. |
| 4 | RP | chMDFe | Chave da MDF-e | N | 44 | Chave de Acesso da MDF-e vinculada ao evento. |