1. Eventos
  • Introdução
    • Integração ONE
    • Visão Geral da API Rest
    • Ciclo de Vida da API
  • Ambiente
    • Ambiente
  • Autenticação
    • Gerando Chaves de Acesso
    • Autenticando-se
    • Token de Acesso
      POST
  • Projetos
    • Entendendo Projetos
    • Criação de Projeto
      POST
  • Medição
    • Entendendo a Medição
    • Criação de Medição
      POST
    • Consulta de Impostos da Empresa
      GET
    • Adição de Retenções Fiscais em uma Medição
      POST
    • Criação de Parcela em Medição
      POST
    • Validação das Parcelas
      POST
    • Validação da Medição
      PATCH
    • Mudança de Status da Medição
      PATCH
  • Contas a Pagar
    • Entendendo o Contas a Pagar
    • Adicinar Comprovante de Pagamento em Parcela
  • Fluxo Financeiro
    • Entendendo o Fluxo Financeiro
  • Webhooks
    • Entendendo o Payload
    • Eventos
      • Utilizando Webhooks
      • Criação de Medição
      • Atualização de Medição
      • Criação e Atualização de Parcela
      • Criação e Atualização de Fluxo Financeiro
  1. Eventos

Criaçã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:
CampoDescrição
idIdentificador do evento
companyIdIdentificador da empresa criando a medição
stakeholdersCNPJ de empresas que receberão este evento
nameTítulo do evento
userIdIdentificador do usuário criando a medição
resourceIdIdentificador da medição
dateTimeHorário da criação da medição
metadata.measurementIdIdentificador da medição
metadata.projectIdIdentificador do projeto
metadata.statusStatus da medição
processInformação se a medição está completa ou incompleta

Exemplo de Payload#

{
    "id":"3902346d-ef1a-4834-8f8f-66540edf3e43",
    "companyId":181,
    "stakeholders":["61574522000191"],
    "name":"MEASUREMENT_CREATED",
    "userId":"206",
    "resourceId":"558",
    "dateTime":"2024-04-25 14:48:24",
    "metadata":{
        "measurementId":558,
        "projectId":6,
        "status":"DRAFT",
    "process":"INCOMPLETE"
    }
}

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.
Modificado em 2024-05-07 14:33:14
Página anterior
Utilizando Webhooks
Próxima página
Atualização de Medição
Built with