v 1.0¶

Este documento contém as definições para integração através da versão 1.0.

Remessa¶

Modelo de dados¶

Cedente¶

Título¶

Sacado¶

Lastro¶

Ocorrências¶

0 - Sincronização¶

Utilizado para importar os títulos presentes no ERP do cliente.

sequenceDiagram
    participant ERP
    participant Vehub

    ERP->>Vehub: Sincronizar com Vehub
    Vehub->>ERP: Confirmação de sincronização

Campos necessários do título para o evento de sincronização:

Exemplo

{
  "ocorrrencia": 0,
  "cedente": {
    "tipoPessoa": 2,
    "cpfCnpj": "12345678000199",
    "nome": "Minha Empresa Ltda"
  },
  "titulos": [
    {
      "numeroControleParticipante": "0001",
      "numeroDocumento": "12345",
      "dataEmissao": "2024-11-28",
      "dataVencimento": "2024-12-28",
      "valorNominal": 1000.5,
      "bancoCobranca": 123,
      "agenciaDepositaria": 4567,
      "especie": "DM",
      "jurosMoraDiaAtraso": 0.5,
      "valorAbatimento": 20,
      "tags": [
        "CC01",
        "RATING_A"
      ],
      "sacado": {
        "tipoPessoa": 2,
        "cpfCnpj": "12345678000199",
        "nome": "Sacado I",
        "cep": "12345678",
        "endereco": "Rua dos Sacados, 1000",
        "cidade": "Blumenau",
        "uf": "SC"
      },
      "lastro": {
        "numeroNotaFiscal": "123456789",
        "numeroSerieNotaFiscal": "001",
        "chaveNfe": "12345678901234567890123456789012345678901234",
        "chaveAcessoNfe": "",
        "inscricaoMunicipal": "",
        "codigoMunicipioIBGE": "",
        "dataEmissao": "2024-11-28",
        "dataVencimento": "2024-12-28",
        "valorTotal": 1000.5,
        "tipoLastroPerformado": "BP"
      }
    }
  ]
}

1 - Cessão¶

Utilizado para comunicar a cessão de títulos presentes no Vehub.

sequenceDiagram
    participant ERP
    participant Vehub
    participant Fundo

    ERP->>Vehub: Envia títulos para cessão
    Vehub->>Fundo: Solicita aquisição dos títulos
    Fundo-->>Vehub: Confirma aquisição
    Vehub-->>ERP: Confirma cessão e altera titularidade

Campos necessários do título para o evento de sincronização:

2 - Repasse¶

Utilizado para comunicar a liquidação de títulos presentes no Vehub.

sequenceDiagram
    participant ERP
    participant Vehub
    participant Fundo

    ERP->>Vehub: Realiza liquidação
    Vehub->>Fundo: Repasse de valores
    Fundo-->>Vehub: Confirma recebimento
    Vehub-->>ERP: Liquidação concluída

Campos necessários do título para o evento de repasse:

3 - Recompra¶

Utilizado para comunicar os títulos que foram recomprados para o Vehub.

sequenceDiagram
    participant ERP
    participant Vehub
    participant Fundo

    ERP->>Vehub: Empresa solicita recompra
    Vehub->>Fundo: Solicita retorno dos títulos
    Fundo-->>Vehub: Confirma devolução
    Vehub-->>ERP: Retorna titularidade

Campos necessários do título para o evento de recompra:

4 - Resolução¶

Utilizado para comunicar o cancelamento de títulos para o Vehub.

sequenceDiagram
    participant ERP
    participant Vehub
    participant Fundo

    ERP->>Vehub: Solicita cancelamento
    Vehub->>Fundo: Notifica cancelamento
    Fundo-->>Vehub: Confirma cancelamento
    Vehub-->>ERP: Cancela título

Campos necessários do título para o evento de resolução:

Retorno¶

Modelo de dados¶

Cedente¶

Título¶

Sacado¶

Lastro¶