---
title: v 1.0
url: https://docs.vehub.com.br/Layouts/%F0%9F%A7%AD%20Vehub/Documenta%C3%A7%C3%A3o/LayoutJsonV1/
---
# v 1.0

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

## Remessa

### Modelo de dados

| Campo       | Tipo                        | Descrição  |
|-------------|-----------------------------|------------|
| `ocorrencia`  | Número                      | <span>0 - Sincronização<br/>1 - Cessão<br/>2 - Repasse<br/>3 - Recompra<br/>4 - Resolução</span> |
| `cedente`     | [Cedente](#cedente)         | Informações do cedente da operação. |
| `titulos`     | [Lista de Títulos](#titulo) | Lista dos títulos relacionados a ocorrência. |

### Cedente

| Campo      | Tipo     | Descrição |
|------------|----------|------------|
| `tipoPessoa` | Número  | <span>1 - Pessoa Física<br/>2 - Pessoa Jurídica</span> |
| `cpfCnpj`    | Texto   | Documento do cedente (CPF ou CNPJ).                    |
| `nome`       | Texto   | Nome da empresa cedente.                               |

### Título

| Campo                        | Tipo    | Descrição |
|------------------------------|---------|----------------|
| `numeroControleParticipante` | Texto | Número de controle do participante |
| `numeroDocumento` | Texto | Número do documento associado |
| `dataEmissao` | Data | Data de emissão do título |
| `dataVencimento` | Data | Data de vencimento do título |
| `valorNominal` | Monetário | Valor original do título |
| `bancoCobranca` | Número | Código do banco responsável pela cobrança |
| `agenciaDepositaria` | Número | Agência depositária |
| `especie` | Texto | <span>DM - Duplicata Mercantil<br/>UR - Unidade de recebível<br/>NS - Nota Fiscal de Serviço<br/>CCB - CCB Pré Digital</span> |
| `jurosMoraDiaAtraso` | Monetário | Juros aplicados por dia de atraso |
| `valorAbatimento` | Monetário | Valor de desconto aplicado |
| `tags` | Lista de Texto | Tags associadas ao título |
| `sacado` | [Sacado](#sacado) | Informações do pagador |
| `lastro` | [Lastro](#lastro) | Informações do lastro (Nota Fiscal) |

### Sacado

| Campo      | Tipo    | Descrição      |
|------------|--------|----------------|
| `tipoPessoa` | Número  | <span>1 - Pessoa Física<br/>2 - Pessoa Jurídica</span> |
| `cpfCnpj`    | Texto   | Documento do sacado (CPF ou CNPJ) |
| `nome`       | Texto   | Nome do sacado |
| `cep`        | Texto   | CEP do endereço |
| `endereco`   | Texto   | Endereço do sacado |
| `cidade`     | Texto   | Cidade do sacado |
| `uf`         | Texto   | Unidade Federativa |

### Lastro

| Campo                 | Tipo   | Descrição |
|-----------------------|:------:|----------------|
| `numeroNotaFiscal`      | Texto  | Número da nota fiscal |
| `numeroSerieNotaFiscal` | Texto  | Número de série da nota fiscal |
| `chaveNfe`              | Texto  | Chave da nota fiscal eletrônica |
| `chaveAcessoNfe`        | Texto  | Chave de acesso da NF-e |
| `inscricaoMunicipal`    | Texto  | Inscrição municipal |
| `codigoMunicipioIBGE`   | Texto  | Código do município segundo o IBGE |
| `dataEmissao`           | Data   | Data de emissão da nota fiscal |
| `dataVencimento`        | Data   | Data de vencimento da nota fiscal |
| `valorTotal`            | Número | Valor total da nota fiscal |
| `tipoLastroPerformado`  | Texto  | <span>SN - Serviços não Performado<br/>SP - Serviços performado<br/>BN - Bens não performado<br/>BP - Bens performado<br/>MN - Bens serviços não performado<br/>MP - Bens serviços performado</span> |


### Ocorrências

#### 0 - Sincronização

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

```mermaid
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:**

| Campo | Tipo | Descrição |
|------------|---------|------------|
| `numeroControleParticipante` | Texto | Identificador único do título. |
| `numeroDocumento` | Texto | Número do documento associado. |
| `dataEmissao` | Data | Data de emissão do título. |
| `dataVencimento` | Data | Data de vencimento do título. |
| `valorNominal` | Número | Valor original do título. |
| `bancoCobranca` | Número | Código do banco responsável pela cobrança. |
| `agenciaDepositaria` | Número | Agência depositária. |
| `especie` | Texto | Tipo do título: `DM`, `UR`, `NS` ou `CCB`. |
| `jurosMoraDiaAtraso` | Número | Juros aplicados por dia de atraso. |
| `valorAbatimento` | Número | Valor de desconto aplicado. |
| `arranjoPagamentos` | Texto | Descrição do arranjo de pagamentos. |
| `tags` | Lista de Texto | Tags associadas ao título. |
| `sacado` | Objeto | Informações do pagador. |
| `lastro` | Objeto | Informações do lastro (Nota Fiscal). |


**Exemplo**

=== ":octicons-link-16: `exemplo_sincronizacao.json`"
	```json
	{
	  "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 na plataforma.

```mermaid
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:**

| Campo | Tipo | Descrição |
|------------|---------|------------|
| `valorAquisicao` | Número | Valor pelo qual o título foi adquirido. |
| `valorPago` | Número | Valor já pago. |
| `pagamentoParcial` | Booleano ou Nulo | Indica se o pagamento foi parcial. |
| `saldoLiquidacao` | Número | Saldo pendente de liquidação. |

#### 2 - Repasse

Utilizado para comunicar a liquidação de títulos presentes na plataforma.

```mermaid
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:**

| Campo | Tipo | Descrição |
|------------|---------|------------|
| `dataLiquidacao` | Data e Hora | Data e hora da liquidação do título. |
| `valorPago` | Número | Valor efetivamente pago. |
| `pagamentoParcial` | Booleano | Indica se houve pagamento parcial. |
| `saldoLiquidacao` | Número | Saldo pendente de liquidação. |

#### 3 - Recompra

Utilizado para comunicar os títulos que foram recomprados para VeHub.

```mermaid
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:**

| Campo | Tipo | Descrição |
|------------|---------|------------|
| `dataLiquidacao` | Data e Hora | Data e hora da liquidação do título. |
| `valorPago` | Número | Valor efetivamente pago. |
| `pagamentoParcial` | Booleano | Indica se houve pagamento parcial. |
| `saldoLiquidacao` | Número | Saldo pendente de liquidação. |

#### 4 - Resolução

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

```mermaid
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:**

| Campo | Tipo | Descrição |
|------------|---------|------------|
| `dataLiquidacao` | Data e Hora | Data e hora da liquidação do título. |
| `valorPago` | Número | Valor efetivamente pago. |
| `pagamentoParcial` | Booleano | Indica se houve pagamento parcial. |
| `saldoLiquidacao` | Número | Saldo pendente de liquidação. |

## Retorno

### Modelo de dados

| Campo       | Tipo                        | Descrição  |
|-------------|-----------------------------|------------|
| `ocorrencia`  | Número                      | Número do lote no **VeHub** |
| `cedente`     | [Cedente](#cedente_1)         | Informações do cedente da operação. |
| `titulos`     | [Lista de Títulos](#titulo_1) | Lista dos títulos relacionados a ocorrência. |

### Cedente

| Campo      | Tipo     | Descrição |
|------------|----------|------------|
| `tipoPessoa` | Número  | <span>1 - Pessoa Física<br/>2 - Pessoa Jurídica</span> |
| `cpfCnpj`    | Texto   | Documento do cedente (CPF ou CNPJ).                    |
| `nome`       | Texto   | Nome da empresa cedente.                               |

### Título

| Campo                        | Tipo    | Descrição |
|------------------------------|---------|----------------|
| `numeroControleParticipante` | Texto | Número de controle do participante |
| `numeroDocumento` | Texto | Número do documento associado |
| `dataEmissao` | Data | Data de emissão do título |
| `dataVencimento` | Data | Data de vencimento do título |
| `valorNominal` | Monetário | Valor original do título |
| `bancoCobranca` | Número | Código do banco responsável pela cobrança |
| `agenciaDepositaria` | Número | Agência depositária |
| `especie` | Texto | <span>DM - Duplicata Mercantil<br/>UR - Unidade de recebível<br/>NS - Nota Fiscal de Serviço<br/>CCB - CCB Pré Digital</span> |
| `jurosMoraDiaAtraso` | Monetário | Juros aplicados por dia de atraso |
| `valorAbatimento` | Monetário | Valor de desconto aplicado |
| `tags` | Lista de Texto | Tags associadas ao título |
| `sacado` | [Sacado](#sacado_1) | Informações do pagador |
| `lastro` | [Lastro](#lastro_1) | Informações do lastro (Nota Fiscal) |

### Sacado

| Campo      | Tipo    | Descrição      |
|------------|--------|----------------|
| `tipoPessoa` | Número  | <span>1 - Pessoa Física<br/>2 - Pessoa Jurídica</span> |
| `cpfCnpj`    | Texto   | Documento do sacado (CPF ou CNPJ) |
| `nome`       | Texto   | Nome do sacado |
| `cep`        | Texto   | CEP do endereço |
| `endereco`   | Texto   | Endereço do sacado |
| `cidade`     | Texto   | Cidade do sacado |
| `uf`         | Texto   | Unidade Federativa |

### Lastro

| Campo                 | Tipo   | Descrição |
|-----------------------|:------:|----------------|
| `numeroNotaFiscal`      | Texto  | Número da nota fiscal |
| `numeroSerieNotaFiscal` | Texto  | Número de série da nota fiscal |
| `chaveNfe`              | Texto  | Chave da nota fiscal eletrônica |
| `chaveAcessoNfe`        | Texto  | Chave de acesso da NF-e |
| `inscricaoMunicipal`    | Texto  | Inscrição municipal |
| `codigoMunicipioIBGE`   | Texto  | Código do município segundo o IBGE |
| `dataEmissao`           | Data   | Data de emissão da nota fiscal |
| `dataVencimento`        | Data   | Data de vencimento da nota fiscal |
| `valorTotal`            | Número | Valor total da nota fiscal |
| `tipoLastroPerformado`  | Texto  | <span>SN - Serviços não Performado<br/>SP - Serviços performado<br/>BN - Bens não performado<br/>BP - Bens performado<br/>MN - Bens serviços não performado<br/>MP - Bens serviços performado</span> |