[Nova] Consultas, Escriturações e Repasses

O que são Consulta de Eventos

Os eventos de garantia representam ações ocorridas durante o ciclo de vida de um contrato do crédito do trabalhador.
Eles são armazenados em nossa base e podem ser consultados a qualquer momento via API.

Tipos de Evento Disponíveis

Nome	Tipo de Evento	Descrição
Escrituração	BOOKKEEPING	Evento mensal que representa a escrituração (impressão da guia de pagamento das parcelas).
Repasse	TRANSFER	Evento mensal que representa o repasse financeiro da Dataprev para instituição financeira.
Consulta de novo Vínculo	ALTER_ANNOTATION	Identificação pelo "status_contract": "DEACTIVATED_RENEWED_LINK" Evento utilizado para consultar quando há novo vínculo empregatício do tomador.
Encerramento de Vínculo	ALTER_ANNOTATION	Identificação pelo "status_contract": "DEACTIVATED_TERMINATED_LINK" Evento utilizado para consultar quando há encerramento de vínculo empregatício do tomador.

Filtros Disponíveis

Campo	Tipo	Descrição
`application_ids`	UUID	Busca eventos relacionados a uma ou mais operações específicas.
`contract_number`	String	Busca pelo número da CCB.
`event_type`	String	Tipo do evento: `BOOKKEEPING`, `TRANSFER`, `ALTER_ANNOTATION`.
`created_from`	DateTime (ISO 8601)	Retorna eventos criados a partir desta data (`YYYY-MM-DDThh:mm:ssZ`).
`created_to`	DateTime (ISO 8601)	Retorna eventos criados até esta data (`YYYY-MM-DDThh:mm:ssZ`).
`page`	Integer	Número da página a ser retornada (inicia em 0). Caso não informado, será considerado 0.
`size`	Integer	Quantidade de elementos por página. Caso não informado, será considerado 25. Valor máximo permitido: 25.

💡
Dica: Combine filtros para refinar os resultados.
Exemplo: buscar apenas eventos TRANSFER de um contract_number específico.

BOOKKEEPING (Escrituração)

Evento mensal que representa a escrituração (impressão da guia de pagamento das parcelas)

Exemplo de Request:

GET https://platform.flowfinance.com.br/banking/originator/guarantee-events?event_type=BOOKKEEPING

Exemplo de Response

 {
            "id": "8afb1ff0-3e59-4997-a8e4-59bd105d23bc",
            "annotation_id": "089bc005-4735-47e6-a1d1-b95a0a92ef07",
            "event_type": "BOOKKEEPING",
            "payload": {
                "payload": {
                    "id": "8775398a-5656-4dab-9bc9-4519017b9edf",
                    "amount": 146.38,
                    "agency_id": "3ac5c11e-088f-4332-99fe-6eeb0d1dd97c",
                    "metadata": {
                        "loan": {
                            "agency_code": 668,
                            "contract_number": "2381209",
                            "installment_amount": 156
                        },
                        "period": "202511",
                        "event_id": 1192353400000002000000000000000000,
                        "analytic": {
                            "correct_link": false,
                            "correct_agency": false,
                            "corresponding_data": true,
                            "exists_employee_booked": true,
                            "correct_installment_amount": false,
                            "exists_contract_number_booked": true
                        },
                        "document": "14545176623",
                        "agency_code": 668,
                        "employee_code": "C01S030125",
                        "employer_number": 19235340,
                        "deletion_event_id": 0,
                        "inclusion_datetime": 1.765969133E9,
                        "employer_registration": {
                            "code": 1,
                            "description": "CNPJ"
                        },
                        "rectification_event_id": 0
                    },
                    "created_at": 1.7659834741319919E9,
                    "event_type": "BOOKKEEPING",
                    "consignee_id": "1fb3d692-6408-4068-af72-1f2f7b8bcb25",
                    "annotation_id": "089bc005-4735-47e6-a1d1-b95a0a92ef07",
                    "contract_number": "2381209"
                },
                "created_at": 1.7659834741319919E9,
                "event_type": "BOOKKEEPING",
                "annotation_id": "089bc005-4735-47e6-a1d1-b95a0a92ef07",
                "contract_number": "2381209"
            },
            "created_at": "2025-12-17T14:57:54.131Z"
        },

Parâmetros BOOKKEEPING

Campo	Tipo	Descrição	Exemplo

TRANSFER (Repasse)

Evento mensal que representa o repasse financeiro da Dataprev para instituição financeira

Exemplo de Request:

GET https://platform.flowfinance.com.br/banking/originator/guarantee-events?event_type=TRANSFER

Exemplo de Response

        {
            "id": "f105e537-4dd6-43fe-beb5-09e8958fcad8",
            "annotation_id": "43e6e754-2d58-456b-a92b-16610aff0b99",
            "event_type": "TRANSFER",
            "payload": {
                "payload": {
                    "id": "10e51a47-5e74-458f-9e16-e033d5735afa",
                    "amount": 280.13,
                    "agency_id": "3ac5c11e-088f-4332-99fe-6eeb0d1dd97c",
                    "metadata": {
                        "nsu": 322283673,
                        "trf_code": 0,
                        "agency_code": 668,
                        "competence": 202512,
                        "operator_cnpj": 0,
                        "payment_datetime": 1.768935509E9,
                        "inclusion_datetime": 1.769571349E9,
                        "payment_guide_number": 1260116157125629,
                        "agency_transfer_datetime": 1.769571313E9
                    },
                    "created_at": 1.7695834110172973E9,
                    "event_type": "TRANSFER",
                    "consignee_id": "1fb3d692-6408-4068-af72-1f2f7b8bcb25",
                    "annotation_id": "43e6e754-2d58-456b-a92b-16610aff0b99",
                    "contract_number": "2683934"
                },
                "created_at": 1.7695834110172973E9,
                "event_type": "TRANSFER",
                "annotation_id": "43e6e754-2d58-456b-a92b-16610aff0b99",
                "contract_number": "2683934"
            },
            "created_at": "2026-01-28T06:56:51.017Z"
        },

