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

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

-

-

-

idRastrear

Identificador único do evento para rastreamento.

20

STRING

S

S

-

-

-

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 de Agenda de Eventos.

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

Método GET:

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

Estrutura de dados:

{
	"instancia": "201",
    "empresaErp": " ",
    "filialErp": " ",
    "codigoEquipto": 4400229,
    "codigoRenavam": 1234,
    "noPlaca": "ABC1234",
    "codigoCcusto": null,
    "codigoCcustoErp": null,
    "codigoFavorecido": 3,
    "descricaoFavorecido": "SEC FAZ FEDERAL",
    "codigoFavorecidoErp": null,
    "cnpjCpf": null,
    "codigoEvent": 5,
    "descricaoEvent": "MULTA",
    "dataVencimento": "2013-01-25T02:00:00.000+00:00",
    "valorDespesa": 500,
    "codigoCtaErp": null,
    "obs": "TESTE_API_HUB_2",
    "idRastrear": "MNF251114184901",
    "codigoEspDoc": 32,
    "codigoEspDocErp": "1",
    "codigoFlxFinanc": 1,
    "codigoFlxFinancErp": "1",
    "statusIntErp": "0"
}


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

{
  "idRastrear": "MNF2511131313400",
  "dtPagamento": "2025-07-10",
  "vlPagamento": 1285.37,
  "fgRealizado": "S",
  "statusIntErp": "0",
  "observacaoIntegracao": "Integrado com sucesso" 
}
{
    "idRastrear": "MNF2511131313400",
    "dtPagamento": "2025-07-10",
    "vlPagamento": 1285.37,
    "fgRealizado": "S",
    "statusIntErp": "0",
    "observacaoIntegracao": "Integrado com sucesso"
}

Observações


Método PATCH:

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


{
    "idRastrear": "MNF2511131313400",
    "statusIntErp": "1"
}
{
    "idRastrear": "MNF2511131313400",
    "statusIntErp": "1"
}

Observações