Web service Portolog: Inclusão/Alteração de Cadastro de Empresa de Origem da Carga
Serviço web que processa os pedidos de inclusão e alteração de cadastros de Empresa de Origem da Carga. Estes cadastros são utilizados para informar no DL-e os dados da empresa que estufou a carga que irá ser encaminhada ao porto. Utilizada somente nos processos logísticos de Exportação, Cabotagem de Origem ou Entrada de Carga.
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/empresa-origem-carga/nova/v1.00
Content-Type:
application/xml ou application/json
Parâmetros da Requisição de Inclusão/Alteração de Cadastro de Empresa de Origem da Carga:
Dados Gerais:
| Nome | Descrição | Tipo | Tamanho | Local | Observações |
|---|---|---|---|---|---|
| versao | versão do arquivo de inclusão/alteração de cadastro de empresa de origem da carga | String(Obrigatório) | 4 | body | Versão Atual: 1.00 |
| cnpjEmissor | CNPJ do Sistema Externo que está solicitando a inclusão/alteração de cadastro de empresa de origem da carga | String(Obrigatório) | 14 | body |
Lista de Empresas de Origem da Carga:
| Nome | Descrição | Tipo | Tamanho | Local | Observações |
|---|---|---|---|---|---|
| seq | Sequencial para identificar o registro dentro do arquivo. Deve ser único para possibilitar o relacionamento no arquivo de retorno do processamento. | Numeric(Obrigatório) | - | body | |
| tipoMovimento | Tipo de Movimento: Cadastramento ou Alteração | String(Obrigatório) | 1 | body | Domínio: C = Cadastramento, A = Alteração |
| cnpjEmpresa | CNPJ da Empresa | String(Obrigatório) | 14 | body | |
| razaoSocialEmpresa | Razão Social da Empresa | String(Obrigatório) | 100 | body | |
| inscricaoEstadual | Inscrição Estadual da Empresa | String(Opcional) | 15 | body | |
| inscricaoMunicipal | Inscrição Municipal da Empresa | String(Opcional) | 15 | body | |
| matriz | Informa se a empresa é matriz ou não (filial) | String(Opcional) | 3 | body | Domínio: SIM/NAO. (*) Campo Obrigatório caso se trate de um cadastramento. |
| cnpjEmpresaMatriz | Cnpj da Empresa de Origem Matriz | String(Opcional) | 14 | body | (*) Campo Obrigatório caso o campo "matriz" esteja preenchido com o valor "SIM". |
Campos de Endereço da Empresa de Origem:
| Nome | Descrição | Tipo | Tamanho | Local | Observações |
|---|---|---|---|---|---|
| cep | CEP do Endereço | Numeric(Opcional) | 8 | body | |
| logradouro | Logradouro do Endereço | String(Opcional) | 100 | body | |
| numero | Número do Local no Endereço | String(Opcional) | 6 | body | |
| complemento | Complemento do Endereço | String(Opcional) | 50 | body | |
| telefone | Número do telefone da empresa | String(Opcional) | 15 | body | |
| bairro | Identificação do Bairro do Endereço | String(Opcional) | 50 | body | |
| endereço de email da empresa | String(Opcional) | 50 | body | ||
| codMunicipio | Código do município, disponível na base de dados do IBGE e que define os campos "Estado" e "Município" dentro do cadastro de endereço da empresa | Numeric(Obrigatório) | 7 | body | (*) Campo obrigatório somente na inclusão do cadastro da empresa de origem. Domínio: Vide campo "observação" logo abaixo. |
Observação:
A relação dos códigos dos municípios pode ser baixada no seguinte endereço: https://sidra.ibge.gov.br/territorio#/N6.
Lista de Representantes Legais da Empresa de Origem(Opcional):
| Nome | Descrição | Tipo | Tamanho | Local | Observações |
|---|---|---|---|---|---|
| seq | Sequencial para identificar o registro dentro do arquivo. Deve ser único para possibilitar o relacionamento no arquivo de retorno do processamento. | Numeric(Obrigatório) | - | body | |
| nome | Nome do Representante Legal. | String(Opcional) | 100 | body | (*) Campo obrigatório somente na inclusão do cadastro da empresa de origem. |
| cpf | CPF do Representante Legal. | String(Opcional) | 11 | body | (*) Campo obrigatório somente na inclusão do cadastro da empresa de origem. |
Campos de Endereço do Representante Legal da Empresa de Origem:
| Nome | Descrição | Tipo | Tamanho | Local | Observações |
|---|---|---|---|---|---|
| cep | CEP do Endereço | Numeric(Opcional) | 8 | body | |
| logradouro | Logradouro do Endereço | String(Opcional) | 100 | body | |
| numero | Número do Local no Endereço | String(Opcional) | 6 | body | |
| complemento | Complemento do Endereço | String(Opcional) | 50 | body | |
| telefone | Número do telefone do representante | String(Opcional) | 15 | body | |
| bairro | Identificação do Bairro do Endereço | String(Opcional) | 50 | body | |
| endereço de email do representante | String(Opcional) | 50 | body | ||
| codMunicipio | Código do município, disponível na base de dados do IBGE e que define os campos "Estado" e "Município" dentro do cadastro do representante legal | Numeric(Opcional) | 7 | body | Domínio: Vide campo "observação" logo abaixo. |
Atenção:
1. A relação dos códigos dos municípios pode ser baixada no seguinte endereço: https://sidra.ibge.gov.br/territorio#/N6.
2. Os dados gerais enviados referentes a alteração de uma empresa de origem da carga serão sempre sobrescritos. Entretanto, a lista de representantes legais será tratada de forma incremental, ou seja, apenas inclui, caso o CPF ainda não esteja cadastrado, ou atualiza os dados existentes, caso o CPF já esteja cadastrado como representante. Não existe a possibilidade de exclusão de representante legal via requisição web service.
Resposta da Requisição:
Dados Gerais:
| Nome | Descrição | Tipo | Observação |
|---|---|---|---|
| versao | Versão do Arquivo de Retorno de inclusão/alteração de cadastro de empresa de origem da carga | String(Obrigatório) | Versão Atual: 1.00 |
| dataProcessamento | Data/Hora do Registro de Processamento de inclusão/alteração de cadastro de empresa de origem da carga | Data/Hora(Obrigatório) |
Dados dos Registros:
| Nome | Descrição | Tipo | Observação |
|---|---|---|---|
| seq | Sequencial do registro dentro do arquivo | Numeric(Obrigatório) | |
| mensagem | Mensagem de confirmação ou erro no processamento de inclusão/alteração de cadastro de empresa de origem da carga | String(Obrigatório) | |
| pontoControle | Código do Ponto de Controle da Empresa de Origem. | String(Opcional) | (*) Campo exibido somente quando a empresa de origem for cadastrada com sucesso ou quando a empresa de origem já estiver cadastrada. |
Exemplos de Arquivos XML/JSON:
Exemplo de JSON do arquivo de Inclusão/Alteração de Cadastro de Empresa de Origem da Carga:
{
"versao":"1.00",
"cnpjEmissor":"82951351000142",
"EOC": [
{
"seq": 0,
"tipoMovimento":"C",
"cnpjEmpresa":"50542724000135",
"razaoSocialEmpresa":"Empresa da Familia Ltda",
"matriz":"SIM",
"endereco":
{
"cep":88888888,
"logradouro":"Rua Teste",
"numero":"222",
"telefone":"3333-9333",
"bairro":"Teste",
"codMunicipio":4201307
},
"listaReprLegal": [
{
"seq": 0,
"cpf":"34218873577",
"nome":"José Bonifácio",
"enderecoReprLegal":
{
"cep":88888888,
"logradouro":"Rua dos Poetas",
"numero":"15",
"telefone":"9999-9333",
"bairro":"Burguês",
"codMunicipio":4201307,
"email": "teste@teste.com"
}
}
]
}
]
}
Exemplo de retorno de JSON com a resposta da requisição:
{
"dataProcessamento" : "2019-11-13T14:50:51.945-03:00",
"versao":"1.00",
"eocProc" : [
{
"mensagem" : [ "[IN0208] Registro processado com sucesso" ],
"pontoControle" : "EO00235",
"seq" : 0
}
]
}
Exemplo de retorno de JSON com resposta de erro:
{
"dataProcessamento" : "2019-11-13T14:50:51.945-03:00",
"versao":"1.00",
"eocProc" : [
{
"mensagem" : [ "[ER0108] O CNPJ informado já está cadastrado." ],
"pontoControle" : "EO00235",
"seq" : 0
}
]
}
Exemplo de XML do arquivo de Inclusão/Alteração de Cadastro de Empresa de Origem da Carga:
<?xml version="1.0" encoding="UTF-8"?>
<loteEOC versao="1.00" xmlns="http://www.portosempapel.gov.br/eoc" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.portosempapel.gov.br/eoc EmpresaOrigem_v1.00.xsd ">
<cnpjEmissor>04291660000120</cnpjEmissor>
<EOC seq="2">
<tipoMovimento>C</tipoMovimento>
<cnpjEmpresa>84229901000140</cnpjEmpresa>
<razaoSocialEmpresa>Outro Teste Empresa</razaoSocialEmpresa>
<matriz>NAO</matriz>
<cnpjEmpresaMatriz>54906381000100</cnpjEmpresaMatriz>
<endereco>
<cep>33333333</cep>
<logradouro>logr3</logradouro>
<numero>333</numero>
<telefone>33333333</telefone>
<bairro>bairro3</bairro>
<codMunicipio>4201307</codMunicipio>
</endereco>
<listaReprLegal seq="0">
<cpf>35578013570</cpf>
<nome>OUTRO NOME</nome>
<enderecoReprLegal>
<cep>99999999</cep>
<logradouro>logr1</logradouro>
<numero>111</numero>
<complemento>compl1</complemento>
<telefone>11111111</telefone>
<bairro>bairro1</bairro>
<codMunicipio>4205407</codMunicipio>
<email>email1</email>
</enderecoReprLegal>
</listaReprLegal>
</EOC>
</loteEOC>
Exemplo de retorno de XML com a resposta da requisição:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<loteEOCProc xmlns="http://www.portosempapel.gov.br/eoc" versao="1.00">
<dataProcessamento>2020-01-16T17:51:33.194-03:00</dataProcessamento>
<eocProc seq="0">
<mensagem>[IN0208] Registro processado com sucesso</mensagem>
<pontoControle>EO00237</pontoControle>
</eocProc>
</loteEOCProc>
Exemplo de retorno de XML com resposta de erro:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<loteEOCProc xmlns="http://www.portosempapel.gov.br/eoc" versao="1.00">
<dataProcessamento>2020-01-16T17:51:33.194-03:00</dataProcessamento>
<eocProc seq="0">
<mensagem>[ER0170] O CNPJ da Empresa Matriz informado não está cadastrado no sistema.</mensagem>
</eocProc>
</loteEOCProc>