TOTVS AGRO

Páginas filhas
  • API Agenda de Eventos

Versões comparadas

Versão antiga 3

changes.mady.by.user Joao Victor Alves Dias

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Joao Victor Alves Dias

Gravado em

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

-

-

-

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

 0

- "Não Integrado"

/ 1 = "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

-

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
titleResponse
{
	"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": null"2",
    	"obs": "TESTE_API_HUB_2",
    "idRastrear": "MNF251114184901",
    Pagamento parcela única",
	"codigoEspDoc": 32null,
    	"codigoEspDocErp": "1"null,
    	"codigoFlxFinanc": 1null,
    	"codigoFlxFinancErp": "1"null,
    	"statusIntErp": "02"
}


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

...

Bloco de código
languagejava
titleBody
{
  "idRastrear": "MNF2511131313400",
  "dtPagamento": "2025-07-10",
  "vlPagamento": 1285.37,
  "fgRealizado": "S",
  "statusIntErp": "0",
  "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
titleResponseBody
{
    "idRastrear": "MNF2511131313400",
    "dtPagamentostatusIntErp": ""1"
}


Observações

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

API Agenda de Eventos 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;

Método GET:

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

Estrutura de dados:

Bloco de código
languagejava
titleResponse
{2025-07-10",
    "vlPagamentoidRastrear": 1285.37"MNF0014630802611",
    "fgRealizadoinstancia": "S0",
    "statusIntErpcodigoEquipto": 4400229,
    "0codigoEvent"
}

...

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

Bloco de código
languagejava
titleBody
{: 3,
    "dataVencimento": "2025-12-15T03:00:00.000+00:00",
    "dataDelecao": "2025-11-18T03:00:00.000+00:00",
    "idRastrearobs": "MNF2511131313400Teste put",
    "statusIntErp": "10"
}


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
titleResponseBody
{
    "idRastrear": "MNF2511131313400MNF0014630802611",
    "statusIntErp": "10"
}


Observações

  • É obrigatório informar os atributos.