Informações Gerais

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).

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

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 empresa do usuário logado e plano de centro de custo ativo na data atual.

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

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.

RowErrors

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