Páginas filhas
  • API Agenda de Eventos

Versões comparadas

Chave

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

Disponibilizado endpoint para integração da Agenda de Eventos com os métodos GET (query), PUT e PATCH.


Estrutura:

Atributos

Descrição

Tamanho

Tipo

Chave Primária

Requerido

Valor Default

Valores Válidos

Observação

idRastrear

Identificador único do evento para rastreamento.

20

STRING

S

S

-

-

-

instancia

Código da Instância.

5

STRING

N

N

-

-

-

empresaErp

Código da empresa ERP.

15

STRING

N

N

-

-

-

filialErp

Código da filial ERP.

15

NUMBER

N

N

-

-

-

codigoEquipto

Código do Equipamento.

8

NUMBER

N

N

-

-

-

codigoRenavam

Número do RENAVAM.

12

NUMBER

N

N

-

-

-

noPlaca

Placa do Equipamento.

8

STRING

N

N

-

-

-

codigoCcusto

Código do Centro de Custo.

20

NUMBER

N

N

-

-

-

codigoCcustoErp

Código do Centro de Custo no ERP.

15

STRING

N

N

-

-

-

codigoFavorecido

Código do Favorecido.

4

NUMBER

N

N

-

-

-

descricaoFavorecido

Nome do Favorecido.

50

STRING

N

N

-

-

-

codigoFavorecidoErp

Código do Favorecido no ERP.

15

STRING

N

N

-

-

-

cnpjCpf

CPF ou CNPJ do favorecido.

18

STRING

N

N

-

-

-

codigoEvent

Código do Evento.

3

NUMBER

N

N

-

-

-

descricaoEvent

Descrição do Evento.

40

STRING

N

N

-

-

-

dataVencimento

Data de vencimento da despesa.

10

DATE

N

N

-

-

-

valorDespesa

Valor previsto da despesa.

13,2

NUMBER

N

N

-

-

-

codigoCtaErp

Código da conta contábil no ERP.

15

STRING

N

N

-

-

-

obs

Observações gerais.

500

STRING

N

N

-

-

-

codigoEspDoc

Código de identificação para a espécie de documento.

6

NUMBER

N

N

-

-

-

codigoEspDocErp

Código de identificação para a espécie de documento no ERP.

20

STRING

N

N

-

-

-

codigoFlxFinanc

Código de identificação para o tipo de fluxo financeiro.

6

NUMBER

N

N

-

-

-

codigoFlxFinancErp

Código de identificação para o tipo de fluxo financeiro no ERP.

20

STRING

N

N

-

-

-

statusIntErp

Status da Integração.

1

STRING

N

N

-

0 - "Não Integrado" (Informação gerada no bioenergia, disponível para integração);
        1 - "Integrado com sucesso" (Informação foi consumida via API, gerada no ERP e atualizada via API para integrada)
        2 - "Alterado" (Informação integrada previamente, sofreu modificações no bioenergia e disponível para integração)
        3 - "Falha Integração" (Informação foi consumida via API, sem sucesso ao gerar no ERP e atualizada via API para falha);

-

dtPagamento

Data em que o pagamento foi realizado

10

DATE

N

S

-

-

-

vlPagamento

Valor efetivamente pago

13,2

NUMBER

N

S

-

-

-

fgRealizado

Status da Integração

1

STRING

N

S

-

S - Sim / N - Não

-

observacaoIntegracao

Observação da Integração

250

STRING

N

N

-

-

-

GET - Consultas

...

de Agenda de Eventos

Disponibilizado endpoint para consulta dos Movimentos de Agenda de Eventos.

Retorna todos os registros com statusIntErp igual a '0', '2', '3' ou nulo;

Método GET:

http:127.0.0.1:8080/api/query/v1/agendaEventosMativ

...

Bloco de código
languagejava
titleAgenda de EventosResponse
{
	"idRastrear": "MNF0016592514609",
	"instancia": "201",
    	"empresaErp": " 10",
    	"filialErp": " 10",
    	"codigoEquipto": 44002294100072,
    	"codigoRenavam": 1234734862881,
    	"noPlaca": "ABC1234CVX3281",
    	"codigoCcusto": null117,
    	"codigoCcustoErp": null"117",
    	"codigoFavorecido": 3,
    	"descricaoFavorecido": "SEC FAZ FEDERAL",
    	"codigoFavorecidoErp": null,
    	"cnpjCpf": null,
    	"codigoEvent": 51,
    	"descricaoEvent": "MULTALICENCIAMENTO OBRIG",
    	"dataVencimento": "2013-0102-25T0213T02:00:00.000+00:00",
    	"valorDespesa": 5001300,
	"codigoCtaErp": "2",
	"obs": "Pagamento parcela única"codigoCtaErp,
	"codigoEspDoc": null,
	"codigoEspDocErp": null,
	"codigoFlxFinanc":   "obsnull,
	"codigoFlxFinancErp": null,
	"statusIntErp": "TESTE_API_HUB_2",
  2"
}


Observações

  • A origem dos atributos "empresaErp", "filialErp", "codigoCcusto", "codigoCcustoErp" e "codigoCtaErp" é realizada de acordo com o parâmetro CD_MODELO_INTEGRACAO.

PUT e PATCH - Atualiza Agenda de Eventos

Disponibilizado endpoint para atualização da Agenda de Eventos.

Método PUT:

http:127.0.0.1:8080/api/entity/v1/agendaEventosMativ

Bloco de código
languagejava
titleBody
{
  "idRastrear": "MNF251114184901MNF2511131313400",
  "dtPagamento": "2025-07-10",
  "codigoEspDocvlPagamento": 321285.37,
  "fgRealizado": "S",
  "codigoEspDocErpstatusIntErp": "10",
  "observacaoIntegracao": "Integrado com sucesso" 
}


