Web service Portolog: Ligação de DL-e com Documento de Origem
Serviço web que efetua a associação do documento de origem previamente importado ao seu respectivo documento logístico. Serviço utilizado somente para DL-es de Exportação, Entrada de Carga ou Cabotagem de Origem.
Atenção:
Um documento de origem pode ser associado a um DL-e somente até o seu sequenciamento, ou seja, o estado "Acesso ao Porto Confirmado". Após este estado não será mais possível a associação de um documento de origem ao DL-e.
Atores que podem utilizar o Serviço:
- Operador Portuário
- Terminal Portuário
- Ponto de Controle
Endpoint do Serviço:
POST url_base/psp-portolog-rest/api/dle/associa-dot/v1.01
Content-Type:
application/xml ou application/json
Parâmetros da Requisição de Ligação de DL-e com Documento de Origem:
Dados Gerais:
| Nome | Descrição | Tipo | Tamanho | Local | Observações |
|---|---|---|---|---|---|
| versao | versão do arquivo de Ligação de DL-e com Documento de Origem | String(Obrigatório) | 4 | body | Versão Atual: 1.01 |
| cnpjEmissor | CNPJ do Sistema Externo que está solicitando a associação do DL-e ao DOT | String(Obrigatório) | 14 | body | |
| numeroDle | Número do DL-e ao qual o documento de origem deve ser associado | Numeric(Obrigatório) | 12 | body | |
| nfne | Lista com os nomes do arquivos quando o tipo do documento de origem for uma Nota Fiscal Não Eletrônica(NF-ne) | String(Opcional) | 60 | body | |
| cte | Lista com os nomes do arquivos quando o tipo do documento de origem for um Conhecimento de Transporte Eletrônico(CT-e) | String(Opcional) | 60 | body | |
| mdfe | Lista com os nomes do arquivos quando o tipo do documento de origem for um Manifesto de Documento Fiscal Eletrônico(MDF-e) | String(Opcional) | 60 | body |
Atenção:
1. Os nomes dos arquivos a serem preenchidos nos campos nfne, cte ou mdfe deve ser o mesmo nome encaminhado no arquivo de retorno do processamento do documento de origem encaminhado anteriormente, conforme Web service de Informação de Documento de Origem.
2. As Notas Fiscais Eletrônicas(NF-e) serão automaticamente associadas a um DL-e através da importação e associação ao DL-e de um CT-e ou MDF-e que possua a informação da chave de acesso dessa nota fiscal. Dessa forma, após a importação da NF-e e do CT-e ou MDF-e que possui a chave dessa nota fiscal, deve-se então encaminhar a requisição de ligação de DL-e com DOT do CT-e, através do campo cte, ou do MDF-e, através do campo mdfe. Assim tanto o CT-e ou MDF-e quanto a NF-e serão associados ao respectivo DL-e.
3. Quando na requisição de ligação for encaminhado um arquivo no formato JSON os campos nfne, cte e mdfe poderão receber uma lista de nomes dos arquivos por cada atributo. Já quando se tratar de um arquivo XML para cada nome de arquivos deverá ser replicada a tag do tipo de arquivo para cada um dos nomes. Ver Exemplos de XML/JSON abaixo.
Resposta da Requisição:
Dados Gerais:
| Nome | Descrição | Tipo | Observação |
|---|---|---|---|
| versao | Versão do Arquivo de Retorno de Processamento de Ligação de DL-e com Documento de Origem | String(Obrigatório) | Versão Atual: 1.01 |
| dataProcessamento | Data/Hora do Registro de Processamento de Ligação de DL-e com Documento de Origem | Data/Hora(Obrigatório) | |
| mensagem | Mensagem de erro no processamento da requisição de Ligação de DL-e com Documento de Origem | String(Opcional) | Campo exibido somente quando houver um erro geral de associação que não esteja associado ao documento de origem em si. |
| dle | Número do DL-e associado ao documento de origem. | Numeric(Opcional) | Campo não exibido quando a requisição de retorno possuir algum erro no seu formato. |
Lista de Arquivos Processados ou Não Processados:
| Nome | Descrição | Tipo | Observação |
|---|---|---|---|
| nomeArquivo | Nome do arquivo do documento de origem associado ou com erro de associação ao DL-e | String(Opcional) | |
| mensagem | Mensagem de confirmação ou erro no processamento de associação do arquivo de documento de origem ao DL-e | String(Opcional) |
Exemplos de Arquivos XML/JSON:
Exemplo de JSON do arquivo de ligação de DL-e com documento de origem:
{
"versao":"1.01",
"cnpjEmissor":"46591057000103",
"numeroDle":"122019",
"nfne":["DOT_123456787_REST_.xml","DOT_123499999_REST_.xml"]
}
Exemplo de retorno de JSON com a resposta da requisição:
{
"dataProcessamento" : "2019-11-28T17:39:49.330-03:00",
"dle" : 18722019,
"arquivosProcessados" :
{
"arquivo" :
[
{
"nomeArquivo" : "DOT_123456787_REST_.xml",
"mensagem" : [ "[IN0208] Arquivo processado com sucesso" ]
},
{
"nomeArquivo" : "DOT_123499999_REST_.xml",
"mensagem" : [ "[IN0208] Arquivo processado com sucesso" ]
}
]
},
"versao" : "1.01"
}
Exemplo de retorno de JSON com resposta de erro:
{
"dataProcessamento" : "2019-11-27T13:24:38.929-03:00",
"dle" : 18682019,
"arquivosNaoProcessados" :
{
"arquivo" :
[
{
"nomeArquivo" : "DOT_MeuTeste2_REST_.xml",
"mensagem" : [ "[ER0244] O arquivo não foi enviado. DOT_MeuTeste2_REST_.xml" ]
},
{
"nomeArquivo" : "DOT_MeuTeste_REST_.xml",
"mensagem" : [ "[ER0244] O arquivo não foi enviado. DOT_MeuTeste_REST_.xml" ]
}
]
},
"versao" : "1.01"
}
Exemplo de XML do arquivo de ligação de DL-e com documento de origem:
<?xml version="1.0" encoding="UTF-8"?>
<relacionamentoDleDot versao="1.01" xmlns="http://www.portosempapel.gov.br/dledot" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.portosempapel.gov.br/dledot ligacaoDleDot_v1.01.xsd ">
<cnpjEmissor>04291660000120</cnpjEmissor>
<numeroDle>18712019</numeroDle>
<nfne>DOT_MesmoDOT_REST_.xml</nfne>
<nfne>DOT_OutroDOT_REST_.xml</nfne>
</relacionamentoDleDot>
Exemplo de retorno de XML com a resposta da requisição:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<relacionamentoDleDotProc xmlns="http://www.portosempapel.gov.br/dledot" versao="1.01">
<dataProcessamento>2019-11-27T13:47:12.950-03:00</dataProcessamento>
<dle>18692019</dle>
<arquivosProcessados>
<arquivo>
<nomeArquivo>DOT_MesmoDOT_REST_.xml</nomeArquivo>
<mensagem>[IN0208] Arquivo processado com sucesso</mensagem>
</arquivo>
<arquivo>
<nomeArquivo>DOT_OutroDOT_REST_.xml</nomeArquivo>
<mensagem>[IN0208] Arquivo processado com sucesso</mensagem>
</arquivo>
</arquivosProcessados>
</relacionamentoDleDotProc>
Exemplo de retorno de XML com resposta de erro:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<relacionamentoDleDotProc xmlns="http://www.portosempapel.gov.br/dledot" versao="1.01">
<dataProcessamento>2019-11-28T17:29:26.561-03:00</dataProcessamento>
<dle>18712019</dle>
<arquivosNaoProcessados>
<arquivo>
<nomeArquivo>DOT_MesmoDOT_REST_.xml</nomeArquivo>
<mensagem>[ER0037] Não é possível incluir o(a) NF-ne, pois já existe outro(a) NF-ne com o(a) mesmo(a) chave de acesso neste DL-e.</mensagem>
</arquivo>
</arquivosNaoProcessados>
</relacionamentoDleDotProc>