Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Dados do Documento | |
Nome | API Fachada Grupo de Cliente |
Descrição |
|
Nome Físico | fchcrm/fchcrm1037api.p |
Include com Parâmetros | fchcrm/fchcrm1037.i |
Release Inicial | 12.1.8 |
Versão de Integração | N/A |
Data Liberação | N/A |
Banco | Mdtcrm |
Tabela | crm_grp_clien |
Aplicativo | Portal CRM |
Evolução | |
Versão | 12.1.8 |
Programa | fchcrm/fchcrm1037api.p |
Objetivo
Realizar a manutenção de grupo de cliente.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
ttFilter | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
c_table | Character |
| Tabela | Sim |
c_property | Character |
| Propriedade | Sim |
c_value | Character |
| Valor | Sim |
ttGrupoCliente | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. identificador | Sim |
idi_natur_clien | integer |
| Natureza cliente | Sim |
idi_niv_aces | integer |
| Nível acesso | Sim |
num_livre_1 | integer |
| Numero livre 1 | Sim |
log_integrad_erp | logical |
| Integrado ERP | Sim |
log_suspenso | logical |
| Suspenso | Sim |
nom_categ_clien | character |
| Nome categoria cliente | Sim |
nom_grp_clien | character |
| Nome grupo cliente | Sim |
cod_grp_clien_erp | character |
| Código grupo cliente ERP | Sim |
num_id_classif | integer |
| Numero Id classificação | Sim |
num_id_cond_pagto | integer |
| Numero Id condição pagamento | Sim |
num_id_portad | integer |
| Numero Id portador | Sim |
num_id_ramo_ativid | integer |
| Numero Id ramo atividade | Sim |
num_id_repres | integer |
| Numero Id representante | Sim |
num_id_tab_preco | integer |
| Numero Id tabela preço | Sim |
num_id_transport | integer |
| Numero Id transportadora | Sim |
num_id_usuar_respons | integer |
| Numero Id usuário responsável | Sim |
num_dias | integer |
| Dias | Sim |
num_dias_atraso | integer |
| Dias de atraso | Sim |
num_atraso_max | integer |
| Atraso máximo | Sim |
num_max_cheq_devolv | integer |
| Numero máximo cheque devolvido | Sim |
num_meses_inativ | integer |
| Meses inativo | Sim |
num_period_atraso | integer |
| Período atraso | Sim |
num_period_cheq_devolv | integer |
| Período cheque devolvido | Sim |
val_max_cheq_devolv | decimal |
| Valor máximo cheque devolvido | Sim |
val_perc_bonifi | decimal |
| Percentual bonificação | Sim |
val_perc_cancel_quant | decimal |
| Percentual quantidade cancelado | Sim |
val_perc_max_faturam_ped | decimal |
| Percentual máximo faturamento pedido | Sim |
val_perc_min_faturam_ped | decimal |
| Percentual mínimo faturamento pedido | Sim |
ttRepresentante | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. identificador | Sim |
nom_repres | character |
| Nome representante | Sim |
log_integrad_erp | logical |
| Integrado ERP | Sim |
ttResponsavel | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. identificador | Sim |
nom_usuar | character |
| Nome usuario | Sim |
nom_email | character |
| Nome email | Sim |
ttTabelaPreco | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. identificador | Sim |
nom_tab_preco | character |
| Nome tabela preço | Sim |
ttRamoAtividade | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. identificador | Sim |
nom_ramo_ativid | character |
| Nome ramo atividade | Sim |
ttCondicaoPagamento | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. identificador | Sim |
cod_cond_pagto_erp | character |
| Codigo condição pagamento ERP | Sim |
nom_cond_pagto | character |
| Nome condição pagamento | Sim |
log_integrad_erp | logical |
| Integrado ERP | Sim |
ttPortador | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. identificador | Sim |
cod_portad_erp | character |
| Codigo portador ERP | Sim |
nom_portador | character |
| Nome portador | Sim |
cod_estab | character |
| Código estabelecimento | Sim |
idi_modalid_portad | integer |
| Modalidade portador | Sim |
log_integrad_erp | logical |
| Integrado ERP | Sim |
ttClassificacao | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. identificador | Sim |
nom_clas_clien | character |
| Nome classificação cliente | Sim |
ttTransportadora | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. identificador | Sim |
nom_transpdor | character |
| Nome transportadora | Sim |
log_integrad_erp | logical |
| Integrado ERP | Sim |
Metodo Básico
Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
findClientGroup | ||
Requisito | N/A | |
Sintaxe | findClientGroup (INPUT i_start, INPUT i_end, INPUT c_properties, INPUT c_values, INPUT c_orderBy, INPUT c_asc, INPUT l_count, INPUT i_type, OUTPUT i_count, OUTPUT DATASET DSCRMGrupoCliente, OUTPUT TABLE RowErrors) | |
Descrição | Retorna os registros (query) conforme parâmetros informados. | |
Parâmetros | Descrição | |
i_start | Valor inicial da faixa de registros | |
i_end | Valor final da faixa de registros | |
c_properties | Propriedades | |
c_values | Valores | |
c_orderBy | Campo para ordenação | |
c_asc | Ascendente ou Decrescente | |
l_count | Contador | |
i_type | Tipo | |
i_count | Quantidade de registros selecionados | |
DATASET DSCRMGrupoCliente | Dataset com os registros selecionados | |
TABLE RowErros | Tabela de erros | |
Retorno | A API/BO irá retornar os registros selecionados e a quantidade. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
Metodo Negócio
getAllClientGroups |
| ||
Requisito | N/A |
| |
Sintaxe | getAllClientGroups (OUTPUT TABLE ttGrupoCliente, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna todos os grupos de cliente. |
| |
Parâmetros | Descrição |
| |
TABLE ttGrupoCliente | Tabela grupo cliente |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar todos os grupos de cliente cadastrados. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
|
getClientGroup |
| ||
Requisito | N/A |
| |
Sintaxe | getClientGroup (INPUT i_id, OUTPUT DATASET DSCRMGrupoCliente, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna o detalhe do grupo de cliente solicitado. |
| |
Parâmetros | Descrição |
| |
i_id | Codigo Identificador Sequencial |
| |
DATASET DSCRMGrupoCliente | Dataset com os registros selecionados |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar o detalhe do grupo de cliente solicitado. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
|