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
  • Pré-Autorização
    • Entendendo a Pré-Autorização
    • Criar uma Pré-Autorização
      POST
    • Cancelar uma Pré-Autorização
      PATCH
  • Webhooks
    • Utilizando Webhooks
    • Eventos
      • Entendendo o Payload
      • Atualização de Pré-Autorização
      • Atualização de Prospecção de Antecipação
      • Atualização de Antecipação
      • Troca de Boletos
  1. Eventos

Troca de Boletos

Introdução#

Quando uma antecipação é realizada, a Construtora não mais deverá realizar o pagamento ao Fornecedor, mas sim à ONE pay. Desta forma, a ONE pay gera um boleto com o valor devido para pagamento no prazo original acordado entre Construtora e Fornecedor.
Este boleto é referenciado nesta antecipação e esta ação, ou evento, é chamada Troca de Boleto.

Metadata do Evento:#

A estrutura do metadata deste evento é padrão e segue a seguinte ordem:
CampoDescrição
preAuthorizationIdID recebido no momento da criação da Pré-Autorização
fileArquivo do boleto
fileExtensionExtensão do arquivo
billNumberLinha digitável do boleto
barCodeCódigo de barras do boleto
dueDateData de vencimento do boleto
ourNumberNosso número do boleto
contractedInformações do Fornecedor
contracted.nameNome do Fornecedor
contracted.taxIdCNPJ do Fornecedor
contractorInformações da Construtora
contractor.nameNome da Construtora
contractor.taxIdCNPJ da Construtora
invoiceInformações da Nota fiscal desta antecipação
invoice.discountedGrossValueValor bruto da nota fiscal, descontando-se as retenções.
invoice.grossValueValor bruto da nota fiscal
invoice.numberNúmero da nota fiscal desta antecipação
invoice.externalId* Identificador informado por você na criação da pré-autorização "uniqueId" referente ao seu sistema

Exemplo de Payload#

{
    "id": "5d85ff87-6b22-4c16-8he2-99d7deae76ld",
    "companyId": 48,
    "name": "BILL_SWAPPED",
    "userId": "20",
    "resourceId": "80",
    "dateTime": "2023-04-11 11:49:36",
    "metadata": {
        "preAuthorizationId": 888,
        "file": "fileBase64",
        "fileExtension": "application/pdf",
        "billNumber": "42297004080000354725412346138329394280000470000",
        "barCode": "42293942800004700007004000003547251234613832"
        "dueDate": "2023-04-27",
        "ourNumber": "120",
        "contracted": {
            "name": "Fornecedor do Serviço",
            "taxId": "56295464000127"
        },
        "contractor": {
            "name": "Construtora Responsável",
            "taxId": "73538818000136"
        },
        "invoice": {
            "discountedGrossValue": "800"
            "grossValue": "1000"
            "number": "11027",
            "externalId": "123456"
        }
    }
}

O que esperamos como retorno#

Ao retorar o http status da família 200 (sucesso) será considerado pelo time ONE que o boleto e os dados de pagamento foram inseridos com sucesso na fatura no seu ERP.
Importante frisar que o sucesso deste webhook não se dá pelo recebimento do boleto e seus dados, mas sim em sua atualização na fatura correta, impedindo pagamentos duplicados ao fornecedor.
Consideramos que qualquer retorno diferente da família 200 como falha na integração e tentaremos reenviar este boleto 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.
Previous
Atualização de Antecipação
Built with