apiCostCenterStatusIntegrMePublic.p - Status 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/apiCostCenterStatusIntegrMePublic.p

Objetivo

Esta API tem como objetivo atualizar o status do processamento de integração dos Centros de Custo na tabela de controle fgl_integr_ccusto_merc. Ela permite que sistemas externos (como a plataforma Mercado Eletrônico (ME)**) reportem se o registro foi processado com sucesso, se houve erro ou se está em alguma etapa específica, além de registrar mensagens de retorno e a data da última atualização.

** 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

Tipo de Execução: A API é executada de forma persistente e utiliza o parser padrão de requisições JSON do framework Datasul.
Persistência: As alterações são realizadas dentro de um bloco de transação (persistenceTransaction), garantindo a integridade dos dados na tabela fgl_integr_ccusto_merc.
Validação: Antes de qualquer alteração, a API valida se o identificador do centro de custo informado existe na tabela de integração através da procedure interna pi-valida-costcenter-integr.

Chamada Recomendada:

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

Método de Negócio

Descrição do método de atualização de status de integração.

pi-put-integra-me-v1

Requisito: É necessário enviar o payload contendo o identificador orderCostCenterME válido e existente na tabela fgl_integr_ccusto_merc.

Descrição: Atualiza os campos de situação (num_sit_integr), data de alteração (dat_alter) e mensagem de processamento (num_msg_integr) de um registro de integração específico. O método centraliza a lógica na procedure pi-store-v1, que gerencia a transação de banco de dados.

Parâmetros

Parâmetro:	Tipo:	Input/Output:	Descrição:
oInput	JsonObject	INPUT	Objeto JSON contendo o payload com os dados de atualização.
oOutput	JsonObject	OUTPUT	Objeto JSON de retorno (vazio em caso de sucesso).
RowErrors	Temp-table	OUTPUT	Tabela contendo erros de validação (ex: registro não encontrado).

Detalhamento dos parâmetros de entrada

payload
- orderCostCenterME: Identificador da integração no Datasul.
- status: Código numérico da nova situação da integração.
- lastUpdateDatetime: Data da atualização (formato Date).
- processMessage: Texto descritivo do processamento ou erro ocorrido no destino.

Exemplo de entrada

JSON

{
  "payload": {
    "orderCostCenterME": "CC-001-EMP01",
    "status": 2,
    "lastUpdateDatetime": "2025-07-21",
    "processMessage": "Integrado com sucesso no portal."
  }
}

Temp-Tables utilizadas

RowErrors

Tabela padrão utilizada para retornar mensagens de erro quando o identificador de integração não é localizado no sistema.

Campo	Tipo	Descrição
ErrorNumber	integer	Código do erro (Exemplo: 10467 quando o registro não existe).
ErrorDescription	character	Descrição da mensagem de erro.
ErrorField	character	Campo que gerou o erro.

DEMAIS INFORMAÇÕES

Conteúdos relacionados:

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

Árvore de páginas