Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Informações Gerais

AtributoDetalhe
ProdutoDatasul
OcorrênciaDocumentação de API
Nome Físicofinapi/apiCostCenterIntegraMePublic.p

...

Objetivo

Esta API tem como propósito realizar a integração de Centros de Custo entre o ERP Datasul e a plataforma Mercado Eletrônico. Ela permite a consulta individual (GET) ou em lote (Query) de centros de custo, controlando o status de integração e sinalizando inclusões, alterações ou exclusões através de uma tabela de controle de integração (fgl_integr_ccusto_merc).

...

Descrição: Retorna os detalhes de um Centro de Custo específico baseado no ID de integração. O método verifica se o registro está ativo na data atual (validade) e atualiza a tabela de controle de integração para o status "Em Processamento". Caso o Centro de Custo não exista mais na tabela principal (ccusto), o retorno é montado com status desativado e tipo de transação de exclusão.

Parâmetros

Parâmetro:Tipo: Input/Output:Descrição:
oInputJsonObjectINPUTObjeto JSON contendo os parâmetros da requisição (ID do registro).
oOutputJsonObjectOUTPUTObjeto JSON contendo os dados do Centro de Custo e sua respectiva empresa.
RowErrors Temp-tableOUTPUTTabela contendo erros de negócio ou infraestrutura encontrados durante a execução.


Detalhamento dos parâmetros de entrada

...

Descrição: Realiza a listagem de Centros de Custo vinculados ao plano de centro de custo da empresa do usuário. O método permite filtragem por descrição através do parâmetro search ou filter. Para cada registro encontrado, a API verifica a necessidade de integração (se houve alteração de descrição ou validade) e gera a estrutura JSON necessária para o Integra.Me.

Parâmetros

Parâmetro:Tipo:Input/Output:Descrição:
oInputJsonObjectINPUTFiltros de pesquisa, ordenação e paginação.
aOutputJsonArrayOUTPUTLista de objetos JSON representando os Centros de Custo encontrados.
lHasNextLogicalOUTPUTIndica se existe uma próxima página de dados a ser consultada.
RowErrorsTemp-tableOUTPUTTabela de erros retornada em caso de falha na consulta.


Detalhamento dos parâmetros de entrada

...

Utilizada internamente para mapear os dados que serão convertidos para o formato JSON do Mercado Eletrônico.

CampoTipoSerialize-nameDescrição
ttv_cod_idcharacterclientCostCenterIdID único de integração (Ex: CC-Empresa-Plano)
ttv_des_tit_ctblcharacterdescriptionDescrição do Centro de Custo
ttv_log_desativadologicalisDeactivatedIndica se o CC está fora da validade
ttv_log_statuslogicalstatusStatus da integração
ttv_num_transactionintegertransactionTipo da transação (1-Inclusão, 2-Alteração, 3-Exclusão)
ttv_cod_empresacharacter-Código da empresa (interno)
ttv_cod_plano_ccustocharacter-Código do plano de
CC
Centro de Custo (interno)
ttv_cod_ccustocharacter-Código do Centro de Custo (interno)

RowErrors

Tabela padrão do framework UT-API para retorno de mensagens de erro.

CampoTipoDescrição
ErrorNumberintegerNúmero da mensagem de erro no ERP
ErrorDescriptioncharacterDescrição amigável do erro ocorrido
ErrorFieldcharacterCampo que originou o erro (se aplicável)