Criação e Atualização de Parcela

Introdução

Quando da criaçaõ da medição, cria-se parcelas com status Rascunho. Ao aprovar a medição, as parcelas seguem para inclusão de método de pagamento e programação do pagamento

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 criando ou atualizando a parcela
resourceId	Identificador da parcela
dateTime	Horário da criação ou edição da parcela
metadata.id	Identificador da parcela
metadata.measurementId	Identificador da medição
metadata.billingType	Informação do tipo de faturamento
metadata.type	Tipo de parcela
metadata.status	Status da parcela
metadata.dueDate	Data de vencimento da parcela
metadata.payerTaxId	CPF/CNPJ do responsável pelo pagamento
metadata.amount	Valor da medição
metadata.supplierTaxId	CNPJ do fornecedor
metadata.billetSwapped	Informação se parcela foi antecipada
metadata.identifier	Número da parcela

Exemplo de Payload

{
    "id":"c8a44e58-2a27-4d5c-9cab-c0ad1f82a648",
    "companyId":35,
    "stakeholders":["73538818000136"],
    "name":"INSTALLMENT_CREATED_OR_UPDATED",
    "userId":"47",
    "resourceId":"812",
    "dateTime":"2024-04-25 15:20:38",
    "metadata":{
                "id":812,
                "measurementId":559,
                "billingType":"CONSTRUCTOR",
                "type":"COMMITMENT",
                "status":"DRAFT",
                "dueDate":[2024,5,10],
                "amount":1000,
                "payerTaxId":"73538818000136",
                "supplierTaxId":"48860613000125",
                "billetSwapped":false,
                "identifier":"1"
      }
}

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 Parcela

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