Atualização de Medição

Introdução

Quando os dados gerais de uma medição são informados, a medição é criada com o status Rascunho.

Após a criação, as próximas informações são enviadas em eventos de atualização da medição.

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 atualizando a medição
stakeholders	CNPJ de empresas que receberão este evento
name	Título do evento
userId	Identificador do usuário atualizando a medição
resourceId	Identificador da medição
dateTime	Horário da criação da medição
metadata.measurementId	Identificador da medição
metadata.projectId	Identificador do projeto
metadata.status	Status da medição
metadata.process	Informação se a medição está completa ou incompleta
metadata.amount	Valor da medição
metadata.contractualRetentionAmount	Valor da retenção contratual
metadata.releasedAmount	Valorliberado da medição
metadata.finalAmount	Valor final da medição
metadata.installments.id	Identificador da parcela
metadata.installments.measurementId	Identificador da medição
metadata.installments.type	Tipo de parcela
metadata.installments.status	Status da parcela
metadata.installments.dueDate	Data de vencimento da parcela
metadata.installments.amount	Valor da parcela
metadata.installments.billetSwapped	Informação se houve antecipação na parcela
metadata.installments.identifier	Número da parcela
invoiceFileBase64	Arquivo da nota fiscal da medição

Exemplo de Payload

{
    "id":"cdf7fce8-1e80-41df-aa3d-a8b44efb1625",
    "companyId":35,
    "resourceType":"MEASUREMENT",
    "stakeholders":["73538818000136"],
    "name":"MEASUREMENT_UPDATED",
    "userId":"47",
    "resourceId":"605",
    "dateTime":"2024-05-03 19:03:09",
    "metadata":{
        "measurementId":605,
        "projectId":16,
        "status":"APPROVED",
        "process":"COMPLETE",
        "amount":2000,
        "contractualRetentionAmount":0,
        "releasedAmount":2000,
        "finalAmount":2000,
        "installments":[{
            "id":995,
            "measurementId":605,
            "type":"COMMITMENT",
            "status":"DRAFT",
            "dueDate":[2024,5,31],
            "amount":2000,
            "billetSwapped":false,
            "identifier":"1"
         }],
    "invoiceFileBase64":""}}

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.

Atualização de Medição

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