Observações

  • É obrigatório informar o atributo chave primária idRastrear.


Método PATCH:

          http:127.0.0.1:8080/api/entity/v1/agendaEventosMativ


Bloco de código
languagejava
titleBody
{"codigoFlxFinanc": 1,
    "codigoFlxFinancErpidRastrear": "1MNF2511131313400",
    "statusIntErp": "01"
}

...


Observações

  • É obrigatório informar o atributo chave primária idRastrear.

API Agenda de Eventos

...

  • instancia: Código da Instância.
  • empresaErp: Código da empresa ERP.
  • filialErp: Código da filial ERP.
  • codigoEquipto: Código do Equipamento.
  • codigoRenavam: Númeor do RENAVAM.
  • noPlaca: Placa do Equipamento.
  • codigoCcusto: Código do Centro de Custo.
  • codigoCcustoErp: Código do Centro de Custo no ERP.
  • codigoFavorecido: Código do Favorecido.
  • descricaoFavorecido: Nome do Favorecido.
  • codigoFavorecidoErp: Código do Favorecido no ERP.
  • cnpjCpf: CPF ou CNPJ do favorecido.
  • codigoEvent: Código do Evento.
  • descricaoEvent: Descrição do Evento.
  • dataVencimento: Data de vencimento da despesa.
  • valorDespesa: Valor previsto da despesa.
  • codigoCtaErp: Código da conta contábil no ERP.
  • obs: Observações gerais.
  • idRastrear: Identificador único do evento para rastreamento.
  • codigoEspDoc: Código de identificação para a espécie de documento.
  • codigoEspDocErp: Código de identificação para a espécie de documento no ERP.
  • codigoFlxFinanc: Código de identificação para o tipo de fluxo financeiro.
  • codigoFlxFinancErp: Código de identificação para o tipo de fluxo financeiro no ERP.
  • statusIntErp: Status da Integração.

Consulta dos Movimentos de Abastecimentos

Deletadas

Disponibilizado endpoint para integração da tabela de Log de Deleção dos registros da Agenda de Eventos com os métodos GET e PUT.


Estrutura:

Atributos

Descrição

Tamanho

Tipo

Chave Primária

Requerido

Valor Default

Valores Válidos

Observação

idRastrear

Identificador único do evento para rastreamento.

20

STRING

S

S

-

-

-

instancia

Código da Instância.

5

STRING

N

N

-

-

-

codigoEquipto

Código do Equipamento.

8

NUMBER

N

N

-

-

-

codigoEvent

Código do Evento.

3

NUMBER

N

N

-

-

-

dataVencimento

Data de vencimento da despesa.

10

DATE

N

N

-

-

-

dataDelecao

Data e hora da deleção do registro na Agenda de Eventos.

10

DATE

N

N

-

-

-

obs

Observações gerais.

255

STRING

N

N

-

-

-

statusIntErp

Status da Integração.

1

STRING

N

S

0

0 - "Não Integrado" (informação gerada no bioenergia, disponível para integração);
1 - "Integrado" (informação foi consumida via API, gerada no ERP e atualizada via API para integrada)

-

GET - Consultas de Agenda de Eventos Deletadas

Disponibilizado endpoint para consulta dos registros deletados da Agenda de Eventos no Bioenergia.
Retorna todos os registros com statusIntErp igual a '0' ou nulo;Disponibilizado endpoint para consulta dos Movimentos de Abastecimentos (tabela temporária).

Método GET:

http:127.0.0.1:8080/api/entityquery/v1/rabastec?page=1&pagesize=20deletedAgendaEventosMativ

Estrutura de dados:

Bloco de código
languagejava
titleResponse
{
    "hasNextidRastrear": false,
    "items": [
        {
            "codigoInstancia": "11",
      MNF0014630802611",
      "numeroColetorinstancia": 1,
            "sequencia": 16"0",
            "codigoPonto"codigoEquipto": 384400229,
            "codigoFrentista"codigoEvent": 1100165583,
            "codigoEquipamentodataVencimento": 32030309,
            "codigoOperador": 1198,
            "dataOperacao": "2024-11-13T00"2025-12-15T03:00:00.000+00:00",
            "horaOperacaodataDelecao": "20242025-11-13T1218T03:00:00.000+00:00",
            "codigoCombustivel": 200870,
            "quantidadeAbastecida": 30.55,
            "horimetroOdometro": 37837376.1,
            "codigoGrupoOperacoes": 611"obs": "Teste put",
            "tipoCombustivel"statusIntErp": "P0",
            "codigoBomba": 7,
            "encerranteInicial": 10.1,
            "encerranteFinal": 11.1,
            "codigoRastreamento": null,
            "tipoMovimento": "I
}


PUT  - Atualiza Agenda de Eventos Deletadas

Disponibilizado endpoint para atualização do status dos registros deletados da Agenda de Eventos no Bioenergia.

Método PUT:

http:127.0.0.1:8080/api/entity/v1/deletedAgendaEventosMativ

Bloco de código
languagejava
titleBody
{
    "idRastrear": "MNF0014630802611",
            "codigoCentroCusto"statusIntErp": null,
            "tanqueCompletado": "S",
            "coordenadaLatitude": null,
            "coordenadaLongitude": null,
            "rowversion": 1
        }
    ]
}

Parâmetros

"0"
}


Observações

  • É obrigatório informar os atributos
  • page: Número da página.
  • pagesize: Quantidade de registros por página.