Criação e Atualização de Fluxo Financeiro

Introdução

Quando o projeto está configurado para utilização de fluxos financeiros, ao programar o pagamento de uma parcela esta será incluída em um fluxo financeiro com o status aberto.
Caso ainda não haja fluxo financeiro ou este esteja como status fechado, será criado um novo fluxo financeiro.

Metadata do Evento:

A estrutura do metadata deste evento é padrão e segue a seguinte ordem:

Campo	Descrição
id	Identificador do evento
resourceType	Origem do evento
companyId	Identificador da empresa criando ou atualizando o fluxo financeiro
stakeholders	CNPJ de empresas que receberão este evento
name	Título do evento
userId	Identificador do usuário criando ou atualizando o fluxo financeiro
resourceId	Identificador do fluxo financeiro
dateTime	Horário da ocorrência do evento
metadata.id	Identificador do fluxo financeiro
metadata.projectId	Identificador do projeto
metadata.status	Status do fluxo financeiro
metadata.createdDate	Data de criação do fluxo financeiro
metadata.closedDate	Data de fechamento do fluxo financeiro
metadata.amount	Valor total das parcelas inclusas no fluxo financeiro
metadata.feeAmount	Valor da taxa ONE aplicada
metadata.identifier	Número do fluxo financeiro
metadata.billingType	Tipo de faturamento
metadata.responsibleForPayment	Responsável pelo pagamento das parcelas inclusas no fluxo financeiro

Exemplo de Payload

{
    "id":"76626574-282a-4a8f-a5b0-163c7aec1f54",
    "companyId":35,
    "resourceType":"FINANCIAL_FLOW",
    "stakeholders":["73538818000136"],
    "name":"FINANCIAL_FLOW_CREATED_OR_UPDATED",
    "userId":"47",
    "resourceId":"73",
    "dateTime":"2024-05-03 16:46:39",
    "metadata":{
                "id":73,
                "companyId":35,
                "projectId":15,
                "status":"OPEN",
                "createdDate":[2024,5,3],
                "closedDate":[2024,5,10],
                "amount":15000,
                "feeAmount":0,
                "identifier":"1",
                "billingType":"CUSTOMER",
                "responsibleForPayment":"ONE_PAY"
                }
}

O que esperamos como retorno

Ao retorar o http status da família 200 (sucesso) será considerado pelo time ONE que os dados foram inseridos com sucesso na fatura no seu ERP.

Importante frisar que o sucesso deste webhook não se dá pelo recebimento de seus dados, mas sim em sua atualização da informação no sistema ERP.

Consideramos que qualquer retorno diferente da família 200 como falha na integração e tentaremos reenviar os dados novamente por mais 5 (cinco) vezes. Persistindo a falha, haverá um reprocessamento durante a noite, notificando a equipe de suporte ONE para solução do problema.

Criação e Atualização de Fluxo Financeiro

Introdução#

Metadata do Evento:#

Exemplo de Payload#

O que esperamos como retorno#

Introdução

Metadata do Evento:

Exemplo de Payload

O que esperamos como retorno