Parâmetros TRANSFER

Campo	Tipo	Descrição	Exemplo

ALTER_ANNOTATION (Consulta de novo vínculo)

Evento utilizado para consultar quando há novo vínculo empregatício do tomador

Exemplo de Request:

GET https://platform.flowfinance.com.br/banking/originator/guarantee-events?event_type=ALTER_ANNOTATION

Exemplo de Response

        {
            "id": "6c53845e-6149-4f3e-943b-fbf35abcca13",
            "annotation_id": "d12ba399-b53b-421c-9785-8afbe3af987e",
            "event_type": "ALTER_ANNOTATION",
            "payload": {
                "status": "SUCCESS",
                "contract": {
                    "number": "2351706",
                    "account": {
                        "bank": "0",
                        "branch": "668",
                        "number": "N/A"
                    },
                    "sequence": "17598202880",
                    "codigo_solicitante": 668,
                    "indicador_analfabetismo": false,
                    "indicador_validacao_com_doc_oficial": false
                },
                "metadata": {
                    "document": "43829061803",
                    "net_amount": 0,
                    "loan_amount": 0,
                    "employer_name": "ENGECON REFORMAS PREDIAIS LTDA",
                    "registration": "546",
                    "employer_number": "32583297",
                    "end_discount_date": 0,
                    "bookings_quantity": 0,
                    "init_discount_date": 0,
                    "payments_quantity": 0,
                    "installment_amount": 0,
                    "installment_quantity": 0,
                    "employer_registration": {
                        "code": 1,
                        "description": "CNPJ"
                    }
                },
                "created_at": "2025-09-25T14:55:11.502Z",
                "action_type": "ALTER_ANNOTATION",
                "operation_id": "17598202880",
                "annotation_id": "d12ba399-b53b-421c-9785-8afbe3af987e",
                "contract_number": "2351706",
                "status_contract": "DEACTIVATED_RENEWED_LINK"
            },
            "created_at": "2025-09-25T14:55:11.502Z"
        },

Parâmetros ALTER_ANNOTATION (Consulta de novo vínculo)

Campo	Tipo	Descrição	Exemplo

ALTER_ANNOTATION (Encerramento de Vínculo)

Evento utilizado para consultar quando há encerramento de vínculo empregatício do tomador

Exemplo de Request:

GET https://platform.flowfinance.com.br/banking/originator/guarantee-events?event_type=ALTER_ANNOTATION

Exemplo de Response

        {
            "id": "ab4c1875-ebca-4d26-b42f-db8cd09419e5",
            "annotation_id": "770335c1-f3f0-4dc0-8c29-f946fd665124",
            "event_type": "ALTER_ANNOTATION",
            "payload": {
                "status": "SUCCESS",
                "contract": {
                    "number": "2419456",
                    "account": {
                        "bank": "0",
                        "branch": "668",
                        "number": "N/A"
                    },
                    "sequence": "17890775785",
                    "codigo_solicitante": 668,
                    "indicador_analfabetismo": false,
                    "indicador_validacao_com_doc_oficial": false
                },
                "metadata": {
                    "document": "12787925626",
                    "net_amount": 484.1,
                    "loan_amount": 490.17,
                    "employee_name": "JONAS DE OLIVEIRA GOMES",
                    "employer_name": "INGLEZA INDUSTRIA DE PRODUTOS DE LIMPEZA E COSMETICOS LTDA.",
                    "registration": "SECERAINGL00000000000000003234",
                    "situation_loan": {
                        "code": 15,
                        "description": "Encerrado por término do vínculo"
                    },
                    "employer_number": "17245028",
                    "proposal_number": "l00yzob30cr",
                    "update_date_time": "2025-11-21T01:41:21",
                    "contract_end_date": "2026-02-21",
                    "end_discount_date": 202601,
                    "termination_date": "2025-09-09",
                    "bookings_quantity": 0,
                    "init_discount_date": 202511,
                    "payments_quantity": 0,
                    "contract_start_date": "2025-10-17",
                    "installment_amount": 252.2,
                    "installment_quantity": 3,
                    "employer_registration": {
                        "code": 1,
                        "description": "CNPJ"
                    },
                    "financial_institution": {
                        "code": 668,
                        "description": "VIA CAPITAL"
                    },
                    "inclusion_loan_date_time": "2025-10-08T18:39:09"
                },
                "created_at": "2025-10-08T21:39:09.612Z",
                "action_type": "ALTER_ANNOTATION",
                "operation_id": "17890775785",
                "annotation_id": "770335c1-f3f0-4dc0-8c29-f946fd665124",
                "contract_number": "2419456",
                "status_contract": "DEACTIVATED_TERMINATED_LINK"
            },
            "created_at": "2025-10-08T21:39:09.612Z"
        },

Parâmetros ALTER_ANNOTATION (Encerramento de Vínculo)

Campo	Tipo	Descrição	Exemplo