Produto: | Datasul |
Ocorrência: | Documentação de API |
| Nome Físico | cdp/cdapi349.p |
Objetivo
Realizar a integração dos dados das tabelas de Fornecedor, Fornecedor Internacional e Cliente Internacional via workflow de Emitente no FLUIG para o ERP.
Funcionamento
A API irá receber os dados previamente validados através da API de Emitente (cdapi366b), responsável pela integração do Cliente/Fornecedor do EMS5 e irá realizar as demais validações e posteriores atualizações das informações do Fornecedor (emitente) e Fornecedor/Cliente Internacional l(emitente-cex).
A execução na forma persistente ...
A sintaxe para executar a API em modo persistente é:
run cdp/cdapi349.p persistent set h-handle. |
A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.
Nos atributos das tabelas temporárias de entrada e saída:
tt_emitente_integr_import | Entr./Saída | ||||
Temp-table contendo os dados do Emitente referentes ao módulo de Importação | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cod-emitente | Integer | >>>>>>>>9 | Cod Emitente | Sim |
|
cod-itiner-exp | Integer | >>,>>9 | Itinerário Padrão para Exportação | Não |
|
cod-idioma | Caracter | x(12) | Idioma Padrão | Não |
|
cod-aba | Caracter | X(12) | ABA | Não |
|
cod-repres | Inteiro | >>>>>>>>9 | Cod Representante | Não |
|
cod-incoterm-exp | Caracter | X(3) | Incoterm padrão para Exportação | Não |
|
cod-itiner-imp | Integer | >>,>>9 | Itinerário Padrão para Importação | Não |
|
cod-incoterm-imp | Caracter | X(3) | Incoterm padrão para Importação | Não |
|
char-1 | Caracter | x(100) |
| Não |
|
char-2 | Caracter | x(100) |
| Não |
|
dec-1 | Decimal | ->>>>>>>>>>>9.99999999 |
| Não |
|
dec-2 | Decimal | ->>>>>>>>>>>9.99999999 |
| Não |
|
int-1 | Inteiro | ->>>>>>>>>9 |
| Não |
|
int-2 | Inteiro | ->>>>>>>>>9 |
| Não |
|
log-1 | Lógico | Sim/Não |
| Não |
|
log-2 | Lógico | Sim/Não |
| Não |
|
data-1 | Data | 99/99/9999 |
| Não |
|
data-2 | Data | 99/99/9999 |
| Não |
|
check-sum | Caracter | X(20) | Check-sum | Não |
|
log-desp-inclusas | Lógico | Sim/Não | Despesas Inclusas | Não |
|
nr-tab | Caracter | x(10) | Tabela Preço | Não |
|
cod-pto-contr | Inteiro | >>,>>9 | Ponto Controle | Não |
|
des-layout-origin-comerc-invoi | Caracter | x(256) | Layout original para emissão da Commercial Invoice | Não |
|
des-layout-origin-packing-list | Caracter | x(256) | Layout original para emissão do Packing List | Não |
|
des-layout-origin-proform-invoi | Caracter | x(256) | Layout original para emissão da Proforma Invoice | Não |
|
cdn-despa-import | Inteiro | >>>>>>>>9 | Despachante Importação | Não |
|
cdn-despa-exter-import | Inteiro | >>>>>>>>9 | Despachante Exterior Importação | Não |
|
cdn-segurad-import | Inteiro | >>>>>>>>9 | Seguradora Importação | Não |
|
cdn-corretor-cambio-import | Inteiro | >>>>>>>>9 | Corretor Câmbio Importação | Não |
|
cdn-corretor-import | Inteiro | >>>>>>>>9 | Corretor Importação | Não |
|
marca-1 | Caracter | X(50) | Marca 1 | Não |
|
marca-2 | Caracter | X(50) | Marca 2 | Não |
|
marca-3 | Caracter | X(50) | Marca 3 | Não |
|
marca-4 | Caracter | X(50) | Marca 4 | Não |
|
marca-5 | Caracter | X(50) | Marca 5 | Não |
|
des-layout-origin-ped-cambio | Caracter | x(256) | Layout original para emissão do pedido de fechamento de câmbio | Não |
|
des-layout-origin-instruc-embarq | Caracter | x(256) | Descrição layout original para emissão da instrução de embarque | Não |
|
des-layout-export-instruc-embarq | Caracter | x(256) | Layout Original para emissão da Instrução Embarque (Exportação) | Não |
|
des-layout-origin-pch-order | Caracter | x(256) | Layout Original para emissão da Purchase Order | Não |
|
mo-codigo | Inteiro | >9 | Código da moeda | Não |
|
cod-ident-fisc-exter | Caracter | x(20) | Código Identificacao Fiscal Exterior | Não |
|
tt_emitente_integr_export | Entrada/Saída | ||||
Temp-table contendo os dados do Emitente referentes ao módulo de Exportação | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cod-emitente | Integer | >>>>>>>>9 | Cod Emitente | Sim |
|
cod-itiner-exp | Integer | >>,>>9 | Itinerário Padrão para Exportação | Não |
|
cod-idioma | Caracter | x(12) | Idioma Padrão | Não |
|
cod-aba | Caracter | X(12) | ABA | Não |
|
cod-repres | Inteiro | >>>>>>>>9 | Cod Representante | Não |
|
cod-incoterm-exp | Caracter | X(3) | Incoterm padrão para Exportação | Não |
|
cod-itiner-imp | Integer | >>,>>9 | Itinerário Padrão para Importação | Não |
|
cod-incoterm-imp | Caracter | X(3) | Incoterm padrão para Importação | Não |
|
char-1 | Caracter | x(100) |
| Não |
|
char-2 | Caracter | x(100) |
| Não |
|
dec-1 | Decimal | ->>>>>>>>>>>9.99999999 |
| Não |
|
dec-2 | Decimal | ->>>>>>>>>>>9.99999999 |
| Não |
|
int-1 | Inteiro | ->>>>>>>>>9 |
| Não |
|
int-2 | Inteiro | ->>>>>>>>>9 |
| Não |
|
log-1 | Lógico | Sim/Não |
| Não |
|
log-2 | Lógico | Sim/Não |
| Não |
|
data-1 | Data | 99/99/9999 |
| Não |
|
data-2 | Data | 99/99/9999 |
| Não |
|
check-sum | Caracter | X(20) | Check-sum | Não |
|
log-desp-inclusas | Lógico | Sim/Não | Despesas Inclusas | Não |
|
nr-tab | Caracter | x(10) | Tabela Preço | Não |
|
cod-pto-contr | Inteiro | >>,>>9 | Ponto Controle | Não |
|
des-layout-origin-comerc-invoi | Caracter | x(256) | Layout original para emissão da Commercial Invoice | Não |
|
des-layout-origin-packing-list | Caracter | x(256) | Layout original para emissão do Packing List | Não |
|
des-layout-origin-proform-invoi | Caracter | x(256) | Layout original para emissão da Proforma Invoice | Não |
|
cdn-despa-import | Inteiro | >>>>>>>>9 | Despachante Importação | Não |
|
cdn-despa-exter-import | Inteiro | >>>>>>>>9 | Despachante Exterior Importação | Não |
|
cdn-segurad-import | Inteiro | >>>>>>>>9 | Seguradora Importação | Não |
|
cdn-corretor-cambio-import | Inteiro | >>>>>>>>9 | Corretor Câmbio Importação | Não |
|
cdn-corretor-import | Inteiro | >>>>>>>>9 | Corretor Importação | Não |
|
marca-1 | Caracter | X(50) | Marca 1 | Não |
|
marca-2 | Caracter | X(50) | Marca 2 | Não |
|
marca-3 | Caracter | X(50) | Marca 3 | Não |
|
marca-4 | Caracter | X(50) | Marca 4 | Não |
|
marca-5 | Caracter | X(50) | Marca 5 | Não |
|
des-layout-origin-ped-cambio | Caracter | x(256) | Layout original para emissão do pedido de fechamento de câmbio | Não |
|
des-layout-origin-instruc-embarq | Caracter | x(256) | Descrição layout original para emissão da instrução de embarque | Não |
|
des-layout-export-instruc-embarq | Caracter | x(256) | Layout Original para emissão da Instrução Embarque (Exportação) | Não |
|
des-layout-origin-pch-order | Caracter | x(256) | Layout Original para emissão da Purchase Order | Não |
|
mo-codigo | Inteiro | >9 | Código da moeda | Não |
|
cod-ident-fisc-exter | Caracter | x(20) | Código Identificacao Fiscal Exterior | Não |
|
RowErrors | Entrada/Saída | ||||
Temp-table contendo as mensagens de validação dos dados | Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ErrorSequence | Inteiro |
| Sequência de Erros | Sim |
|
ErrorNumber | Inteiro |
| Número do Erro | Sim |
|
ErrorDescription | Caracter |
| Descrição do Erro | Sim |
|
ErrorParameters | Caracter |
| Parâmetros do Erro | Sim |
|
ErrorType | Caracter |
| Tipo Erro | Sim |
|
ErrorHelp | Caracter |
| Help | Sim |
|
ErrorSubType | Caracter |
|
| Não |
|
Quando a API for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
pi_validar_emitente_compras | ||
Requisito | Nenhum | |
Sintaxe | pi_validar_emitente_compras (input table tt_emitente_integr_compras, output table RowErrors) | |
Descrição | Procedure responsável pela validação das informações de fornecedores | |
Parâmetros | Descrição | |
tt_emitente_integr_compras
RowErrors | Temp-table com os dados de “Fornecedores” a serem atualizados na tabela “emitente” Temp-table de errors | |
Retorno | A API irá retornar através da tabela “RowErrors” se encontrou alguma inconsistência nas informações passadas na temp-table “tt_emitente_integr_compras” para que o usuário possa estar realizando os devidos ajustes nos registros. | |
pi_validar_emitente_import | ||
Requisito | Nenhum | |
Sintaxe | pi_validar_emitente_import (input table tt_emitente_integr_import, output table RowErrors) | |
Descrição | Procedure responsável pela validação e atualização das informações do fornecedor estrangeiro/trading | |
Parâmetros | Descrição | |
tt_emitente_integr_import
RowErrors | Temp-table com os dados de “Fornecedores Internacionais” a serem atualizados na tabela “emitente-cex” Temp-table de errors | |
Retorno | A API irá retornar através da tabela RowErrors se encontrou alguma inconsistência nas informações passadas na temp-table “tt_emitente_integr_import” para que o usuário possa estar realizando os devidos ajustes nos registros. | |
pi_validar_emitente_export | ||
Requisito | Nenhum | |
Sintaxe | pi_validar_emitente_export (input table tt_emitente_integr_export, output table RowErrors) | |
Descrição | Procedure responsável pela validação e atualização das informações do cliente estrangeiro/trading | |
Parâmetros | Descrição | |
tt_emitente_integr_export
RowErrors | Temp-table com os dados de “Clientes Internacionais” a serem atualizados na tabela “emitente-cex” Temp-table de errors | |
Retorno | A API irá retornar através da tabela “RowErrors” se encontrou alguma inconsistência nas informações passadas na temp-table “tt_emitente_integr_export” para que o usuário possa estar realizando os devidos ajustes nos registros. | |
pi_cria_rowerrors | ||
Requisito | Nenhum | |
Sintaxe | pi_cria_rowerrors (input i_cod_erro, input v_cod_parameters, input v_cod_param_help) | |
Descrição | Procedure responsável pela criação dos erros encontrados no momento da validação Esta temp-table será responsável por mostrar em tela ao usuário os erros encontrados, retornada através das procedures “pi_validar_emitente_compras”, “pi_validar_emitente_import” e “pi_validar_emitente_export”. | |
Parâmetros | Descrição | |
i_cod_erro v_cod_parameters v_cod_param_help | Código do Erro Parâmetros do Erro Parâmetros de Ajuda | |
Retorno | Nenhum | |
pi_grava_emitente_compras | ||
Requisito | Nenhum | |
Sintaxe | pi_grava_emitente_compras (input table tt_emitente_integr_compras) | |
Descrição | Procedure responsável por armazenar os dados do fornecedor na tabela "emitente" na base de dados. | |
Parâmetros | Descrição | |
tt_emitente_integr_compras | Temp-table com os dados de “Fornecedores” a serem atualizados na tabela “emitente”. | |
Retorno | Nenhum | |
pi_grava_emitente_import | ||
Requisito | Nenhum | |
Sintaxe | pi_grava_emitente_import (input table tt_emitente_integr_import) | |
Descrição | Procedure responsável por armazenar os dados do fornecedor internacional na tabela "emitente-cex". | |
Parâmetros | Descrição | |
tt_emitente_integr_import | Temp-table com os dados de “Fornecedores Internacionais” a serem atualizados na tabela “emitente-cex” na base de dados. | |
Retorno | Nenhum | |
pi_grava_emitente_export | ||
Requisito | Nenhum | |
Sintaxe | pi_grava_emitente_export (input table tt_emitente_integr_export) | |
Descrição | Procedure responsável por armazenar os dados do cliente internacional na tabela "emitente-cex" | |
Parâmetros | Descrição | |
tt_emitente_integr_export | Procedure responsável por armazenar os dados do cliente internacional na tabela "emitente-cex" na base de dados. | |
Retorno | Nenhum | |
pi_retorna_dados_emitente_compras | ||
Requisito | Nenhum | |
Sintaxe | pi_retorna_dados_emitente_compras (input pi-cod-emitente, output table tt_emitente_integr_compras) | |
Descrição | Procedure responsável por retornar os dados já armazenados na tabela "emitente" para o folder "Compras" para alteração dos dados. | |
Parâmetros | Descrição | |
pi-cod-emitente tt_emitente_integr_compras | Código do Fornecedor Temp-table com os dados de “Fornecedores” gravados na tabela “emitente”. | |
Retorno | A API irá retornar os dados já armazenados na tabela "emitente" para o folder "Compras" do Workflow de Emitente para alteração dos dados. | |
pi_retorna_dados_emitente_import | ||
Requisito | Nenhum | |
Sintaxe | pi_retorna_dados_emitente_import (input pi-cod-emitente, output table tt_emitente_integr_import) | |
Descrição | Procedure responsável por retornar os dados já armazenados na tabela "emitente-cex" para o folder "Importação" para alteração dos dados | |
Parâmetros | Descrição | |
pi-cod-emitente tt_emitente_integr_import | Código do Fornecedor Temp-table com os dados de “Fornecedores Internacionais” gravados na tabela “emitente-cex” | |
Retorno | A API irá retornar os dados já armazenados na tabela "emitente-cex" para o folder "Importação" do Workflow de Emitente para alteração dos dados. | |
pi_retorna_dados_emitente_export | ||
Requisito | Nenhum | |
Sintaxe | pi_retorna_dados_emitente_export (input pi-cod-emitente, output table tt_emitente_integr_export) | |
Descrição | Procedure responsável por retornar os dados já armazenados na tabela "emitente-cex" para o folder "Exportação" para alteração dos dados. | |
Parâmetros | Descrição | |
pi-cod-emitente tt_emitente_integr_export | Código do Cliente Internacional Temp-table com os dados de “Clientes Internacionais” gravados na tabela “emitente-cex” | |
Retorno | A API irá retornar os dados já armazenados na tabela "emitente-cex" para o folder "Exportação" do Workflow de Emitente para alteração dos dados. | |