apiCostCenterIntegraMePublic - Integração do Centro de Custo com o Mercado Eletrônico

Informações Gerais

Atributo	Detalhe
Produto	Datasul
Ocorrência	Documentação de API
Nome Físico	finapi/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 (ME)**. 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).

** O Mercado Eletrônico (ME) é uma plataforma especializada em comércio eletrônico B2B (Business to Business), voltada à negociação de produtos e serviços entre empresas. A solução possibilita transações comerciais em um ambiente de alta performance, no qual as informações são compartilhadas de forma estratégica e serviços diferenciados são disponibilizados aos parceiros envolvidos.

Funcionamento

Integração: Baseia-se na tabela fgl_integr_ccusto_merc para rastrear o que já foi enviado. Caso um centro de custo seja excluído no Datasul, a API identifica a ausência e gera um registro de "exclusão" para o Mercado Eletrônico.
Contexto: Utiliza variáveis globais de usuário e empresa para filtrar os dados e registrar auditoria.

Chamada Recomendada:

RUN finapi/apiCostCenterIntegraMePublic.p PERSISTENT SET h-api.

Método de Negócio

pi-get-integra-me-v1

Requisito: É necessário informar o identificador da integração (cod_integr_ccusto_merc) via pathParams. O código é composto pelo Centro de Custo - Empresa - Plano de Centro de Custo. Exemplo: CentroCusto1004-Emp10-PlanoCentroCustoA

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:
oInput	JsonObject	INPUT	Objeto JSON contendo os parâmetros da requisição (ID do registro).
oOutput	JsonObject	OUTPUT	Objeto JSON contendo os dados do Centro de Custo e sua respectiva empresa.
RowErrors	Temp-table	OUTPUT	Tabela contendo erros de negócio ou infraestrutura encontrados durante a execução.

Detalhamento dos parâmetros de entrada

pathParams
- id: Código identificador da integração na tabela fgl_integr_ccusto_merc.

Exemplo de entrada

JSON

{
  "pathParams": [
    "1-100-01"
  ]
}

Exemplo de saída (Inferido)

JSON

{
  "transaction": 2,
  "clientCostCenterId": "1-100-01",
  "description": "Centro de Custo Administrativo",
  "isDeactivated": false,
  "status": false,
  "businessOrganizations": [
    {
      "code": "1",
      "entityType": "EMPRESA"
    }
  ]
}

pi-query-integra-me-v1

Requisito: Contexto de todas as empresas da base e dos planos de centro de custo ativos na data atual, incluindo também os registros já integrados ao Mercado Eletrônico (ME) que foram excluídos no ERP Datasul.

Descrição: Realiza a listagem dos Centros de Custo vinculados aos planos de centro de custo de todas as empresas da base. O método permite filtragem por descrição por meio dos parâmetros search ou filter. Para cada registro encontrado, a API valida a necessidade de integração, considerando as alterações de descrição ou validade e gera a estrutura JSON necessária para integração com o Integra.Me.

Parâmetros

Parâmetro:	Tipo:	Input/Output:	Descrição:
oInput	JsonObject	INPUT	Filtros de pesquisa, ordenação e paginação.
aOutput	JsonArray	OUTPUT	Lista de objetos JSON representando os Centros de Custo encontrados.
lHasNext	Logical	OUTPUT	Indica se existe uma próxima página de dados a ser consultada.
RowErrors	Temp-table	OUTPUT	Tabela de erros retornada em caso de falha na consulta.

Detalhamento dos parâmetros de entrada

queryParams
- search: Termo de pesquisa para filtrar pela descrição do centro de custo.
- pageSize: Quantidade de registros por página.
- start: Registro inicial para paginação.

Exemplo de entrada

JSON

{
  "queryParams": {
    "search": ["Administrativo"],
    "pageSize": 10,
    "start": 1
  }
}

Temp-Tables utilizadas

tt_integr_ccusto_merc

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

Campo	Tipo	Serialize-name	Descrição
ttv_cod_id	character	clientCostCenterId	ID único de integração (Exemplo: CC-Empresa-Plano)
ttv_des_tit_ctbl	character	description	Descrição do Centro de Custo
ttv_log_desativado	logical	isDeactivated	Indica se o CC está fora da validade
ttv_log_status	logical	status	Status da integração
ttv_num_transaction	integer	transaction	Tipo da transação (1-Inclusão, 2-Alteração, 3-Exclusão)
ttv_cod_empresa	character	-	Código da empresa (interno)
ttv_cod_plano_ccusto	character	-	Código do plano de Centro de Custo (interno)
ttv_cod_ccusto	character	-	Código do Centro de Custo (interno)

RowErrors

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

Campo	Tipo	Descrição
ErrorNumber	integer	Número da mensagem de erro no ERP
ErrorDescription	character	Descrição amigável do erro ocorrido
ErrorField	character	Campo que originou o erro (se aplicável)

DEMAIS INFORMAÇÕES

Conteúdos relacionados:

Consulte mais informações através dos links abaixo:

Árvore de páginas

apiCostCenterIntegraMePublic - Integração do Centro de Custo com o Mercado Eletrônico

Informações Gerais

Objetivo

Funcionamento

Método de Negócio

pi-get-integra-me-v1

JSON

JSON

pi-query-integra-me-v1

JSON

Temp-Tables utilizadas

tt_integr_ccusto_merc

RowErrors

DEMAIS INFORMAÇÕES