A integração com o Client Suite é realizada através de arquivos. Estes arquivos devem seguir um determinado padrão para que a aplicação entenda qual o tipo de processamento deve ser realizado com o conteúdo de cada arquivo.
Veja abaixo os padrões que você poderá utilizar na geração de seus arquivos para integrar com o Client Suite.
Padrão de nomenclatura e extensão dos arquivos de processamento
O Client Suite utilize o nome e extensão dos arquivos encontrados na pasta Remessas para determinar qual processo deve ser realizado com seu conteúdo.
O prefixo (início) do nome do arquivo será utilizado para identificar o processo a ser realizado. Neste caso, se o nome do arquivo iniciar com MDFEEMISSAO_, o Client Suite entenderá que deverá realizar o processo de Emissão de MDF-e.
A extensão do nome do arquivo será utilizado para determinar o tipo de conteúdo do arquivo. Neste caso, se a extensão do arquivo for .json, o Client Suite entenderá que o conteúdo do arquivo está em formato JSON.
As tabelas abaixo indicam os padrões de prefixo e extensão para cada processo da aplicação.
MDF-e
| Processo | Nome do Arquivo (prefixo) | Extensão |
|---|---|---|
| Emissão por JSON | MDFEEMISSAO_ | .json |
| Emissão por TXT | MDFEEMISSAO_ | .txt |
| Emissão por XML | MDFEEMISSAO_ | .xml |
| Encerramento por JSON | MDFEENC_ | .json |
| Encerramento por TXT | MDFEENC_ | .txt |
| Cancelamento por JSON | MDFECANC_ | .json |
| Cancelamento por TXT | MDFECANC_ | .txt |
| Envio de Email por TXT | MDFEENVIOEMAIL_ | .txt |
| Reimpressão por TXT | MDFEREIMPRIME_ | .txt |
| Reimpressão de evento por TXT | MDFEREIMPRIMEEVENTO_ | .txt |
| Consulta situação por TXT | MDFESITUACAO_ | .txt |
| Inclusão de condutor por TXT | MDFEINCCOND_ | .txt |
| Inclusão de condutor por JSON | MDFEINCCOND_ | .json |
| Inclusão de DF-e por TXT | MDFEINCDFE_ | .txt |
| Inclusão de DF-e por JSON | MDFEINCDFE_ | .json |
| Pagamento de operação por TXT | MDFEPAGOPER_ | .txt |
| Pagamento de operação por JSON | MDFEPAGOPER_ | .json |
NF-e
| Processo | Nome do Arquivo (Prefixo) | Extensão | Observação |
|---|---|---|---|
| Emissão por JSON | NFEEMISSAO_ | .json | |
| Emissão por TXT | NFEEMISSAO_ | .txt | |
| Emissão por XML | NFEEMISSAO_ | .xml | |
| Evento por TXT | NFEEVENTO_ | .txt | A aplicação irá utilizar a linha A do arquivo para identificar automaticamente o evento a ser processado. |
| Cancelamento por JSON | NFECANC_ | json | |
| Cancelamento por TXT | NFECANC_ | .txt | |
| Carta de Correção por JSON | NFECCE_ | .json | |
| Carta de Correção por TXT | NFECCE_ | .txt | |
| Inutilização por JSON | NFEINUT_ | .json | |
| Inutilização por TXT | NFEINUT_ | .txt | |
| Consulta de Situação por TXT | NFESITUACAO_ | .txt | |
| Reenvio de Email por TXT | NFEREENVIOEMAIL_ | .txt | |
| Reimpressão de NF-e por TXT | NFEREIMPRIME_ | .txt | |
| Reimpressão de evento de NF-e por TXT | NFEREIMPRIMEEVENTO_ | .txt | |
| Prévia NF-e por JSON | NFEPREVIA_ | .json | |
| Prévia NF-e por TXT | NFEPREVIA_ | .txt | |
| Comprovante de Entrega por TXT | NFECOMPENTR_ | .txt | |
| Comprovante de Entrega por JSON | NFECOMPENTR | .json | |
| Cancelamento Comprovante de Entrega por TXT | NFECANCCOMPENTR | .txt | |
| Cancelamento Comprovante de Entrega por JSON | NFECANCCOMPENTR | .json |
CT-e e CT-e OS
| Processo | Nome do Arquivo (prefixo) | Extensão | Modelo | Observação |
|---|---|---|---|---|
| Emissão por JSON | CTEEMISSAO_ | .json | CTe | |
| Emissão por JSON | CTEOSEMISSAO_ | .json | CTe OS | |
| Emissão por TXT | CTEEMISSAO_ | .txt | CTe | |
| Emissão por TXT | CTEOSEMISSAO_ | .txt | CTe OS | |
| Emissão por XML | CTEEMISSAO_ | .xml | CTe | |
| Emissão por XML | CTEOSEMISSAO_ | .xml | CTe OS | |
| Evento por TXT | CTEEVENTO_ | .txt | CTe e CTe OS | A aplicação irá utilizar a linha A do arquivo para identificar automaticamente o evento a ser processado. |
| Cancelamento por JSON | CTECANC_ | .json | CTe e CTe OS | |
| Cancelamento por TXT | CTECANC_ | .txt | CTe e CTe OS | |
| Carta de Correção por JSON | CTECCE_ | .json | CTe e CTe OS | |
| Carta de Correção por TXT | CTECCE_ | txt | CTe e CTe OS | |
| Inutilização por JSON | CTEINUT_ | .json | CTe e CTe OS | |
| Inutilização por TXT | CTEINUT_ | .txt | CTe e CTe OS | |
| Comprovante de Entrega por JSON | CTECOMPENTR_ | .json | CTe | |
| Comprovante de Entrega por TXT | CTECOMPENTR_ | .txt | CTe | |
| Cancelamento de Comprovante de Entrega por JSON | CTECANCCOMPENTR_ | .json | CTe | |
| Cancelamento de Comprovante de Entrega por TXT | CTECANCCOMPENTR_ | .txt | CTe | |
| GTV por JSON | CTEOSGTV_ | .json | CTe OS | |
| GTV por TXT | CTEOSGTV_ | txt | CTe OS | |
| Reenvio de Email por TXT | CTEREENVIOEMAIL_ | .txt | CTe | |
| Reimpressão de CT-e por TXT | CTEREIMPRIME_ | .txt | CTe e CTe OS | |
| Reimpressão de evento de CT-e por TXT | CTEREIMPRIMEEVENTO_ | .txt | CTe e CTe OS | Apenas para Cancelamento e CCE |
| Download de Inutilização por TXT | CTEDOWNLOADINUT_ | .txt | CTe e CTe OS |